src/lib/audio_mapping.cc

   1 /*
   2     Copyright (C) 2013-2018 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 #include "audio_mapping.h"
  22 #include "audio_processor.h"
  23 #include "digester.h"
  24 #include "util.h"
  25 #include "warnings.h"
  26 #include <dcp/raw_convert.h>
  27 #include <libcxml/cxml.h>
  28 DCPOMATIC_DISABLE_WARNINGS
  29 #include <libxml++/libxml++.h>
  30 DCPOMATIC_ENABLE_WARNINGS
  31 #include <boost/regex.hpp>
  32 #include <iostream>
  33
  34 using std::list;
  35 using std::cout;
  36 using std::make_pair;
  37 using std::pair;
  38 using std::string;
  39 using std::min;
  40 using std::vector;
  41 using std::abs;
  42 using std::shared_ptr;
  43 using std::dynamic_pointer_cast;
  44 using boost::optional;
  45 using dcp::raw_convert;
  46
  47 AudioMapping::AudioMapping ()
  48         : _input_channels (0)
  49         , _output_channels (0)
  50 {
  51
  52 }
  53
  54 /** Create an empty AudioMapping.
  55  *  @param input_channels Number of input channels.
  56  *  @param output_channels Number of output channels.
  57  */
  58 AudioMapping::AudioMapping (int input_channels, int output_channels)
  59 {
  60         setup (input_channels, output_channels);
  61 }
  62
  63 void
  64 AudioMapping::setup (int input_channels, int output_channels)
  65 {
  66         _input_channels = input_channels;
  67         _output_channels = output_channels;
  68
  69         _gain.resize (_input_channels);
  70         for (int i = 0; i < _input_channels; ++i) {
  71                 _gain[i].resize (_output_channels);
  72         }
  73
  74         make_zero ();
  75 }
  76
  77 void
  78 AudioMapping::make_zero ()
  79 {
  80         for (int i = 0; i < _input_channels; ++i) {
  81                 for (int j = 0; j < _output_channels; ++j) {
  82                         _gain[i][j] = 0;
  83                 }
  84         }
  85 }
  86
  87 struct ChannelRegex
  88 {
  89         ChannelRegex (string regex_, int channel_)
  90                 : regex (regex_)
  91                 , channel (channel_)
  92         {}
  93
  94         string regex;
  95         int channel;
  96 };
  97
  98 void
  99 AudioMapping::make_default (AudioProcessor const * processor, optional<boost::filesystem::path> filename)
 100 {
 101         static ChannelRegex const regex[] = {
 102                 ChannelRegex(".*[\\._-]L[\\._-].*", 0),
 103                 ChannelRegex(".*[\\._-]R[\\._-].*", 1),
 104                 ChannelRegex(".*[\\._-]C[\\._-].*", 2),
 105                 ChannelRegex(".*[\\._-]Lfe[\\._-].*", 3),
 106                 ChannelRegex(".*[\\._-]LFE[\\._-].*", 3),
 107                 ChannelRegex(".*[\\._-]Lss[\\._-].*", 4),
 108                 ChannelRegex(".*[\\._-]Lsr[\\._-].*", 6),
 109                 ChannelRegex(".*[\\._-]Ls[\\._-].*", 4),
 110                 ChannelRegex(".*[\\._-]Rss[\\._-].*", 5),
 111                 ChannelRegex(".*[\\._-]Rsr[\\._-].*", 7),
 112                 ChannelRegex(".*[\\._-]Rs[\\._-].*", 5),
 113         };
 114
 115         static int const regexes = sizeof(regex) / sizeof(*regex);
 116
 117         if (processor) {
 118                 processor->make_audio_mapping_default (*this);
 119         } else {
 120                 make_zero ();
 121                 if (input_channels() == 1) {
 122                         bool guessed = false;
 123
 124                         /* See if we can guess where this stream should go */
 125                         if (filename) {
 126                                 for (int i = 0; i < regexes; ++i) {
 127                                         boost::regex e (regex[i].regex, boost::regex::icase);
 128                                         if (boost::regex_match(filename->string(), e) && regex[i].channel < output_channels()) {
 129                                                 set (0, regex[i].channel, 1);
 130                                                 guessed = true;
 131                                         }
 132                                 }
 133                         }
 134
 135                         if (!guessed) {
 136                                 /* If we have no idea, just put it on centre */
 137                                 set (0, static_cast<int>(dcp::CENTRE), 1);
 138                         }
 139                 } else {
 140                         /* 1:1 mapping */
 141                         for (int i = 0; i < min (input_channels(), output_channels()); ++i) {
 142                                 set (i, i, 1);
 143                         }
 144                 }
 145         }
 146 }
 147
 148 AudioMapping::AudioMapping (cxml::ConstNodePtr node, int state_version)
 149 {
 150         if (state_version < 32) {
 151                 setup (node->number_child<int> ("ContentChannels"), MAX_DCP_AUDIO_CHANNELS);
 152         } else {
 153                 setup (node->number_child<int> ("InputChannels"), node->number_child<int> ("OutputChannels"));
 154         }
 155
 156         if (state_version <= 5) {
 157                 /* Old-style: on/off mapping */
 158                 list<cxml::NodePtr> const c = node->node_children ("Map");
 159                 for (list<cxml::NodePtr>::const_iterator i = c.begin(); i != c.end(); ++i) {
 160                         set ((*i)->number_child<int> ("ContentIndex"), static_cast<dcp::Channel> ((*i)->number_child<int> ("DCP")), 1);
 161                 }
 162         } else {
 163                 list<cxml::NodePtr> const c = node->node_children ("Gain");
 164                 for (list<cxml::NodePtr>::const_iterator i = c.begin(); i != c.end(); ++i) {
 165                         if (state_version < 32) {
 166                                 set (
 167                                         (*i)->number_attribute<int> ("Content"),
 168                                         static_cast<dcp::Channel> ((*i)->number_attribute<int> ("DCP")),
 169                                         raw_convert<float> ((*i)->content ())
 170                                         );
 171                         } else {
 172                                 set (
 173                                         (*i)->number_attribute<int> ("Input"),
 174                                         (*i)->number_attribute<int> ("Output"),
 175                                         raw_convert<float> ((*i)->content ())
 176                                         );
 177                         }
 178                 }
 179         }
 180 }
 181
 182 void
 183 AudioMapping::set (int input_channel, int output_channel, float g)
 184 {
 185         DCPOMATIC_ASSERT (input_channel < int(_gain.size()));
 186         DCPOMATIC_ASSERT (output_channel < int(_gain[0].size()));
 187         _gain[input_channel][output_channel] = g;
 188 }
 189
 190 float
 191 AudioMapping::get (int input_channel, int output_channel) const
 192 {
 193         DCPOMATIC_ASSERT (input_channel < int (_gain.size()));
 194         DCPOMATIC_ASSERT (output_channel < int (_gain[0].size()));
 195         return _gain[input_channel][output_channel];
 196 }
 197
 198 void
 199 AudioMapping::as_xml (xmlpp::Node* node) const
 200 {
 201         node->add_child ("InputChannels")->add_child_text (raw_convert<string> (_input_channels));
 202         node->add_child ("OutputChannels")->add_child_text (raw_convert<string> (_output_channels));
 203
 204         for (int c = 0; c < _input_channels; ++c) {
 205                 for (int d = 0; d < _output_channels; ++d) {
 206                         xmlpp::Element* t = node->add_child ("Gain");
 207                         t->set_attribute ("Input", raw_convert<string> (c));
 208                         t->set_attribute ("Output", raw_convert<string> (d));
 209                         t->add_child_text (raw_convert<string> (get (c, d)));
 210                 }
 211         }
 212 }
 213
 214 /** @return a string which is unique for a given AudioMapping configuration, for
 215  *  differentiation between different AudioMappings.
 216  */
 217 string
 218 AudioMapping::digest () const
 219 {
 220         Digester digester;
 221         digester.add (_input_channels);
 222         digester.add (_output_channels);
 223         for (int i = 0; i < _input_channels; ++i) {
 224                 for (int j = 0; j < _output_channels; ++j) {
 225                         digester.add (_gain[i][j]);
 226                 }
 227         }
 228
 229         return digester.get ();
 230 }
 231
 232 list<int>
 233 AudioMapping::mapped_output_channels () const
 234 {
 235         static float const minus_96_db = 0.000015849;
 236
 237         list<int> mapped;
 238
 239         for (vector<vector<float> >::const_iterator i = _gain.begin(); i != _gain.end(); ++i) {
 240                 BOOST_FOREACH (dcp::Channel j, dcp::used_audio_channels()) {
 241                         if (abs ((*i)[j]) > minus_96_db) {
 242                                 mapped.push_back (j);
 243                         }
 244                 }
 245         }
 246
 247         mapped.sort ();
 248         mapped.unique ();
 249
 250         return mapped;
 251 }
 252
 253 void
 254 AudioMapping::unmap_all ()
 255 {
 256         for (vector<vector<float> >::iterator i = _gain.begin(); i != _gain.end(); ++i) {
 257                 for (vector<float>::iterator j = i->begin(); j != i->end(); ++j) {
 258                         *j = 0;
 259                 }
 260         }
 261 }