src/lib/audio_mapping.h

   1 /*
   2     Copyright (C) 2013-2021 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 /** @file  src/lib/audio_mapping.h
  22  *  @brief AudioMapping class.
  23  */
  24
  25 #ifndef DCPOMATIC_AUDIO_MAPPING_H
  26 #define DCPOMATIC_AUDIO_MAPPING_H
  27
  28 #include <dcp/types.h>
  29 #include <libcxml/cxml.h>
  30 #include <vector>
  31
  32 namespace xmlpp {
  33         class Node;
  34 }
  35
  36 class AudioProcessor;
  37
  38 /** @class AudioMapping.
  39  *  @brief A many-to-many mapping of audio channels.
  40  */
  41 class AudioMapping
  42 {
  43 public:
  44         AudioMapping ();
  45         AudioMapping (int input_channels, int output_channels);
  46         AudioMapping (cxml::ConstNodePtr, int);
  47
  48         /* Default copy constructor is fine */
  49
  50         void as_xml (xmlpp::Node *) const;
  51
  52         void make_zero ();
  53         void make_default (AudioProcessor const * processor, boost::optional<boost::filesystem::path> filename = boost::optional<boost::filesystem::path>());
  54
  55         void set (dcp::Channel input_channel, int output_channel, float);
  56         void set (int input_channel, int output_channel, float);
  57         void set (int input_channel, dcp::Channel output_channel, float);
  58         float get (int input_channel, int output_channel) const;
  59         float get (int input_channel, dcp::Channel output_channel) const;
  60
  61         int input_channels () const {
  62                 return _input_channels;
  63         }
  64
  65         int output_channels () const {
  66                 return _output_channels;
  67         }
  68
  69         std::string digest () const;
  70
  71         std::list<int> mapped_output_channels () const;
  72         void unmap_all ();
  73
  74 private:
  75         void setup (int input_channels, int output_channels);
  76
  77         int _input_channels;
  78         int _output_channels;
  79         std::vector<std::vector<float> > _gain;
  80 };
  81
  82 #endif