src/lib/ffmpeg_file_encoder.cc

   1 /*
   2     Copyright (C) 2017-2018 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 #include "ffmpeg_encoder.h"
  22 #include "film.h"
  23 #include "job.h"
  24 #include "player.h"
  25 #include "player_video.h"
  26 #include "log.h"
  27 #include "image.h"
  28 #include "cross.h"
  29 #include "compose.hpp"
  30 #include <iostream>
  31
  32 #include "i18n.h"
  33
  34 using std::string;
  35 using std::runtime_error;
  36 using std::cout;
  37 using std::pair;
  38 using boost::shared_ptr;
  39 using boost::bind;
  40 using boost::weak_ptr;
  41 using boost::optional;
  42 using namespace dcpomatic;
  43
  44 int FFmpegFileEncoder::_video_stream_index = 0;
  45 int FFmpegFileEncoder::_audio_stream_index = 1;
  46
  47 FFmpegFileEncoder::FFmpegFileEncoder (
  48         dcp::Size video_frame_size,
  49         int video_frame_rate,
  50         int audio_frame_rate,
  51         int channels,
  52         ExportFormat format,
  53         int x264_crf,
  54         boost::filesystem::path output
  55 #ifdef DCPOMATIC_VARIANT_SWAROOP
  56         , optional<dcp::Key> key
  57         , optional<string> id
  58 #endif
  59         )
  60         : _video_options (0)
  61         , _audio_channels (channels)
  62         , _output (output)
  63         , _video_frame_size (video_frame_size)
  64         , _video_frame_rate (video_frame_rate)
  65         , _audio_frame_rate (audio_frame_rate)
  66         , _audio_frames (0)
  67 {
  68         _pixel_format = pixel_format (format);
  69
  70         switch (format) {
  71         case EXPORT_FORMAT_PRORES:
  72                 _sample_format = AV_SAMPLE_FMT_S16;
  73                 _video_codec_name = "prores_ks";
  74                 _audio_codec_name = "pcm_s16le";
  75                 av_dict_set (&_video_options, "profile", "3", 0);
  76                 av_dict_set (&_video_options, "threads", "auto", 0);
  77                 break;
  78         case EXPORT_FORMAT_H264_AAC:
  79                 _sample_format = AV_SAMPLE_FMT_FLTP;
  80                 _video_codec_name = "libx264";
  81                 _audio_codec_name = "aac";
  82                 av_dict_set_int (&_video_options, "crf", x264_crf, 0);
  83                 break;
  84         case EXPORT_FORMAT_H264_PCM:
  85                 _sample_format = AV_SAMPLE_FMT_S32;
  86                 _video_codec_name = "libx264";
  87                 _audio_codec_name = "pcm_s24le";
  88                 av_dict_set_int (&_video_options, "crf", x264_crf, 0);
  89                 break;
  90         default:
  91                 DCPOMATIC_ASSERT (false);
  92         }
  93
  94         setup_video ();
  95         setup_audio ();
  96
  97 #ifdef DCPOMATIC_VARIANT_SWAROOP
  98         int r = avformat_alloc_output_context2 (&_format_context, av_guess_format("mov", 0, 0), 0, 0);
  99 #else
 100         int r = avformat_alloc_output_context2 (&_format_context, 0, 0, _output.string().c_str());
 101 #endif
 102         if (!_format_context) {
 103                 throw runtime_error (String::compose("could not allocate FFmpeg format context (%1)", r));
 104         }
 105
 106         _video_stream = avformat_new_stream (_format_context, _video_codec);
 107         if (!_video_stream) {
 108                 throw runtime_error ("could not create FFmpeg output video stream");
 109         }
 110
 111         _audio_stream = avformat_new_stream (_format_context, _audio_codec);
 112         if (!_audio_stream) {
 113                 throw runtime_error ("could not create FFmpeg output audio stream");
 114         }
 115
 116         _video_stream->id = _video_stream_index;
 117         _video_stream->codec = _video_codec_context;
 118
 119         _audio_stream->id = _audio_stream_index;
 120         _audio_stream->codec = _audio_codec_context;
 121
 122         if (avcodec_open2 (_video_codec_context, _video_codec, &_video_options) < 0) {
 123                 throw runtime_error ("could not open FFmpeg video codec");
 124         }
 125
 126         r = avcodec_open2 (_audio_codec_context, _audio_codec, 0);
 127         if (r < 0) {
 128                 char buffer[256];
 129                 av_strerror (r, buffer, sizeof(buffer));
 130                 throw runtime_error (String::compose ("could not open FFmpeg audio codec (%1)", buffer));
 131         }
 132
 133         if (avio_open_boost (&_format_context->pb, _output, AVIO_FLAG_WRITE) < 0) {
 134                 throw runtime_error ("could not open FFmpeg output file");
 135         }
 136
 137         AVDictionary* options = 0;
 138
 139 #ifdef DCPOMATIC_VARIANT_SWAROOP
 140         if (key) {
 141                 av_dict_set (&options, "encryption_key", key->hex().c_str(), 0);
 142                 /* XXX: is this OK? */
 143                 av_dict_set (&options, "encryption_kid", "00000000000000000000000000000000", 0);
 144                 av_dict_set (&options, "encryption_scheme", "cenc-aes-ctr", 0);
 145         }
 146
 147         if (id) {
 148                 if (av_dict_set(&_format_context->metadata, SWAROOP_ID_TAG, id->c_str(), 0) < 0) {
 149                         throw runtime_error ("Could not write ID to output");
 150                 }
 151         }
 152 #endif
 153
 154         if (avformat_write_header (_format_context, &options) < 0) {
 155                 throw runtime_error ("could not write header to FFmpeg output file");
 156         }
 157
 158         _pending_audio.reset (new AudioBuffers(channels, 0));
 159 }
 160
 161 AVPixelFormat
 162 FFmpegFileEncoder::pixel_format (ExportFormat format)
 163 {
 164         switch (format) {
 165         case EXPORT_FORMAT_PRORES:
 166                 return AV_PIX_FMT_YUV422P10;
 167         case EXPORT_FORMAT_H264_AAC:
 168         case EXPORT_FORMAT_H264_PCM:
 169                 return AV_PIX_FMT_YUV420P;
 170         default:
 171                 DCPOMATIC_ASSERT (false);
 172         }
 173
 174         return AV_PIX_FMT_YUV422P10;
 175 }
 176
 177 void
 178 FFmpegFileEncoder::setup_video ()
 179 {
 180         _video_codec = avcodec_find_encoder_by_name (_video_codec_name.c_str());
 181         if (!_video_codec) {
 182                 throw runtime_error (String::compose ("could not find FFmpeg encoder %1", _video_codec_name));
 183         }
 184
 185         _video_codec_context = avcodec_alloc_context3 (_video_codec);
 186         if (!_video_codec_context) {
 187                 throw runtime_error ("could not allocate FFmpeg video context");
 188         }
 189
 190         avcodec_get_context_defaults3 (_video_codec_context, _video_codec);
 191
 192         /* Variable quantisation */
 193         _video_codec_context->global_quality = 0;
 194         _video_codec_context->width = _video_frame_size.width;
 195         _video_codec_context->height = _video_frame_size.height;
 196         _video_codec_context->time_base = (AVRational) { 1, _video_frame_rate };
 197         _video_codec_context->pix_fmt = _pixel_format;
 198         _video_codec_context->flags |= AV_CODEC_FLAG_QSCALE | AV_CODEC_FLAG_GLOBAL_HEADER;
 199 }
 200
 201 void
 202 FFmpegFileEncoder::setup_audio ()
 203 {
 204         _audio_codec = avcodec_find_encoder_by_name (_audio_codec_name.c_str());
 205         if (!_audio_codec) {
 206                 throw runtime_error (String::compose ("could not find FFmpeg encoder %1", _audio_codec_name));
 207         }
 208
 209         _audio_codec_context = avcodec_alloc_context3 (_audio_codec);
 210         if (!_audio_codec_context) {
 211                 throw runtime_error ("could not allocate FFmpeg audio context");
 212         }
 213
 214         avcodec_get_context_defaults3 (_audio_codec_context, _audio_codec);
 215
 216         /* XXX: configurable */
 217         _audio_codec_context->bit_rate = _audio_channels * 128 * 1024;
 218         _audio_codec_context->sample_fmt = _sample_format;
 219         _audio_codec_context->sample_rate = _audio_frame_rate;
 220         _audio_codec_context->channel_layout = av_get_default_channel_layout (_audio_channels);
 221         _audio_codec_context->channels = _audio_channels;
 222 }
 223
 224 void
 225 FFmpegFileEncoder::flush ()
 226 {
 227         if (_pending_audio->frames() > 0) {
 228                 audio_frame (_pending_audio->frames ());
 229         }
 230
 231         bool flushed_video = false;
 232         bool flushed_audio = false;
 233
 234         while (!flushed_video || !flushed_audio) {
 235                 AVPacket packet;
 236                 av_init_packet (&packet);
 237                 packet.data = 0;
 238                 packet.size = 0;
 239
 240                 int got_packet;
 241                 avcodec_encode_video2 (_video_codec_context, &packet, 0, &got_packet);
 242                 if (got_packet) {
 243                         packet.stream_index = 0;
 244                         av_interleaved_write_frame (_format_context, &packet);
 245                 } else {
 246                         flushed_video = true;
 247                 }
 248                 av_packet_unref (&packet);
 249
 250                 av_init_packet (&packet);
 251                 packet.data = 0;
 252                 packet.size = 0;
 253
 254                 avcodec_encode_audio2 (_audio_codec_context, &packet, 0, &got_packet);
 255                 if (got_packet) {
 256                         packet.stream_index = 0;
 257                         av_interleaved_write_frame (_format_context, &packet);
 258                 } else {
 259                         flushed_audio = true;
 260                 }
 261                 av_packet_unref (&packet);
 262         }
 263
 264         av_write_trailer (_format_context);
 265
 266         avcodec_close (_video_codec_context);
 267         avcodec_close (_audio_codec_context);
 268         avio_close (_format_context->pb);
 269         avformat_free_context (_format_context);
 270 }
 271
 272 void
 273 FFmpegFileEncoder::video (shared_ptr<PlayerVideo> video, DCPTime time)
 274 {
 275         shared_ptr<Image> image = video->image (
 276                 bind (&PlayerVideo::force, _1, _pixel_format),
 277                 true,
 278                 false
 279                 );
 280
 281         AVFrame* frame = av_frame_alloc ();
 282         DCPOMATIC_ASSERT (frame);
 283
 284         {
 285                 boost::mutex::scoped_lock lm (_pending_images_mutex);
 286                 _pending_images[image->data()[0]] = image;
 287         }
 288
 289         for (int i = 0; i < 3; ++i) {
 290                 AVBufferRef* buffer = av_buffer_create(image->data()[i], image->stride()[i] * image->size().height, &buffer_free, this, 0);
 291                 frame->buf[i] = av_buffer_ref (buffer);
 292                 frame->data[i] = buffer->data;
 293                 frame->linesize[i] = image->stride()[i];
 294                 av_buffer_unref (&buffer);
 295         }
 296
 297         frame->width = image->size().width;
 298         frame->height = image->size().height;
 299         frame->format = _pixel_format;
 300         DCPOMATIC_ASSERT (_video_stream->time_base.num == 1);
 301         frame->pts = time.get() * _video_stream->time_base.den / DCPTime::HZ;
 302
 303         AVPacket packet;
 304         av_init_packet (&packet);
 305         packet.data = 0;
 306         packet.size = 0;
 307
 308         int got_packet;
 309         if (avcodec_encode_video2 (_video_codec_context, &packet, frame, &got_packet) < 0) {
 310                 throw EncodeError ("FFmpeg video encode failed");
 311         }
 312
 313         if (got_packet && packet.size) {
 314                 packet.stream_index = _video_stream_index;
 315                 av_interleaved_write_frame (_format_context, &packet);
 316                 av_packet_unref (&packet);
 317         }
 318
 319         av_frame_free (&frame);
 320
 321 }
 322
 323 /** Called when the player gives us some audio */
 324 void
 325 FFmpegFileEncoder::audio (shared_ptr<AudioBuffers> audio)
 326 {
 327         _pending_audio->append (audio);
 328
 329         int frame_size = _audio_codec_context->frame_size;
 330         if (frame_size == 0) {
 331                 /* codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE */
 332                 frame_size = _audio_frame_rate / _video_frame_rate;
 333         }
 334
 335         while (_pending_audio->frames() >= frame_size) {
 336                 audio_frame (frame_size);
 337         }
 338 }
 339
 340 void
 341 FFmpegFileEncoder::audio_frame (int size)
 342 {
 343         DCPOMATIC_ASSERT (size);
 344
 345         AVFrame* frame = av_frame_alloc ();
 346         DCPOMATIC_ASSERT (frame);
 347
 348         int const channels = _pending_audio->channels();
 349         DCPOMATIC_ASSERT (channels);
 350
 351         int const buffer_size = av_samples_get_buffer_size (0, channels, size, _audio_codec_context->sample_fmt, 0);
 352         DCPOMATIC_ASSERT (buffer_size >= 0);
 353
 354         void* samples = av_malloc (buffer_size);
 355         DCPOMATIC_ASSERT (samples);
 356
 357         frame->nb_samples = size;
 358         int r = avcodec_fill_audio_frame (frame, channels, _audio_codec_context->sample_fmt, (const uint8_t *) samples, buffer_size, 0);
 359         DCPOMATIC_ASSERT (r >= 0);
 360
 361         float** p = _pending_audio->data ();
 362         switch (_audio_codec_context->sample_fmt) {
 363         case AV_SAMPLE_FMT_S16:
 364         {
 365                 int16_t* q = reinterpret_cast<int16_t*> (samples);
 366                 for (int i = 0; i < size; ++i) {
 367                         for (int j = 0; j < channels; ++j) {
 368                                 *q++ = p[j][i] * 32767;
 369                         }
 370                 }
 371                 break;
 372         }
 373         case AV_SAMPLE_FMT_S32:
 374         {
 375                 int32_t* q = reinterpret_cast<int32_t*> (samples);
 376                 for (int i = 0; i < size; ++i) {
 377                         for (int j = 0; j < channels; ++j) {
 378                                 *q++ = p[j][i] * 2147483647;
 379                         }
 380                 }
 381                 break;
 382         }
 383         case AV_SAMPLE_FMT_FLTP:
 384         {
 385                 float* q = reinterpret_cast<float*> (samples);
 386                 for (int i = 0; i < channels; ++i) {
 387                         memcpy (q, p[i], sizeof(float) * size);
 388                         q += size;
 389                 }
 390                 break;
 391         }
 392         default:
 393                 DCPOMATIC_ASSERT (false);
 394         }
 395
 396         frame->pts = _audio_frames / (av_q2d (_audio_stream->time_base) * _audio_frame_rate);
 397
 398         AVPacket packet;
 399         av_init_packet (&packet);
 400         packet.data = 0;
 401         packet.size = 0;
 402
 403         int got_packet;
 404         if (avcodec_encode_audio2 (_audio_codec_context, &packet, frame, &got_packet) < 0) {
 405                 throw EncodeError ("FFmpeg audio encode failed");
 406         }
 407
 408         if (got_packet && packet.size) {
 409                 packet.stream_index = _audio_stream_index;
 410                 av_interleaved_write_frame (_format_context, &packet);
 411                 av_packet_unref (&packet);
 412         }
 413
 414         av_free (samples);
 415         av_frame_free (&frame);
 416
 417         _pending_audio->trim_start (size);
 418         _audio_frames += size;
 419 }
 420
 421 void
 422 FFmpegFileEncoder::subtitle (PlayerText, DCPTimePeriod)
 423 {
 424
 425 }
 426
 427 void
 428 FFmpegFileEncoder::buffer_free (void* opaque, uint8_t* data)
 429 {
 430         reinterpret_cast<FFmpegFileEncoder*>(opaque)->buffer_free2(data);
 431 }
 432
 433 void
 434 FFmpegFileEncoder::buffer_free2 (uint8_t* data)
 435 {
 436         boost::mutex::scoped_lock lm (_pending_images_mutex);
 437         if (_pending_images.find(data) != _pending_images.end()) {
 438                 _pending_images.erase (data);
 439         }
 440 }