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>
46 #include <libdcp/rec709_linearised_gamma_lut.h>
47 #include <libdcp/srgb_linearised_gamma_lut.h>
48 #include <libdcp/gamma_lut.h>
49 #include <libdcp/xyz_frame.h>
50 #include <libdcp/rgb_xyz.h>
51 #include <libdcp/colour_matrix.h>
53 #include "dcp_video_frame.h"
55 #include "exceptions.h"
65 using std::stringstream;
68 using boost::shared_ptr;
71 #define DCI_COEFFICENT (48.0 / 52.37)
73 /** Construct a DCP video frame.
74 * @param input Input image.
75 * @param f Index of the frame within the DCP.
76 * @param bw J2K bandwidth to use (see Config::j2k_bandwidth ())
77 * @param l Log to write to.
79 DCPVideoFrame::DCPVideoFrame (
80 shared_ptr<const Image> image, int f, int dcp_fps, int bw, shared_ptr<Log> l
84 , _frames_per_second (dcp_fps)
91 /** J2K-encode this frame on the local host.
92 * @return Encoded data.
94 shared_ptr<EncodedData>
95 DCPVideoFrame::encode_locally ()
97 shared_ptr<libdcp::XYZFrame> xyz = libdcp::rgb_to_xyz (
99 libdcp::SRGBLinearisedGammaLUT::cache.get (12, 2.4),
100 libdcp::GammaLUT::cache.get (16, 1 / 2.6),
101 libdcp::colour_matrix::srgb_to_xyz
104 /* Set the max image and component sizes based on frame_rate */
105 int const max_cs_len = ((float) _j2k_bandwidth) / 8 / _frames_per_second;
106 int const max_comp_size = max_cs_len / 1.25;
108 /* get a J2K compressor handle */
109 opj_cinfo_t* cinfo = opj_create_compress (CODEC_J2K);
111 throw EncodeError (N_("could not create JPEG2000 encoder"));
114 /* Set encoding parameters to default values */
115 opj_cparameters_t parameters;
116 opj_set_default_encoder_parameters (¶meters);
118 /* Set default cinema parameters */
119 parameters.tile_size_on = false;
120 parameters.cp_tdx = 1;
121 parameters.cp_tdy = 1;
124 parameters.tp_flag = 'C';
125 parameters.tp_on = 1;
127 /* Tile and Image shall be at (0,0) */
128 parameters.cp_tx0 = 0;
129 parameters.cp_ty0 = 0;
130 parameters.image_offset_x0 = 0;
131 parameters.image_offset_y0 = 0;
133 /* Codeblock size = 32x32 */
134 parameters.cblockw_init = 32;
135 parameters.cblockh_init = 32;
136 parameters.csty |= 0x01;
138 /* The progression order shall be CPRL */
139 parameters.prog_order = CPRL;
142 parameters.roi_compno = -1;
144 parameters.subsampling_dx = 1;
145 parameters.subsampling_dy = 1;
148 parameters.irreversible = 1;
150 parameters.tcp_rates[0] = 0;
151 parameters.tcp_numlayers++;
152 parameters.cp_disto_alloc = 1;
153 parameters.cp_rsiz = CINEMA2K;
154 parameters.cp_comment = strdup (N_("DCP-o-matic"));
155 parameters.cp_cinema = CINEMA2K_24;
157 /* 3 components, so use MCT */
158 parameters.tcp_mct = 1;
161 parameters.max_comp_size = max_comp_size;
162 parameters.tcp_rates[0] = ((float) (3 * xyz->size().width * xyz->size().height * 12)) / (max_cs_len * 8);
164 /* Set event manager to null (openjpeg 1.3 bug) */
165 cinfo->event_mgr = 0;
167 /* Setup the encoder parameters using the current image and user parameters */
168 opj_setup_encoder (cinfo, ¶meters, xyz->opj_image ());
170 opj_cio_t* cio = opj_cio_open ((opj_common_ptr) cinfo, 0, 0);
172 opj_destroy_compress (cinfo);
173 throw EncodeError (N_("could not open JPEG2000 stream"));
176 int const r = opj_encode (cinfo, cio, xyz->opj_image(), 0);
179 opj_destroy_compress (cinfo);
180 throw EncodeError (N_("JPEG2000 encoding failed"));
183 _log->log (String::compose (N_("Finished locally-encoded frame %1"), _frame));
185 shared_ptr<EncodedData> enc (new LocallyEncodedData (cio->buffer, cio_tell (cio)));
188 free (parameters.cp_comment);
189 opj_destroy_compress (cinfo);
194 /** Send this frame to a remote server for J2K encoding, then read the result.
195 * @param serv Server to send to.
196 * @return Encoded data.
198 shared_ptr<EncodedData>
199 DCPVideoFrame::encode_remotely (ServerDescription const * serv)
201 boost::asio::io_service io_service;
202 boost::asio::ip::tcp::resolver resolver (io_service);
203 boost::asio::ip::tcp::resolver::query query (serv->host_name(), boost::lexical_cast<string> (Config::instance()->server_port ()));
204 boost::asio::ip::tcp::resolver::iterator endpoint_iterator = resolver.resolve (query);
206 shared_ptr<Socket> socket (new Socket);
208 socket->connect (*endpoint_iterator);
211 s << N_("encode please\n")
212 << N_("width ") << _image->size().width << N_("\n")
213 << N_("height ") << _image->size().height << N_("\n")
214 << N_("frame ") << _frame << N_("\n")
215 << N_("frames_per_second ") << _frames_per_second << N_("\n")
216 << N_("j2k_bandwidth ") << _j2k_bandwidth << N_("\n");
218 _log->log (String::compose (
219 N_("Sending to remote; pixel format %1, components %2, lines (%3,%4,%5), line sizes (%6,%7,%8)"),
220 _image->pixel_format(), _image->components(),
221 _image->lines(0), _image->lines(1), _image->lines(2),
222 _image->line_size()[0], _image->line_size()[1], _image->line_size()[2]
225 socket->write (s.str().length() + 1);
226 socket->write ((uint8_t *) s.str().c_str(), s.str().length() + 1);
228 _image->write_to_socket (socket);
230 shared_ptr<EncodedData> e (new RemotelyEncodedData (socket->read_uint32 ()));
231 socket->read (e->data(), e->size());
233 _log->log (String::compose (N_("Finished remotely-encoded frame %1"), _frame));
238 EncodedData::EncodedData (int s)
239 : _data (new uint8_t[s])
245 EncodedData::EncodedData (string file)
247 _size = boost::filesystem::file_size (file);
248 _data = new uint8_t[_size];
250 FILE* f = fopen (file.c_str(), N_("rb"));
252 throw FileError (_("could not open file for reading"), file);
255 size_t const r = fread (_data, 1, _size, f);
256 if (r != size_t (_size)) {
258 throw FileError (_("could not read encoded data"), file);
265 EncodedData::~EncodedData ()
270 /** Write this data to a J2K file.
272 * @param frame DCP frame index.
275 EncodedData::write (shared_ptr<const Film> film, int frame) const
277 string const tmp_j2c = film->j2c_path (frame, true);
279 FILE* f = fopen (tmp_j2c.c_str (), N_("wb"));
282 throw WriteFileError (tmp_j2c, errno);
285 fwrite (_data, 1, _size, f);
288 string const real_j2c = film->j2c_path (frame, false);
290 /* Rename the file from foo.j2c.tmp to foo.j2c now that it is complete */
291 boost::filesystem::rename (tmp_j2c, real_j2c);
295 EncodedData::write_info (shared_ptr<const Film> film, int frame, libdcp::FrameInfo fin) const
297 string const info = film->info_path (frame);
298 ofstream h (info.c_str());
302 /** Send this data to a socket.
303 * @param socket Socket
306 EncodedData::send (shared_ptr<Socket> socket)
308 socket->write (_size);
309 socket->write (_data, _size);
312 LocallyEncodedData::LocallyEncodedData (uint8_t* d, int s)
315 memcpy (_data, d, s);
318 /** @param s Size of data in bytes */
319 RemotelyEncodedData::RemotelyEncodedData (int s)