2 Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
3 Taken from code Copyright (C) 2010-2011 Terrence Meiczinger
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 /** @file src/dcp_video_frame.cc
22 * @brief A single frame of video destined for a DCP.
24 * Given an Image and some settings, this class knows how to encode
25 * the image to J2K either on the local host or on a remote server.
27 * Objects of this class are used for the queue that we keep
28 * of images that require encoding.
41 #include <boost/array.hpp>
42 #include <boost/asio.hpp>
43 #include <boost/filesystem.hpp>
44 #include <boost/lexical_cast.hpp>
45 #include <dcp/gamma_lut.h>
46 #include <dcp/xyz_frame.h>
47 #include <dcp/rgb_xyz.h>
48 #include <dcp/colour_matrix.h>
49 #include <dcp/raw_convert.h>
50 #include <libcxml/cxml.h>
52 #include "dcp_video.h"
54 #include "exceptions.h"
61 #include "player_video.h"
62 #include "encoded_data.h"
64 #define LOG_GENERAL(...) _log->log (String::compose (__VA_ARGS__), Log::TYPE_GENERAL);
70 using boost::shared_ptr;
71 using boost::lexical_cast;
73 using dcp::raw_convert;
75 #define DCI_COEFFICENT (48.0 / 52.37)
77 /** Construct a DCP video frame.
78 * @param frame Input frame.
79 * @param index Index of the frame within the DCP.
80 * @param bw J2K bandwidth to use (see Config::j2k_bandwidth ())
81 * @param l Log to write to.
84 shared_ptr<const PlayerVideo> frame, int index, int dcp_fps, int bw, Resolution r, bool b, shared_ptr<Log> l
88 , _frames_per_second (dcp_fps)
97 DCPVideo::DCPVideo (shared_ptr<const PlayerVideo> frame, shared_ptr<const cxml::Node> node, shared_ptr<Log> log)
101 _index = node->number_child<int> ("Index");
102 _frames_per_second = node->number_child<int> ("FramesPerSecond");
103 _j2k_bandwidth = node->number_child<int> ("J2KBandwidth");
104 _resolution = Resolution (node->optional_number_child<int>("Resolution").get_value_or (RESOLUTION_2K));
105 _burn_subtitles = node->bool_child ("BurnSubtitles");
108 /** J2K-encode this frame on the local host.
109 * @return Encoded data.
111 shared_ptr<EncodedData>
112 DCPVideo::encode_locally ()
114 shared_ptr<dcp::GammaLUT> in_lut = dcp::GammaLUT::cache.get (
115 12, _frame->colour_conversion().input_gamma, _frame->colour_conversion().input_gamma_linearised
118 /* XXX: libdcp should probably use boost */
121 for (int i = 0; i < 3; ++i) {
122 for (int j = 0; j < 3; ++j) {
123 matrix[i][j] = _frame->colour_conversion().matrix (i, j);
127 shared_ptr<dcp::XYZFrame> xyz = dcp::rgb_to_xyz (
128 _frame->image (_burn_subtitles),
130 dcp::GammaLUT::cache.get (16, 1 / _frame->colour_conversion().output_gamma, false),
134 /* Set the max image and component sizes based on frame_rate */
135 int max_cs_len = ((float) _j2k_bandwidth) / 8 / _frames_per_second;
136 if (_frame->eyes() == EYES_LEFT || _frame->eyes() == EYES_RIGHT) {
137 /* In 3D we have only half the normal bandwidth per eye */
140 int const max_comp_size = max_cs_len / 1.25;
142 /* get a J2K compressor handle */
143 opj_cinfo_t* cinfo = opj_create_compress (CODEC_J2K);
145 throw EncodeError (N_("could not create JPEG2000 encoder"));
148 /* Set encoding parameters to default values */
149 opj_cparameters_t parameters;
150 opj_set_default_encoder_parameters (¶meters);
152 /* Set default cinema parameters */
153 parameters.tile_size_on = false;
154 parameters.cp_tdx = 1;
155 parameters.cp_tdy = 1;
158 parameters.tp_flag = 'C';
159 parameters.tp_on = 1;
161 /* Tile and Image shall be at (0,0) */
162 parameters.cp_tx0 = 0;
163 parameters.cp_ty0 = 0;
164 parameters.image_offset_x0 = 0;
165 parameters.image_offset_y0 = 0;
167 /* Codeblock size = 32x32 */
168 parameters.cblockw_init = 32;
169 parameters.cblockh_init = 32;
170 parameters.csty |= 0x01;
172 /* The progression order shall be CPRL */
173 parameters.prog_order = CPRL;
176 parameters.roi_compno = -1;
178 parameters.subsampling_dx = 1;
179 parameters.subsampling_dy = 1;
182 parameters.irreversible = 1;
184 parameters.tcp_rates[0] = 0;
185 parameters.tcp_numlayers++;
186 parameters.cp_disto_alloc = 1;
187 parameters.cp_rsiz = _resolution == RESOLUTION_2K ? CINEMA2K : CINEMA4K;
188 if (_resolution == RESOLUTION_4K) {
189 parameters.numpocs = 2;
190 parameters.POC[0].tile = 1;
191 parameters.POC[0].resno0 = 0;
192 parameters.POC[0].compno0 = 0;
193 parameters.POC[0].layno1 = 1;
194 parameters.POC[0].resno1 = parameters.numresolution - 1;
195 parameters.POC[0].compno1 = 3;
196 parameters.POC[0].prg1 = CPRL;
197 parameters.POC[1].tile = 1;
198 parameters.POC[1].resno0 = parameters.numresolution - 1;
199 parameters.POC[1].compno0 = 0;
200 parameters.POC[1].layno1 = 1;
201 parameters.POC[1].resno1 = parameters.numresolution;
202 parameters.POC[1].compno1 = 3;
203 parameters.POC[1].prg1 = CPRL;
206 parameters.cp_comment = strdup (N_("DCP-o-matic"));
207 parameters.cp_cinema = _resolution == RESOLUTION_2K ? CINEMA2K_24 : CINEMA4K_24;
209 /* 3 components, so use MCT */
210 parameters.tcp_mct = 1;
213 parameters.max_comp_size = max_comp_size;
214 parameters.tcp_rates[0] = ((float) (3 * xyz->size().width * xyz->size().height * 12)) / (max_cs_len * 8);
216 /* Set event manager to null (openjpeg 1.3 bug) */
217 cinfo->event_mgr = 0;
219 /* Setup the encoder parameters using the current image and user parameters */
220 opj_setup_encoder (cinfo, ¶meters, xyz->opj_image ());
222 opj_cio_t* cio = opj_cio_open ((opj_common_ptr) cinfo, 0, 0);
224 opj_destroy_compress (cinfo);
225 throw EncodeError (N_("could not open JPEG2000 stream"));
228 int const r = opj_encode (cinfo, cio, xyz->opj_image(), 0);
231 opj_destroy_compress (cinfo);
232 throw EncodeError (N_("JPEG2000 encoding failed"));
235 switch (_frame->eyes()) {
237 LOG_GENERAL (N_("Finished locally-encoded frame %1 for mono"), _index);
240 LOG_GENERAL (N_("Finished locally-encoded frame %1 for L"), _index);
243 LOG_GENERAL (N_("Finished locally-encoded frame %1 for R"), _index);
249 shared_ptr<EncodedData> enc (new LocallyEncodedData (cio->buffer, cio_tell (cio)));
252 free (parameters.cp_comment);
253 opj_destroy_compress (cinfo);
258 /** Send this frame to a remote server for J2K encoding, then read the result.
259 * @param serv Server to send to.
260 * @return Encoded data.
262 shared_ptr<EncodedData>
263 DCPVideo::encode_remotely (ServerDescription serv)
265 boost::asio::io_service io_service;
266 boost::asio::ip::tcp::resolver resolver (io_service);
267 boost::asio::ip::tcp::resolver::query query (serv.host_name(), raw_convert<string> (Config::instance()->server_port_base ()));
268 boost::asio::ip::tcp::resolver::iterator endpoint_iterator = resolver.resolve (query);
270 shared_ptr<Socket> socket (new Socket);
272 socket->connect (*endpoint_iterator);
274 /* Collect all XML metadata */
276 xmlpp::Element* root = doc.create_root_node ("EncodingRequest");
277 root->add_child("Version")->add_child_text (raw_convert<string> (SERVER_LINK_VERSION));
280 LOG_GENERAL (N_("Sending frame %1 to remote"), _index);
282 /* Send XML metadata */
283 string xml = doc.write_to_string ("UTF-8");
284 socket->write (xml.length() + 1);
285 socket->write ((uint8_t *) xml.c_str(), xml.length() + 1);
287 /* Send binary data */
288 _frame->send_binary (socket, _burn_subtitles);
290 /* Read the response (JPEG2000-encoded data); this blocks until the data
291 is ready and sent back.
293 shared_ptr<EncodedData> e (new RemotelyEncodedData (socket->read_uint32 ()));
294 socket->read (e->data(), e->size());
296 LOG_GENERAL (N_("Finished remotely-encoded frame %1"), _index);
302 DCPVideo::add_metadata (xmlpp::Element* el) const
304 el->add_child("Index")->add_child_text (raw_convert<string> (_index));
305 el->add_child("FramesPerSecond")->add_child_text (raw_convert<string> (_frames_per_second));
306 el->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
307 el->add_child("Resolution")->add_child_text (raw_convert<string> (int (_resolution)));
308 el->add_child("BurnSubtitles")->add_child_text (_burn_subtitles ? "1" : "0");
309 _frame->add_metadata (el, _burn_subtitles);
313 DCPVideo::eyes () const
315 return _frame->eyes ();