src/lib/audio_mapping.h

   1 /*
   2     Copyright (C) 2013-2014 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 /** @file  src/lib/audio_mapping.h
  21  *  @brief AudioMapping class.
  22  */
  23
  24 #ifndef DCPOMATIC_AUDIO_MAPPING_H
  25 #define DCPOMATIC_AUDIO_MAPPING_H
  26
  27 #include <vector>
  28 #include <boost/shared_ptr.hpp>
  29 #include <dcp/types.h>
  30 #include <libcxml/cxml.h>
  31
  32 namespace xmlpp {
  33         class Node;
  34 }
  35
  36 namespace cxml {
  37         class Node;
  38 }
  39
  40 /** @class AudioMapping.
  41  *  @brief A many-to-many mapping from some content channels to DCP channels.
  42  *
  43  *  The number of content channels is set on construction and fixed,
  44  *  and then each of those content channels are mapped to each DCP channel
  45  *  by a linear gain.
  46  */
  47 class AudioMapping
  48 {
  49 public:
  50         AudioMapping ();
  51         AudioMapping (int channels);
  52         AudioMapping (cxml::ConstNodePtr, int);
  53
  54         /* Default copy constructor is fine */
  55
  56         void as_xml (xmlpp::Node *) const;
  57
  58         void make_default ();
  59
  60         void set (int, dcp::Channel, float);
  61         float get (int, dcp::Channel) const;
  62
  63         int content_channels () const {
  64                 return _content_channels;
  65         }
  66
  67         std::string digest () const;
  68
  69 private:
  70         void setup (int);
  71
  72         int _content_channels;
  73         std::vector<std::vector<float> > _gain;
  74 };
  75
  76 #endif