src/lib/dcp_encoder.cc

   1 /*
   2     Copyright (C) 2012-2020 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 /** @file  src/dcp_encoder.cc
  22  *  @brief A class which takes a Film and some Options, then uses those to encode the film into a DCP.
  23  *
  24  *  A decoder is selected according to the content type, and the encoder can be specified
  25  *  as a parameter to the constructor.
  26  */
  27
  28 #include "dcp_encoder.h"
  29 #include "j2k_encoder.h"
  30 #include "film.h"
  31 #include "video_decoder.h"
  32 #include "audio_decoder.h"
  33 #include "player.h"
  34 #include "job.h"
  35 #include "writer.h"
  36 #include "compose.hpp"
  37 #include "referenced_reel_asset.h"
  38 #include "text_content.h"
  39 #include "player_video.h"
  40 #include <boost/signals2.hpp>
  41 #include <boost/foreach.hpp>
  42 #include <iostream>
  43
  44 #include "i18n.h"
  45
  46 using std::string;
  47 using std::cout;
  48 using std::list;
  49 using std::vector;
  50 using boost::shared_ptr;
  51 using boost::weak_ptr;
  52 using boost::dynamic_pointer_cast;
  53 using boost::optional;
  54 #if BOOST_VERSION >= 106100
  55 using namespace boost::placeholders;
  56 #endif
  57 using namespace dcpomatic;
  58
  59 /** Construct a DCP encoder.
  60  *  @param film Film that we are encoding.
  61  *  @param job Job that this encoder is being used in.
  62  */
  63 DCPEncoder::DCPEncoder (shared_ptr<const Film> film, weak_ptr<Job> job)
  64         : Encoder (film, job)
  65         , _finishing (false)
  66         , _non_burnt_subtitles (false)
  67 {
  68         _player_video_connection = _player->Video.connect (bind (&DCPEncoder::video, this, _1, _2));
  69         _player_audio_connection = _player->Audio.connect (bind (&DCPEncoder::audio, this, _1, _2));
  70         _player_text_connection = _player->Text.connect (bind (&DCPEncoder::text, this, _1, _2, _3, _4));
  71         _player_atmos_connection = _player->Atmos.connect (bind (&DCPEncoder::atmos, this, _1, _2, _3));
  72
  73         BOOST_FOREACH (shared_ptr<const Content> c, film->content ()) {
  74                 BOOST_FOREACH (shared_ptr<TextContent> i, c->text) {
  75                         if (i->use() && !i->burn()) {
  76                                 _non_burnt_subtitles = true;
  77                         }
  78                 }
  79         }
  80 }
  81
  82 DCPEncoder::~DCPEncoder ()
  83 {
  84         /* We must stop receiving more video data before we die */
  85         _player_video_connection.release ();
  86         _player_audio_connection.release ();
  87         _player_text_connection.release ();
  88         _player_atmos_connection.release ();
  89 }
  90
  91 void
  92 DCPEncoder::go ()
  93 {
  94         _writer.reset (new Writer (_film, _job));
  95         _writer->start ();
  96
  97         _j2k_encoder.reset (new J2KEncoder (_film, _writer));
  98         _j2k_encoder->begin ();
  99
 100         {
 101                 shared_ptr<Job> job = _job.lock ();
 102                 DCPOMATIC_ASSERT (job);
 103                 job->sub (_("Encoding"));
 104         }
 105
 106         if (_non_burnt_subtitles) {
 107                 vector<FontData> fonts = _player->get_subtitle_fonts ();
 108
 109                 if (fonts.size() > 1 && _film->interop()) {
 110                         /* Interop will ignore second and subsequent <LoadFont>s so don't even
 111                            write them as they upset some validators.
 112                         */
 113                         FontData first = fonts.front ();
 114                         fonts.clear ();
 115                         fonts.push_back (first);
 116                 }
 117
 118                 _writer->write (fonts);
 119         }
 120
 121         while (!_player->pass ()) {}
 122
 123         BOOST_FOREACH (ReferencedReelAsset i, _player->get_reel_assets ()) {
 124                 _writer->write (i);
 125         }
 126
 127         _finishing = true;
 128         _j2k_encoder->end ();
 129         _writer->finish (_film->dir(_film->dcp_name()));
 130 }
 131
 132 void
 133 DCPEncoder::video (shared_ptr<PlayerVideo> data, DCPTime time)
 134 {
 135         if (!_film->three_d()) {
 136                 if (data->eyes() == EYES_LEFT) {
 137                         /* Use left-eye images for both eyes... */
 138                         data->set_eyes (EYES_BOTH);
 139                 } else if (data->eyes() == EYES_RIGHT) {
 140                         /* ...and discard the right */
 141                         return;
 142                 }
 143         }
 144
 145         _j2k_encoder->encode (data, time);
 146 }
 147
 148 void
 149 DCPEncoder::audio (shared_ptr<AudioBuffers> data, DCPTime time)
 150 {
 151         _writer->write (data, time);
 152
 153         shared_ptr<Job> job = _job.lock ();
 154         DCPOMATIC_ASSERT (job);
 155         job->set_progress (float(time.get()) / _film->length().get());
 156 }
 157
 158 void
 159 DCPEncoder::text (PlayerText data, TextType type, optional<DCPTextTrack> track, DCPTimePeriod period)
 160 {
 161         if (type == TEXT_CLOSED_CAPTION || _non_burnt_subtitles) {
 162                 _writer->write (data, type, track, period);
 163         }
 164 }
 165
 166
 167 void
 168 DCPEncoder::atmos (shared_ptr<const dcp::AtmosFrame> data, DCPTime time, AtmosMetadata metadata)
 169 {
 170         _writer->write (data, time, metadata);
 171 }
 172
 173
 174 optional<float>
 175 DCPEncoder::current_rate () const
 176 {
 177         if (!_j2k_encoder) {
 178                 return optional<float>();
 179         }
 180
 181         return _j2k_encoder->current_encoding_rate ();
 182 }
 183
 184 Frame
 185 DCPEncoder::frames_done () const
 186 {
 187         if (!_j2k_encoder) {
 188                 return 0;
 189         }
 190
 191         return _j2k_encoder->video_frames_enqueued ();
 192 }