No-op: remove all trailing whitespace.
[dcpomatic.git] / src / lib / ffmpeg_content.cc
index f4e1b9e72b44be79d63a759d80ec00e24735e559..c4fc363578f6c32ea23c3dec56b6f0a3bc39b0fb 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2013 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2015 Carl Hetherington <cth@carlh.net>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
 
 */
 
-#include <libcxml/cxml.h>
 #include "ffmpeg_content.h"
 #include "ffmpeg_examiner.h"
+#include "ffmpeg_subtitle_stream.h"
+#include "ffmpeg_audio_stream.h"
 #include "compose.hpp"
 #include "job.h"
 #include "util.h"
 #include "filter.h"
 #include "film.h"
 #include "log.h"
+#include "exceptions.h"
+#include "frame_rate_change.h"
+#include "safe_stringstream.h"
+#include "raw_convert.h"
+#include <libcxml/cxml.h>
+extern "C" {
+#include <libavformat/avformat.h>
+}
+#include <boost/foreach.hpp>
 
 #include "i18n.h"
 
+#define LOG_GENERAL(...) film->log()->log (String::compose (__VA_ARGS__), Log::TYPE_GENERAL);
+
 using std::string;
-using std::stringstream;
 using std::vector;
 using std::list;
 using std::cout;
+using std::pair;
 using boost::shared_ptr;
-using boost::lexical_cast;
+using boost::dynamic_pointer_cast;
 
 int const FFmpegContentProperty::SUBTITLE_STREAMS = 100;
 int const FFmpegContentProperty::SUBTITLE_STREAM = 101;
-int const FFmpegContentProperty::AUDIO_STREAMS = 102;
-int const FFmpegContentProperty::AUDIO_STREAM = 103;
-int const FFmpegContentProperty::FILTERS = 104;
-
-FFmpegContent::FFmpegContent (shared_ptr<const Film> f, boost::filesystem::path p)
-       : Content (f, p)
-       , VideoContent (f, p)
-       , AudioContent (f, p)
-       , SubtitleContent (f, p)
+int const FFmpegContentProperty::FILTERS = 102;
+
+FFmpegContent::FFmpegContent (shared_ptr<const Film> film, boost::filesystem::path p)
+       : Content (film, p)
+       , VideoContent (film, p)
+       , AudioContent (film, p)
+       , SubtitleContent (film, p)
 {
 
 }
 
-FFmpegContent::FFmpegContent (shared_ptr<const Film> f, shared_ptr<const cxml::Node> node)
-       : Content (f, node)
-       , VideoContent (f, node)
-       , AudioContent (f, node)
-       , SubtitleContent (f, node)
+FFmpegContent::FFmpegContent (shared_ptr<const Film> film, cxml::ConstNodePtr node, int version, list<string>& notes)
+       : Content (film, node)
+       , VideoContent (film, node, version)
+       , AudioContent (film, node)
+       , SubtitleContent (film, node, version)
 {
-       list<shared_ptr<cxml::Node> > c = node->node_children ("SubtitleStream");
-       for (list<shared_ptr<cxml::Node> >::const_iterator i = c.begin(); i != c.end(); ++i) {
+       list<cxml::NodePtr> c = node->node_children ("SubtitleStream");
+       for (list<cxml::NodePtr>::const_iterator i = c.begin(); i != c.end(); ++i) {
                _subtitle_streams.push_back (shared_ptr<FFmpegSubtitleStream> (new FFmpegSubtitleStream (*i)));
                if ((*i)->optional_number_child<int> ("Selected")) {
                        _subtitle_stream = _subtitle_streams.back ();
@@ -67,32 +77,47 @@ FFmpegContent::FFmpegContent (shared_ptr<const Film> f, shared_ptr<const cxml::N
        }
 
        c = node->node_children ("AudioStream");
-       for (list<shared_ptr<cxml::Node> >::const_iterator i = c.begin(); i != c.end(); ++i) {
-               _audio_streams.push_back (shared_ptr<FFmpegAudioStream> (new FFmpegAudioStream (*i)));
-               if ((*i)->optional_number_child<int> ("Selected")) {
-                       _audio_stream = _audio_streams.back ();
+       for (list<cxml::NodePtr>::const_iterator i = c.begin(); i != c.end(); ++i) {
+               _audio_streams.push_back (shared_ptr<FFmpegAudioStream> (new FFmpegAudioStream (*i, version)));
+               if (version < 11 && !(*i)->optional_node_child ("Selected")) {
+                       /* This is an old file and this stream is not selected, so un-map it */
+                       _audio_streams.back()->set_mapping (AudioMapping (_audio_streams.back()->channels (), MAX_DCP_AUDIO_CHANNELS));
                }
        }
 
        c = node->node_children ("Filter");
-       for (list<shared_ptr<cxml::Node> >::iterator i = c.begin(); i != c.end(); ++i) {
-               _filters.push_back (Filter::from_id ((*i)->content ()));
+       for (list<cxml::NodePtr>::iterator i = c.begin(); i != c.end(); ++i) {
+               Filter const * f = Filter::from_id ((*i)->content ());
+               if (f) {
+                       _filters.push_back (f);
+               } else {
+                       notes.push_back (String::compose (_("DCP-o-matic no longer supports the `%1' filter, so it has been turned off."), (*i)->content()));
+               }
        }
 
        _first_video = node->optional_number_child<double> ("FirstVideo");
 }
 
-FFmpegContent::FFmpegContent (FFmpegContent const & o)
-       : Content (o)
-       , VideoContent (o)
-       , AudioContent (o)
-       , SubtitleContent (o)
-       , _subtitle_streams (o._subtitle_streams)
-       , _subtitle_stream (o._subtitle_stream)
-       , _audio_streams (o._audio_streams)
-       , _audio_stream (o._audio_stream)
+FFmpegContent::FFmpegContent (shared_ptr<const Film> film, vector<boost::shared_ptr<Content> > c)
+       : Content (film, c)
+       , VideoContent (film, c)
+       , AudioContent (film, c)
+       , SubtitleContent (film, c)
 {
+       shared_ptr<FFmpegContent> ref = dynamic_pointer_cast<FFmpegContent> (c[0]);
+       DCPOMATIC_ASSERT (ref);
 
+       for (size_t i = 0; i < c.size(); ++i) {
+               shared_ptr<FFmpegContent> fc = dynamic_pointer_cast<FFmpegContent> (c[i]);
+               if (fc->use_subtitles() && *(fc->_subtitle_stream.get()) != *(ref->_subtitle_stream.get())) {
+                       throw JoinError (_("Content to be joined must use the same subtitle stream."));
+               }
+       }
+
+       _subtitle_streams = ref->subtitle_streams ();
+       _subtitle_stream = ref->subtitle_stream ();
+       _audio_streams = ref->ffmpeg_audio_streams ();
+       _first_video = ref->_first_video;
 }
 
 void
@@ -115,11 +140,7 @@ FFmpegContent::as_xml (xmlpp::Node* node) const
        }
 
        for (vector<shared_ptr<FFmpegAudioStream> >::const_iterator i = _audio_streams.begin(); i != _audio_streams.end(); ++i) {
-               xmlpp::Node* t = node->add_child("AudioStream");
-               if (_audio_stream && *i == _audio_stream) {
-                       t->add_child("Selected")->add_child_text("1");
-               }
-               (*i)->as_xml (t);
+               (*i)->as_xml (node->add_child("AudioStream"));
        }
 
        for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
@@ -127,7 +148,7 @@ FFmpegContent::as_xml (xmlpp::Node* node) const
        }
 
        if (_first_video) {
-               node->add_child("FirstVideo")->add_child_text (lexical_cast<string> (_first_video.get ()));
+               node->add_child("FirstVideo")->add_child_text (raw_convert<string> (_first_video.get().get()));
        }
 }
 
@@ -138,263 +159,170 @@ FFmpegContent::examine (shared_ptr<Job> job)
 
        Content::examine (job);
 
-       shared_ptr<const Film> film = _film.lock ();
-       assert (film);
-
-       shared_ptr<FFmpegExaminer> examiner (new FFmpegExaminer (shared_from_this ()));
+       shared_ptr<FFmpegExaminer> examiner (new FFmpegExaminer (shared_from_this (), job));
+       take_from_video_examiner (examiner);
 
-       VideoContent::Frame video_length = 0;
-       video_length = examiner->video_length ();
-       film->log()->log (String::compose ("Video length obtained from header as %1 frames", video_length));
+       shared_ptr<const Film> film = _film.lock ();
+       DCPOMATIC_ASSERT (film);
 
        {
                boost::mutex::scoped_lock lm (_mutex);
 
-               _video_length = video_length;
-
                _subtitle_streams = examiner->subtitle_streams ();
                if (!_subtitle_streams.empty ()) {
                        _subtitle_stream = _subtitle_streams.front ();
                }
-               
+
                _audio_streams = examiner->audio_streams ();
+
                if (!_audio_streams.empty ()) {
-                       _audio_stream = _audio_streams.front ();
+                       AudioMapping m = _audio_streams.front()->mapping ();
+                       film->make_audio_mapping_default (m);
+                       _audio_streams.front()->set_mapping (m);
                }
 
                _first_video = examiner->first_video ();
        }
 
-       take_from_video_examiner (examiner);
-
-       signal_changed (ContentProperty::LENGTH);
        signal_changed (FFmpegContentProperty::SUBTITLE_STREAMS);
        signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
-       signal_changed (FFmpegContentProperty::AUDIO_STREAMS);
-       signal_changed (FFmpegContentProperty::AUDIO_STREAM);
-       signal_changed (AudioContentProperty::AUDIO_CHANNELS);
+       signal_changed (AudioContentProperty::AUDIO_STREAMS);
 }
 
 string
 FFmpegContent::summary () const
 {
-       return String::compose (_("Movie: %1"), file().filename().string());
+       /* Get the string() here so that the name does not have quotes around it */
+       return String::compose (_("%1 [movie]"), path_summary ());
 }
 
 string
-FFmpegContent::information () const
+FFmpegContent::technical_summary () const
 {
-       if (video_length() == 0 || video_frame_rate() == 0) {
-               return "";
+       string as = "";
+       BOOST_FOREACH (shared_ptr<FFmpegAudioStream> i, ffmpeg_audio_streams ()) {
+               as += i->technical_summary () + " " ;
        }
-       
-       stringstream s;
-       
-       s << String::compose (_("%1 frames; %2 frames per second"), video_length(), video_frame_rate()) << "\n";
-       s << VideoContent::information ();
 
-       return s.str ();
-}
+       if (as.empty ()) {
+               as = "none";
+       }
 
-void
-FFmpegContent::set_subtitle_stream (shared_ptr<FFmpegSubtitleStream> s)
-{
-       {
-               boost::mutex::scoped_lock lm (_mutex);
-               _subtitle_stream = s;
+       string ss = "none";
+       if (_subtitle_stream) {
+               ss = _subtitle_stream->technical_summary ();
        }
 
-       signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
+       string filt = Filter::ffmpeg_string (_filters);
+
+       return Content::technical_summary() + " - "
+               + VideoContent::technical_summary() + " - "
+               + AudioContent::technical_summary() + " - "
+               + String::compose (
+                       "ffmpeg: audio %1 subtitle %2 filters %3", as, ss, filt
+                       );
 }
 
 void
-FFmpegContent::set_audio_stream (shared_ptr<FFmpegAudioStream> s)
+FFmpegContent::set_subtitle_stream (shared_ptr<FFmpegSubtitleStream> s)
 {
        {
                boost::mutex::scoped_lock lm (_mutex);
-               _audio_stream = s;
-       }
-
-       signal_changed (FFmpegContentProperty::AUDIO_STREAM);
-}
-
-AudioContent::Frame
-FFmpegContent::audio_length () const
-{
-       int const cafr = content_audio_frame_rate ();
-       int const vfr  = video_frame_rate ();
-       VideoContent::Frame const vl = video_length ();
-
-       boost::mutex::scoped_lock lm (_mutex);
-       if (!_audio_stream) {
-               return 0;
-       }
-       
-       return video_frames_to_audio_frames (vl, cafr, vfr);
-}
-
-int
-FFmpegContent::audio_channels () const
-{
-       boost::mutex::scoped_lock lm (_mutex);
-       
-       if (!_audio_stream) {
-               return 0;
-       }
-
-       return _audio_stream->channels;
-}
-
-int
-FFmpegContent::content_audio_frame_rate () const
-{
-       boost::mutex::scoped_lock lm (_mutex);
-
-       if (!_audio_stream) {
-               return 0;
-       }
-
-       return _audio_stream->frame_rate;
-}
-
-int
-FFmpegContent::output_audio_frame_rate () const
-{
-       shared_ptr<const Film> film = _film.lock ();
-       assert (film);
-       
-       /* Resample to a DCI-approved sample rate */
-       double t = dcp_audio_frame_rate (content_audio_frame_rate ());
-
-       FrameRateConversion frc (video_frame_rate(), film->dcp_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
-          look different in the DCP compared to the source (slower or faster).
-          skip/repeat doesn't come into effect here.
-       */
-
-       if (frc.change_speed) {
-               t *= video_frame_rate() * frc.factor() / film->dcp_video_frame_rate();
+               _subtitle_stream = s;
        }
 
-       return rint (t);
+       signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
 }
 
 bool
-operator== (FFmpegSubtitleStream const & a, FFmpegSubtitleStream const & b)
+operator== (FFmpegStream const & a, FFmpegStream const & b)
 {
-       return a.id == b.id;
+       return a._id == b._id;
 }
 
 bool
-operator== (FFmpegAudioStream const & a, FFmpegAudioStream const & b)
+operator!= (FFmpegStream const & a, FFmpegStream const & b)
 {
-       return a.id == b.id;
+       return a._id != b._id;
 }
 
-FFmpegAudioStream::FFmpegAudioStream (shared_ptr<const cxml::Node> node)
+DCPTime
+FFmpegContent::full_length () const
 {
-       name = node->string_child ("Name");
-       id = node->number_child<int> ("Id");
-       frame_rate = node->number_child<int> ("FrameRate");
-       channels = node->number_child<int64_t> ("Channels");
-       mapping = AudioMapping (node->node_child ("Mapping"));
-       first_audio = node->optional_number_child<Time> ("FirstAudio");
+       shared_ptr<const Film> film = _film.lock ();
+       DCPOMATIC_ASSERT (film);
+       FrameRateChange const frc (video_frame_rate (), film->video_frame_rate ());
+       return DCPTime::from_frames (rint (video_length_after_3d_combine() * frc.factor()), film->video_frame_rate());
 }
 
 void
-FFmpegAudioStream::as_xml (xmlpp::Node* root) const
+FFmpegContent::set_filters (vector<Filter const *> const & filters)
 {
-       root->add_child("Name")->add_child_text (name);
-       root->add_child("Id")->add_child_text (lexical_cast<string> (id));
-       root->add_child("FrameRate")->add_child_text (lexical_cast<string> (frame_rate));
-       root->add_child("Channels")->add_child_text (lexical_cast<string> (channels));
-       if (first_audio) {
-               root->add_child("FirstAudio")->add_child_text (lexical_cast<string> (first_audio));
+       {
+               boost::mutex::scoped_lock lm (_mutex);
+               _filters = filters;
        }
-       mapping.as_xml (root->add_child("Mapping"));
-}
-
-/** Construct a SubtitleStream from a value returned from to_string().
- *  @param t String returned from to_string().
- *  @param v State file version.
- */
-FFmpegSubtitleStream::FFmpegSubtitleStream (shared_ptr<const cxml::Node> node)
-{
-       name = node->string_child ("Name");
-       id = node->number_child<int> ("Id");
-}
 
-void
-FFmpegSubtitleStream::as_xml (xmlpp::Node* root) const
-{
-       root->add_child("Name")->add_child_text (name);
-       root->add_child("Id")->add_child_text (lexical_cast<string> (id));
+       signal_changed (FFmpegContentProperty::FILTERS);
 }
 
-shared_ptr<Content>
-FFmpegContent::clone () const
+string
+FFmpegContent::identifier () const
 {
-       return shared_ptr<Content> (new FFmpegContent (*this));
-}
+       SafeStringStream s;
 
-Time
-FFmpegContent::length () const
-{
-       shared_ptr<const Film> film = _film.lock ();
-       assert (film);
-       
-       FrameRateConversion frc (video_frame_rate (), film->dcp_video_frame_rate ());
-       return video_length() * frc.factor() * TIME_HZ / film->dcp_video_frame_rate ();
-}
+       s << VideoContent::identifier();
 
-AudioMapping
-FFmpegContent::audio_mapping () const
-{
        boost::mutex::scoped_lock lm (_mutex);
 
-       if (!_audio_stream) {
-               return AudioMapping ();
+       if (_subtitle_stream) {
+               s << "_" << _subtitle_stream->identifier ();
        }
 
-       return _audio_stream->mapping;
+       for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
+               s << "_" << (*i)->id ();
+       }
+
+       return s.str ();
 }
 
-void
-FFmpegContent::set_filters (vector<Filter const *> const & filters)
+list<ContentTimePeriod>
+FFmpegContent::subtitles_during (ContentTimePeriod period, bool starting) const
 {
-       {
-               boost::mutex::scoped_lock lm (_mutex);
-               _filters = filters;
+       shared_ptr<FFmpegSubtitleStream> stream = subtitle_stream ();
+       if (!stream) {
+               return list<ContentTimePeriod> ();
        }
 
-       signal_changed (FFmpegContentProperty::FILTERS);
+       return stream->subtitles_during (period, starting);
 }
 
-void
-FFmpegContent::set_audio_mapping (AudioMapping m)
+bool
+FFmpegContent::has_subtitles () const
 {
-       audio_stream()->mapping = m;
-       signal_changed (AudioContentProperty::AUDIO_MAPPING);
+       return !subtitle_streams().empty ();
 }
 
-string
-FFmpegContent::identifier () const
+void
+FFmpegContent::set_default_colour_conversion ()
 {
-       stringstream s;
-
-       s << VideoContent::identifier();
+       dcp::Size const s = video_size ();
 
        boost::mutex::scoped_lock lm (_mutex);
 
-       if (_subtitle_stream) {
-               s << "_" << _subtitle_stream->id;
+       if (s.width < 1080) {
+               _colour_conversion = PresetColourConversion::from_id ("rec601").conversion;
+       } else {
+               _colour_conversion = PresetColourConversion::from_id ("rec709").conversion;
        }
+}
 
-       for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
-               s << "_" << (*i)->id ();
-       }
+vector<AudioStreamPtr>
+FFmpegContent::audio_streams () const
+{
+       boost::mutex::scoped_lock lm (_mutex);
 
-       return s.str ();
+       vector<AudioStreamPtr> s;
+       copy (_audio_streams.begin(), _audio_streams.end(), back_inserter (s));
+       return s;
 }