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