src/lib/ffmpeg.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.h"
  21 #include "ffmpeg_content.h"
  22 #include "film.h"
  23 #include "exceptions.h"
  24 #include "util.h"
  25 #include "raw_convert.h"
  26 #include "log.h"
  27 #include "ffmpeg_subtitle_stream.h"
  28 #include "ffmpeg_audio_stream.h"
  29 #include "compose.hpp"
  30 extern "C" {
  31 #include <libavcodec/avcodec.h>
  32 #include <libavformat/avformat.h>
  33 #include <libswscale/swscale.h>
  34 }
  35 #include <boost/algorithm/string.hpp>
  36 #include <boost/foreach.hpp>
  37 #include <iostream>
  38
  39 #include "i18n.h"
  40
  41 using std::string;
  42 using std::cout;
  43 using std::cerr;
  44 using std::vector;
  45 using boost::shared_ptr;
  46 using boost::optional;
  47
  48 boost::mutex FFmpeg::_mutex;
  49 boost::weak_ptr<Log> FFmpeg::_ffmpeg_log;
  50
  51 FFmpeg::FFmpeg (boost::shared_ptr<const FFmpegContent> c)
  52         : _ffmpeg_content (c)
  53         , _avio_buffer (0)
  54         , _avio_buffer_size (4096)
  55         , _avio_context (0)
  56         , _format_context (0)
  57         , _frame (0)
  58         , _video_stream (-1)
  59 {
  60         setup_general ();
  61         setup_decoders ();
  62 }
  63
  64 FFmpeg::~FFmpeg ()
  65 {
  66         boost::mutex::scoped_lock lm (_mutex);
  67
  68         for (uint32_t i = 0; i < _format_context->nb_streams; ++i) {
  69                 avcodec_close (_format_context->streams[i]->codec);
  70         }
  71
  72         av_frame_free (&_frame);
  73         avformat_close_input (&_format_context);
  74 }
  75
  76 static int
  77 avio_read_wrapper (void* data, uint8_t* buffer, int amount)
  78 {
  79         return reinterpret_cast<FFmpeg*>(data)->avio_read (buffer, amount);
  80 }
  81
  82 static int64_t
  83 avio_seek_wrapper (void* data, int64_t offset, int whence)
  84 {
  85         return reinterpret_cast<FFmpeg*>(data)->avio_seek (offset, whence);
  86 }
  87
  88 void
  89 FFmpeg::ffmpeg_log_callback (void* ptr, int level, const char* fmt, va_list vl)
  90 {
  91         if (level > AV_LOG_WARNING) {
  92                 return;
  93         }
  94
  95         char line[1024];
  96         static int prefix = 0;
  97         av_log_format_line (ptr, level, fmt, vl, line, sizeof (line), &prefix);
  98         shared_ptr<Log> log = _ffmpeg_log.lock ();
  99         if (log) {
 100                 string str (line);
 101                 boost::algorithm::trim (str);
 102                 log->log (String::compose ("FFmpeg: %1", str), LogEntry::TYPE_GENERAL);
 103         } else {
 104                 cerr << line;
 105         }
 106 }
 107
 108 void
 109 FFmpeg::setup_general ()
 110 {
 111         av_register_all ();
 112
 113         /* This might not work too well in some cases of multiple FFmpeg decoders,
 114            but it's probably good enough.
 115         */
 116         _ffmpeg_log = _ffmpeg_content->film()->log ();
 117         av_log_set_callback (FFmpeg::ffmpeg_log_callback);
 118
 119         _file_group.set_paths (_ffmpeg_content->paths ());
 120         _avio_buffer = static_cast<uint8_t*> (wrapped_av_malloc (_avio_buffer_size));
 121         _avio_context = avio_alloc_context (_avio_buffer, _avio_buffer_size, 0, this, avio_read_wrapper, 0, avio_seek_wrapper);
 122         _format_context = avformat_alloc_context ();
 123         _format_context->pb = _avio_context;
 124
 125         AVDictionary* options = 0;
 126         /* These durations are in microseconds, and represent how far into the content file
 127            we will look for streams.
 128         */
 129         av_dict_set (&options, "analyzeduration", raw_convert<string> (5 * 60 * 1000000).c_str(), 0);
 130         av_dict_set (&options, "probesize", raw_convert<string> (5 * 60 * 1000000).c_str(), 0);
 131
 132         if (avformat_open_input (&_format_context, 0, 0, &options) < 0) {
 133                 throw OpenFileError (_ffmpeg_content->path(0).string ());
 134         }
 135
 136         if (avformat_find_stream_info (_format_context, 0) < 0) {
 137                 throw DecodeError (_("could not find stream information"));
 138         }
 139
 140         /* Find video stream */
 141
 142         int video_stream_undefined_frame_rate = -1;
 143
 144         for (uint32_t i = 0; i < _format_context->nb_streams; ++i) {
 145                 AVStream* s = _format_context->streams[i];
 146                 if (s->codec->codec_type == AVMEDIA_TYPE_VIDEO) {
 147                         if (s->avg_frame_rate.num > 0 && s->avg_frame_rate.den > 0) {
 148                                 /* This is definitely our video stream */
 149                                 _video_stream = i;
 150                         } else {
 151                                 /* This is our video stream if we don't get a better offer */
 152                                 video_stream_undefined_frame_rate = i;
 153                         }
 154                 }
 155         }
 156
 157         /* Files from iTunes sometimes have two video streams, one with the avg_frame_rate.num and .den set
 158            to zero.  Only use such a stream if there is no alternative.
 159         */
 160         if (_video_stream == -1 && video_stream_undefined_frame_rate != -1) {
 161                 _video_stream = video_stream_undefined_frame_rate;
 162         }
 163
 164         if (_video_stream < 0) {
 165                 throw DecodeError (N_("could not find video stream"));
 166         }
 167
 168         /* Hack: if the AVStreams have duplicate IDs, replace them with our
 169            own.  We use the IDs so that we can cope with VOBs, in which streams
 170            move about in index but remain with the same ID in different
 171            VOBs.  However, some files have duplicate IDs, hence this hack.
 172         */
 173
 174         bool duplicates = false;
 175         for (uint32_t i = 0; i < _format_context->nb_streams; ++i) {
 176                 for (uint32_t j = i + 1; j < _format_context->nb_streams; ++j) {
 177                         if (_format_context->streams[i]->id == _format_context->streams[j]->id) {
 178                                 duplicates = true;
 179                         }
 180                 }
 181         }
 182
 183         if (duplicates) {
 184                 /* Put in our own IDs */
 185                 for (uint32_t i = 0; i < _format_context->nb_streams; ++i) {
 186                         _format_context->streams[i]->id = i;
 187                 }
 188         }
 189
 190         _frame = av_frame_alloc ();
 191         if (_frame == 0) {
 192                 throw DecodeError (N_("could not allocate frame"));
 193         }
 194 }
 195
 196 void
 197 FFmpeg::setup_decoders ()
 198 {
 199         boost::mutex::scoped_lock lm (_mutex);
 200
 201         for (uint32_t i = 0; i < _format_context->nb_streams; ++i) {
 202                 AVCodecContext* context = _format_context->streams[i]->codec;
 203
 204                 AVCodec* codec = avcodec_find_decoder (context->codec_id);
 205                 if (codec) {
 206
 207                         /* This option disables decoding of DCA frame footers in our patched version
 208                            of FFmpeg.  I believe these footers are of no use to us, and they can cause
 209                            problems when FFmpeg fails to decode them (mantis #352).
 210                         */
 211                         AVDictionary* options = 0;
 212                         av_dict_set (&options, "disable_footer", "1", 0);
 213
 214                         if (avcodec_open2 (context, codec, &options) < 0) {
 215                                 throw DecodeError (N_("could not open decoder"));
 216                         }
 217                 }
 218
 219                 /* We are silently ignoring any failures to find suitable decoders here */
 220         }
 221 }
 222
 223 AVCodecContext *
 224 FFmpeg::video_codec_context () const
 225 {
 226         return _format_context->streams[_video_stream]->codec;
 227 }
 228
 229 AVCodecContext *
 230 FFmpeg::subtitle_codec_context () const
 231 {
 232         if (!_ffmpeg_content->subtitle_stream ()) {
 233                 return 0;
 234         }
 235
 236         return _ffmpeg_content->subtitle_stream()->stream(_format_context)->codec;
 237 }
 238
 239 int
 240 FFmpeg::avio_read (uint8_t* buffer, int const amount)
 241 {
 242         return _file_group.read (buffer, amount);
 243 }
 244
 245 int64_t
 246 FFmpeg::avio_seek (int64_t const pos, int whence)
 247 {
 248         if (whence == AVSEEK_SIZE) {
 249                 return _file_group.length ();
 250         }
 251
 252         return _file_group.seek (pos, whence);
 253 }
 254
 255 FFmpegSubtitlePeriod
 256 FFmpeg::subtitle_period (AVSubtitle const & sub)
 257 {
 258         ContentTime const packet_time = ContentTime::from_seconds (static_cast<double> (sub.pts) / AV_TIME_BASE);
 259
 260         if (sub.end_display_time == static_cast<uint32_t> (-1)) {
 261                 /* End time is not known */
 262                 return FFmpegSubtitlePeriod (packet_time + ContentTime::from_seconds (sub.start_display_time / 1e3));
 263         }
 264
 265         return FFmpegSubtitlePeriod (
 266                 packet_time + ContentTime::from_seconds (sub.start_display_time / 1e3),
 267                 packet_time + ContentTime::from_seconds (sub.end_display_time / 1e3)
 268                 );
 269 }
 270
 271 /** Compute the pts offset to use given a set of audio streams and some video details.
 272  *  Sometimes these parameters will have just been determined by an Examiner, sometimes
 273  *  they will have been retrieved from a piece of Content, hence the need for this method
 274  *  in FFmpeg.
 275  */
 276 ContentTime
 277 FFmpeg::pts_offset (vector<shared_ptr<FFmpegAudioStream> > audio_streams, optional<ContentTime> first_video, double video_frame_rate) const
 278 {
 279         /* Audio and video frame PTS values may not start with 0.  We want
 280            to fiddle them so that:
 281
 282            1.  One of them starts at time 0.
 283            2.  The first video PTS value ends up on a frame boundary.
 284
 285            Then we remove big initial gaps in PTS and we allow our
 286            insertion of black frames to work.
 287
 288            We will do:
 289              audio_pts_to_use = audio_pts_from_ffmpeg + pts_offset;
 290              video_pts_to_use = video_pts_from_ffmpeg + pts_offset;
 291         */
 292
 293         /* First, make one of them start at 0 */
 294
 295         ContentTime po = ContentTime::min ();
 296
 297         if (first_video) {
 298                 po = - first_video.get ();
 299         }
 300
 301         BOOST_FOREACH (shared_ptr<FFmpegAudioStream> i, audio_streams) {
 302                 if (i->first_audio) {
 303                         po = max (po, - i->first_audio.get ());
 304                 }
 305         }
 306
 307         /* If the offset is positive we would be pushing things from a -ve PTS to be played.
 308            I don't think we ever want to do that, as it seems things at -ve PTS are not meant
 309            to be seen (use for alignment bars etc.); see mantis #418.
 310         */
 311         if (po > ContentTime ()) {
 312                 po = ContentTime ();
 313         }
 314
 315         /* Now adjust so that the video pts starts on a frame */
 316         if (first_video) {
 317                 ContentTime const fvc = first_video.get() + po;
 318                 po += fvc.round_up (video_frame_rate) - fvc;
 319         }
 320
 321         return po;
 322 }