src/lib/ffmpeg_content.cc

   1 /*
   2     Copyright (C) 2013-2014 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 extern "C" {
  21 #include <libavformat/avformat.h>
  22 }
  23 #include <libcxml/cxml.h>
  24 #include <dcp/raw_convert.h>
  25 #include "ffmpeg_content.h"
  26 #include "ffmpeg_examiner.h"
  27 #include "ffmpeg_subtitle_stream.h"
  28 #include "ffmpeg_audio_stream.h"
  29 #include "compose.hpp"
  30 #include "job.h"
  31 #include "util.h"
  32 #include "filter.h"
  33 #include "film.h"
  34 #include "log.h"
  35 #include "exceptions.h"
  36 #include "frame_rate_change.h"
  37
  38 #include "i18n.h"
  39
  40 #define LOG_GENERAL(...) film->log()->log (String::compose (__VA_ARGS__), Log::TYPE_GENERAL);
  41
  42 using std::string;
  43 using std::stringstream;
  44 using std::vector;
  45 using std::list;
  46 using std::cout;
  47 using std::pair;
  48 using boost::shared_ptr;
  49 using boost::dynamic_pointer_cast;
  50 using dcp::raw_convert;
  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::AUDIO_STREAM = 103;
  56 int const FFmpegContentProperty::FILTERS = 104;
  57
  58 FFmpegContent::FFmpegContent (shared_ptr<const Film> f, boost::filesystem::path p)
  59         : Content (f, p)
  60         , VideoContent (f, p)
  61         , AudioContent (f, p)
  62         , SubtitleContent (f, p)
  63 {
  64
  65 }
  66
  67 FFmpegContent::FFmpegContent (shared_ptr<const Film> f, cxml::ConstNodePtr node, int version, list<string>& notes)
  68         : Content (f, node)
  69         , VideoContent (f, node, version)
  70         , AudioContent (f, node)
  71         , SubtitleContent (f, node, version)
  72 {
  73         list<cxml::NodePtr> c = node->node_children ("SubtitleStream");
  74         for (list<cxml::NodePtr>::const_iterator i = c.begin(); i != c.end(); ++i) {
  75                 _subtitle_streams.push_back (shared_ptr<FFmpegSubtitleStream> (new FFmpegSubtitleStream (*i)));
  76                 if ((*i)->optional_number_child<int> ("Selected")) {
  77                         _subtitle_stream = _subtitle_streams.back ();
  78                 }
  79         }
  80
  81         c = node->node_children ("AudioStream");
  82         for (list<cxml::NodePtr>::const_iterator i = c.begin(); i != c.end(); ++i) {
  83                 _audio_streams.push_back (shared_ptr<FFmpegAudioStream> (new FFmpegAudioStream (*i, version)));
  84                 if ((*i)->optional_number_child<int> ("Selected")) {
  85                         _audio_stream = _audio_streams.back ();
  86                 }
  87         }
  88
  89         c = node->node_children ("Filter");
  90         for (list<cxml::NodePtr>::iterator i = c.begin(); i != c.end(); ++i) {
  91                 Filter const * f = Filter::from_id ((*i)->content ());
  92                 if (f) {
  93                         _filters.push_back (f);
  94                 } else {
  95                         notes.push_back (String::compose (_("DCP-o-matic no longer supports the `%1' filter, so it has been turned off."), (*i)->content()));
  96                 }
  97         }
  98
  99         _first_video = node->optional_number_child<double> ("FirstVideo");
 100 }
 101
 102 FFmpegContent::FFmpegContent (shared_ptr<const Film> f, vector<boost::shared_ptr<Content> > c)
 103         : Content (f, c)
 104         , VideoContent (f, c)
 105         , AudioContent (f, c)
 106         , SubtitleContent (f, c)
 107 {
 108         shared_ptr<FFmpegContent> ref = dynamic_pointer_cast<FFmpegContent> (c[0]);
 109         assert (ref);
 110
 111         for (size_t i = 0; i < c.size(); ++i) {
 112                 shared_ptr<FFmpegContent> fc = dynamic_pointer_cast<FFmpegContent> (c[i]);
 113                 if (fc->use_subtitles() && *(fc->_subtitle_stream.get()) != *(ref->_subtitle_stream.get())) {
 114                         throw JoinError (_("Content to be joined must use the same subtitle stream."));
 115                 }
 116
 117                 if (*(fc->_audio_stream.get()) != *(ref->_audio_stream.get())) {
 118                         throw JoinError (_("Content to be joined must use the same audio stream."));
 119                 }
 120         }
 121
 122         _subtitle_streams = ref->subtitle_streams ();
 123         _subtitle_stream = ref->subtitle_stream ();
 124         _audio_streams = ref->audio_streams ();
 125         _audio_stream = ref->audio_stream ();
 126         _first_video = ref->_first_video;
 127 }
 128
 129 void
 130 FFmpegContent::as_xml (xmlpp::Node* node) const
 131 {
 132         node->add_child("Type")->add_child_text ("FFmpeg");
 133         Content::as_xml (node);
 134         VideoContent::as_xml (node);
 135         AudioContent::as_xml (node);
 136         SubtitleContent::as_xml (node);
 137
 138         boost::mutex::scoped_lock lm (_mutex);
 139
 140         for (vector<shared_ptr<FFmpegSubtitleStream> >::const_iterator i = _subtitle_streams.begin(); i != _subtitle_streams.end(); ++i) {
 141                 xmlpp::Node* t = node->add_child("SubtitleStream");
 142                 if (_subtitle_stream && *i == _subtitle_stream) {
 143                         t->add_child("Selected")->add_child_text("1");
 144                 }
 145                 (*i)->as_xml (t);
 146         }
 147
 148         for (vector<shared_ptr<FFmpegAudioStream> >::const_iterator i = _audio_streams.begin(); i != _audio_streams.end(); ++i) {
 149                 xmlpp::Node* t = node->add_child("AudioStream");
 150                 if (_audio_stream && *i == _audio_stream) {
 151                         t->add_child("Selected")->add_child_text("1");
 152                 }
 153                 (*i)->as_xml (t);
 154         }
 155
 156         for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
 157                 node->add_child("Filter")->add_child_text ((*i)->id ());
 158         }
 159
 160         if (_first_video) {
 161                 node->add_child("FirstVideo")->add_child_text (raw_convert<string> (_first_video.get().get()));
 162         }
 163 }
 164
 165 void
 166 FFmpegContent::examine (shared_ptr<Job> job)
 167 {
 168         job->set_progress_unknown ();
 169
 170         Content::examine (job);
 171
 172         shared_ptr<FFmpegExaminer> examiner (new FFmpegExaminer (shared_from_this ()));
 173         take_from_video_examiner (examiner);
 174
 175         shared_ptr<const Film> film = _film.lock ();
 176         assert (film);
 177
 178         {
 179                 boost::mutex::scoped_lock lm (_mutex);
 180
 181                 _subtitle_streams = examiner->subtitle_streams ();
 182                 if (!_subtitle_streams.empty ()) {
 183                         _subtitle_stream = _subtitle_streams.front ();
 184                 }
 185
 186                 _audio_streams = examiner->audio_streams ();
 187                 if (!_audio_streams.empty ()) {
 188                         _audio_stream = _audio_streams.front ();
 189                 }
 190
 191                 _first_video = examiner->first_video ();
 192         }
 193
 194         signal_changed (FFmpegContentProperty::SUBTITLE_STREAMS);
 195         signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
 196         signal_changed (FFmpegContentProperty::AUDIO_STREAMS);
 197         signal_changed (FFmpegContentProperty::AUDIO_STREAM);
 198         signal_changed (AudioContentProperty::AUDIO_CHANNELS);
 199 }
 200
 201 string
 202 FFmpegContent::summary () const
 203 {
 204         /* Get the string() here so that the name does not have quotes around it */
 205         return String::compose (_("%1 [movie]"), path_summary ());
 206 }
 207
 208 string
 209 FFmpegContent::technical_summary () const
 210 {
 211         string as = "none";
 212         if (_audio_stream) {
 213                 as = _audio_stream->technical_summary ();
 214         }
 215
 216         string ss = "none";
 217         if (_subtitle_stream) {
 218                 ss = _subtitle_stream->technical_summary ();
 219         }
 220
 221         string filt = Filter::ffmpeg_string (_filters);
 222
 223         return Content::technical_summary() + " - "
 224                 + VideoContent::technical_summary() + " - "
 225                 + AudioContent::technical_summary() + " - "
 226                 + String::compose (
 227                         "ffmpeg: audio %1, subtitle %2, filters %3", as, ss, filt
 228                         );
 229 }
 230
 231 string
 232 FFmpegContent::information () const
 233 {
 234         if (video_length() == ContentTime (0) || video_frame_rate() == 0) {
 235                 return "";
 236         }
 237
 238         stringstream s;
 239
 240         s << String::compose (_("%1 frames; %2 frames per second"), video_length_after_3d_combine().frames (video_frame_rate()), video_frame_rate()) << "\n";
 241         s << VideoContent::information ();
 242
 243         return s.str ();
 244 }
 245
 246 void
 247 FFmpegContent::set_subtitle_stream (shared_ptr<FFmpegSubtitleStream> s)
 248 {
 249         {
 250                 boost::mutex::scoped_lock lm (_mutex);
 251                 _subtitle_stream = s;
 252         }
 253
 254         signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
 255 }
 256
 257 void
 258 FFmpegContent::set_audio_stream (shared_ptr<FFmpegAudioStream> s)
 259 {
 260         {
 261                 boost::mutex::scoped_lock lm (_mutex);
 262                 _audio_stream = s;
 263         }
 264
 265         signal_changed (FFmpegContentProperty::AUDIO_STREAM);
 266 }
 267
 268 ContentTime
 269 FFmpegContent::audio_length () const
 270 {
 271         if (!audio_stream ()) {
 272                 return ContentTime ();
 273         }
 274
 275         return video_length ();
 276 }
 277
 278 int
 279 FFmpegContent::audio_channels () const
 280 {
 281         boost::mutex::scoped_lock lm (_mutex);
 282
 283         if (!_audio_stream) {
 284                 return 0;
 285         }
 286
 287         return _audio_stream->channels;
 288 }
 289
 290 int
 291 FFmpegContent::audio_frame_rate () const
 292 {
 293         boost::mutex::scoped_lock lm (_mutex);
 294
 295         if (!_audio_stream) {
 296                 return 0;
 297         }
 298
 299         return _audio_stream->frame_rate;
 300 }
 301
 302 bool
 303 operator== (FFmpegStream const & a, FFmpegStream const & b)
 304 {
 305         return a._id == b._id;
 306 }
 307
 308 bool
 309 operator!= (FFmpegStream const & a, FFmpegStream const & b)
 310 {
 311         return a._id != b._id;
 312 }
 313
 314 DCPTime
 315 FFmpegContent::full_length () const
 316 {
 317         shared_ptr<const Film> film = _film.lock ();
 318         assert (film);
 319         return DCPTime (video_length_after_3d_combine(), FrameRateChange (video_frame_rate (), film->video_frame_rate ()));
 320 }
 321
 322 AudioMapping
 323 FFmpegContent::audio_mapping () const
 324 {
 325         boost::mutex::scoped_lock lm (_mutex);
 326
 327         if (!_audio_stream) {
 328                 return AudioMapping ();
 329         }
 330
 331         return _audio_stream->mapping;
 332 }
 333
 334 void
 335 FFmpegContent::set_filters (vector<Filter const *> const & filters)
 336 {
 337         {
 338                 boost::mutex::scoped_lock lm (_mutex);
 339                 _filters = filters;
 340         }
 341
 342         signal_changed (FFmpegContentProperty::FILTERS);
 343 }
 344
 345 void
 346 FFmpegContent::set_audio_mapping (AudioMapping m)
 347 {
 348         audio_stream()->mapping = m;
 349         AudioContent::set_audio_mapping (m);
 350 }
 351
 352 string
 353 FFmpegContent::identifier () const
 354 {
 355         stringstream s;
 356
 357         s << VideoContent::identifier();
 358
 359         boost::mutex::scoped_lock lm (_mutex);
 360
 361         if (_subtitle_stream) {
 362                 s << "_" << _subtitle_stream->identifier ();
 363         }
 364
 365         for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
 366                 s << "_" << (*i)->id ();
 367         }
 368
 369         return s.str ();
 370 }
 371
 372 boost::filesystem::path
 373 FFmpegContent::audio_analysis_path () const
 374 {
 375         shared_ptr<const Film> film = _film.lock ();
 376         if (!film) {
 377                 return boost::filesystem::path ();
 378         }
 379
 380         /* We need to include the stream ID in this path so that we get different
 381            analyses for each stream.
 382         */
 383
 384         boost::filesystem::path p = film->audio_analysis_dir ();
 385         string name = digest ();
 386         if (audio_stream ()) {
 387                 name += "_" + audio_stream()->identifier ();
 388         }
 389         p /= name;
 390         return p;
 391 }
 392
 393 list<ContentTimePeriod>
 394 FFmpegContent::subtitles_during (ContentTimePeriod period, bool starting) const
 395 {
 396         list<ContentTimePeriod> d;
 397
 398         shared_ptr<FFmpegSubtitleStream> stream = subtitle_stream ();
 399         if (!stream) {
 400                 return d;
 401         }
 402
 403         /* XXX: inefficient */
 404         for (vector<ContentTimePeriod>::const_iterator i = stream->periods.begin(); i != stream->periods.end(); ++i) {
 405                 if ((starting && period.contains (i->from)) || (!starting && period.overlaps (*i))) {
 406                         d.push_back (*i);
 407                 }
 408         }
 409
 410         return d;
 411 }
 412
 413 bool
 414 FFmpegContent::has_subtitles () const
 415 {
 416         return !subtitle_streams().empty ();
 417 }