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 <dcp/gamma_lut.h>
47 #include <dcp/xyz_frame.h>
48 #include <dcp/rgb_xyz.h>
49 #include <dcp/colour_matrix.h>
50 #include <dcp/raw_convert.h>
51 #include <libcxml/cxml.h>
53 #include "dcp_video_frame.h"
55 #include "exceptions.h"
62 #include "player_video_frame.h"
64 #define LOG_GENERAL(...) _log->log (String::compose (__VA_ARGS__), Log::TYPE_GENERAL);
69 using std::stringstream;
71 using boost::shared_ptr;
72 using boost::lexical_cast;
74 using dcp::raw_convert;
76 #define DCI_COEFFICENT (48.0 / 52.37)
78 /** Construct a DCP video frame.
79 * @param frame Input frame.
80 * @param index Index of the frame within the DCP.
81 * @param bw J2K bandwidth to use (see Config::j2k_bandwidth ())
82 * @param l Log to write to.
84 DCPVideoFrame::DCPVideoFrame (
85 shared_ptr<const PlayerVideoFrame> frame, int index, int dcp_fps, int bw, Resolution r, shared_ptr<Log> l
89 , _frames_per_second (dcp_fps)
97 DCPVideoFrame::DCPVideoFrame (shared_ptr<const PlayerVideoFrame> 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));
107 /** J2K-encode this frame on the local host.
108 * @return Encoded data.
110 shared_ptr<EncodedData>
111 DCPVideoFrame::encode_locally ()
113 shared_ptr<dcp::GammaLUT> in_lut = dcp::GammaLUT::cache.get (
114 12, _frame->colour_conversion().input_gamma, _frame->colour_conversion().input_gamma_linearised
117 /* XXX: libdcp should probably use boost */
120 for (int i = 0; i < 3; ++i) {
121 for (int j = 0; j < 3; ++j) {
122 matrix[i][j] = _frame->colour_conversion().matrix (i, j);
126 shared_ptr<dcp::XYZFrame> xyz = dcp::rgb_to_xyz (
129 dcp::GammaLUT::cache.get (16, 1 / _frame->colour_conversion().output_gamma, false),
133 /* Set the max image and component sizes based on frame_rate */
134 int max_cs_len = ((float) _j2k_bandwidth) / 8 / _frames_per_second;
135 if (_frame->eyes() == EYES_LEFT || _frame->eyes() == EYES_RIGHT) {
136 /* In 3D we have only half the normal bandwidth per eye */
139 int const max_comp_size = max_cs_len / 1.25;
141 /* get a J2K compressor handle */
142 opj_cinfo_t* cinfo = opj_create_compress (CODEC_J2K);
144 throw EncodeError (N_("could not create JPEG2000 encoder"));
147 /* Set encoding parameters to default values */
148 opj_cparameters_t parameters;
149 opj_set_default_encoder_parameters (¶meters);
151 /* Set default cinema parameters */
152 parameters.tile_size_on = false;
153 parameters.cp_tdx = 1;
154 parameters.cp_tdy = 1;
157 parameters.tp_flag = 'C';
158 parameters.tp_on = 1;
160 /* Tile and Image shall be at (0,0) */
161 parameters.cp_tx0 = 0;
162 parameters.cp_ty0 = 0;
163 parameters.image_offset_x0 = 0;
164 parameters.image_offset_y0 = 0;
166 /* Codeblock size = 32x32 */
167 parameters.cblockw_init = 32;
168 parameters.cblockh_init = 32;
169 parameters.csty |= 0x01;
171 /* The progression order shall be CPRL */
172 parameters.prog_order = CPRL;
175 parameters.roi_compno = -1;
177 parameters.subsampling_dx = 1;
178 parameters.subsampling_dy = 1;
181 parameters.irreversible = 1;
183 parameters.tcp_rates[0] = 0;
184 parameters.tcp_numlayers++;
185 parameters.cp_disto_alloc = 1;
186 parameters.cp_rsiz = _resolution == RESOLUTION_2K ? CINEMA2K : CINEMA4K;
187 if (_resolution == RESOLUTION_4K) {
188 parameters.numpocs = 2;
189 parameters.POC[0].tile = 1;
190 parameters.POC[0].resno0 = 0;
191 parameters.POC[0].compno0 = 0;
192 parameters.POC[0].layno1 = 1;
193 parameters.POC[0].resno1 = parameters.numresolution - 1;
194 parameters.POC[0].compno1 = 3;
195 parameters.POC[0].prg1 = CPRL;
196 parameters.POC[1].tile = 1;
197 parameters.POC[1].resno0 = parameters.numresolution - 1;
198 parameters.POC[1].compno0 = 0;
199 parameters.POC[1].layno1 = 1;
200 parameters.POC[1].resno1 = parameters.numresolution;
201 parameters.POC[1].compno1 = 3;
202 parameters.POC[1].prg1 = CPRL;
205 parameters.cp_comment = strdup (N_("DCP-o-matic"));
206 parameters.cp_cinema = _resolution == RESOLUTION_2K ? CINEMA2K_24 : CINEMA4K_24;
208 /* 3 components, so use MCT */
209 parameters.tcp_mct = 1;
212 parameters.max_comp_size = max_comp_size;
213 parameters.tcp_rates[0] = ((float) (3 * xyz->size().width * xyz->size().height * 12)) / (max_cs_len * 8);
215 /* Set event manager to null (openjpeg 1.3 bug) */
216 cinfo->event_mgr = 0;
218 /* Setup the encoder parameters using the current image and user parameters */
219 opj_setup_encoder (cinfo, ¶meters, xyz->opj_image ());
221 opj_cio_t* cio = opj_cio_open ((opj_common_ptr) cinfo, 0, 0);
223 opj_destroy_compress (cinfo);
224 throw EncodeError (N_("could not open JPEG2000 stream"));
227 int const r = opj_encode (cinfo, cio, xyz->opj_image(), 0);
230 opj_destroy_compress (cinfo);
231 throw EncodeError (N_("JPEG2000 encoding failed"));
234 switch (_frame->eyes()) {
236 LOG_GENERAL (N_("Finished locally-encoded frame %1 for mono"), _index);
239 LOG_GENERAL (N_("Finished locally-encoded frame %1 for L"), _index);
242 LOG_GENERAL (N_("Finished locally-encoded frame %1 for R"), _index);
248 shared_ptr<EncodedData> enc (new LocallyEncodedData (cio->buffer, cio_tell (cio)));
251 free (parameters.cp_comment);
252 opj_destroy_compress (cinfo);
257 /** Send this frame to a remote server for J2K encoding, then read the result.
258 * @param serv Server to send to.
259 * @return Encoded data.
261 shared_ptr<EncodedData>
262 DCPVideoFrame::encode_remotely (ServerDescription serv)
264 boost::asio::io_service io_service;
265 boost::asio::ip::tcp::resolver resolver (io_service);
266 boost::asio::ip::tcp::resolver::query query (serv.host_name(), raw_convert<string> (Config::instance()->server_port_base ()));
267 boost::asio::ip::tcp::resolver::iterator endpoint_iterator = resolver.resolve (query);
269 shared_ptr<Socket> socket (new Socket);
271 socket->connect (*endpoint_iterator);
273 /* Collect all XML metadata */
275 xmlpp::Element* root = doc.create_root_node ("EncodingRequest");
276 root->add_child("Version")->add_child_text (raw_convert<string> (SERVER_LINK_VERSION));
279 LOG_GENERAL (N_("Sending frame %1 to remote"), _index);
281 /* Send XML metadata */
283 doc.write_to_stream (xml, "UTF-8");
284 socket->write (xml.str().length() + 1);
285 socket->write ((uint8_t *) xml.str().c_str(), xml.str().length() + 1);
287 /* Send binary data */
288 _frame->send_binary (socket);
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 DCPVideoFrame::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 _frame->add_metadata (el);
312 DCPVideoFrame::eyes () const
314 return _frame->eyes ();
317 EncodedData::EncodedData (int s)
318 : _data (new uint8_t[s])
324 EncodedData::EncodedData (boost::filesystem::path file)
326 _size = boost::filesystem::file_size (file);
327 _data = new uint8_t[_size];
329 FILE* f = fopen_boost (file, "rb");
331 throw FileError (_("could not open file for reading"), file);
334 size_t const r = fread (_data, 1, _size, f);
335 if (r != size_t (_size)) {
337 throw FileError (_("could not read encoded data"), file);
344 EncodedData::~EncodedData ()
349 /** Write this data to a J2K file.
351 * @param frame DCP frame index.
354 EncodedData::write (shared_ptr<const Film> film, int frame, Eyes eyes) const
356 boost::filesystem::path const tmp_j2c = film->j2c_path (frame, eyes, true);
358 FILE* f = fopen_boost (tmp_j2c, "wb");
361 throw WriteFileError (tmp_j2c, errno);
364 fwrite (_data, 1, _size, f);
367 boost::filesystem::path const real_j2c = film->j2c_path (frame, eyes, false);
369 /* Rename the file from foo.j2c.tmp to foo.j2c now that it is complete */
370 boost::filesystem::rename (tmp_j2c, real_j2c);
374 EncodedData::write_info (shared_ptr<const Film> film, int frame, Eyes eyes, dcp::FrameInfo fin) const
376 boost::filesystem::path const info = film->info_path (frame, eyes);
377 FILE* h = fopen_boost (info, "w");
382 /** Send this data to a socket.
383 * @param socket Socket
386 EncodedData::send (shared_ptr<Socket> socket)
388 socket->write (_size);
389 socket->write (_data, _size);
392 LocallyEncodedData::LocallyEncodedData (uint8_t* d, int s)
395 memcpy (_data, d, s);
398 /** @param s Size of data in bytes */
399 RemotelyEncodedData::RemotelyEncodedData (int s)