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