Various subtitle UI tweaks.
[dcpomatic.git] / src / lib / ffmpeg_content.cc
index 394c16aa53568c4b55fe4e13be3bf0818bb28504..a12f45a30f81d20d6af73fb97e0b62f805a54a54 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2013 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2014 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
@@ -21,8 +21,11 @@ extern "C" {
 #include <libavformat/avformat.h>
 }
 #include <libcxml/cxml.h>
+#include <dcp/raw_convert.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"
@@ -30,9 +33,12 @@ extern "C" {
 #include "film.h"
 #include "log.h"
 #include "exceptions.h"
+#include "frame_rate_change.h"
 
 #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;
@@ -40,8 +46,8 @@ using std::list;
 using std::cout;
 using std::pair;
 using boost::shared_ptr;
-using boost::lexical_cast;
 using boost::dynamic_pointer_cast;
+using dcp::raw_convert;
 
 int const FFmpegContentProperty::SUBTITLE_STREAMS = 100;
 int const FFmpegContentProperty::SUBTITLE_STREAM = 101;
@@ -58,15 +64,15 @@ FFmpegContent::FFmpegContent (shared_ptr<const Film> f, boost::filesystem::path
 
 }
 
-FFmpegContent::FFmpegContent (shared_ptr<const Film> f, shared_ptr<const cxml::Node> node, int version)
+FFmpegContent::FFmpegContent (shared_ptr<const Film> f, cxml::ConstNodePtr node, int version, list<string>& notes)
        : Content (f, node)
-       , VideoContent (f, node)
+       , VideoContent (f, node, version)
        , AudioContent (f, node)
-       , SubtitleContent (f, node)
+       , SubtitleContent (f, node, version)
 {
        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, version)));
+               _subtitle_streams.push_back (shared_ptr<FFmpegSubtitleStream> (new FFmpegSubtitleStream (*i)));
                if ((*i)->optional_number_child<int> ("Selected")) {
                        _subtitle_stream = _subtitle_streams.back ();
                }
@@ -82,7 +88,12 @@ FFmpegContent::FFmpegContent (shared_ptr<const Film> f, shared_ptr<const cxml::N
 
        c = node->node_children ("Filter");
        for (list<cxml::NodePtr>::iterator i = c.begin(); i != c.end(); ++i) {
-               _filters.push_back (Filter::from_id ((*i)->content ()));
+               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");
@@ -99,7 +110,7 @@ FFmpegContent::FFmpegContent (shared_ptr<const Film> f, vector<boost::shared_ptr
 
        for (size_t i = 0; i < c.size(); ++i) {
                shared_ptr<FFmpegContent> fc = dynamic_pointer_cast<FFmpegContent> (c[i]);
-               if (f->with_subtitles() && *(fc->_subtitle_stream.get()) != *(ref->_subtitle_stream.get())) {
+               if (fc->subtitle_use() && *(fc->_subtitle_stream.get()) != *(ref->_subtitle_stream.get())) {
                        throw JoinError (_("Content to be joined must use the same subtitle stream."));
                }
 
@@ -147,7 +158,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()));
        }
 }
 
@@ -158,14 +169,14 @@ 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 ()));
+       take_from_video_examiner (examiner);
 
-       VideoFrame video_length = 0;
-       video_length = examiner->video_length ();
-       film->log()->log (String::compose ("Video length obtained from header as %1 frames", video_length));
+       ContentTime video_length = examiner->video_length ();
+
+       shared_ptr<const Film> film = _film.lock ();
+       assert (film);
+       LOG_GENERAL ("Video length obtained from header as %1 frames", video_length.frames (video_frame_rate ()));
 
        {
                boost::mutex::scoped_lock lm (_mutex);
@@ -185,8 +196,6 @@ FFmpegContent::examine (shared_ptr<Job> job)
                _first_video = examiner->first_video ();
        }
 
-       take_from_video_examiner (examiner);
-
        signal_changed (ContentProperty::LENGTH);
        signal_changed (FFmpegContentProperty::SUBTITLE_STREAMS);
        signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
@@ -207,34 +216,34 @@ FFmpegContent::technical_summary () const
 {
        string as = "none";
        if (_audio_stream) {
-               as = String::compose ("id %1", _audio_stream->id);
+               as = _audio_stream->technical_summary ();
        }
 
        string ss = "none";
        if (_subtitle_stream) {
-               ss = String::compose ("id %1", _subtitle_stream->id);
+               ss = _subtitle_stream->technical_summary ();
        }
 
-       pair<string, string> filt = Filter::ffmpeg_strings (_filters);
+       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 %4", as, ss, filt.first, filt.second
+                       "ffmpeg: audio %1, subtitle %2, filters %3", as, ss, filt
                        );
 }
 
 string
 FFmpegContent::information () const
 {
-       if (video_length() == 0 || video_frame_rate() == 0) {
+       if (video_length() == ContentTime (0) || video_frame_rate() == 0) {
                return "";
        }
        
        stringstream s;
        
-       s << String::compose (_("%1 frames; %2 frames per second"), video_length(), video_frame_rate()) << "\n";
+       s << String::compose (_("%1 frames; %2 frames per second"), video_length_after_3d_combine().frames (video_frame_rate()), video_frame_rate()) << "\n";
        s << VideoContent::information ();
 
        return s.str ();
@@ -262,19 +271,14 @@ FFmpegContent::set_audio_stream (shared_ptr<FFmpegAudioStream> s)
        signal_changed (FFmpegContentProperty::AUDIO_STREAM);
 }
 
-AudioFrame
+ContentTime
 FFmpegContent::audio_length () const
 {
-       int const cafr = content_audio_frame_rate ();
-       int const vfr  = video_frame_rate ();
-       VideoFrame const vl = video_length ();
-
-       boost::mutex::scoped_lock lm (_mutex);
-       if (!_audio_stream) {
-               return 0;
+       if (!audio_stream ()) {
+               return ContentTime ();
        }
-       
-       return video_frames_to_audio_frames (vl, cafr, vfr);
+
+       return video_length ();
 }
 
 int
@@ -290,7 +294,7 @@ FFmpegContent::audio_channels () const
 }
 
 int
-FFmpegContent::content_audio_frame_rate () const
+FFmpegContent::audio_frame_rate () const
 {
        boost::mutex::scoped_lock lm (_mutex);
 
@@ -301,148 +305,16 @@ FFmpegContent::content_audio_frame_rate () const
        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 ());
-
-       FrameRateChange frc (video_frame_rate(), 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
-          look different in the DCP compared to the source (slower or faster).
-       */
-
-       if (frc.change_speed) {
-               t /= frc.speed_up;
-       }
-
-       return rint (t);
-}
-
-bool
-operator== (FFmpegSubtitleStream const & a, FFmpegSubtitleStream const & b)
-{
-       return a.id == b.id;
-}
-
-bool
-operator!= (FFmpegSubtitleStream const & a, FFmpegSubtitleStream const & b)
-{
-       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;
 }
 
 bool
-operator!= (FFmpegAudioStream const & a, FFmpegAudioStream const & b)
-{
-       return a.id != b.id;
-}
-
-FFmpegStream::FFmpegStream (shared_ptr<const cxml::Node> node, int version)
-       : _legacy_id (false)
-{
-       name = node->string_child ("Name");
-       id = node->number_child<int> ("Id");
-       if (version == 4 || node->optional_bool_child ("LegacyId")) {
-               _legacy_id = true;
-       }
-}
-
-void
-FFmpegStream::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));
-       if (_legacy_id) {
-               /* Write this so that version > 4 files are read in correctly
-                  if the Id came originally from a version <= 4 file.
-               */
-               root->add_child("LegacyId")->add_child_text ("1");
-       }
-}
-
-FFmpegAudioStream::FFmpegAudioStream (shared_ptr<const cxml::Node> node, int version)
-       : FFmpegStream (node, version)
-       , mapping (node->node_child ("Mapping"), version)
+operator!= (FFmpegStream const & a, FFmpegStream const & b)
 {
-       frame_rate = node->number_child<int> ("FrameRate");
-       channels = node->number_child<int64_t> ("Channels");
-       first_audio = node->optional_number_child<double> ("FirstAudio");
-}
-
-void
-FFmpegAudioStream::as_xml (xmlpp::Node* root) const
-{
-       FFmpegStream::as_xml (root);
-       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.get ()));
-       }
-       mapping.as_xml (root->add_child("Mapping"));
-}
-
-int
-FFmpegStream::index (AVFormatContext const * fc) const
-{
-       if (_legacy_id) {
-               return id;
-       }
-       
-       size_t i = 0;
-       while (i < fc->nb_streams) {
-               if (fc->streams[i]->id == id) {
-                       return i;
-               }
-               ++i;
-       }
-
-       assert (false);
-}
-
-AVStream *
-FFmpegStream::stream (AVFormatContext const * fc) const
-{
-       if (_legacy_id) {
-               return fc->streams[id];
-       }
-       
-       size_t i = 0;
-       while (i < fc->nb_streams) {
-               if (fc->streams[i]->id == id) {
-                       return fc->streams[i];
-               }
-               ++i;
-       }
-
-       assert (false);
-       return 0;
-}
-
-/** 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, int version)
-       : FFmpegStream (node, version)
-{
-       
-}
-
-void
-FFmpegSubtitleStream::as_xml (xmlpp::Node* root) const
-{
-       FFmpegStream::as_xml (root);
+       return a._id != b._id;
 }
 
 DCPTime
@@ -450,9 +322,7 @@ FFmpegContent::full_length () const
 {
        shared_ptr<const Film> film = _film.lock ();
        assert (film);
-       
-       FrameRateChange frc (video_frame_rate (), film->video_frame_rate ());
-       return video_length() * frc.factor() * TIME_HZ / film->video_frame_rate ();
+       return DCPTime (video_length_after_3d_combine(), FrameRateChange (video_frame_rate (), film->video_frame_rate ()));
 }
 
 AudioMapping
@@ -482,7 +352,7 @@ void
 FFmpegContent::set_audio_mapping (AudioMapping m)
 {
        audio_stream()->mapping = m;
-       signal_changed (AudioContentProperty::AUDIO_MAPPING);
+       AudioContent::set_audio_mapping (m);
 }
 
 string
@@ -495,7 +365,7 @@ FFmpegContent::identifier () const
        boost::mutex::scoped_lock lm (_mutex);
 
        if (_subtitle_stream) {
-               s << "_" << _subtitle_stream->id;
+               s << "_" << _subtitle_stream->identifier ();
        }
 
        for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
@@ -505,3 +375,41 @@ FFmpegContent::identifier () const
        return s.str ();
 }
 
+boost::filesystem::path
+FFmpegContent::audio_analysis_path () const
+{
+       shared_ptr<const Film> film = _film.lock ();
+       if (!film) {
+               return boost::filesystem::path ();
+       }
+
+       /* We need to include the stream ID in this path so that we get different
+          analyses for each stream.
+       */
+
+       boost::filesystem::path p = film->audio_analysis_dir ();
+       string name = digest ();
+       if (audio_stream ()) {
+               name += "_" + audio_stream()->identifier ();
+       }
+       p /= name;
+       return p;
+}
+
+bool
+FFmpegContent::has_subtitle_during (ContentTimePeriod period) const
+{
+       shared_ptr<FFmpegSubtitleStream> stream = subtitle_stream ();
+       if (!stream) {
+               return false;
+       }
+
+       /* XXX: inefficient */
+       for (vector<ContentTimePeriod>::const_iterator i = stream->periods.begin(); i != stream->periods.end(); ++i) {
+               if (i->from <= period.to && i->to >= period.from) {
+                       return true;
+               }
+       }
+
+       return false;
+}