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
  22 /** @file  src/lib/audio_mapping.h
  23  *  @brief AudioMapping class.
  24  */
  25
  26
  27 #ifndef DCPOMATIC_AUDIO_MAPPING_H
  28 #define DCPOMATIC_AUDIO_MAPPING_H
  29
  30
  31 #include <dcp/types.h>
  32 #include <libcxml/cxml.h>
  33 #include <vector>
  34
  35
  36 namespace xmlpp {
  37         class Node;
  38 }
  39
  40 class AudioProcessor;
  41
  42
  43 /** @class AudioMapping.
  44  *  @brief A many-to-many mapping of audio channels.
  45  */
  46 class AudioMapping
  47 {
  48 public:
  49         AudioMapping () {}
  50         AudioMapping (int input_channels, int output_channels);
  51         AudioMapping (cxml::ConstNodePtr, int);
  52
  53         /* Default copy constructor is fine */
  54
  55         void as_xml (xmlpp::Node *) const;
  56
  57         void make_zero ();
  58         void make_default (AudioProcessor const * processor, boost::optional<boost::filesystem::path> filename = boost::optional<boost::filesystem::path>());
  59
  60         void set (dcp::Channel input_channel, int output_channel, float);
  61         void set (int input_channel, int output_channel, float);
  62         void set (int input_channel, dcp::Channel output_channel, float);
  63         float get (int input_channel, int output_channel) const;
  64         float get (int input_channel, dcp::Channel output_channel) const;
  65
  66         int input_channels () const {
  67                 return _gain.size();
  68         }
  69
  70         int output_channels () const {
  71                 return _gain.empty() ? 0 : _gain[0].size();
  72         }
  73
  74         std::string digest () const;
  75
  76         std::list<int> mapped_output_channels () const;
  77         void unmap_all ();
  78
  79         void take_from(AudioMapping const& other);
  80
  81 private:
  82         void setup (int input_channels, int output_channels);
  83
  84         /** Linear gains */
  85         std::vector<std::vector<float>> _gain;
  86 };
  87
  88
  89 #endif