libs/ardour/ardour/chan_mapping.h

   1 /*
   2     Copyright (C) 2009 Paul Davis
   3     Author: David Robillard
   4
   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.
   9
  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.
  14
  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.
  18 */
  19
  20 #ifndef __ardour_chan_mapping_h__
  21 #define __ardour_chan_mapping_h__
  22
  23 #include <map>
  24 #include <cassert>
  25 #include <ostream>
  26 #include <utility>
  27
  28 #include "ardour/data_type.h"
  29 #include "ardour/chan_count.h"
  30
  31 namespace ARDOUR {
  32
  33
  34 /** A mapping from one set of channels to another
  35  * (e.g. how to 'connect' two BufferSets).
  36  *
  37  * for plugins the form is  "pin" -> "buffer"
  38  */
  39 class LIBARDOUR_API ChanMapping {
  40 public:
  41         ChanMapping() {}
  42         ChanMapping(ARDOUR::ChanCount identity);
  43         ChanMapping(const ChanMapping&);
  44
  45         uint32_t get(DataType t, uint32_t from, bool* valid) const;
  46
  47         /** get buffer mapping for given data type and pin
  48          * @param type data type
  49          * @param from pin
  50          * @returns mapped buffer number (or ChanMapping::Invalid)
  51          */
  52         uint32_t get(DataType t, uint32_t from) const { return get (t, from, NULL); }
  53         /** set buffer mapping for given data type
  54          * @param type data type
  55          * @param from pin
  56          * @param to buffer
  57          */
  58         void     set(DataType t, uint32_t from, uint32_t to);
  59         void     offset_from(DataType t, int32_t delta);
  60         void     offset_to(DataType t, int32_t delta);
  61
  62         /** remove mapping
  63          * @param type data type
  64          * @param from source to remove from mapping
  65          */
  66         void     unset(DataType t, uint32_t from);
  67
  68         /** Test mapping matrix for identity
  69          * @param offset per data-type offset to take into account
  70          * @returns true if the mapping is a channel identity map
  71          */
  72         bool     is_identity (ARDOUR::ChanCount offset = ARDOUR::ChanCount()) const;
  73
  74         /** Test if this mapping is monotonic (useful to see if inplace processing is feasible)
  75          * @returns true if the map is a strict monotonic set
  76          */
  77         bool     is_monotonic () const;
  78
  79
  80         /** Test if this mapping is a subset
  81          * @param superset to test against
  82          * @returns true if all mapping are also present in the superset
  83          */
  84         bool     is_subset (const ChanMapping& superset) const;
  85
  86         typedef std::map<uint32_t, uint32_t>    TypeMapping;
  87         typedef std::map<DataType, TypeMapping> Mappings;
  88
  89         Mappings       mappings()       { return _mappings; }
  90         const Mappings mappings() const { return _mappings; }
  91
  92         bool operator==(const ChanMapping& other) const {
  93                 return (_mappings == other._mappings);
  94         }
  95
  96         bool operator!=(const ChanMapping& other) const {
  97                 return ! (*this == other);
  98         }
  99
 100 private:
 101         Mappings _mappings;
 102 };
 103
 104 } // namespace ARDOUR
 105
 106 std::ostream& operator<<(std::ostream& o, const ARDOUR::ChanMapping& m);
 107
 108 #endif // __ardour_chan_mapping_h__
 109