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