libs/ardour/ardour/chan_count.h

   1 /*
   2     Copyright (C) 2006 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_count_h__
  21 #define __ardour_chan_count_h__
  22
  23 #include <cassert>
  24 #include <ostream>
  25
  26 #include "pbd/xml++.h"
  27 #include "ardour/data_type.h"
  28
  29 namespace ARDOUR {
  30
  31
  32 /** A count of channels, possibly with many types.
  33  *
  34  * Operators are defined so this may safely be used as if it were a simple
  35  * (single-typed) integer count of channels.
  36  */
  37 class ChanCount {
  38 public:
  39         ChanCount(const XMLNode& node);
  40         ChanCount() { reset(); }
  41
  42         // Convenience constructor for making single-typed streams (stereo, mono, etc)
  43         ChanCount(DataType type, uint32_t channels) {
  44                 reset();
  45                 set(type, channels);
  46         }
  47
  48         void reset() {
  49                 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
  50                         _counts[*t] = 0;
  51                 }
  52         }
  53
  54         void     set(DataType t, uint32_t count) { assert(t != DataType::NIL); _counts[t] = count; }
  55         uint32_t get(DataType t) const { assert(t != DataType::NIL); return _counts[t]; }
  56
  57         inline uint32_t n_audio() const { return _counts[DataType::AUDIO]; }
  58         inline void set_audio(uint32_t a) { _counts[DataType::AUDIO] = a; }
  59
  60         inline uint32_t n_midi()  const { return _counts[DataType::MIDI]; }
  61         inline void set_midi(uint32_t m) { _counts[DataType::MIDI] = m; }
  62
  63         uint32_t n_total() const {
  64                 uint32_t ret = 0;
  65                 for (uint32_t i=0; i < DataType::num_types; ++i)
  66                         ret += _counts[i];
  67
  68                 return ret;
  69         }
  70
  71         bool operator==(const ChanCount& other) const {
  72                 for (uint32_t i=0; i < DataType::num_types; ++i)
  73                         if (_counts[i] != other._counts[i])
  74                                 return false;
  75
  76                 return true;
  77         }
  78
  79         bool operator!=(const ChanCount& other) const {
  80                 return ! (*this == other);
  81         }
  82
  83         bool operator<(const ChanCount& other) const {
  84                 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
  85                         if (_counts[*t] > other._counts[*t]) {
  86                                 return false;
  87                         }
  88                 }
  89                 return (*this != other);
  90         }
  91
  92         bool operator<=(const ChanCount& other) const {
  93                 return ( (*this < other) || (*this == other) );
  94         }
  95
  96         bool operator>(const ChanCount& other) const {
  97                 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
  98                         if (_counts[*t] < other._counts[*t]) {
  99                                 return false;
 100                         }
 101                 }
 102                 return (*this != other);
 103         }
 104
 105         bool operator>=(const ChanCount& other) const {
 106                 return ( (*this > other) || (*this == other) );
 107         }
 108
 109         ChanCount operator+(const ChanCount& other) const {
 110                 ChanCount ret;
 111                 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
 112                         ret.set(*t, get(*t) + other.get(*t));
 113                 }
 114                 return ret;
 115         }
 116
 117         ChanCount& operator+=(const ChanCount& other) {
 118                 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
 119                         _counts[*t] += other._counts[*t];
 120                 }
 121                 return *this;
 122         }
 123
 124         static ChanCount min(const ChanCount& a, const ChanCount& b) {
 125                 ChanCount ret;
 126                 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
 127                         ret.set(*t, std::min(a.get(*t), b.get(*t)));
 128                 }
 129                 return ret;
 130         }
 131
 132         static ChanCount max(const ChanCount& a, const ChanCount& b) {
 133                 ChanCount ret;
 134                 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
 135                         ret.set(*t, std::max(a.get(*t), b.get(*t)));
 136                 }
 137                 return ret;
 138         }
 139
 140         XMLNode* state(const std::string& name) const;
 141
 142         static const ChanCount INFINITE;
 143         static const ChanCount ZERO;
 144
 145 private:
 146         uint32_t _counts[DataType::num_types];
 147 };
 148
 149 } // namespace ARDOUR
 150
 151 std::ostream& operator<<(std::ostream& o, const ARDOUR::ChanCount& c);
 152
 153 #endif // __ardour_chan_count_h__
 154