1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
|
/*
Copyright (C) 2009 Paul Davis
Author: David Robillard
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#ifndef __ardour_chan_mapping_h__
#define __ardour_chan_mapping_h__
#include <map>
#include <cassert>
#include <ostream>
#include <utility>
#include "pbd/xml++.h"
#include "ardour/data_type.h"
#include "ardour/chan_count.h"
namespace ARDOUR {
/** A mapping from one set of channels to another.
* The general form is 1 source (from), many sinks (to).
* numeric IDs are used to identify sources and sinks.
*
* for plugins this is used to map "plugin-pin" to "audio-buffer"
*/
class LIBARDOUR_API ChanMapping {
public:
ChanMapping() {}
ChanMapping(ARDOUR::ChanCount identity);
ChanMapping(const ChanMapping&);
ChanMapping(const XMLNode& node);
uint32_t get(DataType t, uint32_t from, bool* valid) const;
/** reverse lookup
* @param type data type
* @param to pin
* @param valid pointer to a boolean. If not NULL it is set to true if the mapping is found, and false otherwise.
* @returns first "from" that matches given "to"
*/
uint32_t get_src(DataType t, uint32_t to, bool* valid) const;
/** get buffer mapping for given data type and pin
* @param type data type
* @param from numeric source id
* @returns mapped buffer number (or ChanMapping::Invalid)
*/
uint32_t get (DataType t, uint32_t from) const { return get (t, from, NULL); }
/** set buffer mapping for given data type
* @param type data type
* @param from numeric source id
* @param to buffer
*/
void set(DataType t, uint32_t from, uint32_t to);
void offset_from(DataType t, int32_t delta);
void offset_to(DataType t, int32_t delta);
/** remove mapping
* @param type data type
* @param from numeric source to remove from mapping
*/
void unset(DataType t, uint32_t from);
/** Test mapping matrix for identity
* @param offset per data-type offset to take into account
* @returns true if the mapping is a channel identity map
*/
bool is_identity (ARDOUR::ChanCount offset = ARDOUR::ChanCount()) const;
/** Test if this mapping is monotonic (useful to see if inplace processing is feasible)
* @returns true if the map is a strict monotonic set
*/
bool is_monotonic () const;
uint32_t n_total () const;
ChanCount count () const;
XMLNode* state(const std::string& name) const;
/** Test if this mapping is a subset
* @param superset to test against
* @returns true if all mapping are also present in the superset
*/
bool is_subset (const ChanMapping& superset) const;
typedef std::map<uint32_t, uint32_t> TypeMapping;
typedef std::map<DataType, TypeMapping> Mappings;
Mappings mappings() { return _mappings; }
const Mappings mappings() const { return _mappings; }
bool operator==(const ChanMapping& other) const {
return (_mappings == other._mappings);
}
bool operator!=(const ChanMapping& other) const {
return ! (*this == other);
}
private:
Mappings _mappings;
};
} // namespace ARDOUR
std::ostream& operator<<(std::ostream& o, const ARDOUR::ChanMapping& m);
#endif // __ardour_chan_mapping_h__
|
