src/lib/ffmpeg_file_encoder.cc

   1 /*
   2     Copyright (C) 2017-2021 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21
  22 #include "compose.hpp"
  23 #include "cross.h"
  24 #include "ffmpeg_encoder.h"
  25 #include "ffmpeg_wrapper.h"
  26 #include "film.h"
  27 #include "image.h"
  28 #include "job.h"
  29 #include "log.h"
  30 #include "player.h"
  31 #include "player_video.h"
  32 extern "C" {
  33 #include <libavutil/channel_layout.h>
  34 }
  35 #include <iostream>
  36
  37 #include "i18n.h"
  38
  39
  40 using std::cout;
  41 using std::make_shared;
  42 using std::shared_ptr;
  43 using std::string;
  44 using boost::bind;
  45 using namespace dcpomatic;
  46 #if BOOST_VERSION >= 106100
  47 using namespace boost::placeholders;
  48 #endif
  49
  50
  51 int FFmpegFileEncoder::_video_stream_index = 0;
  52 int FFmpegFileEncoder::_audio_stream_index_base = 1;
  53
  54
  55 class ExportAudioStream
  56 {
  57 public:
  58         ExportAudioStream (string codec_name, int channels, int frame_rate, AVSampleFormat sample_format, AVFormatContext* format_context, int stream_index)
  59                 : _format_context (format_context)
  60                 , _stream_index (stream_index)
  61         {
  62                 _codec = avcodec_find_encoder_by_name (codec_name.c_str());
  63                 if (!_codec) {
  64                         throw EncodeError (String::compose("avcodec_find_encoder_by_name failed for %1", codec_name));
  65                 }
  66
  67                 _codec_context = avcodec_alloc_context3 (_codec);
  68                 if (!_codec_context) {
  69                         throw std::bad_alloc ();
  70                 }
  71
  72                 /* XXX: configurable */
  73                 _codec_context->bit_rate = channels * 128 * 1024;
  74                 _codec_context->sample_fmt = sample_format;
  75                 _codec_context->sample_rate = frame_rate;
  76                 _codec_context->channel_layout = av_get_default_channel_layout (channels);
  77                 _codec_context->channels = channels;
  78
  79                 int r = avcodec_open2 (_codec_context, _codec, 0);
  80                 if (r < 0) {
  81                         throw EncodeError (N_("avcodec_open2"), N_("ExportAudioStream::ExportAudioStream"), r);
  82                 }
  83
  84                 _stream = avformat_new_stream (format_context, _codec);
  85                 if (!_stream) {
  86                         throw EncodeError (N_("avformat_new_stream"), N_("ExportAudioStream::ExportAudioStream"));
  87                 }
  88
  89                 _stream->id = stream_index;
  90                 _stream->disposition |= AV_DISPOSITION_DEFAULT;
  91                 r = avcodec_parameters_from_context (_stream->codecpar, _codec_context);
  92                 if (r < 0) {
  93                         throw EncodeError (N_("avcodec_parameters_from_context"), N_("ExportAudioStream::ExportAudioStream"), r);
  94                 }
  95         }
  96
  97         ~ExportAudioStream ()
  98         {
  99                 avcodec_close (_codec_context);
 100         }
 101
 102         ExportAudioStream (ExportAudioStream const&) = delete;
 103         ExportAudioStream& operator= (ExportAudioStream const&) = delete;
 104
 105         int frame_size () const {
 106                 return _codec_context->frame_size;
 107         }
 108
 109         bool flush ()
 110         {
 111                 int r = avcodec_send_frame (_codec_context, nullptr);
 112                 if (r < 0 && r != AVERROR_EOF) {
 113                         /* We get EOF if we've already flushed the stream once */
 114                         throw EncodeError (N_("avcodec_send_frame"), N_("ExportAudioStream::flush"), r);
 115                 }
 116
 117                 ffmpeg::Packet packet;
 118                 r = avcodec_receive_packet (_codec_context, packet.get());
 119                 if (r == AVERROR_EOF) {
 120                         return true;
 121                 } else if (r < 0) {
 122                         throw EncodeError (N_("avcodec_receive_packet"), N_("ExportAudioStream::flush"), r);
 123                 }
 124
 125                 packet->stream_index = _stream_index;
 126                 av_interleaved_write_frame (_format_context, packet.get());
 127                 return false;
 128         }
 129
 130         void write (int size, int channel_offset, int channels, float* const* data, int64_t sample_offset)
 131         {
 132                 DCPOMATIC_ASSERT (size);
 133
 134                 auto frame = av_frame_alloc ();
 135                 DCPOMATIC_ASSERT (frame);
 136
 137                 int line_size;
 138                 int const buffer_size = av_samples_get_buffer_size (&line_size, channels, size, _codec_context->sample_fmt, 0);
 139                 DCPOMATIC_ASSERT (buffer_size >= 0);
 140
 141                 auto samples = av_malloc (buffer_size);
 142                 DCPOMATIC_ASSERT (samples);
 143
 144                 frame->nb_samples = size;
 145                 frame->format = _codec_context->sample_fmt;
 146                 frame->channels = channels;
 147                 int r = avcodec_fill_audio_frame (frame, channels, _codec_context->sample_fmt, (const uint8_t *) samples, buffer_size, 0);
 148                 DCPOMATIC_ASSERT (r >= 0);
 149
 150                 switch (_codec_context->sample_fmt) {
 151                 case AV_SAMPLE_FMT_S16:
 152                 {
 153                         int16_t* q = reinterpret_cast<int16_t*> (samples);
 154                         for (int i = 0; i < size; ++i) {
 155                                 for (int j = 0; j < channels; ++j) {
 156                                         *q++ = data[j + channel_offset][i] * 32767;
 157                                 }
 158                         }
 159                         break;
 160                 }
 161                 case AV_SAMPLE_FMT_S32:
 162                 {
 163                         int32_t* q = reinterpret_cast<int32_t*> (samples);
 164                         for (int i = 0; i < size; ++i) {
 165                                 for (int j = 0; j < channels; ++j) {
 166                                         *q++ = data[j + channel_offset][i] * 2147483647;
 167                                 }
 168                         }
 169                         break;
 170                 }
 171                 case AV_SAMPLE_FMT_FLTP:
 172                 {
 173                         for (int i = 0; i < channels; ++i) {
 174                                 memcpy (reinterpret_cast<float*>(static_cast<uint8_t*>(samples) + i * line_size), data[i + channel_offset], sizeof(float) * size);
 175                         }
 176                         break;
 177                 }
 178                 default:
 179                         DCPOMATIC_ASSERT (false);
 180                 }
 181
 182                 DCPOMATIC_ASSERT (_codec_context->time_base.num == 1);
 183                 frame->pts = sample_offset * _codec_context->time_base.den / _codec_context->sample_rate;
 184
 185                 r = avcodec_send_frame (_codec_context, frame);
 186                 av_free (samples);
 187                 av_frame_free (&frame);
 188                 if (r < 0) {
 189                         throw EncodeError (N_("avcodec_send_frame"), N_("ExportAudioStream::write"), r);
 190                 }
 191
 192                 ffmpeg::Packet packet;
 193                 r = avcodec_receive_packet (_codec_context, packet.get());
 194                 if (r < 0 && r != AVERROR(EAGAIN)) {
 195                         throw EncodeError (N_("avcodec_receive_packet"), N_("ExportAudioStream::write"), r);
 196                 } else if (r >= 0) {
 197                         packet->stream_index = _stream_index;
 198                         av_interleaved_write_frame (_format_context, packet.get());
 199                 }
 200         }
 201
 202 private:
 203         AVFormatContext* _format_context;
 204         AVCodec const * _codec;
 205         AVCodecContext* _codec_context;
 206         AVStream* _stream;
 207         int _stream_index;
 208 };
 209
 210
 211 FFmpegFileEncoder::FFmpegFileEncoder (
 212         dcp::Size video_frame_size,
 213         int video_frame_rate,
 214         int audio_frame_rate,
 215         int channels,
 216         ExportFormat format,
 217         bool audio_stream_per_channel,
 218         int x264_crf,
 219         boost::filesystem::path output
 220         )
 221         : _audio_stream_per_channel (audio_stream_per_channel)
 222         , _audio_channels (channels)
 223         , _output (output)
 224         , _video_frame_size (video_frame_size)
 225         , _video_frame_rate (video_frame_rate)
 226         , _audio_frame_rate (audio_frame_rate)
 227 {
 228         _pixel_format = pixel_format (format);
 229
 230         switch (format) {
 231         case ExportFormat::PRORES_4444:
 232                 _sample_format = AV_SAMPLE_FMT_S16;
 233                 _video_codec_name = "prores_ks";
 234                 _audio_codec_name = "pcm_s16le";
 235                 av_dict_set(&_video_options, "profile", "4", 0);
 236                 av_dict_set(&_video_options, "threads", "auto", 0);
 237                 break;
 238         case ExportFormat::PRORES_HQ:
 239                 _sample_format = AV_SAMPLE_FMT_S16;
 240                 _video_codec_name = "prores_ks";
 241                 _audio_codec_name = "pcm_s16le";
 242                 av_dict_set (&_video_options, "profile", "3", 0);
 243                 av_dict_set (&_video_options, "threads", "auto", 0);
 244                 break;
 245         case ExportFormat::H264_AAC:
 246                 _sample_format = AV_SAMPLE_FMT_FLTP;
 247                 _video_codec_name = "libx264";
 248                 _audio_codec_name = "aac";
 249                 av_dict_set_int (&_video_options, "crf", x264_crf, 0);
 250                 break;
 251         default:
 252                 DCPOMATIC_ASSERT (false);
 253         }
 254
 255         int r = avformat_alloc_output_context2 (&_format_context, 0, 0, _output.string().c_str());
 256         if (!_format_context) {
 257                 throw EncodeError (N_("avformat_alloc_output_context2"), "FFmpegFileEncoder::FFmpegFileEncoder", r);
 258         }
 259
 260         setup_video ();
 261         setup_audio ();
 262
 263         r = avio_open_boost (&_format_context->pb, _output, AVIO_FLAG_WRITE);
 264         if (r < 0) {
 265                 throw EncodeError (String::compose(_("Could not open output file %1 (%2)"), _output.string(), r));
 266         }
 267
 268         AVDictionary* options = nullptr;
 269
 270         r = avformat_write_header (_format_context, &options);
 271         if (r < 0) {
 272                 throw EncodeError (N_("avformat_write_header"), N_("FFmpegFileEncoder::FFmpegFileEncoder"), r);
 273         }
 274
 275         _pending_audio = make_shared<AudioBuffers>(channels, 0);
 276 }
 277
 278
 279 FFmpegFileEncoder::~FFmpegFileEncoder ()
 280 {
 281         _audio_streams.clear ();
 282         avcodec_close (_video_codec_context);
 283         avformat_free_context (_format_context);
 284 }
 285
 286
 287 AVPixelFormat
 288 FFmpegFileEncoder::pixel_format (ExportFormat format)
 289 {
 290         switch (format) {
 291         case ExportFormat::PRORES_4444:
 292                 return AV_PIX_FMT_YUV444P10;
 293         case ExportFormat::PRORES_HQ:
 294                 return AV_PIX_FMT_YUV422P10;
 295         case ExportFormat::H264_AAC:
 296                 return AV_PIX_FMT_YUV420P;
 297         default:
 298                 DCPOMATIC_ASSERT (false);
 299         }
 300
 301         return AV_PIX_FMT_YUV422P10;
 302 }
 303
 304
 305 void
 306 FFmpegFileEncoder::setup_video ()
 307 {
 308         _video_codec = avcodec_find_encoder_by_name (_video_codec_name.c_str());
 309         if (!_video_codec) {
 310                 throw EncodeError (String::compose("avcodec_find_encoder_by_name failed for %1", _video_codec_name));
 311         }
 312
 313         _video_codec_context = avcodec_alloc_context3 (_video_codec);
 314         if (!_video_codec_context) {
 315                 throw std::bad_alloc ();
 316         }
 317
 318         /* Variable quantisation */
 319         _video_codec_context->global_quality = 0;
 320         _video_codec_context->width = _video_frame_size.width;
 321         _video_codec_context->height = _video_frame_size.height;
 322         _video_codec_context->time_base = (AVRational) { 1, _video_frame_rate };
 323         _video_codec_context->pix_fmt = _pixel_format;
 324         _video_codec_context->flags |= AV_CODEC_FLAG_QSCALE | AV_CODEC_FLAG_GLOBAL_HEADER;
 325
 326         if (avcodec_open2 (_video_codec_context, _video_codec, &_video_options) < 0) {
 327                 throw EncodeError (N_("avcodec_open"), N_("FFmpegFileEncoder::setup_video"));
 328         }
 329
 330         _video_stream = avformat_new_stream (_format_context, _video_codec);
 331         if (!_video_stream) {
 332                 throw EncodeError (N_("avformat_new_stream"), N_("FFmpegFileEncoder::setup_video"));
 333         }
 334
 335         _video_stream->id = _video_stream_index;
 336         int r = avcodec_parameters_from_context (_video_stream->codecpar, _video_codec_context);
 337         if (r < 0) {
 338                 throw EncodeError (N_("avcodec_parameters_from_context"), N_("FFmpegFileEncoder::setup_video"), r);
 339         }
 340 }
 341
 342
 343 void
 344 FFmpegFileEncoder::setup_audio ()
 345 {
 346         int const streams = _audio_stream_per_channel ? _audio_channels : 1;
 347         int const channels_per_stream = _audio_stream_per_channel ? 1 : _audio_channels;
 348
 349         for (int i = 0; i < streams; ++i) {
 350                 _audio_streams.push_back(
 351                         make_shared<ExportAudioStream>(
 352                                 _audio_codec_name, channels_per_stream, _audio_frame_rate, _sample_format, _format_context, _audio_stream_index_base + i
 353                                 )
 354                         );
 355         }
 356 }
 357
 358
 359 void
 360 FFmpegFileEncoder::flush ()
 361 {
 362         if (_pending_audio->frames() > 0) {
 363                 audio_frame (_pending_audio->frames ());
 364         }
 365
 366         bool flushed_video = false;
 367         bool flushed_audio = false;
 368
 369         while (!flushed_video || !flushed_audio) {
 370                 int r = avcodec_send_frame (_video_codec_context, nullptr);
 371                 if (r < 0 && r != AVERROR_EOF) {
 372                         /* We get EOF if we've already flushed the stream once */
 373                         throw EncodeError (N_("avcodec_send_frame"), N_("FFmpegFileEncoder::flush"), r);
 374                 }
 375
 376                 ffmpeg::Packet packet;
 377                 r = avcodec_receive_packet (_video_codec_context, packet.get());
 378                 if (r == AVERROR_EOF) {
 379                         flushed_video = true;
 380                 } else if (r < 0) {
 381                         throw EncodeError (N_("avcodec_receive_packet"), N_("FFmpegFileEncoder::flush"), r);
 382                 } else {
 383                         packet->stream_index = _video_stream_index;
 384                         av_interleaved_write_frame (_format_context, packet.get());
 385                 }
 386
 387                 flushed_audio = true;
 388                 for (auto i: _audio_streams) {
 389                         if (!i->flush()) {
 390                                 flushed_audio = false;
 391                         }
 392                 }
 393         }
 394
 395         av_write_trailer (_format_context);
 396 }
 397
 398
 399 void
 400 FFmpegFileEncoder::video (shared_ptr<PlayerVideo> video, DCPTime time)
 401 {
 402         /* All our output formats are video range at the moment */
 403         auto image = video->image (
 404                 bind (&PlayerVideo::force, _pixel_format),
 405                 VideoRange::VIDEO,
 406                 false
 407                 );
 408
 409         auto frame = av_frame_alloc ();
 410         DCPOMATIC_ASSERT (frame);
 411
 412         {
 413                 boost::mutex::scoped_lock lm (_pending_images_mutex);
 414                 _pending_images[image->data()[0]] = image;
 415         }
 416
 417         for (int i = 0; i < 3; ++i) {
 418                 auto buffer = av_buffer_create(image->data()[i], image->stride()[i] * image->size().height, &buffer_free, this, 0);
 419                 frame->buf[i] = av_buffer_ref (buffer);
 420                 frame->data[i] = buffer->data;
 421                 frame->linesize[i] = image->stride()[i];
 422                 av_buffer_unref (&buffer);
 423         }
 424
 425         frame->width = image->size().width;
 426         frame->height = image->size().height;
 427         frame->format = _pixel_format;
 428         DCPOMATIC_ASSERT (_video_stream->time_base.num == 1);
 429         frame->pts = time.get() * _video_stream->time_base.den / DCPTime::HZ;
 430
 431         int r = avcodec_send_frame (_video_codec_context, frame);
 432         av_frame_free (&frame);
 433         if (r < 0) {
 434                 throw EncodeError (N_("avcodec_send_frame"), N_("FFmpegFileEncoder::video"), r);
 435         }
 436
 437         ffmpeg::Packet packet;
 438         r = avcodec_receive_packet (_video_codec_context, packet.get());
 439         if (r < 0 && r != AVERROR(EAGAIN)) {
 440                 throw EncodeError (N_("avcodec_receive_packet"), N_("FFmpegFileEncoder::video"), r);
 441         } else if (r >= 0) {
 442                 packet->stream_index = _video_stream_index;
 443                 av_interleaved_write_frame (_format_context, packet.get());
 444         }
 445 }
 446
 447
 448 /** Called when the player gives us some audio */
 449 void
 450 FFmpegFileEncoder::audio (shared_ptr<AudioBuffers> audio)
 451 {
 452         _pending_audio->append (audio);
 453
 454         DCPOMATIC_ASSERT (!_audio_streams.empty());
 455         int frame_size = _audio_streams[0]->frame_size();
 456         if (frame_size == 0) {
 457                 /* codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE */
 458                 frame_size = _audio_frame_rate / _video_frame_rate;
 459         }
 460
 461         while (_pending_audio->frames() >= frame_size) {
 462                 audio_frame (frame_size);
 463         }
 464 }
 465
 466
 467 void
 468 FFmpegFileEncoder::audio_frame (int size)
 469 {
 470         if (_audio_stream_per_channel) {
 471                 int offset = 0;
 472                 for (auto i: _audio_streams) {
 473                         i->write (size, offset, 1, _pending_audio->data(), _audio_frames);
 474                         ++offset;
 475                 }
 476         } else {
 477                 DCPOMATIC_ASSERT (!_audio_streams.empty());
 478                 DCPOMATIC_ASSERT (_pending_audio->channels());
 479                 _audio_streams[0]->write (size, 0, _pending_audio->channels(), _pending_audio->data(), _audio_frames);
 480         }
 481
 482         _pending_audio->trim_start (size);
 483         _audio_frames += size;
 484 }
 485
 486
 487 void
 488 FFmpegFileEncoder::subtitle (PlayerText, DCPTimePeriod)
 489 {
 490
 491 }
 492
 493
 494 void
 495 FFmpegFileEncoder::buffer_free (void* opaque, uint8_t* data)
 496 {
 497         reinterpret_cast<FFmpegFileEncoder*>(opaque)->buffer_free2(data);
 498 }
 499
 500
 501 void
 502 FFmpegFileEncoder::buffer_free2 (uint8_t* data)
 503 {
 504         boost::mutex::scoped_lock lm (_pending_images_mutex);
 505         if (_pending_images.find(data) != _pending_images.end()) {
 506                 _pending_images.erase (data);
 507         }
 508 }