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.
42 #include <boost/array.hpp>
43 #include <boost/asio.hpp>
44 #include <boost/filesystem.hpp>
45 #include <boost/lexical_cast.hpp>
46 #include <openssl/md5.h>
47 #include <dcp/gamma_lut.h>
48 #include <dcp/xyz_frame.h>
49 #include <dcp/rgb_xyz.h>
50 #include <dcp/colour_matrix.h>
51 #include <dcp/raw_convert.h>
52 #include <libcxml/cxml.h>
54 #include "dcp_video_frame.h"
56 #include "exceptions.h"
63 #include "player_video_frame.h"
68 using std::stringstream;
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.
83 DCPVideoFrame::DCPVideoFrame (
84 shared_ptr<const PlayerVideoFrame> frame, int index, int dcp_fps, int bw, Resolution r, shared_ptr<Log> l
88 , _frames_per_second (dcp_fps)
96 DCPVideoFrame::DCPVideoFrame (shared_ptr<const PlayerVideoFrame> frame, shared_ptr<const cxml::Node> node, shared_ptr<Log> log)
100 _index = node->number_child<int> ("Index");
101 _frames_per_second = node->number_child<int> ("FramesPerSecond");
102 _j2k_bandwidth = node->number_child<int> ("J2KBandwidth");
103 _resolution = Resolution (node->optional_number_child<int>("Resolution").get_value_or (RESOLUTION_2K));
106 /** J2K-encode this frame on the local host.
107 * @return Encoded data.
109 shared_ptr<EncodedData>
110 DCPVideoFrame::encode_locally ()
112 shared_ptr<dcp::GammaLUT> in_lut = dcp::GammaLUT::cache.get (
113 12, _frame->colour_conversion().input_gamma, _frame->colour_conversion().input_gamma_linearised
116 /* XXX: libdcp should probably use boost */
119 for (int i = 0; i < 3; ++i) {
120 for (int j = 0; j < 3; ++j) {
121 matrix[i][j] = _frame->colour_conversion().matrix (i, j);
125 shared_ptr<dcp::XYZFrame> xyz = dcp::rgb_to_xyz (
128 dcp::GammaLUT::cache.get (16, 1 / _frame->colour_conversion().output_gamma, false),
134 MD5_Init (&md5_context);
135 MD5_Update (&md5_context, xyz->data(0), 1998 * 1080 * 4);
136 MD5_Update (&md5_context, xyz->data(1), 1998 * 1080 * 4);
137 MD5_Update (&md5_context, xyz->data(2), 1998 * 1080 * 4);
138 unsigned char digest[MD5_DIGEST_LENGTH];
139 MD5_Final (digest, &md5_context);
142 for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
143 s << std::hex << std::setfill('0') << std::setw(2) << ((int) digest[i]);
147 /* Set the max image and component sizes based on frame_rate */
148 int max_cs_len = ((float) _j2k_bandwidth) / 8 / _frames_per_second;
149 if (_frame->eyes() == EYES_LEFT || _frame->eyes() == EYES_RIGHT) {
150 /* In 3D we have only half the normal bandwidth per eye */
153 int const max_comp_size = max_cs_len / 1.25;
155 /* get a J2K compressor handle */
156 opj_cinfo_t* cinfo = opj_create_compress (CODEC_J2K);
158 throw EncodeError (N_("could not create JPEG2000 encoder"));
161 /* Set encoding parameters to default values */
162 opj_cparameters_t parameters;
163 opj_set_default_encoder_parameters (¶meters);
165 /* Set default cinema parameters */
166 parameters.tile_size_on = false;
167 parameters.cp_tdx = 1;
168 parameters.cp_tdy = 1;
171 parameters.tp_flag = 'C';
172 parameters.tp_on = 1;
174 /* Tile and Image shall be at (0,0) */
175 parameters.cp_tx0 = 0;
176 parameters.cp_ty0 = 0;
177 parameters.image_offset_x0 = 0;
178 parameters.image_offset_y0 = 0;
180 /* Codeblock size = 32x32 */
181 parameters.cblockw_init = 32;
182 parameters.cblockh_init = 32;
183 parameters.csty |= 0x01;
185 /* The progression order shall be CPRL */
186 parameters.prog_order = CPRL;
189 parameters.roi_compno = -1;
191 parameters.subsampling_dx = 1;
192 parameters.subsampling_dy = 1;
195 parameters.irreversible = 1;
197 parameters.tcp_rates[0] = 0;
198 parameters.tcp_numlayers++;
199 parameters.cp_disto_alloc = 1;
200 parameters.cp_rsiz = _resolution == RESOLUTION_2K ? CINEMA2K : CINEMA4K;
201 if (_resolution == RESOLUTION_4K) {
202 parameters.numpocs = 2;
203 parameters.POC[0].tile = 1;
204 parameters.POC[0].resno0 = 0;
205 parameters.POC[0].compno0 = 0;
206 parameters.POC[0].layno1 = 1;
207 parameters.POC[0].resno1 = parameters.numresolution - 1;
208 parameters.POC[0].compno1 = 3;
209 parameters.POC[0].prg1 = CPRL;
210 parameters.POC[1].tile = 1;
211 parameters.POC[1].resno0 = parameters.numresolution - 1;
212 parameters.POC[1].compno0 = 0;
213 parameters.POC[1].layno1 = 1;
214 parameters.POC[1].resno1 = parameters.numresolution;
215 parameters.POC[1].compno1 = 3;
216 parameters.POC[1].prg1 = CPRL;
219 parameters.cp_comment = strdup (N_("DCP-o-matic"));
220 parameters.cp_cinema = _resolution == RESOLUTION_2K ? CINEMA2K_24 : CINEMA4K_24;
222 /* 3 components, so use MCT */
223 parameters.tcp_mct = 1;
226 parameters.max_comp_size = max_comp_size;
227 parameters.tcp_rates[0] = ((float) (3 * xyz->size().width * xyz->size().height * 12)) / (max_cs_len * 8);
229 /* Set event manager to null (openjpeg 1.3 bug) */
230 cinfo->event_mgr = 0;
232 /* Setup the encoder parameters using the current image and user parameters */
233 opj_setup_encoder (cinfo, ¶meters, xyz->opj_image ());
235 opj_cio_t* cio = opj_cio_open ((opj_common_ptr) cinfo, 0, 0);
237 opj_destroy_compress (cinfo);
238 throw EncodeError (N_("could not open JPEG2000 stream"));
241 int const r = opj_encode (cinfo, cio, xyz->opj_image(), 0);
244 opj_destroy_compress (cinfo);
245 throw EncodeError (N_("JPEG2000 encoding failed"));
248 switch (_frame->eyes()) {
250 _log->log (String::compose (N_("Finished locally-encoded frame %1 for mono"), _index));
253 _log->log (String::compose (N_("Finished locally-encoded frame %1 for L"), _index));
256 _log->log (String::compose (N_("Finished locally-encoded frame %1 for R"), _index));
262 shared_ptr<EncodedData> enc (new LocallyEncodedData (cio->buffer, cio_tell (cio)));
265 free (parameters.cp_comment);
266 opj_destroy_compress (cinfo);
271 /** Send this frame to a remote server for J2K encoding, then read the result.
272 * @param serv Server to send to.
273 * @return Encoded data.
275 shared_ptr<EncodedData>
276 DCPVideoFrame::encode_remotely (ServerDescription serv)
278 boost::asio::io_service io_service;
279 boost::asio::ip::tcp::resolver resolver (io_service);
280 boost::asio::ip::tcp::resolver::query query (serv.host_name(), raw_convert<string> (Config::instance()->server_port_base ()));
281 boost::asio::ip::tcp::resolver::iterator endpoint_iterator = resolver.resolve (query);
283 shared_ptr<Socket> socket (new Socket);
285 socket->connect (*endpoint_iterator);
287 /* Collect all XML metadata */
289 xmlpp::Element* root = doc.create_root_node ("EncodingRequest");
290 root->add_child("Version")->add_child_text (raw_convert<string> (SERVER_LINK_VERSION));
293 _log->log (String::compose (N_("Sending frame %1 to remote"), _index));
295 /* Send XML metadata */
297 doc.write_to_stream (xml, "UTF-8");
298 socket->write (xml.str().length() + 1);
299 socket->write ((uint8_t *) xml.str().c_str(), xml.str().length() + 1);
301 /* Send binary data */
302 _frame->send_binary (socket);
304 /* Read the response (JPEG2000-encoded data); this blocks until the data
305 is ready and sent back.
307 shared_ptr<EncodedData> e (new RemotelyEncodedData (socket->read_uint32 ()));
308 socket->read (e->data(), e->size());
310 _log->log (String::compose (N_("Finished remotely-encoded frame %1"), _index));
316 DCPVideoFrame::add_metadata (xmlpp::Element* el) const
318 el->add_child("Index")->add_child_text (raw_convert<string> (_index));
319 el->add_child("FramesPerSecond")->add_child_text (raw_convert<string> (_frames_per_second));
320 el->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
321 el->add_child("Resolution")->add_child_text (raw_convert<string> (int (_resolution)));
322 _frame->add_metadata (el);
326 DCPVideoFrame::eyes () const
328 return _frame->eyes ();
331 EncodedData::EncodedData (int s)
332 : _data (new uint8_t[s])
338 EncodedData::EncodedData (boost::filesystem::path file)
340 _size = boost::filesystem::file_size (file);
341 _data = new uint8_t[_size];
343 FILE* f = fopen_boost (file, "rb");
345 throw FileError (_("could not open file for reading"), file);
348 size_t const r = fread (_data, 1, _size, f);
349 if (r != size_t (_size)) {
351 throw FileError (_("could not read encoded data"), file);
358 EncodedData::~EncodedData ()
363 /** Write this data to a J2K file.
365 * @param frame DCP frame index.
368 EncodedData::write (shared_ptr<const Film> film, int frame, Eyes eyes) const
370 boost::filesystem::path const tmp_j2c = film->j2c_path (frame, eyes, true);
372 FILE* f = fopen_boost (tmp_j2c, "wb");
375 throw WriteFileError (tmp_j2c, errno);
378 fwrite (_data, 1, _size, f);
381 boost::filesystem::path const real_j2c = film->j2c_path (frame, eyes, false);
383 /* Rename the file from foo.j2c.tmp to foo.j2c now that it is complete */
384 boost::filesystem::rename (tmp_j2c, real_j2c);
388 EncodedData::write_info (shared_ptr<const Film> film, int frame, Eyes eyes, dcp::FrameInfo fin) const
390 boost::filesystem::path const info = film->info_path (frame, eyes);
391 FILE* h = fopen_boost (info, "w");
396 /** Send this data to a socket.
397 * @param socket Socket
400 EncodedData::send (shared_ptr<Socket> socket)
402 socket->write (_size);
403 socket->write (_data, _size);
406 LocallyEncodedData::LocallyEncodedData (uint8_t* d, int s)
409 memcpy (_data, d, s);
412 /** @param s Size of data in bytes */
413 RemotelyEncodedData::RemotelyEncodedData (int s)