2 Copyright (C) 2012-2015 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.
31 #include "dcp_video.h"
33 #include "exceptions.h"
34 #include "server_description.h"
35 #include "dcpomatic_socket.h"
39 #include "player_video.h"
40 #include "raw_convert.h"
42 #include "compose.hpp"
43 #include <libcxml/cxml.h>
44 #include <dcp/openjpeg_image.h>
45 #include <dcp/rgb_xyz.h>
46 #include <dcp/colour_matrix.h>
48 #include <libxml++/libxml++.h>
49 #include <boost/asio.hpp>
50 #include <boost/thread.hpp>
55 #define LOG_GENERAL(...) _log->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
56 #define LOG_DEBUG_ENCODE(...) _log->log (String::compose (__VA_ARGS__), LogEntry::TYPE_DEBUG_ENCODE);
57 #define LOG_TIMING(...) _log->log (String::compose (__VA_ARGS__), LogEntry::TYPE_TIMING);
63 using boost::shared_ptr;
66 #define DCI_COEFFICENT (48.0 / 52.37)
68 /** Construct a DCP video frame.
69 * @param frame Input frame.
70 * @param index Index of the frame within the DCP.
71 * @param bw J2K bandwidth to use (see Config::j2k_bandwidth ())
72 * @param l Log to write to.
75 shared_ptr<const PlayerVideo> frame, int index, int dcp_fps, int bw, Resolution r, shared_ptr<Log> l
79 , _frames_per_second (dcp_fps)
87 DCPVideo::DCPVideo (shared_ptr<const PlayerVideo> frame, shared_ptr<const cxml::Node> node, shared_ptr<Log> log)
91 _index = node->number_child<int> ("Index");
92 _frames_per_second = node->number_child<int> ("FramesPerSecond");
93 _j2k_bandwidth = node->number_child<int> ("J2KBandwidth");
94 _resolution = Resolution (node->optional_number_child<int>("Resolution").get_value_or (RESOLUTION_2K));
97 shared_ptr<dcp::OpenJPEGImage>
98 DCPVideo::convert_to_xyz (shared_ptr<const PlayerVideo> frame, dcp::NoteHandler note)
100 shared_ptr<dcp::OpenJPEGImage> xyz;
102 shared_ptr<Image> image = frame->image (note);
103 if (frame->colour_conversion()) {
104 xyz = dcp::rgb_to_xyz (
108 frame->colour_conversion().get(),
112 xyz = dcp::xyz_to_xyz (image->data()[0], image->size(), image->stride()[0]);
118 /** J2K-encode this frame on the local host.
119 * @return Encoded data.
122 DCPVideo::encode_locally (dcp::NoteHandler note)
124 shared_ptr<dcp::OpenJPEGImage> xyz = convert_to_xyz (_frame, note);
126 /* Set the max image and component sizes based on frame_rate */
127 int max_cs_len = ((float) _j2k_bandwidth) / 8 / _frames_per_second;
128 if (_frame->eyes() == EYES_LEFT || _frame->eyes() == EYES_RIGHT) {
129 /* In 3D we have only half the normal bandwidth per eye */
132 int const max_comp_size = max_cs_len / 1.25;
134 /* get a J2K compressor handle */
135 opj_cinfo_t* cinfo = opj_create_compress (CODEC_J2K);
137 throw EncodeError (N_("could not create JPEG2000 encoder"));
140 /* Set encoding parameters to default values */
141 opj_cparameters_t parameters;
142 opj_set_default_encoder_parameters (¶meters);
144 /* Set default cinema parameters */
145 parameters.tile_size_on = false;
146 parameters.cp_tdx = 1;
147 parameters.cp_tdy = 1;
150 parameters.tp_flag = 'C';
151 parameters.tp_on = 1;
153 /* Tile and Image shall be at (0,0) */
154 parameters.cp_tx0 = 0;
155 parameters.cp_ty0 = 0;
156 parameters.image_offset_x0 = 0;
157 parameters.image_offset_y0 = 0;
159 /* Codeblock size = 32x32 */
160 parameters.cblockw_init = 32;
161 parameters.cblockh_init = 32;
162 parameters.csty |= 0x01;
164 /* The progression order shall be CPRL */
165 parameters.prog_order = CPRL;
168 parameters.roi_compno = -1;
170 parameters.subsampling_dx = 1;
171 parameters.subsampling_dy = 1;
174 parameters.irreversible = 1;
176 parameters.tcp_rates[0] = 0;
177 parameters.tcp_numlayers++;
178 parameters.cp_disto_alloc = 1;
179 parameters.cp_rsiz = _resolution == RESOLUTION_2K ? CINEMA2K : CINEMA4K;
180 if (_resolution == RESOLUTION_4K) {
181 parameters.numpocs = 2;
182 parameters.POC[0].tile = 1;
183 parameters.POC[0].resno0 = 0;
184 parameters.POC[0].compno0 = 0;
185 parameters.POC[0].layno1 = 1;
186 parameters.POC[0].resno1 = parameters.numresolution - 1;
187 parameters.POC[0].compno1 = 3;
188 parameters.POC[0].prg1 = CPRL;
189 parameters.POC[1].tile = 1;
190 parameters.POC[1].resno0 = parameters.numresolution - 1;
191 parameters.POC[1].compno0 = 0;
192 parameters.POC[1].layno1 = 1;
193 parameters.POC[1].resno1 = parameters.numresolution;
194 parameters.POC[1].compno1 = 3;
195 parameters.POC[1].prg1 = CPRL;
198 parameters.cp_comment = strdup (N_("DCP-o-matic"));
199 parameters.cp_cinema = _resolution == RESOLUTION_2K ? CINEMA2K_24 : CINEMA4K_24;
201 /* 3 components, so use MCT */
202 parameters.tcp_mct = 1;
205 parameters.max_comp_size = max_comp_size;
206 parameters.tcp_rates[0] = ((float) (3 * xyz->size().width * xyz->size().height * 12)) / (max_cs_len * 8);
208 /* Set event manager to null (openjpeg 1.3 bug) */
209 cinfo->event_mgr = 0;
211 /* Setup the encoder parameters using the current image and user parameters */
212 opj_setup_encoder (cinfo, ¶meters, xyz->opj_image ());
214 opj_cio_t* cio = opj_cio_open ((opj_common_ptr) cinfo, 0, 0);
216 opj_destroy_compress (cinfo);
217 throw EncodeError (N_("could not open JPEG2000 stream"));
220 int const r = opj_encode (cinfo, cio, xyz->opj_image(), 0);
223 opj_destroy_compress (cinfo);
224 throw EncodeError (N_("JPEG2000 encoding failed"));
227 switch (_frame->eyes()) {
229 LOG_DEBUG_ENCODE (N_("Finished locally-encoded frame %1 for mono"), _index);
232 LOG_DEBUG_ENCODE (N_("Finished locally-encoded frame %1 for L"), _index);
235 LOG_DEBUG_ENCODE (N_("Finished locally-encoded frame %1 for R"), _index);
241 Data enc (cio->buffer, cio_tell (cio));
244 free (parameters.cp_comment);
245 opj_destroy_compress (cinfo);
250 /** Send this frame to a remote server for J2K encoding, then read the result.
251 * @param serv Server to send to.
252 * @return Encoded data.
255 DCPVideo::encode_remotely (ServerDescription serv)
257 boost::asio::io_service io_service;
258 boost::asio::ip::tcp::resolver resolver (io_service);
259 boost::asio::ip::tcp::resolver::query query (serv.host_name(), raw_convert<string> (Config::instance()->server_port_base ()));
260 boost::asio::ip::tcp::resolver::iterator endpoint_iterator = resolver.resolve (query);
262 shared_ptr<Socket> socket (new Socket);
264 socket->connect (*endpoint_iterator);
266 /* Collect all XML metadata */
268 xmlpp::Element* root = doc.create_root_node ("EncodingRequest");
269 root->add_child("Version")->add_child_text (raw_convert<string> (SERVER_LINK_VERSION));
272 LOG_DEBUG_ENCODE (N_("Sending frame %1 to remote"), _index);
274 /* Send XML metadata */
275 string xml = doc.write_to_string ("UTF-8");
276 socket->write (xml.length() + 1);
277 socket->write ((uint8_t *) xml.c_str(), xml.length() + 1);
279 /* Send binary data */
280 LOG_TIMING("start-remote-send thread=%1", boost::this_thread::get_id());
281 _frame->send_binary (socket);
283 /* Read the response (JPEG2000-encoded data); this blocks until the data
284 is ready and sent back.
286 LOG_TIMING("start-remote-encode thread=%1", boost::this_thread::get_id ());
287 Data e (socket->read_uint32 ());
288 LOG_TIMING("start-remote-receive thread=%1", boost::this_thread::get_id ());
289 socket->read (e.data().get(), e.size());
290 LOG_TIMING("finish-remote-receive thread=%1", boost::this_thread::get_id ());
292 LOG_DEBUG_ENCODE (N_("Finished remotely-encoded frame %1"), _index);
298 DCPVideo::add_metadata (xmlpp::Element* el) const
300 el->add_child("Index")->add_child_text (raw_convert<string> (_index));
301 el->add_child("FramesPerSecond")->add_child_text (raw_convert<string> (_frames_per_second));
302 el->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
303 el->add_child("Resolution")->add_child_text (raw_convert<string> (int (_resolution)));
304 _frame->add_metadata (el);
308 DCPVideo::eyes () const
310 return _frame->eyes ();
313 /** @return true if this DCPVideo is definitely the same as another;
314 * (apart from the frame index), false if it is probably not.
317 DCPVideo::same (shared_ptr<const DCPVideo> other) const
319 if (_frames_per_second != other->_frames_per_second ||
320 _j2k_bandwidth != other->_j2k_bandwidth ||
321 _resolution != other->_resolution) {
325 return _frame->same (other->_frame);