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