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