src/lib/ffmpeg_content.cc

   1 /*
   2     Copyright (C) 2013-2015 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #include "ffmpeg_content.h"
  21 #include "ffmpeg_examiner.h"
  22 #include "ffmpeg_subtitle_stream.h"
  23 #include "ffmpeg_audio_stream.h"
  24 #include "compose.hpp"
  25 #include "job.h"
  26 #include "util.h"
  27 #include "filter.h"
  28 #include "film.h"
  29 #include "log.h"
  30 #include "exceptions.h"
  31 #include "frame_rate_change.h"
  32 #include "safe_stringstream.h"
  33 #include "raw_convert.h"
  34 #include <libcxml/cxml.h>
  35 extern "C" {
  36 #include <libavformat/avformat.h>
  37 }
  38 #include <boost/foreach.hpp>
  39
  40 #include "i18n.h"
  41
  42 #define LOG_GENERAL(...) film->log()->log (String::compose (__VA_ARGS__), Log::TYPE_GENERAL);
  43
  44 using std::string;
  45 using std::vector;
  46 using std::list;
  47 using std::cout;
  48 using std::pair;
  49 using boost::shared_ptr;
  50 using boost::dynamic_pointer_cast;
  51
  52 int const FFmpegContentProperty::SUBTITLE_STREAMS = 100;
  53 int const FFmpegContentProperty::SUBTITLE_STREAM = 101;
  54 int const FFmpegContentProperty::FILTERS = 102;
  55
  56 FFmpegContent::FFmpegContent (shared_ptr<const Film> f, boost::filesystem::path p)
  57         : Content (f, p)
  58         , VideoContent (f, p)
  59         , AudioContent (f, p)
  60         , SubtitleContent (f, p)
  61 {
  62
  63 }
  64
  65 FFmpegContent::FFmpegContent (shared_ptr<const Film> f, cxml::ConstNodePtr node, int version, list<string>& notes)
  66         : Content (f, node)
  67         , VideoContent (f, node, version)
  68         , AudioContent (f, node)
  69         , SubtitleContent (f, node, version)
  70 {
  71         list<cxml::NodePtr> c = node->node_children ("SubtitleStream");
  72         for (list<cxml::NodePtr>::const_iterator i = c.begin(); i != c.end(); ++i) {
  73                 _subtitle_streams.push_back (shared_ptr<FFmpegSubtitleStream> (new FFmpegSubtitleStream (*i)));
  74                 if ((*i)->optional_number_child<int> ("Selected")) {
  75                         _subtitle_stream = _subtitle_streams.back ();
  76                 }
  77         }
  78
  79         c = node->node_children ("AudioStream");
  80         for (list<cxml::NodePtr>::const_iterator i = c.begin(); i != c.end(); ++i) {
  81                 _audio_streams.push_back (shared_ptr<FFmpegAudioStream> (new FFmpegAudioStream (*i, version)));
  82         }
  83
  84         c = node->node_children ("Filter");
  85         for (list<cxml::NodePtr>::iterator i = c.begin(); i != c.end(); ++i) {
  86                 Filter const * f = Filter::from_id ((*i)->content ());
  87                 if (f) {
  88                         _filters.push_back (f);
  89                 } else {
  90                         notes.push_back (String::compose (_("DCP-o-matic no longer supports the `%1' filter, so it has been turned off."), (*i)->content()));
  91                 }
  92         }
  93
  94         _first_video = node->optional_number_child<double> ("FirstVideo");
  95 }
  96
  97 FFmpegContent::FFmpegContent (shared_ptr<const Film> f, vector<boost::shared_ptr<Content> > c)
  98         : Content (f, c)
  99         , VideoContent (f, c)
 100         , AudioContent (f, c)
 101         , SubtitleContent (f, c)
 102 {
 103         shared_ptr<FFmpegContent> ref = dynamic_pointer_cast<FFmpegContent> (c[0]);
 104         DCPOMATIC_ASSERT (ref);
 105
 106         for (size_t i = 0; i < c.size(); ++i) {
 107                 shared_ptr<FFmpegContent> fc = dynamic_pointer_cast<FFmpegContent> (c[i]);
 108                 if (fc->use_subtitles() && *(fc->_subtitle_stream.get()) != *(ref->_subtitle_stream.get())) {
 109                         throw JoinError (_("Content to be joined must use the same subtitle stream."));
 110                 }
 111         }
 112
 113         _subtitle_streams = ref->subtitle_streams ();
 114         _subtitle_stream = ref->subtitle_stream ();
 115         _audio_streams = ref->ffmpeg_audio_streams ();
 116         _first_video = ref->_first_video;
 117 }
 118
 119 void
 120 FFmpegContent::as_xml (xmlpp::Node* node) const
 121 {
 122         node->add_child("Type")->add_child_text ("FFmpeg");
 123         Content::as_xml (node);
 124         VideoContent::as_xml (node);
 125         AudioContent::as_xml (node);
 126         SubtitleContent::as_xml (node);
 127
 128         boost::mutex::scoped_lock lm (_mutex);
 129
 130         for (vector<shared_ptr<FFmpegSubtitleStream> >::const_iterator i = _subtitle_streams.begin(); i != _subtitle_streams.end(); ++i) {
 131                 xmlpp::Node* t = node->add_child("SubtitleStream");
 132                 if (_subtitle_stream && *i == _subtitle_stream) {
 133                         t->add_child("Selected")->add_child_text("1");
 134                 }
 135                 (*i)->as_xml (t);
 136         }
 137
 138         for (vector<shared_ptr<FFmpegAudioStream> >::const_iterator i = _audio_streams.begin(); i != _audio_streams.end(); ++i) {
 139                 (*i)->as_xml (node->add_child("AudioStream"));
 140         }
 141
 142         for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
 143                 node->add_child("Filter")->add_child_text ((*i)->id ());
 144         }
 145
 146         if (_first_video) {
 147                 node->add_child("FirstVideo")->add_child_text (raw_convert<string> (_first_video.get().get()));
 148         }
 149 }
 150
 151 void
 152 FFmpegContent::examine (shared_ptr<Job> job)
 153 {
 154         job->set_progress_unknown ();
 155
 156         Content::examine (job);
 157
 158         shared_ptr<FFmpegExaminer> examiner (new FFmpegExaminer (shared_from_this (), job));
 159         take_from_video_examiner (examiner);
 160
 161         shared_ptr<const Film> film = _film.lock ();
 162         DCPOMATIC_ASSERT (film);
 163
 164         {
 165                 boost::mutex::scoped_lock lm (_mutex);
 166
 167                 _subtitle_streams = examiner->subtitle_streams ();
 168                 if (!_subtitle_streams.empty ()) {
 169                         _subtitle_stream = _subtitle_streams.front ();
 170                 }
 171
 172                 _audio_streams = examiner->audio_streams ();
 173
 174                 if (!_audio_streams.empty ()) {
 175                         AudioMapping m = _audio_streams.front()->mapping ();
 176                         m.make_default ();
 177                         _audio_streams.front()->set_mapping (m);
 178                 }
 179
 180                 _first_video = examiner->first_video ();
 181         }
 182
 183         signal_changed (FFmpegContentProperty::SUBTITLE_STREAMS);
 184         signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
 185         signal_changed (AudioContentProperty::AUDIO_STREAMS);
 186 }
 187
 188 string
 189 FFmpegContent::summary () const
 190 {
 191         /* Get the string() here so that the name does not have quotes around it */
 192         return String::compose (_("%1 [movie]"), path_summary ());
 193 }
 194
 195 string
 196 FFmpegContent::technical_summary () const
 197 {
 198         string as = "";
 199         BOOST_FOREACH (shared_ptr<FFmpegAudioStream> i, ffmpeg_audio_streams ()) {
 200                 as += i->technical_summary () + " " ;
 201         }
 202
 203         if (as.empty ()) {
 204                 as = "none";
 205         }
 206
 207         string ss = "none";
 208         if (_subtitle_stream) {
 209                 ss = _subtitle_stream->technical_summary ();
 210         }
 211
 212         string filt = Filter::ffmpeg_string (_filters);
 213
 214         return Content::technical_summary() + " - "
 215                 + VideoContent::technical_summary() + " - "
 216                 + AudioContent::technical_summary() + " - "
 217                 + String::compose (
 218                         "ffmpeg: audio %1 subtitle %2 filters %3", as, ss, filt
 219                         );
 220 }
 221
 222 void
 223 FFmpegContent::set_subtitle_stream (shared_ptr<FFmpegSubtitleStream> s)
 224 {
 225         {
 226                 boost::mutex::scoped_lock lm (_mutex);
 227                 _subtitle_stream = s;
 228         }
 229
 230         signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
 231 }
 232
 233 bool
 234 operator== (FFmpegStream const & a, FFmpegStream const & b)
 235 {
 236         return a._id == b._id;
 237 }
 238
 239 bool
 240 operator!= (FFmpegStream const & a, FFmpegStream const & b)
 241 {
 242         return a._id != b._id;
 243 }
 244
 245 DCPTime
 246 FFmpegContent::full_length () const
 247 {
 248         shared_ptr<const Film> film = _film.lock ();
 249         DCPOMATIC_ASSERT (film);
 250         FrameRateChange const frc (video_frame_rate (), film->video_frame_rate ());
 251         return DCPTime::from_frames (rint (video_length_after_3d_combine() * frc.factor()), film->video_frame_rate());
 252 }
 253
 254 void
 255 FFmpegContent::set_filters (vector<Filter const *> const & filters)
 256 {
 257         {
 258                 boost::mutex::scoped_lock lm (_mutex);
 259                 _filters = filters;
 260         }
 261
 262         signal_changed (FFmpegContentProperty::FILTERS);
 263 }
 264
 265 string
 266 FFmpegContent::identifier () const
 267 {
 268         SafeStringStream s;
 269
 270         s << VideoContent::identifier();
 271
 272         boost::mutex::scoped_lock lm (_mutex);
 273
 274         if (_subtitle_stream) {
 275                 s << "_" << _subtitle_stream->identifier ();
 276         }
 277
 278         for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
 279                 s << "_" << (*i)->id ();
 280         }
 281
 282         return s.str ();
 283 }
 284
 285 list<ContentTimePeriod>
 286 FFmpegContent::subtitles_during (ContentTimePeriod period, bool starting) const
 287 {
 288         shared_ptr<FFmpegSubtitleStream> stream = subtitle_stream ();
 289         if (!stream) {
 290                 return list<ContentTimePeriod> ();
 291         }
 292
 293         return stream->subtitles_during (period, starting);
 294 }
 295
 296 bool
 297 FFmpegContent::has_subtitles () const
 298 {
 299         return !subtitle_streams().empty ();
 300 }
 301
 302 void
 303 FFmpegContent::set_default_colour_conversion ()
 304 {
 305         dcp::Size const s = video_size ();
 306
 307         boost::mutex::scoped_lock lm (_mutex);
 308
 309         if (s.width < 1080) {
 310                 _colour_conversion = PresetColourConversion::from_id ("rec601").conversion;
 311         } else {
 312                 _colour_conversion = PresetColourConversion::from_id ("rec709").conversion;
 313         }
 314 }
 315
 316 vector<AudioStreamPtr>
 317 FFmpegContent::audio_streams () const
 318 {
 319         boost::mutex::scoped_lock lm (_mutex);
 320
 321         vector<AudioStreamPtr> s;
 322         copy (_audio_streams.begin(), _audio_streams.end(), back_inserter (s));
 323         return s;
 324 }