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.
32 #include "dcp_video.h"
34 #include "exceptions.h"
41 #include "player_video.h"
42 #include "encoded_data.h"
43 #include <libcxml/cxml.h>
44 #include <dcp/gamma_lut.h>
45 #include <dcp/xyz_frame.h>
46 #include <dcp/rgb_xyz.h>
47 #include <dcp/colour_matrix.h>
48 #include <dcp/raw_convert.h>
49 #include <boost/array.hpp>
50 #include <boost/asio.hpp>
51 #include <boost/filesystem.hpp>
52 #include <boost/lexical_cast.hpp>
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::XYZFrame> xyz;
116 if (_frame->colour_conversion()) {
117 ColourConversion conversion = _frame->colour_conversion().get ();
118 shared_ptr<dcp::GammaLUT> in_lut = dcp::GammaLUT::cache.get (
119 12, conversion.input_gamma, conversion.input_gamma_linearised
122 /* XXX: dcp should probably use boost */
125 for (int i = 0; i < 3; ++i) {
126 for (int j = 0; j < 3; ++j) {
127 matrix[i][j] = conversion.matrix (i, j);
131 xyz = dcp::rgb_to_xyz (
132 _frame->image (AV_PIX_FMT_RGB48LE, _burn_subtitles),
134 dcp::GammaLUT::cache.get (16, 1 / conversion.output_gamma, false),
138 xyz = dcp::xyz_to_xyz (_frame->image (AV_PIX_FMT_RGB48LE, _burn_subtitles));
141 /* Set the max image and component sizes based on frame_rate */
142 int max_cs_len = ((float) _j2k_bandwidth) / 8 / _frames_per_second;
143 if (_frame->eyes() == EYES_LEFT || _frame->eyes() == EYES_RIGHT) {
144 /* In 3D we have only half the normal bandwidth per eye */
147 int const max_comp_size = max_cs_len / 1.25;
149 /* get a J2K compressor handle */
150 opj_cinfo_t* cinfo = opj_create_compress (CODEC_J2K);
152 throw EncodeError (N_("could not create JPEG2000 encoder"));
155 /* Set encoding parameters to default values */
156 opj_cparameters_t parameters;
157 opj_set_default_encoder_parameters (¶meters);
159 /* Set default cinema parameters */
160 parameters.tile_size_on = false;
161 parameters.cp_tdx = 1;
162 parameters.cp_tdy = 1;
165 parameters.tp_flag = 'C';
166 parameters.tp_on = 1;
168 /* Tile and Image shall be at (0,0) */
169 parameters.cp_tx0 = 0;
170 parameters.cp_ty0 = 0;
171 parameters.image_offset_x0 = 0;
172 parameters.image_offset_y0 = 0;
174 /* Codeblock size = 32x32 */
175 parameters.cblockw_init = 32;
176 parameters.cblockh_init = 32;
177 parameters.csty |= 0x01;
179 /* The progression order shall be CPRL */
180 parameters.prog_order = CPRL;
183 parameters.roi_compno = -1;
185 parameters.subsampling_dx = 1;
186 parameters.subsampling_dy = 1;
189 parameters.irreversible = 1;
191 parameters.tcp_rates[0] = 0;
192 parameters.tcp_numlayers++;
193 parameters.cp_disto_alloc = 1;
194 parameters.cp_rsiz = _resolution == RESOLUTION_2K ? CINEMA2K : CINEMA4K;
195 if (_resolution == RESOLUTION_4K) {
196 parameters.numpocs = 2;
197 parameters.POC[0].tile = 1;
198 parameters.POC[0].resno0 = 0;
199 parameters.POC[0].compno0 = 0;
200 parameters.POC[0].layno1 = 1;
201 parameters.POC[0].resno1 = parameters.numresolution - 1;
202 parameters.POC[0].compno1 = 3;
203 parameters.POC[0].prg1 = CPRL;
204 parameters.POC[1].tile = 1;
205 parameters.POC[1].resno0 = parameters.numresolution - 1;
206 parameters.POC[1].compno0 = 0;
207 parameters.POC[1].layno1 = 1;
208 parameters.POC[1].resno1 = parameters.numresolution;
209 parameters.POC[1].compno1 = 3;
210 parameters.POC[1].prg1 = CPRL;
213 parameters.cp_comment = strdup (N_("DCP-o-matic"));
214 parameters.cp_cinema = _resolution == RESOLUTION_2K ? CINEMA2K_24 : CINEMA4K_24;
216 /* 3 components, so use MCT */
217 parameters.tcp_mct = 1;
220 parameters.max_comp_size = max_comp_size;
221 parameters.tcp_rates[0] = ((float) (3 * xyz->size().width * xyz->size().height * 12)) / (max_cs_len * 8);
223 /* Set event manager to null (openjpeg 1.3 bug) */
224 cinfo->event_mgr = 0;
226 /* Setup the encoder parameters using the current image and user parameters */
227 opj_setup_encoder (cinfo, ¶meters, xyz->opj_image ());
229 opj_cio_t* cio = opj_cio_open ((opj_common_ptr) cinfo, 0, 0);
231 opj_destroy_compress (cinfo);
232 throw EncodeError (N_("could not open JPEG2000 stream"));
235 int const r = opj_encode (cinfo, cio, xyz->opj_image(), 0);
238 opj_destroy_compress (cinfo);
239 throw EncodeError (N_("JPEG2000 encoding failed"));
242 switch (_frame->eyes()) {
244 LOG_GENERAL (N_("Finished locally-encoded frame %1 for mono"), _index);
247 LOG_GENERAL (N_("Finished locally-encoded frame %1 for L"), _index);
250 LOG_GENERAL (N_("Finished locally-encoded frame %1 for R"), _index);
256 shared_ptr<EncodedData> enc (new LocallyEncodedData (cio->buffer, cio_tell (cio)));
259 free (parameters.cp_comment);
260 opj_destroy_compress (cinfo);
265 /** Send this frame to a remote server for J2K encoding, then read the result.
266 * @param serv Server to send to.
267 * @return Encoded data.
269 shared_ptr<EncodedData>
270 DCPVideo::encode_remotely (ServerDescription serv)
272 boost::asio::io_service io_service;
273 boost::asio::ip::tcp::resolver resolver (io_service);
274 boost::asio::ip::tcp::resolver::query query (serv.host_name(), raw_convert<string> (Config::instance()->server_port_base ()));
275 boost::asio::ip::tcp::resolver::iterator endpoint_iterator = resolver.resolve (query);
277 shared_ptr<Socket> socket (new Socket);
279 socket->connect (*endpoint_iterator);
281 /* Collect all XML metadata */
283 xmlpp::Element* root = doc.create_root_node ("EncodingRequest");
284 root->add_child("Version")->add_child_text (raw_convert<string> (SERVER_LINK_VERSION));
287 LOG_GENERAL (N_("Sending frame %1 to remote"), _index);
289 /* Send XML metadata */
290 string xml = doc.write_to_string ("UTF-8");
291 socket->write (xml.length() + 1);
292 socket->write ((uint8_t *) xml.c_str(), xml.length() + 1);
294 /* Send binary data */
295 _frame->send_binary (socket, _burn_subtitles);
297 /* Read the response (JPEG2000-encoded data); this blocks until the data
298 is ready and sent back.
300 shared_ptr<EncodedData> e (new RemotelyEncodedData (socket->read_uint32 ()));
301 socket->read (e->data(), e->size());
303 LOG_GENERAL (N_("Finished remotely-encoded frame %1"), _index);
309 DCPVideo::add_metadata (xmlpp::Element* el) const
311 el->add_child("Index")->add_child_text (raw_convert<string> (_index));
312 el->add_child("FramesPerSecond")->add_child_text (raw_convert<string> (_frames_per_second));
313 el->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
314 el->add_child("Resolution")->add_child_text (raw_convert<string> (int (_resolution)));
315 el->add_child("BurnSubtitles")->add_child_text (_burn_subtitles ? "1" : "0");
316 _frame->add_metadata (el, _burn_subtitles);
320 DCPVideo::eyes () const
322 return _frame->eyes ();
325 /** @return true if this DCPVideo is definitely the same as another;
326 * (apart from the frame index), false if it is probably not.
329 DCPVideo::same (shared_ptr<const DCPVideo> other) const
331 if (_frames_per_second != other->_frames_per_second ||
332 _j2k_bandwidth != other->_j2k_bandwidth ||
333 _resolution != other->_resolution ||
334 _burn_subtitles != other->_burn_subtitles) {
338 return _frame->same (other->_frame);