Various work on better seeking (and seeking of audio).
[dcpomatic.git] / src / lib / ffmpeg_decoder.cc
1 /*
2     Copyright (C) 2012 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 /** @file  src/ffmpeg_decoder.cc
21  *  @brief A decoder using FFmpeg to decode content.
22  */
23
24 #include <stdexcept>
25 #include <vector>
26 #include <sstream>
27 #include <iomanip>
28 #include <iostream>
29 #include <stdint.h>
30 #include <boost/lexical_cast.hpp>
31 #include <sndfile.h>
32 extern "C" {
33 #include <libavcodec/avcodec.h>
34 #include <libavformat/avformat.h>
35 }
36 #include "film.h"
37 #include "filter.h"
38 #include "exceptions.h"
39 #include "image.h"
40 #include "util.h"
41 #include "log.h"
42 #include "ffmpeg_decoder.h"
43 #include "filter_graph.h"
44 #include "audio_buffers.h"
45 #include "ffmpeg_content.h"
46
47 #include "i18n.h"
48
49 using std::cout;
50 using std::string;
51 using std::vector;
52 using std::stringstream;
53 using std::list;
54 using std::min;
55 using std::pair;
56 using boost::shared_ptr;
57 using boost::optional;
58 using boost::dynamic_pointer_cast;
59 using libdcp::Size;
60
61 FFmpegDecoder::FFmpegDecoder (shared_ptr<const Film> f, shared_ptr<const FFmpegContent> c, bool video, bool audio)
62         : Decoder (f)
63         , VideoDecoder (f, c)
64         , AudioDecoder (f, c)
65         , SubtitleDecoder (f)
66         , FFmpeg (c)
67         , _subtitle_codec_context (0)
68         , _subtitle_codec (0)
69         , _decode_video (video)
70         , _decode_audio (audio)
71         , _video_pts_offset (0)
72         , _audio_pts_offset (0)
73         , _just_sought (false)
74 {
75         setup_subtitle ();
76
77         /* Audio and video frame PTS values may not start with 0.  We want
78            to fiddle them so that:
79
80            1.  One of them starts at time 0.
81            2.  The first video PTS value ends up on a frame boundary.
82
83            Then we remove big initial gaps in PTS and we allow our
84            insertion of black frames to work.
85
86            We will do:
87              audio_pts_to_use = audio_pts_from_ffmpeg + audio_pts_offset;
88              video_pts_to_use = video_pts_from_ffmpeg + video_pts_offset;
89         */
90
91         bool const have_video = video && c->first_video();
92         bool const have_audio = audio && c->audio_stream() && c->audio_stream()->first_audio;
93
94         /* First, make one of them start at 0 */
95
96         if (have_audio && have_video) {
97                 _video_pts_offset = _audio_pts_offset = - min (c->first_video().get(), c->audio_stream()->first_audio.get());
98         } else if (have_video) {
99                 _video_pts_offset = - c->first_video().get();
100         } else if (have_audio) {
101                 _audio_pts_offset = - c->audio_stream()->first_audio.get();
102         }
103
104         /* Now adjust both so that the video pts starts on a frame */
105         if (have_video && have_audio) {
106                 double first_video = c->first_video().get() + _video_pts_offset;
107                 double const old_first_video = first_video;
108                 
109                 /* Round the first video up to a frame boundary */
110                 if (fabs (rint (first_video * c->video_frame_rate()) - first_video * c->video_frame_rate()) > 1e-6) {
111                         first_video = ceil (first_video * c->video_frame_rate()) / c->video_frame_rate ();
112                 }
113
114                 _video_pts_offset += first_video - old_first_video;
115                 _audio_pts_offset += first_video - old_first_video;
116         }
117 }
118
119 FFmpegDecoder::~FFmpegDecoder ()
120 {
121         boost::mutex::scoped_lock lm (_mutex);
122
123         if (_subtitle_codec_context) {
124                 avcodec_close (_subtitle_codec_context);
125         }
126 }
127
128 void
129 FFmpegDecoder::flush ()
130 {
131         /* Get any remaining frames */
132         
133         _packet.data = 0;
134         _packet.size = 0;
135         
136         /* XXX: should we reset _packet.data and size after each *_decode_* call? */
137         
138         if (_decode_video) {
139                 while (decode_video_packet ()) {}
140         }
141         
142         if (_ffmpeg_content->audio_stream() && _decode_audio) {
143                 decode_audio_packet ();
144         }
145
146         /* Stop us being asked for any more data */
147         _video_position = _ffmpeg_content->video_length ();
148         _audio_position = _ffmpeg_content->audio_length ();
149 }
150
151 void
152 FFmpegDecoder::pass ()
153 {
154         int r = av_read_frame (_format_context, &_packet);
155
156         if (r < 0) {
157                 if (r != AVERROR_EOF) {
158                         /* Maybe we should fail here, but for now we'll just finish off instead */
159                         char buf[256];
160                         av_strerror (r, buf, sizeof(buf));
161                         shared_ptr<const Film> film = _film.lock ();
162                         assert (film);
163                         film->log()->log (String::compose (N_("error on av_read_frame (%1) (%2)"), buf, r));
164                 }
165
166                 flush ();
167                 return;
168         }
169
170         avcodec_get_frame_defaults (_frame);
171
172         shared_ptr<const Film> film = _film.lock ();
173         assert (film);
174
175         int const si = _packet.stream_index;
176         
177         if (si == _video_stream && _decode_video) {
178                 decode_video_packet ();
179         } else if (_ffmpeg_content->audio_stream() && si == _ffmpeg_content->audio_stream()->index (_format_context) && _decode_audio) {
180                 decode_audio_packet ();
181         } else if (_ffmpeg_content->subtitle_stream() && si == _ffmpeg_content->subtitle_stream()->index (_format_context) && film->with_subtitles ()) {
182                 decode_subtitle_packet ();
183         }
184
185         av_free_packet (&_packet);
186 }
187
188 /** @param data pointer to array of pointers to buffers.
189  *  Only the first buffer will be used for non-planar data, otherwise there will be one per channel.
190  */
191 shared_ptr<AudioBuffers>
192 FFmpegDecoder::deinterleave_audio (uint8_t** data, int size)
193 {
194         assert (_ffmpeg_content->audio_channels());
195         assert (bytes_per_audio_sample());
196
197         /* Deinterleave and convert to float */
198
199         assert ((size % (bytes_per_audio_sample() * _ffmpeg_content->audio_channels())) == 0);
200
201         int const total_samples = size / bytes_per_audio_sample();
202         int const frames = total_samples / _ffmpeg_content->audio_channels();
203         shared_ptr<AudioBuffers> audio (new AudioBuffers (_ffmpeg_content->audio_channels(), frames));
204
205         switch (audio_sample_format()) {
206         case AV_SAMPLE_FMT_S16:
207         {
208                 int16_t* p = reinterpret_cast<int16_t *> (data[0]);
209                 int sample = 0;
210                 int channel = 0;
211                 for (int i = 0; i < total_samples; ++i) {
212                         audio->data(channel)[sample] = float(*p++) / (1 << 15);
213
214                         ++channel;
215                         if (channel == _ffmpeg_content->audio_channels()) {
216                                 channel = 0;
217                                 ++sample;
218                         }
219                 }
220         }
221         break;
222
223         case AV_SAMPLE_FMT_S16P:
224         {
225                 int16_t** p = reinterpret_cast<int16_t **> (data);
226                 for (int i = 0; i < _ffmpeg_content->audio_channels(); ++i) {
227                         for (int j = 0; j < frames; ++j) {
228                                 audio->data(i)[j] = static_cast<float>(p[i][j]) / (1 << 15);
229                         }
230                 }
231         }
232         break;
233         
234         case AV_SAMPLE_FMT_S32:
235         {
236                 int32_t* p = reinterpret_cast<int32_t *> (data[0]);
237                 int sample = 0;
238                 int channel = 0;
239                 for (int i = 0; i < total_samples; ++i) {
240                         audio->data(channel)[sample] = static_cast<float>(*p++) / (1 << 31);
241
242                         ++channel;
243                         if (channel == _ffmpeg_content->audio_channels()) {
244                                 channel = 0;
245                                 ++sample;
246                         }
247                 }
248         }
249         break;
250
251         case AV_SAMPLE_FMT_FLT:
252         {
253                 float* p = reinterpret_cast<float*> (data[0]);
254                 int sample = 0;
255                 int channel = 0;
256                 for (int i = 0; i < total_samples; ++i) {
257                         audio->data(channel)[sample] = *p++;
258
259                         ++channel;
260                         if (channel == _ffmpeg_content->audio_channels()) {
261                                 channel = 0;
262                                 ++sample;
263                         }
264                 }
265         }
266         break;
267                 
268         case AV_SAMPLE_FMT_FLTP:
269         {
270                 float** p = reinterpret_cast<float**> (data);
271                 for (int i = 0; i < _ffmpeg_content->audio_channels(); ++i) {
272                         memcpy (audio->data(i), p[i], frames * sizeof(float));
273                 }
274         }
275         break;
276
277         default:
278                 throw DecodeError (String::compose (_("Unrecognised audio sample format (%1)"), static_cast<int> (audio_sample_format())));
279         }
280
281         return audio;
282 }
283
284 AVSampleFormat
285 FFmpegDecoder::audio_sample_format () const
286 {
287         if (!_ffmpeg_content->audio_stream()) {
288                 return (AVSampleFormat) 0;
289         }
290         
291         return audio_codec_context()->sample_fmt;
292 }
293
294 int
295 FFmpegDecoder::bytes_per_audio_sample () const
296 {
297         return av_get_bytes_per_sample (audio_sample_format ());
298 }
299
300 int
301 FFmpegDecoder::minimal_run (boost::function<bool (int)> finished)
302 {
303         int frames_read = 0;
304         
305         while (!finished (frames_read)) {
306                 int r = av_read_frame (_format_context, &_packet);
307                 if (r < 0) {
308                         return -1;
309                 }
310
311                 ++frames_read;
312
313                 double const time_base = av_q2d (_format_context->streams[_packet.stream_index]->time_base);
314
315                 if (_packet.stream_index == _video_stream) {
316
317                         avcodec_get_frame_defaults (_frame);
318                         
319                         int finished = 0;
320                         r = avcodec_decode_video2 (video_codec_context(), _frame, &finished, &_packet);
321                         if (r >= 0 && finished) {
322                                 _video_position = rint (
323                                         (av_frame_get_best_effort_timestamp (_frame) * time_base + _video_pts_offset) * _ffmpeg_content->video_frame_rate()
324                                         );
325                         }
326
327                 } else if (_ffmpeg_content->audio_stream() && _packet.stream_index == _ffmpeg_content->audio_stream()->index (_format_context)) {
328
329                         AVPacket copy_packet = _packet;
330
331                         while (copy_packet.size > 0) {
332
333                                 int finished;
334                                 r = avcodec_decode_audio4 (audio_codec_context(), _frame, &finished, &copy_packet);
335                                 if (r >= 0 && finished) {
336                                         _audio_position = rint (
337                                                 (av_frame_get_best_effort_timestamp (_frame) * time_base + _audio_pts_offset) *
338                                                 _ffmpeg_content->audio_stream()->frame_rate
339                                                 );
340                                 }
341
342                                 copy_packet.data += r;
343                                 copy_packet.size -= r;
344                         }
345                 }
346
347                 av_free_packet (&_packet);
348         }
349
350         return frames_read;
351 }
352
353 bool
354 FFmpegDecoder::seek_overrun_finished (Time seek) const
355 {
356         return (
357                 _video_position >= _ffmpeg_content->time_to_content_video_frames (seek) ||
358                 _audio_position >= _ffmpeg_content->time_to_content_audio_frames (seek, _ffmpeg_content->position())
359                 );
360 }
361
362 bool
363 FFmpegDecoder::seek_final_finished (int n, int done) const
364 {
365         return n == done;
366 }
367
368 void
369 FFmpegDecoder::seek_and_flush (Time t)
370 {
371         int64_t const initial_v = ((_ffmpeg_content->time_to_content_video_frames (t) / _ffmpeg_content->video_frame_rate()) - _video_pts_offset) /
372                 av_q2d (_format_context->streams[_video_stream]->time_base);
373
374         av_seek_frame (_format_context, _video_stream, initial_v, AVSEEK_FLAG_BACKWARD);
375
376         shared_ptr<FFmpegAudioStream> as = _ffmpeg_content->audio_stream ();
377         if (as) {
378                 int64_t initial_a = ((_ffmpeg_content->time_to_content_audio_frames (t, t) / as->frame_rate) - _audio_pts_offset) /
379                         av_q2d (as->stream(_format_context)->time_base);
380
381                 av_seek_frame (_format_context, as->index (_format_context), initial_a, AVSEEK_FLAG_BACKWARD);
382         }
383
384         avcodec_flush_buffers (video_codec_context());
385         if (audio_codec_context ()) {
386                 avcodec_flush_buffers (audio_codec_context ());
387         }
388         if (_subtitle_codec_context) {
389                 avcodec_flush_buffers (_subtitle_codec_context);
390         }
391
392         _video_position = _ffmpeg_content->time_to_content_video_frames (t);
393         _audio_position = _ffmpeg_content->time_to_content_audio_frames (t, t);
394 }
395
396 void
397 FFmpegDecoder::seek (Time time, bool accurate)
398 {
399         /* If we are doing an accurate seek, our initial shot will be 200ms (200 being
400            a number plucked from the air) earlier than we want to end up.  The loop below
401            will hopefully then step through to where we want to be.
402         */
403
404         Time pre_roll = accurate ? (0.2 * TIME_HZ) : 0;
405         Time initial_seek = time - pre_roll;
406         if (initial_seek < 0) {
407                 initial_seek = 0;
408         }
409         
410         /* Initial seek time in the video stream's timebase */
411
412         seek_and_flush (initial_seek);
413
414         _just_sought = true;
415         
416         if (time == 0 || !accurate) {
417                 /* We're already there, or we're as close as we need to be */
418                 return;
419         }
420
421         int const N = minimal_run (boost::bind (&FFmpegDecoder::seek_overrun_finished, this, time));
422
423         seek_and_flush (initial_seek);
424         if (N > 0) {
425                 minimal_run (boost::bind (&FFmpegDecoder::seek_final_finished, this, N - 1, _1));
426         }
427 }
428
429 void
430 FFmpegDecoder::decode_audio_packet ()
431 {
432         /* Audio packets can contain multiple frames, so we may have to call avcodec_decode_audio4
433            several times.
434         */
435         
436         AVPacket copy_packet = _packet;
437         
438         while (copy_packet.size > 0) {
439
440                 int frame_finished;
441                 int const decode_result = avcodec_decode_audio4 (audio_codec_context(), _frame, &frame_finished, &copy_packet);
442
443                 if (decode_result < 0) {
444                         shared_ptr<const Film> film = _film.lock ();
445                         assert (film);
446                         film->log()->log (String::compose ("avcodec_decode_audio4 failed (%1)", decode_result));
447                         return;
448                 }
449
450                 if (frame_finished) {
451                         
452                         if (_audio_position == 0) {
453                                 /* Where we are in the source, in seconds */
454                                 double const pts = av_q2d (_format_context->streams[copy_packet.stream_index]->time_base)
455                                         * av_frame_get_best_effort_timestamp(_frame) + _audio_pts_offset;
456
457                                 if (pts > 0) {
458                                         /* Emit some silence */
459                                         shared_ptr<AudioBuffers> silence (
460                                                 new AudioBuffers (
461                                                         _ffmpeg_content->audio_channels(),
462                                                         pts * _ffmpeg_content->content_audio_frame_rate()
463                                                         )
464                                                 );
465                                         
466                                         silence->make_silent ();
467                                         audio (silence, _audio_position);
468                                 }
469                         }
470                         
471                         int const data_size = av_samples_get_buffer_size (
472                                 0, audio_codec_context()->channels, _frame->nb_samples, audio_sample_format (), 1
473                                 );
474                         
475                         audio (deinterleave_audio (_frame->data, data_size), _audio_position);
476                 }
477                         
478                 copy_packet.data += decode_result;
479                 copy_packet.size -= decode_result;
480         }
481 }
482
483 bool
484 FFmpegDecoder::decode_video_packet ()
485 {
486         int frame_finished;
487         if (avcodec_decode_video2 (video_codec_context(), _frame, &frame_finished, &_packet) < 0 || !frame_finished) {
488                 return false;
489         }
490
491         boost::mutex::scoped_lock lm (_filter_graphs_mutex);
492
493         shared_ptr<FilterGraph> graph;
494         
495         list<shared_ptr<FilterGraph> >::iterator i = _filter_graphs.begin();
496         while (i != _filter_graphs.end() && !(*i)->can_process (libdcp::Size (_frame->width, _frame->height), (AVPixelFormat) _frame->format)) {
497                 ++i;
498         }
499
500         if (i == _filter_graphs.end ()) {
501                 shared_ptr<const Film> film = _film.lock ();
502                 assert (film);
503
504                 graph.reset (new FilterGraph (_ffmpeg_content, libdcp::Size (_frame->width, _frame->height), (AVPixelFormat) _frame->format));
505                 _filter_graphs.push_back (graph);
506
507                 film->log()->log (String::compose (N_("New graph for %1x%2, pixel format %3"), _frame->width, _frame->height, _frame->format));
508         } else {
509                 graph = *i;
510         }
511
512         list<pair<shared_ptr<Image>, int64_t> > images = graph->process (_frame);
513
514         string post_process = Filter::ffmpeg_strings (_ffmpeg_content->filters()).second;
515         
516         for (list<pair<shared_ptr<Image>, int64_t> >::iterator i = images.begin(); i != images.end(); ++i) {
517
518                 shared_ptr<Image> image = i->first;
519                 if (!post_process.empty ()) {
520                         image = image->post_process (post_process, true);
521                 }
522                 
523                 if (i->second != AV_NOPTS_VALUE) {
524
525                         double const pts = i->second * av_q2d (_format_context->streams[_video_stream]->time_base) + _video_pts_offset;
526
527                         if (_just_sought) {
528                                 /* We just did a seek, so disable any attempts to correct for where we
529                                    are / should be.
530                                 */
531                                 _video_position = rint (pts * _ffmpeg_content->video_frame_rate ());
532                                 _just_sought = false;
533                         }
534
535                         double const next = _video_position / _ffmpeg_content->video_frame_rate();
536                         double const one_frame = 1 / _ffmpeg_content->video_frame_rate ();
537                         double delta = pts - next;
538
539                         while (delta > one_frame) {
540                                 /* This PTS is more than one frame forward in time of where we think we should be; emit
541                                    a black frame.
542                                 */
543
544                                 /* XXX: I think this should be a copy of the last frame... */
545                                 boost::shared_ptr<Image> black (
546                                         new Image (
547                                                 static_cast<AVPixelFormat> (_frame->format),
548                                                 libdcp::Size (video_codec_context()->width, video_codec_context()->height),
549                                                 true
550                                                 )
551                                         );
552                                 
553                                 black->make_black ();
554                                 video (image, false, _video_position);
555                                 delta -= one_frame;
556                         }
557
558                         if (delta > -one_frame) {
559                                 /* This PTS is within a frame of being right; emit this (otherwise it will be dropped) */
560                                 video (image, false, _video_position);
561                         }
562                                 
563                 } else {
564                         shared_ptr<const Film> film = _film.lock ();
565                         assert (film);
566                         film->log()->log ("Dropping frame without PTS");
567                 }
568         }
569
570         return true;
571 }
572
573         
574 void
575 FFmpegDecoder::setup_subtitle ()
576 {
577         boost::mutex::scoped_lock lm (_mutex);
578         
579         if (!_ffmpeg_content->subtitle_stream() || _ffmpeg_content->subtitle_stream()->index (_format_context) >= int (_format_context->nb_streams)) {
580                 return;
581         }
582
583         _subtitle_codec_context = _ffmpeg_content->subtitle_stream()->stream(_format_context)->codec;
584         _subtitle_codec = avcodec_find_decoder (_subtitle_codec_context->codec_id);
585
586         if (_subtitle_codec == 0) {
587                 throw DecodeError (_("could not find subtitle decoder"));
588         }
589         
590         if (avcodec_open2 (_subtitle_codec_context, _subtitle_codec, 0) < 0) {
591                 throw DecodeError (N_("could not open subtitle decoder"));
592         }
593 }
594
595 bool
596 FFmpegDecoder::done () const
597 {
598         bool const vd = !_decode_video || (_video_position >= _ffmpeg_content->video_length());
599         bool const ad = !_decode_audio || !_ffmpeg_content->audio_stream() || (_audio_position >= _ffmpeg_content->audio_length());
600         return vd && ad;
601 }
602         
603 void
604 FFmpegDecoder::decode_subtitle_packet ()
605 {
606         int got_subtitle;
607         AVSubtitle sub;
608         if (avcodec_decode_subtitle2 (_subtitle_codec_context, &sub, &got_subtitle, &_packet) < 0 || !got_subtitle) {
609                 return;
610         }
611
612         /* Sometimes we get an empty AVSubtitle, which is used by some codecs to
613            indicate that the previous subtitle should stop.
614         */
615         if (sub.num_rects <= 0) {
616                 subtitle (shared_ptr<Image> (), dcpomatic::Rect<double> (), 0, 0);
617                 return;
618         } else if (sub.num_rects > 1) {
619                 throw DecodeError (_("multi-part subtitles not yet supported"));
620         }
621                 
622         /* Subtitle PTS in seconds (within the source, not taking into account any of the
623            source that we may have chopped off for the DCP)
624         */
625         double const packet_time = static_cast<double> (sub.pts) / AV_TIME_BASE;
626         
627         /* hence start time for this sub */
628         Time const from = (packet_time + (double (sub.start_display_time) / 1e3)) * TIME_HZ;
629         Time const to = (packet_time + (double (sub.end_display_time) / 1e3)) * TIME_HZ;
630
631         AVSubtitleRect const * rect = sub.rects[0];
632
633         if (rect->type != SUBTITLE_BITMAP) {
634                 throw DecodeError (_("non-bitmap subtitles not yet supported"));
635         }
636         
637         shared_ptr<Image> image (new Image (PIX_FMT_RGBA, libdcp::Size (rect->w, rect->h), true));
638
639         /* Start of the first line in the subtitle */
640         uint8_t* sub_p = rect->pict.data[0];
641         /* sub_p looks up into a RGB palette which is here */
642         uint32_t const * palette = (uint32_t *) rect->pict.data[1];
643         /* Start of the output data */
644         uint32_t* out_p = (uint32_t *) image->data()[0];
645         
646         for (int y = 0; y < rect->h; ++y) {
647                 uint8_t* sub_line_p = sub_p;
648                 uint32_t* out_line_p = out_p;
649                 for (int x = 0; x < rect->w; ++x) {
650                         *out_line_p++ = palette[*sub_line_p++];
651                 }
652                 sub_p += rect->pict.linesize[0];
653                 out_p += image->stride()[0] / sizeof (uint32_t);
654         }
655
656         libdcp::Size const vs = _ffmpeg_content->video_size ();
657
658         subtitle (
659                 image,
660                 dcpomatic::Rect<double> (
661                         static_cast<double> (rect->x) / vs.width,
662                         static_cast<double> (rect->y) / vs.height,
663                         static_cast<double> (rect->w) / vs.width,
664                         static_cast<double> (rect->h) / vs.height
665                         ),
666                 from,
667                 to
668                 );
669                           
670         
671         avsubtitle_free (&sub);
672 }