bcfbea4316df8999af3d7b31440aa2ffcaf48047
[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 extern "C" {
32 #include <libavcodec/avcodec.h>
33 #include <libavformat/avformat.h>
34 #include <libswscale/swscale.h>
35 #include <libpostproc/postprocess.h>
36 }
37 #include <sndfile.h>
38 #include "film.h"
39 #include "format.h"
40 #include "transcoder.h"
41 #include "job.h"
42 #include "filter.h"
43 #include "options.h"
44 #include "exceptions.h"
45 #include "image.h"
46 #include "util.h"
47 #include "log.h"
48 #include "ffmpeg_decoder.h"
49 #include "filter_graph.h"
50 #include "subtitle.h"
51
52 #include "i18n.h"
53
54 using std::cout;
55 using std::string;
56 using std::vector;
57 using std::stringstream;
58 using std::list;
59 using boost::shared_ptr;
60 using boost::optional;
61 using boost::dynamic_pointer_cast;
62 using libdcp::Size;
63
64 FFmpegDecoder::FFmpegDecoder (shared_ptr<Film> f, DecodeOptions o)
65         : Decoder (f, o)
66         , VideoDecoder (f, o)
67         , AudioDecoder (f, o)
68         , _format_context (0)
69         , _video_stream (-1)
70         , _frame (0)
71         , _video_codec_context (0)
72         , _video_codec (0)
73         , _audio_codec_context (0)
74         , _audio_codec (0)
75         , _subtitle_codec_context (0)
76         , _subtitle_codec (0)
77 {
78         setup_general ();
79         setup_video ();
80         setup_audio ();
81         setup_subtitle ();
82 }
83
84 FFmpegDecoder::~FFmpegDecoder ()
85 {
86         if (_audio_codec_context) {
87                 avcodec_close (_audio_codec_context);
88         }
89         
90         if (_video_codec_context) {
91                 avcodec_close (_video_codec_context);
92         }
93
94         if (_subtitle_codec_context) {
95                 avcodec_close (_subtitle_codec_context);
96         }
97
98         av_free (_frame);
99         
100         avformat_close_input (&_format_context);
101 }       
102
103 void
104 FFmpegDecoder::setup_general ()
105 {
106         av_register_all ();
107
108         if (avformat_open_input (&_format_context, _film->content_path().c_str(), 0, 0) < 0) {
109                 throw OpenFileError (_film->content_path ());
110         }
111
112         if (avformat_find_stream_info (_format_context, 0) < 0) {
113                 throw DecodeError (_("could not find stream information"));
114         }
115
116         /* Find video, audio and subtitle streams and choose the first of each */
117
118         for (uint32_t i = 0; i < _format_context->nb_streams; ++i) {
119                 AVStream* s = _format_context->streams[i];
120                 if (s->codec->codec_type == AVMEDIA_TYPE_VIDEO) {
121                         _video_stream = i;
122                 } else if (s->codec->codec_type == AVMEDIA_TYPE_AUDIO) {
123
124                         /* This is a hack; sometimes it seems that _audio_codec_context->channel_layout isn't set up,
125                            so bodge it here.  No idea why we should have to do this.
126                         */
127
128                         if (s->codec->channel_layout == 0) {
129                                 s->codec->channel_layout = av_get_default_channel_layout (s->codec->channels);
130                         }
131                         
132                         _audio_streams.push_back (
133                                 shared_ptr<AudioStream> (
134                                         new FFmpegAudioStream (stream_name (s), i, s->codec->sample_rate, s->codec->channel_layout)
135                                         )
136                                 );
137                         
138                 } else if (s->codec->codec_type == AVMEDIA_TYPE_SUBTITLE) {
139                         _subtitle_streams.push_back (
140                                 shared_ptr<SubtitleStream> (
141                                         new SubtitleStream (stream_name (s), i)
142                                         )
143                                 );
144                 }
145         }
146
147         if (_video_stream < 0) {
148                 throw DecodeError (N_("could not find video stream"));
149         }
150
151         _frame = avcodec_alloc_frame ();
152         if (_frame == 0) {
153                 throw DecodeError (N_("could not allocate frame"));
154         }
155 }
156
157 void
158 FFmpegDecoder::setup_video ()
159 {
160         _video_codec_context = _format_context->streams[_video_stream]->codec;
161         _video_codec = avcodec_find_decoder (_video_codec_context->codec_id);
162
163         if (_video_codec == 0) {
164                 throw DecodeError (_("could not find video decoder"));
165         }
166
167         if (avcodec_open2 (_video_codec_context, _video_codec, 0) < 0) {
168                 throw DecodeError (N_("could not open video decoder"));
169         }
170 }
171
172 void
173 FFmpegDecoder::setup_audio ()
174 {
175         if (!_audio_stream) {
176                 return;
177         }
178
179         shared_ptr<FFmpegAudioStream> ffa = dynamic_pointer_cast<FFmpegAudioStream> (_audio_stream);
180         assert (ffa);
181         
182         _audio_codec_context = _format_context->streams[ffa->id()]->codec;
183         _audio_codec = avcodec_find_decoder (_audio_codec_context->codec_id);
184
185         if (_audio_codec == 0) {
186                 throw DecodeError (_("could not find audio decoder"));
187         }
188
189         if (avcodec_open2 (_audio_codec_context, _audio_codec, 0) < 0) {
190                 throw DecodeError (N_("could not open audio decoder"));
191         }
192 }
193
194 void
195 FFmpegDecoder::setup_subtitle ()
196 {
197         if (!_subtitle_stream || _subtitle_stream->id() >= int (_format_context->nb_streams)) {
198                 return;
199         }
200
201         _subtitle_codec_context = _format_context->streams[_subtitle_stream->id()]->codec;
202         _subtitle_codec = avcodec_find_decoder (_subtitle_codec_context->codec_id);
203
204         if (_subtitle_codec == 0) {
205                 throw DecodeError (_("could not find subtitle decoder"));
206         }
207         
208         if (avcodec_open2 (_subtitle_codec_context, _subtitle_codec, 0) < 0) {
209                 throw DecodeError (N_("could not open subtitle decoder"));
210         }
211 }
212
213
214 bool
215 FFmpegDecoder::pass ()
216 {
217         int r = av_read_frame (_format_context, &_packet);
218         
219         if (r < 0) {
220                 if (r != AVERROR_EOF) {
221                         /* Maybe we should fail here, but for now we'll just finish off instead */
222                         char buf[256];
223                         av_strerror (r, buf, sizeof(buf));
224                         _film->log()->log (String::compose (N_("error on av_read_frame (%1) (%2)"), buf, r));
225                 }
226
227                 /* Get any remaining frames */
228                 
229                 _packet.data = 0;
230                 _packet.size = 0;
231                 
232                 /* XXX: should we reset _packet.data and size after each *_decode_* call? */
233                 
234                 int frame_finished;
235                 
236                 if (_opt.decode_video) {
237                         while (avcodec_decode_video2 (_video_codec_context, _frame, &frame_finished, &_packet) >= 0 && frame_finished) {
238                                 filter_and_emit_video ();
239                         }
240                 }
241                 
242                 if (_audio_stream && _opt.decode_audio) {
243                         decode_audio_packet ();
244                 }
245                         
246                 return true;
247         }
248
249         avcodec_get_frame_defaults (_frame);
250
251         shared_ptr<FFmpegAudioStream> ffa = dynamic_pointer_cast<FFmpegAudioStream> (_audio_stream);
252
253         if (_packet.stream_index == _video_stream && _opt.decode_video) {
254
255                 int frame_finished;
256                 int const r = avcodec_decode_video2 (_video_codec_context, _frame, &frame_finished, &_packet);
257                 if (r >= 0 && frame_finished) {
258
259                         if (r != _packet.size) {
260                                 _film->log()->log (String::compose (N_("Used only %1 bytes of %2 in packet"), r, _packet.size));
261                         }
262
263                         filter_and_emit_video ();
264                 }
265
266         } else if (ffa && _packet.stream_index == ffa->id() && _opt.decode_audio) {
267                 decode_audio_packet ();
268         } else if (_subtitle_stream && _packet.stream_index == _subtitle_stream->id() && _opt.decode_subtitles) {
269
270                 int got_subtitle;
271                 AVSubtitle sub;
272                 if (avcodec_decode_subtitle2 (_subtitle_codec_context, &sub, &got_subtitle, &_packet) && got_subtitle) {
273                         /* Sometimes we get an empty AVSubtitle, which is used by some codecs to
274                            indicate that the previous subtitle should stop.
275                         */
276                         if (sub.num_rects > 0) {
277                                 shared_ptr<TimedSubtitle> ts;
278                                 try {
279                                         emit_subtitle (shared_ptr<TimedSubtitle> (new TimedSubtitle (sub)));
280                                 } catch (...) {
281                                         /* some problem with the subtitle; we probably didn't understand it */
282                                 }
283                         } else {
284                                 emit_subtitle (shared_ptr<TimedSubtitle> ());
285                         }
286                         avsubtitle_free (&sub);
287                 }
288         }
289         
290         av_free_packet (&_packet);
291         return false;
292 }
293
294 /** @param data pointer to array of pointers to buffers.
295  *  Only the first buffer will be used for non-planar data, otherwise there will be one per channel.
296  */
297 shared_ptr<AudioBuffers>
298 FFmpegDecoder::deinterleave_audio (uint8_t** data, int size)
299 {
300         assert (_film->audio_channels());
301         assert (bytes_per_audio_sample());
302
303         shared_ptr<FFmpegAudioStream> ffa = dynamic_pointer_cast<FFmpegAudioStream> (_audio_stream);
304         assert (ffa);
305         
306         /* Deinterleave and convert to float */
307
308         assert ((size % (bytes_per_audio_sample() * ffa->channels())) == 0);
309
310         int const total_samples = size / bytes_per_audio_sample();
311         int const frames = total_samples / _film->audio_channels();
312         shared_ptr<AudioBuffers> audio (new AudioBuffers (ffa->channels(), frames));
313
314         switch (audio_sample_format()) {
315         case AV_SAMPLE_FMT_S16:
316         {
317                 int16_t* p = reinterpret_cast<int16_t *> (data[0]);
318                 int sample = 0;
319                 int channel = 0;
320                 for (int i = 0; i < total_samples; ++i) {
321                         audio->data(channel)[sample] = float(*p++) / (1 << 15);
322
323                         ++channel;
324                         if (channel == _film->audio_channels()) {
325                                 channel = 0;
326                                 ++sample;
327                         }
328                 }
329         }
330         break;
331
332         case AV_SAMPLE_FMT_S16P:
333         {
334                 int16_t** p = reinterpret_cast<int16_t **> (data);
335                 for (int i = 0; i < _film->audio_channels(); ++i) {
336                         for (int j = 0; j < frames; ++j) {
337                                 audio->data(i)[j] = static_cast<float>(p[i][j]) / (1 << 15);
338                         }
339                 }
340         }
341         break;
342         
343         case AV_SAMPLE_FMT_S32:
344         {
345                 int32_t* p = reinterpret_cast<int32_t *> (data[0]);
346                 int sample = 0;
347                 int channel = 0;
348                 for (int i = 0; i < total_samples; ++i) {
349                         audio->data(channel)[sample] = static_cast<float>(*p++) / (1 << 31);
350
351                         ++channel;
352                         if (channel == _film->audio_channels()) {
353                                 channel = 0;
354                                 ++sample;
355                         }
356                 }
357         }
358         break;
359
360         case AV_SAMPLE_FMT_FLT:
361         {
362                 float* p = reinterpret_cast<float*> (data[0]);
363                 int sample = 0;
364                 int channel = 0;
365                 for (int i = 0; i < total_samples; ++i) {
366                         audio->data(channel)[sample] = *p++;
367
368                         ++channel;
369                         if (channel == _film->audio_channels()) {
370                                 channel = 0;
371                                 ++sample;
372                         }
373                 }
374         }
375         break;
376                 
377         case AV_SAMPLE_FMT_FLTP:
378         {
379                 float** p = reinterpret_cast<float**> (data);
380                 for (int i = 0; i < _film->audio_channels(); ++i) {
381                         memcpy (audio->data(i), p[i], frames * sizeof(float));
382                 }
383         }
384         break;
385
386         default:
387                 throw DecodeError (String::compose (_("Unrecognised audio sample format (%1)"), static_cast<int> (audio_sample_format())));
388         }
389
390         return audio;
391 }
392
393 float
394 FFmpegDecoder::frames_per_second () const
395 {
396         AVStream* s = _format_context->streams[_video_stream];
397
398         if (s->avg_frame_rate.num && s->avg_frame_rate.den) {
399                 return av_q2d (s->avg_frame_rate);
400         }
401
402         return av_q2d (s->r_frame_rate);
403 }
404
405 AVSampleFormat
406 FFmpegDecoder::audio_sample_format () const
407 {
408         if (_audio_codec_context == 0) {
409                 return (AVSampleFormat) 0;
410         }
411         
412         return _audio_codec_context->sample_fmt;
413 }
414
415 libdcp::Size
416 FFmpegDecoder::native_size () const
417 {
418         return libdcp::Size (_video_codec_context->width, _video_codec_context->height);
419 }
420
421 PixelFormat
422 FFmpegDecoder::pixel_format () const
423 {
424         return _video_codec_context->pix_fmt;
425 }
426
427 int
428 FFmpegDecoder::time_base_numerator () const
429 {
430         return _video_codec_context->time_base.num;
431 }
432
433 int
434 FFmpegDecoder::time_base_denominator () const
435 {
436         return _video_codec_context->time_base.den;
437 }
438
439 int
440 FFmpegDecoder::sample_aspect_ratio_numerator () const
441 {
442         return _video_codec_context->sample_aspect_ratio.num;
443 }
444
445 int
446 FFmpegDecoder::sample_aspect_ratio_denominator () const
447 {
448         return _video_codec_context->sample_aspect_ratio.den;
449 }
450
451 string
452 FFmpegDecoder::stream_name (AVStream* s) const
453 {
454         stringstream n;
455
456         if (s->metadata) {
457                 AVDictionaryEntry const * lang = av_dict_get (s->metadata, N_("language"), 0, 0);
458                 if (lang) {
459                         n << lang->value;
460                 }
461                 
462                 AVDictionaryEntry const * title = av_dict_get (s->metadata, N_("title"), 0, 0);
463                 if (title) {
464                         if (!n.str().empty()) {
465                                 n << N_(" ");
466                         }
467                         n << title->value;
468                 }
469         }
470
471         if (n.str().empty()) {
472                 n << N_("unknown");
473         }
474
475         return n.str ();
476 }
477
478 int
479 FFmpegDecoder::bytes_per_audio_sample () const
480 {
481         return av_get_bytes_per_sample (audio_sample_format ());
482 }
483
484 void
485 FFmpegDecoder::set_audio_stream (shared_ptr<AudioStream> s)
486 {
487         AudioDecoder::set_audio_stream (s);
488         setup_audio ();
489 }
490
491 void
492 FFmpegDecoder::set_subtitle_stream (shared_ptr<SubtitleStream> s)
493 {
494         VideoDecoder::set_subtitle_stream (s);
495         setup_subtitle ();
496         OutputChanged ();
497 }
498
499 void
500 FFmpegDecoder::filter_and_emit_video ()
501 {
502         int64_t const bet = av_frame_get_best_effort_timestamp (_frame);
503         if (bet == AV_NOPTS_VALUE) {
504                 _film->log()->log ("Dropping frame without PTS");
505                 return;
506         }
507         
508         shared_ptr<FilterGraph> graph;
509
510         {
511                 boost::mutex::scoped_lock lm (_filter_graphs_mutex);
512                 
513                 list<shared_ptr<FilterGraph> >::iterator i = _filter_graphs.begin();
514                 while (i != _filter_graphs.end() && !(*i)->can_process (libdcp::Size (_frame->width, _frame->height), (AVPixelFormat) _frame->format)) {
515                         ++i;
516                 }
517                 
518                 if (i == _filter_graphs.end ()) {
519                         graph = filter_graph_factory (_film, this, libdcp::Size (_frame->width, _frame->height), (AVPixelFormat) _frame->format);
520                         _filter_graphs.push_back (graph);
521                         _film->log()->log (String::compose (N_("New graph for %1x%2, pixel format %3"), _frame->width, _frame->height, _frame->format));
522                 } else {
523                         graph = *i;
524                 }
525         }
526
527         list<shared_ptr<Image> > images = graph->process (_frame);
528
529         for (list<shared_ptr<Image> >::iterator i = images.begin(); i != images.end(); ++i) {
530                 emit_video (*i, false, bet * av_q2d (_format_context->streams[_video_stream]->time_base));
531         }
532 }
533
534 bool
535 FFmpegDecoder::seek (double p)
536 {
537         return do_seek (p, false, false);
538 }
539
540 bool
541 FFmpegDecoder::seek_to_last ()
542 {
543         /* This AVSEEK_FLAG_BACKWARD in do_seek is a bit of a hack; without it, if we ask for a seek to the same place as last time
544            (used when we change decoder parameters and want to re-fetch the frame) we end up going forwards rather than
545            staying in the same place.
546         */
547         return do_seek (last_source_time(), true, false);
548 }
549
550 void
551 FFmpegDecoder::seek_back ()
552 {
553         do_seek (last_source_time() - 2.5 / frames_per_second (), true, true);
554 }
555
556 void
557 FFmpegDecoder::seek_forward ()
558 {
559         do_seek (last_source_time() - 0.5 / frames_per_second(), true, true);
560 }
561
562 bool
563 FFmpegDecoder::do_seek (double p, bool backwards, bool accurate)
564 {
565         int64_t const vt = p / av_q2d (_format_context->streams[_video_stream]->time_base);
566
567         int const r = av_seek_frame (_format_context, _video_stream, vt, backwards ? AVSEEK_FLAG_BACKWARD : 0);
568
569         avcodec_flush_buffers (_video_codec_context);
570         if (_subtitle_codec_context) {
571                 avcodec_flush_buffers (_subtitle_codec_context);
572         }
573
574         if (accurate) {
575                 while (1) {
576                         int r = av_read_frame (_format_context, &_packet);
577                         if (r < 0) {
578                                 return true;
579                         }
580                         
581                         avcodec_get_frame_defaults (_frame);
582                         
583                         if (_packet.stream_index == _video_stream) {
584                                 int finished = 0;
585                                 int const r = avcodec_decode_video2 (_video_codec_context, _frame, &finished, &_packet);
586                                 if (r >= 0 && finished) {
587                                         int64_t const bet = av_frame_get_best_effort_timestamp (_frame);
588                                         if (bet > vt) {
589                                                 break;
590                                         }
591                                 }
592                         }
593                         
594                         av_free_packet (&_packet);
595                 }
596         }
597                 
598         return r < 0;
599 }
600
601 shared_ptr<FFmpegAudioStream>
602 FFmpegAudioStream::create (string t, optional<int> v)
603 {
604         if (!v) {
605                 /* version < 1; no type in the string, and there's only FFmpeg streams anyway */
606                 return shared_ptr<FFmpegAudioStream> (new FFmpegAudioStream (t, v));
607         }
608
609         stringstream s (t);
610         string type;
611         s >> type;
612         if (type != N_("ffmpeg")) {
613                 return shared_ptr<FFmpegAudioStream> ();
614         }
615
616         return shared_ptr<FFmpegAudioStream> (new FFmpegAudioStream (t, v));
617 }
618
619 FFmpegAudioStream::FFmpegAudioStream (string t, optional<int> version)
620 {
621         stringstream n (t);
622         
623         int name_index = 4;
624         if (!version) {
625                 name_index = 2;
626                 int channels;
627                 n >> _id >> channels;
628                 _channel_layout = av_get_default_channel_layout (channels);
629                 _sample_rate = 0;
630         } else {
631                 string type;
632                 /* Current (marked version 1) */
633                 n >> type >> _id >> _sample_rate >> _channel_layout;
634                 assert (type == N_("ffmpeg"));
635         }
636
637         for (int i = 0; i < name_index; ++i) {
638                 size_t const s = t.find (' ');
639                 if (s != string::npos) {
640                         t = t.substr (s + 1);
641                 }
642         }
643
644         _name = t;
645 }
646
647 string
648 FFmpegAudioStream::to_string () const
649 {
650         return String::compose (N_("ffmpeg %1 %2 %3 %4"), _id, _sample_rate, _channel_layout, _name);
651 }
652
653 void
654 FFmpegDecoder::film_changed (Film::Property p)
655 {
656         switch (p) {
657         case Film::CROP:
658         case Film::FILTERS:
659         {
660                 boost::mutex::scoped_lock lm (_filter_graphs_mutex);
661                 _filter_graphs.clear ();
662         }
663         OutputChanged ();
664         break;
665
666         default:
667                 break;
668         }
669 }
670
671 /** @return Length (in video frames) according to our content's header */
672 SourceFrame
673 FFmpegDecoder::length () const
674 {
675         return (double(_format_context->duration) / AV_TIME_BASE) * frames_per_second();
676 }
677
678 void
679 FFmpegDecoder::decode_audio_packet ()
680 {
681         shared_ptr<FFmpegAudioStream> ffa = dynamic_pointer_cast<FFmpegAudioStream> (_audio_stream);
682         assert (ffa);
683
684         /* Audio packets can contain multiple frames, so we may have to call avcodec_decode_audio4
685            several times.
686         */
687         
688         AVPacket copy_packet = _packet;
689
690         while (copy_packet.size > 0) {
691
692                 int frame_finished;
693                 int const decode_result = avcodec_decode_audio4 (_audio_codec_context, _frame, &frame_finished, &copy_packet);
694                 if (decode_result >= 0) {
695                         if (frame_finished) {
696                         
697                                 /* Where we are in the source, in seconds */
698                                 double const source_pts_seconds = av_q2d (_format_context->streams[copy_packet.stream_index]->time_base)
699                                         * av_frame_get_best_effort_timestamp(_frame);
700                                 
701                                 int const data_size = av_samples_get_buffer_size (
702                                         0, _audio_codec_context->channels, _frame->nb_samples, audio_sample_format (), 1
703                                         );
704                                 
705                                 assert (_audio_codec_context->channels == _film->audio_channels());
706                                 Audio (deinterleave_audio (_frame->data, data_size), source_pts_seconds);
707                         }
708                         
709                         copy_packet.data += decode_result;
710                         copy_packet.size -= decode_result;
711                 }
712         }
713 }