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.
41 #include <boost/array.hpp>
42 #include <boost/asio.hpp>
43 #include <boost/filesystem.hpp>
44 #include <boost/lexical_cast.hpp>
46 #include "dcp_video_frame.h"
49 #include "film_state.h"
51 #include "exceptions.h"
63 using namespace boost;
65 /** Construct a DCP video frame.
66 * @param input Input image.
67 * @param out Required size of output, in pixels (including any padding).
68 * @param s Scaler to use.
69 * @param p Number of pixels of padding either side of the image.
70 * @param f Index of the frame within the Film.
71 * @param fps Frames per second of the Film.
72 * @param pp FFmpeg post-processing string to use.
73 * @param clut Colour look-up table to use (see Config::colour_lut_index ())
74 * @param bw J2K bandwidth to use (see Config::j2k_bandwidth ())
75 * @param l Log to write to.
77 DCPVideoFrame::DCPVideoFrame (
78 shared_ptr<Image> yuv, Size out, int p, Scaler const * s, int f, float fps, string pp, int clut, int bw, Log* l)
84 /* we round here; not sure if this is right */
85 , _frames_per_second (rint (fps))
87 , _colour_lut_index (clut)
98 /** Create a libopenjpeg container suitable for our output image */
100 DCPVideoFrame::create_openjpeg_container ()
102 for (int i = 0; i < 3; ++i) {
105 _cmptparm[i].w = _out_size.width;
106 _cmptparm[i].h = _out_size.height;
109 _cmptparm[i].prec = 12;
110 _cmptparm[i].bpp = 12;
111 _cmptparm[i].sgnd = 0;
114 _image = opj_image_create (3, &_cmptparm[0], CLRSPC_SRGB);
116 throw EncodeError ("could not create libopenjpeg image");
121 _image->x1 = _out_size.width;
122 _image->y1 = _out_size.height;
125 DCPVideoFrame::~DCPVideoFrame ()
128 opj_image_destroy (_image);
132 opj_cio_close (_cio);
136 opj_destroy_compress (_cinfo);
140 free (_parameters->cp_comment);
141 free (_parameters->cp_matrice);
147 /** J2K-encode this frame on the local host.
148 * @return Encoded data.
150 shared_ptr<EncodedData>
151 DCPVideoFrame::encode_locally ()
153 shared_ptr<Image> prepared = _input;
155 if (!_post_process.empty ()) {
156 prepared = prepared->post_process (_post_process);
159 prepared = prepared->scale_and_convert_to_rgb (_out_size, _padding, _scaler);
161 create_openjpeg_container ();
163 int const size = _out_size.width * _out_size.height;
173 /* Copy our RGB into the openjpeg container, converting to XYZ in the process */
175 uint8_t* p = prepared->data()[0];
176 for (int i = 0; i < size; ++i) {
177 /* In gamma LUT (converting 8-bit input to 12-bit) */
178 s.r = lut_in[_colour_lut_index][*p++ << 4];
179 s.g = lut_in[_colour_lut_index][*p++ << 4];
180 s.b = lut_in[_colour_lut_index][*p++ << 4];
182 /* RGB to XYZ Matrix */
183 d.x = ((s.r * color_matrix[_colour_lut_index][0][0]) + (s.g * color_matrix[_colour_lut_index][0][1]) + (s.b * color_matrix[_colour_lut_index][0][2]));
184 d.y = ((s.r * color_matrix[_colour_lut_index][1][0]) + (s.g * color_matrix[_colour_lut_index][1][1]) + (s.b * color_matrix[_colour_lut_index][1][2]));
185 d.z = ((s.r * color_matrix[_colour_lut_index][2][0]) + (s.g * color_matrix[_colour_lut_index][2][1]) + (s.b * color_matrix[_colour_lut_index][2][2]));
188 d.x = d.x * DCI_COEFFICENT * (DCI_LUT_SIZE - 1);
189 d.y = d.y * DCI_COEFFICENT * (DCI_LUT_SIZE - 1);
190 d.z = d.z * DCI_COEFFICENT * (DCI_LUT_SIZE - 1);
193 _image->comps[0].data[i] = lut_out[LO_DCI][(int) d.x];
194 _image->comps[1].data[i] = lut_out[LO_DCI][(int) d.y];
195 _image->comps[2].data[i] = lut_out[LO_DCI][(int) d.z];
198 /* Set the max image and component sizes based on frame_rate */
199 int const max_cs_len = ((float) _j2k_bandwidth) / 8 / _frames_per_second;
200 int const max_comp_size = max_cs_len / 1.25;
202 /* Set encoding parameters to default values */
203 _parameters = new opj_cparameters_t;
204 opj_set_default_encoder_parameters (_parameters);
206 /* Set default cinema parameters */
207 _parameters->tile_size_on = false;
208 _parameters->cp_tdx = 1;
209 _parameters->cp_tdy = 1;
212 _parameters->tp_flag = 'C';
213 _parameters->tp_on = 1;
215 /* Tile and Image shall be at (0,0) */
216 _parameters->cp_tx0 = 0;
217 _parameters->cp_ty0 = 0;
218 _parameters->image_offset_x0 = 0;
219 _parameters->image_offset_y0 = 0;
221 /* Codeblock size = 32x32 */
222 _parameters->cblockw_init = 32;
223 _parameters->cblockh_init = 32;
224 _parameters->csty |= 0x01;
226 /* The progression order shall be CPRL */
227 _parameters->prog_order = CPRL;
230 _parameters->roi_compno = -1;
232 _parameters->subsampling_dx = 1;
233 _parameters->subsampling_dy = 1;
236 _parameters->irreversible = 1;
238 _parameters->tcp_rates[0] = 0;
239 _parameters->tcp_numlayers++;
240 _parameters->cp_disto_alloc = 1;
241 _parameters->cp_rsiz = CINEMA2K;
242 _parameters->cp_comment = strdup ("DVD-o-matic");
243 _parameters->cp_cinema = CINEMA2K_24;
245 /* 3 components, so use MCT */
246 _parameters->tcp_mct = 1;
249 _parameters->max_comp_size = max_comp_size;
250 _parameters->tcp_rates[0] = ((float) (3 * _image->comps[0].w * _image->comps[0].h * _image->comps[0].prec)) / (max_cs_len * 8);
252 /* get a J2K compressor handle */
253 _cinfo = opj_create_compress (CODEC_J2K);
255 /* Set event manager to null (openjpeg 1.3 bug) */
256 _cinfo->event_mgr = 0;
259 md5_data ("J2K in X frame " + lexical_cast<string> (_frame), _image->comps[0].data, size * sizeof (int));
260 md5_data ("J2K in Y frame " + lexical_cast<string> (_frame), _image->comps[1].data, size * sizeof (int));
261 md5_data ("J2K in Z frame " + lexical_cast<string> (_frame), _image->comps[2].data, size * sizeof (int));
264 /* Setup the encoder parameters using the current image and user parameters */
265 opj_setup_encoder (_cinfo, _parameters, _image);
267 _cio = opj_cio_open ((opj_common_ptr) _cinfo, 0, 0);
269 int const r = opj_encode (_cinfo, _cio, _image, 0);
271 throw EncodeError ("jpeg2000 encoding failed");
275 md5_data ("J2K out frame " + lexical_cast<string> (_frame), _cio->buffer, cio_tell (_cio));
280 s << "Finished locally-encoded frame " << _frame;
281 _log->log (s.str ());
284 return shared_ptr<EncodedData> (new LocallyEncodedData (_cio->buffer, cio_tell (_cio)));
287 /** Send this frame to a remote server for J2K encoding, then read the result.
288 * @param serv Server to send to.
289 * @return Encoded data.
291 shared_ptr<EncodedData>
292 DCPVideoFrame::encode_remotely (ServerDescription const * serv)
294 asio::io_service io_service;
295 asio::ip::tcp::resolver resolver (io_service);
297 asio::ip::tcp::resolver::query query (serv->host_name(), boost::lexical_cast<string> (Config::instance()->server_port ()));
298 asio::ip::tcp::resolver::iterator endpoint_iterator = resolver.resolve (query);
300 DeadlineWrapper wrapper;
302 wrapper.connect (*endpoint_iterator, 30);
305 _input->hash ("Input for remote encoding (before sending)");
310 << _input->size().width << " " << _input->size().height << " "
311 << _input->pixel_format() << " "
312 << _out_size.width << " " << _out_size.height << " "
314 << _scaler->id () << " "
316 << _frames_per_second << " "
317 << (_post_process.empty() ? "none" : _post_process) << " "
318 << Config::instance()->colour_lut_index () << " "
319 << Config::instance()->j2k_bandwidth () << " ";
321 for (int i = 0; i < _input->components(); ++i) {
322 s << _input->line_size()[i] << " ";
325 wrapper.write ((uint8_t *) s.str().c_str(), s.str().length() + 1, 30);
327 for (int i = 0; i < _input->components(); ++i) {
328 wrapper.write (_input->data()[i], _input->line_size()[i] * _input->lines(i), 30);
332 wrapper.read_indefinite ((uint8_t *) buffer, sizeof (buffer), 30);
333 wrapper.consume (strlen (buffer) + 1);
334 shared_ptr<EncodedData> e (new RemotelyEncodedData (atoi (buffer)));
336 /* now read the rest */
337 wrapper.read_definite_and_consume (e->data(), e->size(), 30);
340 e->hash ("Encoded image (after receiving)");
345 s << "Finished remotely-encoded frame " << _frame;
346 _log->log (s.str ());
352 /** Write this data to a J2K file.
353 * @param opt Options.
354 * @param frame Frame index.
357 EncodedData::write (shared_ptr<const Options> opt, int frame)
359 string const tmp_j2k = opt->frame_out_path (frame, true);
361 FILE* f = fopen (tmp_j2k.c_str (), "wb");
364 throw WriteFileError (tmp_j2k, errno);
367 fwrite (_data, 1, _size, f);
370 /* Rename the file from foo.j2c.tmp to foo.j2c now that it is complete */
371 filesystem::rename (tmp_j2k, opt->frame_out_path (frame, false));
374 /** Send this data to a socket.
375 * @param socket Socket
378 EncodedData::send (shared_ptr<DeadlineWrapper> wrapper)
382 wrapper->write ((uint8_t *) s.str().c_str(), s.str().length() + 1, 30);
383 wrapper->write (_data, _size, 30);
388 EncodedData::hash (string n) const
390 md5_data (n, _data, _size);
394 /** @param s Size of data in bytes */
395 RemotelyEncodedData::RemotelyEncodedData (int s)
396 : EncodedData (new uint8_t[s], s)
401 RemotelyEncodedData::~RemotelyEncodedData ()