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