src/lib/ffmpeg_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
  22 #include "butler.h"
  23 #include "cross.h"
  24 #include "ffmpeg_encoder.h"
  25 #include "film.h"
  26 #include "image.h"
  27 #include "job.h"
  28 #include "log.h"
  29 #include "player.h"
  30 #include "player_video.h"
  31 #include "compose.hpp"
  32 #include <iostream>
  33
  34 #include "i18n.h"
  35
  36
  37 using std::cout;
  38 using std::list;
  39 using std::make_shared;
  40 using std::shared_ptr;
  41 using std::string;
  42 using std::weak_ptr;
  43 using boost::bind;
  44 using boost::optional;
  45 using namespace dcpomatic;
  46 #if BOOST_VERSION >= 106100
  47 using namespace boost::placeholders;
  48 #endif
  49
  50
  51 /** @param key Key to use to encrypt MP4 outputs */
  52 FFmpegEncoder::FFmpegEncoder (
  53         shared_ptr<const Film> film,
  54         weak_ptr<Job> job,
  55         boost::filesystem::path output,
  56         ExportFormat format,
  57         bool mixdown_to_stereo,
  58         bool split_reels,
  59         bool audio_stream_per_channel,
  60         int x264_crf
  61         )
  62         : Encoder (film, job)
  63         , _history (200)
  64         , _output (output)
  65         , _format (format)
  66         , _split_reels (split_reels)
  67         , _audio_stream_per_channel (audio_stream_per_channel)
  68         , _x264_crf (x264_crf)
  69 {
  70         _player->set_always_burn_open_subtitles ();
  71         _player->set_play_referenced ();
  72
  73         int const ch = film->audio_channels ();
  74
  75         AudioMapping map;
  76         if (mixdown_to_stereo) {
  77                 _output_audio_channels = 2;
  78                 map = AudioMapping (ch, 2);
  79                 float const overall_gain = 2 / (4 + sqrt(2));
  80                 float const minus_3dB = 1 / sqrt(2);
  81                 if (ch == 2) {
  82                         map.set (dcp::Channel::LEFT, 0, 1);
  83                         map.set (dcp::Channel::RIGHT, 1, 1);
  84                 } else if (ch == 4) {
  85                         map.set (dcp::Channel::LEFT,   0, overall_gain);
  86                         map.set (dcp::Channel::RIGHT,  1, overall_gain);
  87                         map.set (dcp::Channel::CENTRE, 0, overall_gain * minus_3dB);
  88                         map.set (dcp::Channel::CENTRE, 1, overall_gain * minus_3dB);
  89                         map.set (dcp::Channel::LS,     0, overall_gain);
  90                 } else if (ch >= 6) {
  91                         map.set (dcp::Channel::LEFT,   0, overall_gain);
  92                         map.set (dcp::Channel::RIGHT,  1, overall_gain);
  93                         map.set (dcp::Channel::CENTRE, 0, overall_gain * minus_3dB);
  94                         map.set (dcp::Channel::CENTRE, 1, overall_gain * minus_3dB);
  95                         map.set (dcp::Channel::LS,     0, overall_gain);
  96                         map.set (dcp::Channel::RS,     1, overall_gain);
  97                 }
  98                 /* XXX: maybe we should do something better for >6 channel DCPs */
  99         } else {
 100                 /* Our encoders don't really want to encode any channel count between 9 and 15 inclusive,
 101                  * so let's just use 16 channel exports for any project with more than 8 channels.
 102                  */
 103                 _output_audio_channels = ch > 8 ? 16 : ch;
 104                 map = AudioMapping (ch, _output_audio_channels);
 105                 for (int i = 0; i < ch; ++i) {
 106                         map.set (i, i, 1);
 107                 }
 108         }
 109
 110         _butler = std::make_shared<Butler>(
 111                 _film, _player, map, _output_audio_channels, bind(&PlayerVideo::force, _1, FFmpegFileEncoder::pixel_format(format)), VideoRange::VIDEO, Image::Alignment::PADDED, false, false
 112                 );
 113 }
 114
 115
 116 void
 117 FFmpegEncoder::go ()
 118 {
 119         {
 120                 auto job = _job.lock ();
 121                 DCPOMATIC_ASSERT (job);
 122                 job->sub (_("Encoding"));
 123         }
 124
 125         Waker waker;
 126
 127         list<FileEncoderSet> file_encoders;
 128
 129         int const files = _split_reels ? _film->reels().size() : 1;
 130         for (int i = 0; i < files; ++i) {
 131
 132                 boost::filesystem::path filename = _output;
 133                 string extension = boost::filesystem::extension (filename);
 134                 filename = boost::filesystem::change_extension (filename, "");
 135
 136                 if (files > 1) {
 137                         /// TRANSLATORS: _reel%1 here is to be added to an export filename to indicate
 138                         /// which reel it is.  Preserve the %1; it will be replaced with the reel number.
 139                         filename = filename.string() + String::compose(_("_reel%1"), i + 1);
 140                 }
 141
 142                 file_encoders.push_back (
 143                         FileEncoderSet (
 144                                 _film->frame_size(),
 145                                 _film->video_frame_rate(),
 146                                 _film->audio_frame_rate(),
 147                                 _output_audio_channels,
 148                                 _format,
 149                                 _audio_stream_per_channel,
 150                                 _x264_crf,
 151                                 _film->three_d(),
 152                                 filename,
 153                                 extension
 154                                 )
 155                         );
 156         }
 157
 158         auto reel_periods = _film->reels ();
 159         auto reel = reel_periods.begin ();
 160         auto encoder = file_encoders.begin ();
 161
 162         auto const video_frame = DCPTime::from_frames (1, _film->video_frame_rate ());
 163         int const audio_frames = video_frame.frames_round(_film->audio_frame_rate());
 164         float* interleaved = new float[_output_audio_channels * audio_frames];
 165         auto deinterleaved = make_shared<AudioBuffers>(_output_audio_channels, audio_frames);
 166         int const gets_per_frame = _film->three_d() ? 2 : 1;
 167         for (DCPTime i; i < _film->length(); i += video_frame) {
 168
 169                 if (file_encoders.size() > 1 && !reel->contains(i)) {
 170                         /* Next reel and file */
 171                         ++reel;
 172                         ++encoder;
 173                         DCPOMATIC_ASSERT (reel != reel_periods.end());
 174                         DCPOMATIC_ASSERT (encoder != file_encoders.end());
 175                 }
 176
 177                 for (int j = 0; j < gets_per_frame; ++j) {
 178                         Butler::Error e;
 179                         auto v = _butler->get_video (Butler::Behaviour::BLOCKING, &e);
 180                         _butler->rethrow ();
 181                         if (v.first) {
 182                                 auto fe = encoder->get (v.first->eyes());
 183                                 if (fe) {
 184                                         fe->video(v.first, v.second - reel->from);
 185                                 }
 186                         } else {
 187                                 if (e.code != Butler::Error::Code::FINISHED) {
 188                                         throw DecodeError(String::compose("Error during decoding: %1", e.summary()));
 189                                 }
 190                         }
 191                 }
 192
 193                 _history.event ();
 194
 195                 {
 196                         boost::mutex::scoped_lock lm (_mutex);
 197                         _last_time = i;
 198                 }
 199
 200                 auto job = _job.lock ();
 201                 if (job) {
 202                         job->set_progress (float(i.get()) / _film->length().get());
 203                 }
 204
 205                 waker.nudge ();
 206
 207                 _butler->get_audio (Butler::Behaviour::BLOCKING, interleaved, audio_frames);
 208                 /* XXX: inefficient; butler interleaves and we deinterleave again */
 209                 float* p = interleaved;
 210                 for (int j = 0; j < audio_frames; ++j) {
 211                         for (int k = 0; k < _output_audio_channels; ++k) {
 212                                 deinterleaved->data(k)[j] = *p++;
 213                         }
 214                 }
 215                 encoder->audio (deinterleaved);
 216         }
 217         delete[] interleaved;
 218
 219         for (auto i: file_encoders) {
 220                 i.flush ();
 221         }
 222 }
 223
 224 optional<float>
 225 FFmpegEncoder::current_rate () const
 226 {
 227         return _history.rate ();
 228 }
 229
 230 Frame
 231 FFmpegEncoder::frames_done () const
 232 {
 233         boost::mutex::scoped_lock lm (_mutex);
 234         return _last_time.frames_round (_film->video_frame_rate ());
 235 }
 236
 237 FFmpegEncoder::FileEncoderSet::FileEncoderSet (
 238         dcp::Size video_frame_size,
 239         int video_frame_rate,
 240         int audio_frame_rate,
 241         int channels,
 242         ExportFormat format,
 243         bool audio_stream_per_channel,
 244         int x264_crf,
 245         bool three_d,
 246         boost::filesystem::path output,
 247         string extension
 248         )
 249 {
 250         if (three_d) {
 251                 /// TRANSLATORS: L here is an abbreviation for "left", to indicate the left-eye part of a 3D export
 252                 _encoders[Eyes::LEFT] = make_shared<FFmpegFileEncoder>(
 253                         video_frame_size, video_frame_rate, audio_frame_rate, channels, format,
 254                         audio_stream_per_channel, x264_crf, String::compose("%1_%2%3", output.string(), _("L"), extension)
 255                         );
 256                 /// TRANSLATORS: R here is an abbreviation for "right", to indicate the right-eye part of a 3D export
 257                 _encoders[Eyes::RIGHT] = make_shared<FFmpegFileEncoder>(
 258                         video_frame_size, video_frame_rate, audio_frame_rate, channels, format,
 259                         audio_stream_per_channel, x264_crf, String::compose("%1_%2%3", output.string(), _("R"), extension)
 260                         );
 261         } else {
 262                 _encoders[Eyes::BOTH] = make_shared<FFmpegFileEncoder>(
 263                         video_frame_size, video_frame_rate, audio_frame_rate, channels, format,
 264                         audio_stream_per_channel, x264_crf, String::compose("%1%2", output.string(), extension)
 265                         );
 266         }
 267 }
 268
 269 shared_ptr<FFmpegFileEncoder>
 270 FFmpegEncoder::FileEncoderSet::get (Eyes eyes) const
 271 {
 272         if (_encoders.size() == 1) {
 273                 /* We are doing a 2D export... */
 274                 if (eyes == Eyes::LEFT) {
 275                         /* ...but we got some 3D data; put the left eye into the output... */
 276                         eyes = Eyes::BOTH;
 277                 } else if (eyes == Eyes::RIGHT) {
 278                         /* ...and ignore the right eye.*/
 279                         return {};
 280                 }
 281         }
 282
 283         auto i = _encoders.find (eyes);
 284         DCPOMATIC_ASSERT (i != _encoders.end());
 285         return i->second;
 286 }
 287
 288 void
 289 FFmpegEncoder::FileEncoderSet::flush ()
 290 {
 291         for (auto& i: _encoders) {
 292                 i.second->flush ();
 293         }
 294 }
 295
 296 void
 297 FFmpegEncoder::FileEncoderSet::audio (shared_ptr<AudioBuffers> a)
 298 {
 299         for (auto& i: _encoders) {
 300                 i.second->audio (a);
 301         }
 302 }