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