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