Support Dolby-style WAV back surround names when guessing mappings (#2427).
[dcpomatic.git] / src / lib / audio_mapping.cc
index bf454b5e5e43cddbdfa48695e5e9fc01eacc863d..ca2425862e733dc68acc9a08312f904580d78b99 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2013-2015 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2021 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
 
 */
 
+
 #include "audio_mapping.h"
-#include "util.h"
+#include "audio_processor.h"
+#include "constants.h"
+#include "dcpomatic_assert.h"
 #include "digester.h"
 #include <dcp/raw_convert.h>
+#include <dcp/warnings.h>
 #include <libcxml/cxml.h>
+LIBDCP_DISABLE_WARNINGS
 #include <libxml++/libxml++.h>
+LIBDCP_ENABLE_WARNINGS
+#include <boost/regex.hpp>
 #include <iostream>
 
+
 using std::list;
 using std::cout;
 using std::make_pair;
@@ -34,16 +42,11 @@ using std::string;
 using std::min;
 using std::vector;
 using std::abs;
-using boost::shared_ptr;
-using boost::dynamic_pointer_cast;
+using std::shared_ptr;
+using std::dynamic_pointer_cast;
+using boost::optional;
 using dcp::raw_convert;
 
-AudioMapping::AudioMapping ()
-       : _input_channels (0)
-       , _output_channels (0)
-{
-
-}
 
 /** Create an empty AudioMapping.
  *  @param input_channels Number of input channels.
@@ -54,6 +57,7 @@ AudioMapping::AudioMapping (int input_channels, int output_channels)
        setup (input_channels, output_channels);
 }
 
+
 void
 AudioMapping::setup (int input_channels, int output_channels)
 {
@@ -68,6 +72,7 @@ AudioMapping::setup (int input_channels, int output_channels)
        make_zero ();
 }
 
+
 void
 AudioMapping::make_zero ()
 {
@@ -78,46 +83,135 @@ AudioMapping::make_zero ()
        }
 }
 
+
+struct ChannelRegex
+{
+       ChannelRegex (string regex_, int channel_)
+               : regex (regex_)
+               , channel (channel_)
+       {}
+
+       string regex;
+       int channel;
+};
+
+
+void
+AudioMapping::make_default (AudioProcessor const * processor, optional<boost::filesystem::path> filename)
+{
+       static ChannelRegex const regex[] = {
+               ChannelRegex(".*[\\._-]L[\\._-].*", 0),
+               ChannelRegex(".*[\\._-]R[\\._-].*", 1),
+               ChannelRegex(".*[\\._-]C[\\._-].*", 2),
+               ChannelRegex(".*[\\._-]Lfe[\\._-].*", 3),
+               ChannelRegex(".*[\\._-]LFE[\\._-].*", 3),
+               ChannelRegex(".*[\\._-]Lss[\\._-].*", 4),
+               ChannelRegex(".*[\\._-]Lsr[\\._-].*", 6),
+               ChannelRegex(".*[\\._-]Lrs[\\._-].*", 6),
+               ChannelRegex(".*[\\._-]Ls[\\._-].*", 4),
+               ChannelRegex(".*[\\._-]Rss[\\._-].*", 5),
+               ChannelRegex(".*[\\._-]Rsr[\\._-].*", 7),
+               ChannelRegex(".*[\\._-]Rrs[\\._-].*", 7),
+               ChannelRegex(".*[\\._-]Rs[\\._-].*", 5),
+       };
+
+       static int const regexes = sizeof(regex) / sizeof(*regex);
+
+       if (processor) {
+               processor->make_audio_mapping_default (*this);
+       } else {
+               make_zero ();
+               if (input_channels() == 1) {
+                       bool guessed = false;
+
+                       /* See if we can guess where this stream should go */
+                       if (filename) {
+                               for (int i = 0; i < regexes; ++i) {
+                                       boost::regex e (regex[i].regex, boost::regex::icase);
+                                       if (boost::regex_match(filename->filename().string(), e) && regex[i].channel < output_channels()) {
+                                               set (0, regex[i].channel, 1);
+                                               guessed = true;
+                                       }
+                               }
+                       }
+
+                       if (!guessed) {
+                               /* If we have no idea, just put it on centre */
+                               set (0, static_cast<int>(dcp::Channel::CENTRE), 1);
+                       }
+               } else {
+                       /* 1:1 mapping */
+                       for (int i = 0; i < min (input_channels(), output_channels()); ++i) {
+                               set (i, i, 1);
+                       }
+               }
+       }
+}
+
+
 AudioMapping::AudioMapping (cxml::ConstNodePtr node, int state_version)
 {
        if (state_version < 32) {
-               setup (node->number_child<int> ("ContentChannels"), MAX_DCP_AUDIO_CHANNELS);
+               setup (node->number_child<int>("ContentChannels"), MAX_DCP_AUDIO_CHANNELS);
        } else {
-               setup (node->number_child<int> ("InputChannels"), node->number_child<int> ("OutputChannels"));
+               setup (node->number_child<int>("InputChannels"), node->number_child<int>("OutputChannels"));
        }
 
        if (state_version <= 5) {
                /* Old-style: on/off mapping */
-               list<cxml::NodePtr> const c = node->node_children ("Map");
-               for (list<cxml::NodePtr>::const_iterator i = c.begin(); i != c.end(); ++i) {
-                       set ((*i)->number_child<int> ("ContentIndex"), static_cast<dcp::Channel> ((*i)->number_child<int> ("DCP")), 1);
+               for (auto i: node->node_children ("Map")) {
+                       set (i->number_child<int>("ContentIndex"), i->number_child<int>("DCP"), 1);
                }
        } else {
-               list<cxml::NodePtr> const c = node->node_children ("Gain");
-               for (list<cxml::NodePtr>::const_iterator i = c.begin(); i != c.end(); ++i) {
+               for (auto i: node->node_children("Gain")) {
                        if (state_version < 32) {
                                set (
-                                       (*i)->number_attribute<int> ("Content"),
-                                       static_cast<dcp::Channel> ((*i)->number_attribute<int> ("DCP")),
-                                       raw_convert<float> ((*i)->content ())
+                                       i->number_attribute<int>("Content"),
+                                       i->number_attribute<int>("DCP"),
+                                       raw_convert<float>(i->content())
                                        );
                        } else {
                                set (
-                                       (*i)->number_attribute<int> ("Input"),
-                                       (*i)->number_attribute<int> ("Output"),
-                                       raw_convert<float> ((*i)->content ())
+                                       i->number_attribute<int>("Input"),
+                                       i->number_attribute<int>("Output"),
+                                       raw_convert<float>(i->content())
                                        );
                        }
                }
        }
 }
 
+
+void
+AudioMapping::set (dcp::Channel input_channel, int output_channel, float g)
+{
+       set (static_cast<int>(input_channel), output_channel, g);
+}
+
+
+void
+AudioMapping::set (int input_channel, dcp::Channel output_channel, float g)
+{
+       set (input_channel, static_cast<int>(output_channel), g);
+}
+
+
 void
 AudioMapping::set (int input_channel, int output_channel, float g)
 {
+       DCPOMATIC_ASSERT (input_channel < int(_gain.size()));
+       DCPOMATIC_ASSERT (output_channel < int(_gain[0].size()));
        _gain[input_channel][output_channel] = g;
 }
 
+
+float
+AudioMapping::get (int input_channel, dcp::Channel output_channel) const
+{
+       return get (input_channel, static_cast<int>(output_channel));
+}
+
+
 float
 AudioMapping::get (int input_channel, int output_channel) const
 {
@@ -126,6 +220,7 @@ AudioMapping::get (int input_channel, int output_channel) const
        return _gain[input_channel][output_channel];
 }
 
+
 void
 AudioMapping::as_xml (xmlpp::Node* node) const
 {
@@ -134,7 +229,7 @@ AudioMapping::as_xml (xmlpp::Node* node) const
 
        for (int c = 0; c < _input_channels; ++c) {
                for (int d = 0; d < _output_channels; ++d) {
-                       xmlpp::Element* t = node->add_child ("Gain");
+                       auto t = node->add_child ("Gain");
                        t->set_attribute ("Input", raw_convert<string> (c));
                        t->set_attribute ("Output", raw_convert<string> (d));
                        t->add_child_text (raw_convert<string> (get (c, d)));
@@ -142,6 +237,7 @@ AudioMapping::as_xml (xmlpp::Node* node) const
        }
 }
 
+
 /** @return a string which is unique for a given AudioMapping configuration, for
  *  differentiation between different AudioMappings.
  */
@@ -160,6 +256,7 @@ AudioMapping::digest () const
        return digester.get ();
 }
 
+
 list<int>
 AudioMapping::mapped_output_channels () const
 {
@@ -167,10 +264,10 @@ AudioMapping::mapped_output_channels () const
 
        list<int> mapped;
 
-       for (vector<vector<float> >::const_iterator i = _gain.begin(); i != _gain.end(); ++i) {
-               for (size_t j = 0; j < i->size(); ++j) {
-                       if (abs ((*i)[j]) > minus_96_db) {
-                               mapped.push_back (j);
+       for (auto const& i: _gain) {
+               for (auto j: dcp::used_audio_channels()) {
+                       if (abs(i[static_cast<int>(j)]) > minus_96_db) {
+                               mapped.push_back (static_cast<int>(j));
                        }
                }
        }
@@ -181,12 +278,13 @@ AudioMapping::mapped_output_channels () const
        return mapped;
 }
 
+
 void
 AudioMapping::unmap_all ()
 {
-       for (vector<vector<float> >::iterator i = _gain.begin(); i != _gain.end(); ++i) {
-               for (vector<float>::iterator j = i->begin(); j != i->end(); ++j) {
-                       *j = 0;
+       for (auto& i: _gain) {
+               for (auto& j: i) {
+                       j = 0;
                }
        }
 }