Rename SafeStringStream -> locked_stringstream. Bump deps for removal of stringstream.
[dcpomatic.git] / src / lib / audio_content.cc
index bd4bb565ff73c9b8e553369a9a40d5f7d3968365..4e9d5cd5cee5395b3a22058fd0cf6c08f57e1e57 100644 (file)
@@ -1,19 +1,20 @@
 /*
     Copyright (C) 2013-2016 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of DCP-o-matic.
+
+    DCP-o-matic is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    DCP-o-matic is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 
@@ -34,7 +35,6 @@
 using std::string;
 using std::cout;
 using std::vector;
-using std::stringstream;
 using std::fixed;
 using std::list;
 using std::pair;
@@ -44,110 +44,98 @@ using boost::dynamic_pointer_cast;
 using boost::optional;
 
 /** Something stream-related has changed */
-int const AudioContentProperty::AUDIO_STREAMS = 200;
-int const AudioContentProperty::AUDIO_GAIN = 201;
-int const AudioContentProperty::AUDIO_DELAY = 202;
-int const AudioContentProperty::AUDIO_VIDEO_FRAME_RATE = 203;
-
-AudioContent::AudioContent (shared_ptr<const Film> film)
-       : Content (film)
-       , _audio_gain (0)
-       , _audio_delay (Config::instance()->default_audio_delay ())
+int const AudioContentProperty::STREAMS = 200;
+int const AudioContentProperty::GAIN = 201;
+int const AudioContentProperty::DELAY = 202;
+
+AudioContent::AudioContent (Content* parent)
+       : ContentPart (parent)
+       , _gain (0)
+       , _delay (Config::instance()->default_audio_delay ())
 {
 
 }
 
-AudioContent::AudioContent (shared_ptr<const Film> film, DCPTime s)
-       : Content (film, s)
-       , _audio_gain (0)
-       , _audio_delay (Config::instance()->default_audio_delay ())
+shared_ptr<AudioContent>
+AudioContent::from_xml (Content* parent, cxml::ConstNodePtr node, int version)
 {
+       if (version < 34) {
+               /* With old metadata FFmpeg content has the audio-related tags even with no
+                  audio streams, so check for that.
+               */
+               if (node->string_child("Type") == "FFmpeg" && node->node_children("AudioStream").empty()) {
+                       return shared_ptr<AudioContent> ();
+               }
 
-}
+               /* Otherwise we can drop through to the newer logic */
+       }
 
-AudioContent::AudioContent (shared_ptr<const Film> film, boost::filesystem::path p)
-       : Content (film, p)
-       , _audio_gain (0)
-       , _audio_delay (Config::instance()->default_audio_delay ())
-{
+       if (!node->optional_number_child<double> ("AudioGain")) {
+               return shared_ptr<AudioContent> ();
+       }
 
+       return shared_ptr<AudioContent> (new AudioContent (parent, node));
 }
 
-AudioContent::AudioContent (shared_ptr<const Film> film, cxml::ConstNodePtr node)
-       : Content (film, node)
+AudioContent::AudioContent (Content* parent, cxml::ConstNodePtr node)
+       : ContentPart (parent)
 {
-       _audio_gain = node->number_child<double> ("AudioGain");
-       _audio_delay = node->number_child<int> ("AudioDelay");
-       _audio_video_frame_rate = node->optional_number_child<double> ("AudioVideoFrameRate");
+       _gain = node->number_child<double> ("AudioGain");
+       _delay = node->number_child<int> ("AudioDelay");
+
+       /* Backwards compatibility */
+       optional<double> r = node->optional_number_child<double> ("AudioVideoFrameRate");
+       if (r) {
+               _parent->set_video_frame_rate (r.get ());
+       }
 }
 
-AudioContent::AudioContent (shared_ptr<const Film> film, vector<shared_ptr<Content> > c)
-       : Content (film, c)
+AudioContent::AudioContent (Content* parent, vector<shared_ptr<Content> > c)
+       : ContentPart (parent)
 {
-       shared_ptr<AudioContent> ref = dynamic_pointer_cast<AudioContent> (c[0]);
+       shared_ptr<AudioContent> ref = c[0]->audio;
        DCPOMATIC_ASSERT (ref);
 
-       for (size_t i = 0; i < c.size(); ++i) {
-               shared_ptr<AudioContent> ac = dynamic_pointer_cast<AudioContent> (c[i]);
-
-               if (ac->audio_gain() != ref->audio_gain()) {
+       for (size_t i = 1; i < c.size(); ++i) {
+               if (c[i]->audio->gain() != ref->gain()) {
                        throw JoinError (_("Content to be joined must have the same audio gain."));
                }
 
-               if (ac->audio_delay() != ref->audio_delay()) {
+               if (c[i]->audio->delay() != ref->delay()) {
                        throw JoinError (_("Content to be joined must have the same audio delay."));
                }
-
-               if (ac->audio_video_frame_rate() != ref->audio_video_frame_rate()) {
-                       throw JoinError (_("Content to be joined must have the same video frame rate."));
-               }
        }
 
-       _audio_gain = ref->audio_gain ();
-       _audio_delay = ref->audio_delay ();
-       /* Preserve the optional<> part of this */
-       _audio_video_frame_rate = ref->_audio_video_frame_rate;
+       _gain = ref->gain ();
+       _delay = ref->delay ();
+       _streams = ref->streams ();
 }
 
 void
 AudioContent::as_xml (xmlpp::Node* node) const
 {
        boost::mutex::scoped_lock lm (_mutex);
-       node->add_child("AudioGain")->add_child_text (raw_convert<string> (_audio_gain));
-       node->add_child("AudioDelay")->add_child_text (raw_convert<string> (_audio_delay));
-       if (_audio_video_frame_rate) {
-               node->add_child("AudioVideoFrameRate")->add_child_text (raw_convert<string> (_audio_video_frame_rate.get()));
-       }
+       node->add_child("AudioGain")->add_child_text (raw_convert<string> (_gain));
+       node->add_child("AudioDelay")->add_child_text (raw_convert<string> (_delay));
 }
 
-
 void
-AudioContent::set_audio_gain (double g)
+AudioContent::set_gain (double g)
 {
-       {
-               boost::mutex::scoped_lock lm (_mutex);
-               _audio_gain = g;
-       }
-
-       signal_changed (AudioContentProperty::AUDIO_GAIN);
+       maybe_set (_gain, g, AudioContentProperty::GAIN);
 }
 
 void
-AudioContent::set_audio_delay (int d)
+AudioContent::set_delay (int d)
 {
-       {
-               boost::mutex::scoped_lock lm (_mutex);
-               _audio_delay = d;
-       }
-
-       signal_changed (AudioContentProperty::AUDIO_DELAY);
+       maybe_set (_delay, d, AudioContentProperty::DELAY);
 }
 
 string
 AudioContent::technical_summary () const
 {
        string s = "audio :";
-       BOOST_FOREACH (AudioStreamPtr i, audio_streams ()) {
+       BOOST_FOREACH (AudioStreamPtr i, streams ()) {
                s += String::compose ("stream channels %1 rate %2", i->channels(), i->frame_rate());
        }
 
@@ -155,10 +143,10 @@ AudioContent::technical_summary () const
 }
 
 void
-AudioContent::set_audio_mapping (AudioMapping mapping)
+AudioContent::set_mapping (AudioMapping mapping)
 {
        int c = 0;
-       BOOST_FOREACH (AudioStreamPtr i, audio_streams ()) {
+       BOOST_FOREACH (AudioStreamPtr i, streams ()) {
                AudioMapping stream_mapping (i->channels (), MAX_DCP_AUDIO_CHANNELS);
                for (int j = 0; j < i->channels(); ++j) {
                        for (int k = 0; k < MAX_DCP_AUDIO_CHANNELS; ++k) {
@@ -169,14 +157,14 @@ AudioContent::set_audio_mapping (AudioMapping mapping)
                i->set_mapping (stream_mapping);
        }
 
-       signal_changed (AudioContentProperty::AUDIO_STREAMS);
+       _parent->signal_changed (AudioContentProperty::STREAMS);
 }
 
 AudioMapping
-AudioContent::audio_mapping () const
+AudioContent::mapping () const
 {
        int channels = 0;
-       BOOST_FOREACH (AudioStreamPtr i, audio_streams ()) {
+       BOOST_FOREACH (AudioStreamPtr i, streams ()) {
                channels += i->channels ();
        }
 
@@ -185,7 +173,7 @@ AudioContent::audio_mapping () const
 
        int c = 0;
        int s = 0;
-       BOOST_FOREACH (AudioStreamPtr i, audio_streams ()) {
+       BOOST_FOREACH (AudioStreamPtr i, streams ()) {
                AudioMapping mapping = i->mapping ();
                for (int j = 0; j < mapping.input_channels(); ++j) {
                        for (int k = 0; k < MAX_DCP_AUDIO_CHANNELS; ++k) {
@@ -205,12 +193,12 @@ AudioContent::audio_mapping () const
  *  that it is in sync with the active video content at its start time.
  */
 int
-AudioContent::resampled_audio_frame_rate () const
+AudioContent::resampled_frame_rate () const
 {
        /* Resample to a DCI-approved sample rate */
        double t = has_rate_above_48k() ? 96000 : 48000;
 
-       FrameRateChange frc (audio_video_frame_rate(), film()->video_frame_rate());
+       FrameRateChange frc (_parent->active_video_frame_rate(), _parent->film()->video_frame_rate());
 
        /* Compensate if the DCP is being run at a different frame rate
           to the source; that is, if the video is run such that it will
@@ -227,8 +215,7 @@ AudioContent::resampled_audio_frame_rate () const
 string
 AudioContent::processing_description () const
 {
-       vector<AudioStreamPtr> streams = audio_streams ();
-       if (streams.empty ()) {
+       if (streams().empty ()) {
                return "";
        }
 
@@ -244,8 +231,8 @@ AudioContent::processing_description () const
        bool same = true;
 
        optional<int> common_frame_rate;
-       BOOST_FOREACH (AudioStreamPtr i, streams) {
-               if (i->frame_rate() != resampled_audio_frame_rate()) {
+       BOOST_FOREACH (AudioStreamPtr i, streams()) {
+               if (i->frame_rate() != resampled_frame_rate()) {
                        resampled = true;
                } else {
                        not_resampled = true;
@@ -262,14 +249,14 @@ AudioContent::processing_description () const
        }
 
        if (not_resampled && resampled) {
-               return String::compose (_("Some audio will be resampled to %1kHz"), resampled_audio_frame_rate ());
+               return String::compose (_("Some audio will be resampled to %1kHz"), resampled_frame_rate ());
        }
 
        if (!not_resampled && resampled) {
                if (same) {
-                       return String::compose (_("Audio will be resampled from %1kHz to %2kHz"), common_frame_rate.get(), resampled_audio_frame_rate ());
+                       return String::compose (_("Audio will be resampled from %1kHz to %2kHz"), common_frame_rate.get(), resampled_frame_rate ());
                } else {
-                       return String::compose (_("Audio will be resampled to %1kHz"), resampled_audio_frame_rate ());
+                       return String::compose (_("Audio will be resampled to %1kHz"), resampled_frame_rate ());
                }
        }
 
@@ -280,7 +267,7 @@ AudioContent::processing_description () const
 bool
 AudioContent::has_rate_above_48k () const
 {
-       BOOST_FOREACH (AudioStreamPtr i, audio_streams ()) {
+       BOOST_FOREACH (AudioStreamPtr i, streams ()) {
                if (i->frame_rate() > 48000) {
                        return true;
                }
@@ -291,12 +278,12 @@ AudioContent::has_rate_above_48k () const
 
 /** @return User-visible names of each of our audio channels */
 vector<string>
-AudioContent::audio_channel_names () const
+AudioContent::channel_names () const
 {
        vector<string> n;
 
        int t = 1;
-       BOOST_FOREACH (AudioStreamPtr i, audio_streams ()) {
+       BOOST_FOREACH (AudioStreamPtr i, streams ()) {
                for (int j = 0; j < i->channels(); ++j) {
                        n.push_back (String::compose ("%1:%2", t, j + 1));
                }
@@ -310,69 +297,84 @@ void
 AudioContent::add_properties (list<UserProperty>& p) const
 {
        shared_ptr<const AudioStream> stream;
-       if (audio_streams().size() == 1) {
-               stream = audio_streams().front ();
+       if (streams().size() == 1) {
+               stream = streams().front ();
        }
 
        if (stream) {
-               p.push_back (UserProperty (_("Audio"), _("Channels"), stream->channels ()));
-               p.push_back (UserProperty (_("Audio"), _("Content audio frame rate"), stream->frame_rate(), _("Hz")));
+               p.push_back (UserProperty (UserProperty::AUDIO, _("Channels"), stream->channels ()));
+               p.push_back (UserProperty (UserProperty::AUDIO, _("Content audio sample rate"), stream->frame_rate(), _("Hz")));
        }
 
-       FrameRateChange const frc (audio_video_frame_rate(), film()->video_frame_rate());
-       ContentTime const c (full_length(), frc);
+       FrameRateChange const frc (_parent->active_video_frame_rate(), _parent->film()->video_frame_rate());
+       ContentTime const c (_parent->full_length(), frc);
 
        p.push_back (
-               UserProperty (_("Length"), _("Full length in video frames at content rate"), c.frames_round(frc.source))
+               UserProperty (UserProperty::LENGTH, _("Full length in video frames at content rate"), c.frames_round(frc.source))
                );
 
        if (stream) {
                p.push_back (
                        UserProperty (
-                               _("Length"),
-                               _("Full length in audio frames at content rate"),
+                               UserProperty::LENGTH,
+                               _("Full length in audio samples at content rate"),
                                c.frames_round (stream->frame_rate ())
                                )
                        );
        }
 
-       p.push_back (UserProperty (_("Audio"), _("DCP frame rate"), resampled_audio_frame_rate (), _("Hz")));
-       p.push_back (UserProperty (_("Length"), _("Full length in video frames at DCP rate"), c.frames_round (frc.dcp)));
+       p.push_back (UserProperty (UserProperty::AUDIO, _("DCP sample rate"), resampled_frame_rate (), _("Hz")));
+       p.push_back (UserProperty (UserProperty::LENGTH, _("Full length in video frames at DCP rate"), c.frames_round (frc.dcp)));
 
        if (stream) {
                p.push_back (
                        UserProperty (
-                               _("Length"),
-                               _("Full length in audio frames at DCP rate"),
-                               c.frames_round (resampled_audio_frame_rate ())
+                               UserProperty::LENGTH,
+                               _("Full length in audio samples at DCP rate"),
+                               c.frames_round (resampled_frame_rate ())
                                )
                        );
        }
 }
 
 void
-AudioContent::set_audio_video_frame_rate (double r)
+AudioContent::set_streams (vector<AudioStreamPtr> streams)
 {
        {
                boost::mutex::scoped_lock lm (_mutex);
-               _audio_video_frame_rate = r;
+               _streams = streams;
        }
 
-       signal_changed (AudioContentProperty::AUDIO_VIDEO_FRAME_RATE);
+       _parent->signal_changed (AudioContentProperty::STREAMS);
 }
 
-double
-AudioContent::audio_video_frame_rate () const
+AudioStreamPtr
+AudioContent::stream () const
+{
+       boost::mutex::scoped_lock lm (_mutex);
+       DCPOMATIC_ASSERT (_streams.size() == 1);
+       return _streams.front ();
+}
+
+void
+AudioContent::add_stream (AudioStreamPtr stream)
 {
        {
                boost::mutex::scoped_lock lm (_mutex);
-               if (_audio_video_frame_rate) {
-                       return _audio_video_frame_rate.get ();
-               }
+               _streams.push_back (stream);
        }
 
-       /* No frame rate specified, so assume this content has been
-          prepared for any concurrent video content.
-       */
-       return film()->active_frame_rate_change(position()).source;
+       _parent->signal_changed (AudioContentProperty::STREAMS);
+}
+
+void
+AudioContent::set_stream (AudioStreamPtr stream)
+{
+       {
+               boost::mutex::scoped_lock lm (_mutex);
+               _streams.clear ();
+               _streams.push_back (stream);
+       }
+
+       _parent->signal_changed (AudioContentProperty::STREAMS);
 }