src/lib/audio_mapping.cc

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