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::AUDIO_STREAMS = 102;
  55 int const FFmpegContentProperty::FILTERS = 103;
  56
  57 FFmpegContent::FFmpegContent (shared_ptr<const Film> f, boost::filesystem::path p)
  58         : Content (f, p)
  59         , VideoContent (f, p)
  60         , AudioContent (f, p)
  61         , SubtitleContent (f, p)
  62 {
  63
  64 }
  65
  66 FFmpegContent::FFmpegContent (shared_ptr<const Film> f, cxml::ConstNodePtr node, int version, list<string>& notes)
  67         : Content (f, node)
  68         , VideoContent (f, node, version)
  69         , AudioContent (f, node)
  70         , SubtitleContent (f, node, version)
  71 {
  72         list<cxml::NodePtr> c = node->node_children ("SubtitleStream");
  73         for (list<cxml::NodePtr>::const_iterator i = c.begin(); i != c.end(); ++i) {
  74                 _subtitle_streams.push_back (shared_ptr<FFmpegSubtitleStream> (new FFmpegSubtitleStream (*i)));
  75                 if ((*i)->optional_number_child<int> ("Selected")) {
  76                         _subtitle_stream = _subtitle_streams.back ();
  77                 }
  78         }
  79
  80         c = node->node_children ("AudioStream");
  81         for (list<cxml::NodePtr>::const_iterator i = c.begin(); i != c.end(); ++i) {
  82                 _audio_streams.push_back (shared_ptr<FFmpegAudioStream> (new FFmpegAudioStream (*i, version)));
  83         }
  84
  85         c = node->node_children ("Filter");
  86         for (list<cxml::NodePtr>::iterator i = c.begin(); i != c.end(); ++i) {
  87                 Filter const * f = Filter::from_id ((*i)->content ());
  88                 if (f) {
  89                         _filters.push_back (f);
  90                 } else {
  91                         notes.push_back (String::compose (_("DCP-o-matic no longer supports the `%1' filter, so it has been turned off."), (*i)->content()));
  92                 }
  93         }
  94
  95         _first_video = node->optional_number_child<double> ("FirstVideo");
  96 }
  97
  98 FFmpegContent::FFmpegContent (shared_ptr<const Film> f, vector<boost::shared_ptr<Content> > c)
  99         : Content (f, c)
 100         , VideoContent (f, c)
 101         , AudioContent (f, c)
 102         , SubtitleContent (f, c)
 103 {
 104         shared_ptr<FFmpegContent> ref = dynamic_pointer_cast<FFmpegContent> (c[0]);
 105         DCPOMATIC_ASSERT (ref);
 106
 107         for (size_t i = 0; i < c.size(); ++i) {
 108                 shared_ptr<FFmpegContent> fc = dynamic_pointer_cast<FFmpegContent> (c[i]);
 109                 if (fc->use_subtitles() && *(fc->_subtitle_stream.get()) != *(ref->_subtitle_stream.get())) {
 110                         throw JoinError (_("Content to be joined must use the same subtitle stream."));
 111                 }
 112         }
 113
 114         _subtitle_streams = ref->subtitle_streams ();
 115         _subtitle_stream = ref->subtitle_stream ();
 116         _audio_streams = ref->ffmpeg_audio_streams ();
 117         _first_video = ref->_first_video;
 118 }
 119
 120 void
 121 FFmpegContent::as_xml (xmlpp::Node* node) const
 122 {
 123         node->add_child("Type")->add_child_text ("FFmpeg");
 124         Content::as_xml (node);
 125         VideoContent::as_xml (node);
 126         AudioContent::as_xml (node);
 127         SubtitleContent::as_xml (node);
 128
 129         boost::mutex::scoped_lock lm (_mutex);
 130
 131         for (vector<shared_ptr<FFmpegSubtitleStream> >::const_iterator i = _subtitle_streams.begin(); i != _subtitle_streams.end(); ++i) {
 132                 xmlpp::Node* t = node->add_child("SubtitleStream");
 133                 if (_subtitle_stream && *i == _subtitle_stream) {
 134                         t->add_child("Selected")->add_child_text("1");
 135                 }
 136                 (*i)->as_xml (t);
 137         }
 138
 139         for (vector<shared_ptr<FFmpegAudioStream> >::const_iterator i = _audio_streams.begin(); i != _audio_streams.end(); ++i) {
 140                 (*i)->as_xml (node->add_child("AudioStream"));
 141         }
 142
 143         for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
 144                 node->add_child("Filter")->add_child_text ((*i)->id ());
 145         }
 146
 147         if (_first_video) {
 148                 node->add_child("FirstVideo")->add_child_text (raw_convert<string> (_first_video.get().get()));
 149         }
 150 }
 151
 152 void
 153 FFmpegContent::examine (shared_ptr<Job> job)
 154 {
 155         job->set_progress_unknown ();
 156
 157         Content::examine (job);
 158
 159         shared_ptr<FFmpegExaminer> examiner (new FFmpegExaminer (shared_from_this (), job));
 160         take_from_video_examiner (examiner);
 161
 162         shared_ptr<const Film> film = _film.lock ();
 163         DCPOMATIC_ASSERT (film);
 164
 165         {
 166                 boost::mutex::scoped_lock lm (_mutex);
 167
 168                 _subtitle_streams = examiner->subtitle_streams ();
 169                 if (!_subtitle_streams.empty ()) {
 170                         _subtitle_stream = _subtitle_streams.front ();
 171                 }
 172
 173                 _audio_streams = examiner->audio_streams ();
 174
 175                 if (!_audio_streams.empty ()) {
 176                         AudioMapping m = _audio_streams.front()->mapping ();
 177                         m.make_default ();
 178                         _audio_streams.front()->set_mapping (m);
 179                 }
 180
 181                 _first_video = examiner->first_video ();
 182         }
 183
 184         signal_changed (FFmpegContentProperty::SUBTITLE_STREAMS);
 185         signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
 186         signal_changed (FFmpegContentProperty::AUDIO_STREAMS);
 187 }
 188
 189 string
 190 FFmpegContent::summary () const
 191 {
 192         /* Get the string() here so that the name does not have quotes around it */
 193         return String::compose (_("%1 [movie]"), path_summary ());
 194 }
 195
 196 string
 197 FFmpegContent::technical_summary () const
 198 {
 199         string as = "";
 200         BOOST_FOREACH (shared_ptr<FFmpegAudioStream> i, ffmpeg_audio_streams ()) {
 201                 as += i->technical_summary () + " " ;
 202         }
 203
 204         if (as.empty ()) {
 205                 as = "none";
 206         }
 207
 208         string ss = "none";
 209         if (_subtitle_stream) {
 210                 ss = _subtitle_stream->technical_summary ();
 211         }
 212
 213         string filt = Filter::ffmpeg_string (_filters);
 214
 215         return Content::technical_summary() + " - "
 216                 + VideoContent::technical_summary() + " - "
 217                 + AudioContent::technical_summary() + " - "
 218                 + String::compose (
 219                         "ffmpeg: audio %1 subtitle %2 filters %3", as, ss, filt
 220                         );
 221 }
 222
 223 void
 224 FFmpegContent::set_subtitle_stream (shared_ptr<FFmpegSubtitleStream> s)
 225 {
 226         {
 227                 boost::mutex::scoped_lock lm (_mutex);
 228                 _subtitle_stream = s;
 229         }
 230
 231         signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
 232 }
 233
 234 bool
 235 operator== (FFmpegStream const & a, FFmpegStream const & b)
 236 {
 237         return a._id == b._id;
 238 }
 239
 240 bool
 241 operator!= (FFmpegStream const & a, FFmpegStream const & b)
 242 {
 243         return a._id != b._id;
 244 }
 245
 246 DCPTime
 247 FFmpegContent::full_length () const
 248 {
 249         shared_ptr<const Film> film = _film.lock ();
 250         DCPOMATIC_ASSERT (film);
 251         FrameRateChange const frc (video_frame_rate (), film->video_frame_rate ());
 252         return DCPTime::from_frames (rint (video_length_after_3d_combine() * frc.factor()), film->video_frame_rate());
 253 }
 254
 255 void
 256 FFmpegContent::set_filters (vector<Filter const *> const & filters)
 257 {
 258         {
 259                 boost::mutex::scoped_lock lm (_mutex);
 260                 _filters = filters;
 261         }
 262
 263         signal_changed (FFmpegContentProperty::FILTERS);
 264 }
 265
 266 string
 267 FFmpegContent::identifier () const
 268 {
 269         SafeStringStream s;
 270
 271         s << VideoContent::identifier();
 272
 273         boost::mutex::scoped_lock lm (_mutex);
 274
 275         if (_subtitle_stream) {
 276                 s << "_" << _subtitle_stream->identifier ();
 277         }
 278
 279         for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
 280                 s << "_" << (*i)->id ();
 281         }
 282
 283         return s.str ();
 284 }
 285
 286 list<ContentTimePeriod>
 287 FFmpegContent::subtitles_during (ContentTimePeriod period, bool starting) const
 288 {
 289         shared_ptr<FFmpegSubtitleStream> stream = subtitle_stream ();
 290         if (!stream) {
 291                 return list<ContentTimePeriod> ();
 292         }
 293
 294         return stream->subtitles_during (period, starting);
 295 }
 296
 297 bool
 298 FFmpegContent::has_subtitles () const
 299 {
 300         return !subtitle_streams().empty ();
 301 }
 302
 303 void
 304 FFmpegContent::set_default_colour_conversion ()
 305 {
 306         dcp::Size const s = video_size ();
 307
 308         boost::mutex::scoped_lock lm (_mutex);
 309
 310         if (s.width < 1080) {
 311                 _colour_conversion = PresetColourConversion::from_id ("rec601").conversion;
 312         } else {
 313                 _colour_conversion = PresetColourConversion::from_id ("rec709").conversion;
 314         }
 315 }
 316
 317 vector<AudioStreamPtr>
 318 FFmpegContent::audio_streams () const
 319 {
 320         boost::mutex::scoped_lock lm (_mutex);
 321
 322         vector<AudioStreamPtr> s;
 323         copy (_audio_streams.begin(), _audio_streams.end(), back_inserter (s));
 324         return s;
 325 }