2 Copyright (C) 2012 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>
47 #include "dcp_video_frame.h"
50 #include "film_state.h"
52 #include "exceptions.h"
61 using namespace boost;
63 /** Construct a DCP video frame.
64 * @param input Input image.
65 * @param out Required size of output, in pixels (including any padding).
66 * @param s Scaler to use.
67 * @param p Number of pixels of padding either side of the image.
68 * @param f Index of the frame within the Film.
69 * @param fps Frames per second of the Film.
70 * @param pp FFmpeg post-processing string to use.
71 * @param clut Colour look-up table to use (see Config::colour_lut_index ())
72 * @param bw J2K bandwidth to use (see Config::j2k_bandwidth ())
73 * @param l Log to write to.
75 DCPVideoFrame::DCPVideoFrame (
76 shared_ptr<Image> yuv, shared_ptr<Subtitle> sub,
77 Size out, int p, int subtitle_offset, float subtitle_scale,
78 Scaler const * s, int f, float fps, string pp, int clut, int bw, Log* l
84 , _subtitle_offset (subtitle_offset)
85 , _subtitle_scale (subtitle_scale)
88 /* we round here; not sure if this is right */
89 , _frames_per_second (rint (fps))
91 , _colour_lut_index (clut)
102 /** Create a libopenjpeg container suitable for our output image */
104 DCPVideoFrame::create_openjpeg_container ()
106 for (int i = 0; i < 3; ++i) {
109 _cmptparm[i].w = _out_size.width;
110 _cmptparm[i].h = _out_size.height;
113 _cmptparm[i].prec = 12;
114 _cmptparm[i].bpp = 12;
115 _cmptparm[i].sgnd = 0;
118 _image = opj_image_create (3, &_cmptparm[0], CLRSPC_SRGB);
120 throw EncodeError ("could not create libopenjpeg image");
125 _image->x1 = _out_size.width;
126 _image->y1 = _out_size.height;
129 DCPVideoFrame::~DCPVideoFrame ()
132 opj_image_destroy (_image);
136 opj_cio_close (_cio);
140 opj_destroy_compress (_cinfo);
144 free (_parameters->cp_comment);
145 free (_parameters->cp_matrice);
151 /** J2K-encode this frame on the local host.
152 * @return Encoded data.
154 shared_ptr<EncodedData>
155 DCPVideoFrame::encode_locally ()
157 if (!_post_process.empty ()) {
158 _input = _input->post_process (_post_process);
161 shared_ptr<Image> prepared = _input->scale_and_convert_to_rgb (_out_size, _padding, _scaler);
164 Rect tx = subtitle_transformed_area (
165 float (_out_size.width) / _input->size().width,
166 float (_out_size.height) / _input->size().height,
167 _subtitle->area(), _subtitle_offset, _subtitle_scale
170 shared_ptr<Image> im = _subtitle->image()->scale (tx.size(), _scaler);
171 prepared->alpha_blend (im, tx.position());
174 create_openjpeg_container ();
184 /* Copy our RGB into the openjpeg container, converting to XYZ in the process */
187 for (int y = 0; y < _out_size.height; ++y) {
188 uint8_t* p = prepared->data()[0] + y * prepared->stride()[0];
189 for (int x = 0; x < _out_size.width; ++x) {
191 /* In gamma LUT (converting 8-bit input to 12-bit) */
192 s.r = lut_in[_colour_lut_index][*p++ << 4];
193 s.g = lut_in[_colour_lut_index][*p++ << 4];
194 s.b = lut_in[_colour_lut_index][*p++ << 4];
196 /* RGB to XYZ Matrix */
197 d.x = ((s.r * color_matrix[_colour_lut_index][0][0]) +
198 (s.g * color_matrix[_colour_lut_index][0][1]) +
199 (s.b * color_matrix[_colour_lut_index][0][2]));
201 d.y = ((s.r * color_matrix[_colour_lut_index][1][0]) +
202 (s.g * color_matrix[_colour_lut_index][1][1]) +
203 (s.b * color_matrix[_colour_lut_index][1][2]));
205 d.z = ((s.r * color_matrix[_colour_lut_index][2][0]) +
206 (s.g * color_matrix[_colour_lut_index][2][1]) +
207 (s.b * color_matrix[_colour_lut_index][2][2]));
210 d.x = d.x * DCI_COEFFICENT * (DCI_LUT_SIZE - 1);
211 d.y = d.y * DCI_COEFFICENT * (DCI_LUT_SIZE - 1);
212 d.z = d.z * DCI_COEFFICENT * (DCI_LUT_SIZE - 1);
215 _image->comps[0].data[jn] = lut_out[LO_DCI][(int) d.x];
216 _image->comps[1].data[jn] = lut_out[LO_DCI][(int) d.y];
217 _image->comps[2].data[jn] = lut_out[LO_DCI][(int) d.z];
223 /* Set the max image and component sizes based on frame_rate */
224 int const max_cs_len = ((float) _j2k_bandwidth) / 8 / _frames_per_second;
225 int const max_comp_size = max_cs_len / 1.25;
227 /* Set encoding parameters to default values */
228 _parameters = new opj_cparameters_t;
229 opj_set_default_encoder_parameters (_parameters);
231 /* Set default cinema parameters */
232 _parameters->tile_size_on = false;
233 _parameters->cp_tdx = 1;
234 _parameters->cp_tdy = 1;
237 _parameters->tp_flag = 'C';
238 _parameters->tp_on = 1;
240 /* Tile and Image shall be at (0,0) */
241 _parameters->cp_tx0 = 0;
242 _parameters->cp_ty0 = 0;
243 _parameters->image_offset_x0 = 0;
244 _parameters->image_offset_y0 = 0;
246 /* Codeblock size = 32x32 */
247 _parameters->cblockw_init = 32;
248 _parameters->cblockh_init = 32;
249 _parameters->csty |= 0x01;
251 /* The progression order shall be CPRL */
252 _parameters->prog_order = CPRL;
255 _parameters->roi_compno = -1;
257 _parameters->subsampling_dx = 1;
258 _parameters->subsampling_dy = 1;
261 _parameters->irreversible = 1;
263 _parameters->tcp_rates[0] = 0;
264 _parameters->tcp_numlayers++;
265 _parameters->cp_disto_alloc = 1;
266 _parameters->cp_rsiz = CINEMA2K;
267 _parameters->cp_comment = strdup ("DVD-o-matic");
268 _parameters->cp_cinema = CINEMA2K_24;
270 /* 3 components, so use MCT */
271 _parameters->tcp_mct = 1;
274 _parameters->max_comp_size = max_comp_size;
275 _parameters->tcp_rates[0] = ((float) (3 * _image->comps[0].w * _image->comps[0].h * _image->comps[0].prec)) / (max_cs_len * 8);
277 /* get a J2K compressor handle */
278 _cinfo = opj_create_compress (CODEC_J2K);
280 /* Set event manager to null (openjpeg 1.3 bug) */
281 _cinfo->event_mgr = 0;
283 /* Setup the encoder parameters using the current image and user parameters */
284 opj_setup_encoder (_cinfo, _parameters, _image);
286 _cio = opj_cio_open ((opj_common_ptr) _cinfo, 0, 0);
288 int const r = opj_encode (_cinfo, _cio, _image, 0);
290 throw EncodeError ("jpeg2000 encoding failed");
293 _log->log (String::compose ("Finished locally-encoded frame %1", _frame));
295 return shared_ptr<EncodedData> (new LocallyEncodedData (_cio->buffer, cio_tell (_cio)));
298 /** Send this frame to a remote server for J2K encoding, then read the result.
299 * @param serv Server to send to.
300 * @return Encoded data.
302 shared_ptr<EncodedData>
303 DCPVideoFrame::encode_remotely (ServerDescription const * serv)
305 asio::io_service io_service;
306 asio::ip::tcp::resolver resolver (io_service);
307 asio::ip::tcp::resolver::query query (serv->host_name(), boost::lexical_cast<string> (Config::instance()->server_port ()));
308 asio::ip::tcp::resolver::iterator endpoint_iterator = resolver.resolve (query);
310 shared_ptr<Socket> socket (new Socket);
312 socket->connect (*endpoint_iterator, 30);
315 s << "encode please\n"
316 << "input_width " << _input->size().width << "\n"
317 << "input_height " << _input->size().height << "\n"
318 << "input_pixel_format " << _input->pixel_format() << "\n"
319 << "output_width " << _out_size.width << "\n"
320 << "output_height " << _out_size.height << "\n"
321 << "padding " << _padding << "\n"
322 << "subtitle_offset " << _subtitle_offset << "\n"
323 << "subtitle_scale " << _subtitle_scale << "\n"
324 << "scaler " << _scaler->id () << "\n"
325 << "frame " << _frame << "\n"
326 << "frames_per_second " << _frames_per_second << "\n";
328 if (!_post_process.empty()) {
329 s << "post_process " << _post_process << "\n";
332 s << "colour_lut " << Config::instance()->colour_lut_index () << "\n"
333 << "j2k_bandwidth " << Config::instance()->j2k_bandwidth () << "\n";
336 s << "subtitle_x " << _subtitle->position().x << "\n"
337 << "subtitle_y " << _subtitle->position().y << "\n"
338 << "subtitle_width " << _subtitle->image()->size().width << "\n"
339 << "subtitle_height " << _subtitle->image()->size().height << "\n";
342 socket->write ((uint8_t *) s.str().c_str(), s.str().length() + 1, 30);
344 _input->write_to_socket (socket);
346 _subtitle->image()->write_to_socket (socket);
350 socket->read_indefinite ((uint8_t *) buffer, sizeof (buffer), 30);
351 socket->consume (strlen (buffer) + 1);
352 shared_ptr<EncodedData> e (new RemotelyEncodedData (atoi (buffer)));
354 /* now read the rest */
355 socket->read_definite_and_consume (e->data(), e->size(), 30);
357 _log->log (String::compose ("Finished remotely-encoded frame %1", _frame));
362 /** Write this data to a J2K file.
363 * @param opt Options.
364 * @param frame Frame index.
367 EncodedData::write (shared_ptr<const Options> opt, int frame)
369 string const tmp_j2k = opt->frame_out_path (frame, true);
371 FILE* f = fopen (tmp_j2k.c_str (), "wb");
374 throw WriteFileError (tmp_j2k, errno);
377 fwrite (_data, 1, _size, f);
380 string const real_j2k = opt->frame_out_path (frame, false);
382 /* Rename the file from foo.j2c.tmp to foo.j2c now that it is complete */
383 filesystem::rename (tmp_j2k, real_j2k);
385 /* Write a file containing the hash */
386 string const hash = real_j2k + ".md5";
387 ofstream h (hash.c_str());
388 h << md5_digest (_data, _size) << "\n";
392 /** Send this data to a socket.
393 * @param socket Socket
396 EncodedData::send (shared_ptr<Socket> socket)
400 socket->write ((uint8_t *) s.str().c_str(), s.str().length() + 1, 30);
401 socket->write (_data, _size, 30);
404 /** @param s Size of data in bytes */
405 RemotelyEncodedData::RemotelyEncodedData (int s)
406 : EncodedData (new uint8_t[s], s)
411 RemotelyEncodedData::~RemotelyEncodedData ()