src/lib/dcp_video_frame.cc

   1 /*
   2     Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
   3     Taken from code Copyright (C) 2010-2011 Terrence Meiczinger
   4
   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.
   9
  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.
  14
  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.
  18
  19 */
  20
  21 /** @file  src/dcp_video_frame.cc
  22  *  @brief A single frame of video destined for a DCP.
  23  *
  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.
  26  *
  27  *  Objects of this class are used for the queue that we keep
  28  *  of images that require encoding.
  29  */
  30
  31 #include <stdint.h>
  32 #include <cstring>
  33 #include <cstdlib>
  34 #include <stdexcept>
  35 #include <cstdio>
  36 #include <iomanip>
  37 #include <sstream>
  38 #include <iostream>
  39 #include <fstream>
  40 #include <unistd.h>
  41 #include <errno.h>
  42 #include <boost/array.hpp>
  43 #include <boost/asio.hpp>
  44 #include <boost/filesystem.hpp>
  45 #include <boost/lexical_cast.hpp>
  46 #include "film.h"
  47 #include "dcp_video_frame.h"
  48 #include "lut.h"
  49 #include "config.h"
  50 #include "options.h"
  51 #include "exceptions.h"
  52 #include "server.h"
  53 #include "util.h"
  54 #include "scaler.h"
  55 #include "image.h"
  56 #include "log.h"
  57 #include "subtitle.h"
  58
  59 using std::string;
  60 using std::stringstream;
  61 using std::ofstream;
  62 using boost::shared_ptr;
  63
  64 /** Construct a DCP video frame.
  65  *  @param input Input image.
  66  *  @param out Required size of output, in pixels (including any padding).
  67  *  @param s Scaler to use.
  68  *  @param p Number of pixels of padding either side of the image.
  69  *  @param f Index of the frame within the Film's source.
  70  *  @param fps Frames per second of the Film's source.
  71  *  @param pp FFmpeg post-processing string to use.
  72  *  @param clut Colour look-up table to use (see Config::colour_lut_index ())
  73  *  @param bw J2K bandwidth to use (see Config::j2k_bandwidth ())
  74  *  @param l Log to write to.
  75  */
  76 DCPVideoFrame::DCPVideoFrame (
  77         shared_ptr<const Image> yuv, shared_ptr<Subtitle> sub,
  78         Size out, int p, int subtitle_offset, float subtitle_scale,
  79         Scaler const * s, SourceFrame f, float fps, string pp, int clut, int bw, Log* l
  80         )
  81         : _input (yuv)
  82         , _subtitle (sub)
  83         , _out_size (out)
  84         , _padding (p)
  85         , _subtitle_offset (subtitle_offset)
  86         , _subtitle_scale (subtitle_scale)
  87         , _scaler (s)
  88         , _frame (f)
  89         , _frames_per_second (DCPFrameRate(fps).frames_per_second)
  90         , _post_process (pp)
  91         , _colour_lut (clut)
  92         , _j2k_bandwidth (bw)
  93         , _log (l)
  94         , _image (0)
  95         , _parameters (0)
  96         , _cinfo (0)
  97         , _cio (0)
  98 {
  99
 100 }
 101
 102 /** Create a libopenjpeg container suitable for our output image */
 103 void
 104 DCPVideoFrame::create_openjpeg_container ()
 105 {
 106         for (int i = 0; i < 3; ++i) {
 107                 _cmptparm[i].dx = 1;
 108                 _cmptparm[i].dy = 1;
 109                 _cmptparm[i].w = _out_size.width;
 110                 _cmptparm[i].h = _out_size.height;
 111                 _cmptparm[i].x0 = 0;
 112                 _cmptparm[i].y0 = 0;
 113                 _cmptparm[i].prec = 12;
 114                 _cmptparm[i].bpp = 12;
 115                 _cmptparm[i].sgnd = 0;
 116         }
 117
 118         _image = opj_image_create (3, &_cmptparm[0], CLRSPC_SRGB);
 119         if (_image == 0) {
 120                 throw EncodeError ("could not create libopenjpeg image");
 121         }
 122
 123         _image->x0 = 0;
 124         _image->y0 = 0;
 125         _image->x1 = _out_size.width;
 126         _image->y1 = _out_size.height;
 127 }
 128
 129 DCPVideoFrame::~DCPVideoFrame ()
 130 {
 131         if (_image) {
 132                 opj_image_destroy (_image);
 133         }
 134
 135         if (_cio) {
 136                 opj_cio_close (_cio);
 137         }
 138
 139         if (_cinfo) {
 140                 opj_destroy_compress (_cinfo);
 141         }
 142
 143         if (_parameters) {
 144                 free (_parameters->cp_comment);
 145         }
 146
 147         delete _parameters;
 148 }
 149
 150 /** J2K-encode this frame on the local host.
 151  *  @return Encoded data.
 152  */
 153 shared_ptr<EncodedData>
 154 DCPVideoFrame::encode_locally ()
 155 {
 156         if (!_post_process.empty ()) {
 157                 _input = _input->post_process (_post_process, true);
 158         }
 159
 160         shared_ptr<Image> prepared = _input->scale_and_convert_to_rgb (_out_size, _padding, _scaler, true);
 161
 162         if (_subtitle) {
 163                 Rect tx = subtitle_transformed_area (
 164                         float (_out_size.width) / _input->size().width,
 165                         float (_out_size.height) / _input->size().height,
 166                         _subtitle->area(), _subtitle_offset, _subtitle_scale
 167                         );
 168
 169                 shared_ptr<Image> im = _subtitle->image()->scale (tx.size(), _scaler, true);
 170                 prepared->alpha_blend (im, tx.position());
 171         }
 172
 173         create_openjpeg_container ();
 174
 175         struct {
 176                 double r, g, b;
 177         } s;
 178
 179         struct {
 180                 double x, y, z;
 181         } d;
 182
 183         /* Copy our RGB into the openjpeg container, converting to XYZ in the process */
 184
 185         int jn = 0;
 186         for (int y = 0; y < _out_size.height; ++y) {
 187                 uint8_t* p = prepared->data()[0] + y * prepared->stride()[0];
 188                 for (int x = 0; x < _out_size.width; ++x) {
 189
 190                         /* In gamma LUT (converting 8-bit input to 12-bit) */
 191                         s.r = lut_in[_colour_lut][*p++ << 4];
 192                         s.g = lut_in[_colour_lut][*p++ << 4];
 193                         s.b = lut_in[_colour_lut][*p++ << 4];
 194
 195                         /* RGB to XYZ Matrix */
 196                         d.x = ((s.r * color_matrix[_colour_lut][0][0]) +
 197                                (s.g * color_matrix[_colour_lut][0][1]) +
 198                                (s.b * color_matrix[_colour_lut][0][2]));
 199
 200                         d.y = ((s.r * color_matrix[_colour_lut][1][0]) +
 201                                (s.g * color_matrix[_colour_lut][1][1]) +
 202                                (s.b * color_matrix[_colour_lut][1][2]));
 203
 204                         d.z = ((s.r * color_matrix[_colour_lut][2][0]) +
 205                                (s.g * color_matrix[_colour_lut][2][1]) +
 206                                (s.b * color_matrix[_colour_lut][2][2]));
 207
 208                         /* DCI companding */
 209                         d.x = d.x * DCI_COEFFICENT * (DCI_LUT_SIZE - 1);
 210                         d.y = d.y * DCI_COEFFICENT * (DCI_LUT_SIZE - 1);
 211                         d.z = d.z * DCI_COEFFICENT * (DCI_LUT_SIZE - 1);
 212
 213                         /* Out gamma LUT */
 214                         _image->comps[0].data[jn] = lut_out[LO_DCI][(int) d.x];
 215                         _image->comps[1].data[jn] = lut_out[LO_DCI][(int) d.y];
 216                         _image->comps[2].data[jn] = lut_out[LO_DCI][(int) d.z];
 217
 218                         ++jn;
 219                 }
 220         }
 221
 222         /* Set the max image and component sizes based on frame_rate */
 223         int const max_cs_len = ((float) _j2k_bandwidth) / 8 / _frames_per_second;
 224         int const max_comp_size = max_cs_len / 1.25;
 225
 226         /* Set encoding parameters to default values */
 227         _parameters = new opj_cparameters_t;
 228         opj_set_default_encoder_parameters (_parameters);
 229
 230         /* Set default cinema parameters */
 231         _parameters->tile_size_on = false;
 232         _parameters->cp_tdx = 1;
 233         _parameters->cp_tdy = 1;
 234
 235         /* Tile part */
 236         _parameters->tp_flag = 'C';
 237         _parameters->tp_on = 1;
 238
 239         /* Tile and Image shall be at (0,0) */
 240         _parameters->cp_tx0 = 0;
 241         _parameters->cp_ty0 = 0;
 242         _parameters->image_offset_x0 = 0;
 243         _parameters->image_offset_y0 = 0;
 244
 245         /* Codeblock size = 32x32 */
 246         _parameters->cblockw_init = 32;
 247         _parameters->cblockh_init = 32;
 248         _parameters->csty |= 0x01;
 249
 250         /* The progression order shall be CPRL */
 251         _parameters->prog_order = CPRL;
 252
 253         /* No ROI */
 254         _parameters->roi_compno = -1;
 255
 256         _parameters->subsampling_dx = 1;
 257         _parameters->subsampling_dy = 1;
 258
 259         /* 9-7 transform */
 260         _parameters->irreversible = 1;
 261
 262         _parameters->tcp_rates[0] = 0;
 263         _parameters->tcp_numlayers++;
 264         _parameters->cp_disto_alloc = 1;
 265         _parameters->cp_rsiz = CINEMA2K;
 266         _parameters->cp_comment = strdup ("DVD-o-matic");
 267         _parameters->cp_cinema = CINEMA2K_24;
 268
 269         /* 3 components, so use MCT */
 270         _parameters->tcp_mct = 1;
 271
 272         /* set max image */
 273         _parameters->max_comp_size = max_comp_size;
 274         _parameters->tcp_rates[0] = ((float) (3 * _image->comps[0].w * _image->comps[0].h * _image->comps[0].prec)) / (max_cs_len * 8);
 275
 276         /* get a J2K compressor handle */
 277         _cinfo = opj_create_compress (CODEC_J2K);
 278         if (_cinfo == 0) {
 279                 throw EncodeError ("could not create JPEG2000 encoder");
 280         }
 281
 282         /* Set event manager to null (openjpeg 1.3 bug) */
 283         _cinfo->event_mgr = 0;
 284
 285         /* Setup the encoder parameters using the current image and user parameters */
 286         opj_setup_encoder (_cinfo, _parameters, _image);
 287
 288         _cio = opj_cio_open ((opj_common_ptr) _cinfo, 0, 0);
 289         if (_cio == 0) {
 290                 throw EncodeError ("could not open JPEG2000 stream");
 291         }
 292
 293         int const r = opj_encode (_cinfo, _cio, _image, 0);
 294         if (r == 0) {
 295                 throw EncodeError ("JPEG2000 encoding failed");
 296         }
 297
 298         _log->log (String::compose ("Finished locally-encoded frame %1", _frame));
 299
 300         return shared_ptr<EncodedData> (new LocallyEncodedData (_cio->buffer, cio_tell (_cio)));
 301 }
 302
 303 /** Send this frame to a remote server for J2K encoding, then read the result.
 304  *  @param serv Server to send to.
 305  *  @return Encoded data.
 306  */
 307 shared_ptr<EncodedData>
 308 DCPVideoFrame::encode_remotely (ServerDescription const * serv)
 309 {
 310         boost::asio::io_service io_service;
 311         boost::asio::ip::tcp::resolver resolver (io_service);
 312         boost::asio::ip::tcp::resolver::query query (serv->host_name(), boost::lexical_cast<string> (Config::instance()->server_port ()));
 313         boost::asio::ip::tcp::resolver::iterator endpoint_iterator = resolver.resolve (query);
 314
 315         shared_ptr<Socket> socket (new Socket);
 316
 317         socket->connect (*endpoint_iterator, 30);
 318
 319         stringstream s;
 320         s << "encode please\n"
 321           << "input_width " << _input->size().width << "\n"
 322           << "input_height " << _input->size().height << "\n"
 323           << "input_pixel_format " << _input->pixel_format() << "\n"
 324           << "output_width " << _out_size.width << "\n"
 325           << "output_height " << _out_size.height << "\n"
 326           << "padding " <<  _padding << "\n"
 327           << "subtitle_offset " << _subtitle_offset << "\n"
 328           << "subtitle_scale " << _subtitle_scale << "\n"
 329           << "scaler " << _scaler->id () << "\n"
 330           << "frame " << _frame << "\n"
 331           << "frames_per_second " << _frames_per_second << "\n";
 332
 333         if (!_post_process.empty()) {
 334                 s << "post_process " << _post_process << "\n";
 335         }
 336
 337         s << "colour_lut " << _colour_lut << "\n"
 338           << "j2k_bandwidth " << _j2k_bandwidth << "\n";
 339
 340         if (_subtitle) {
 341                 s << "subtitle_x " << _subtitle->position().x << "\n"
 342                   << "subtitle_y " << _subtitle->position().y << "\n"
 343                   << "subtitle_width " << _subtitle->image()->size().width << "\n"
 344                   << "subtitle_height " << _subtitle->image()->size().height << "\n";
 345         }
 346
 347         _log->log (String::compose (
 348                            "Sending to remote; pixel format %1, components %2, lines (%3,%4,%5), line sizes (%6,%7,%8)",
 349                            _input->pixel_format(), _input->components(),
 350                            _input->lines(0), _input->lines(1), _input->lines(2),
 351                            _input->line_size()[0], _input->line_size()[1], _input->line_size()[2]
 352                            ));
 353
 354         socket->write ((uint8_t *) s.str().c_str(), s.str().length() + 1, 30);
 355
 356         _input->write_to_socket (socket);
 357         if (_subtitle) {
 358                 _subtitle->image()->write_to_socket (socket);
 359         }
 360
 361         char buffer[32];
 362         socket->read_indefinite ((uint8_t *) buffer, sizeof (buffer), 30);
 363         socket->consume (strlen (buffer) + 1);
 364         shared_ptr<EncodedData> e (new RemotelyEncodedData (atoi (buffer)));
 365
 366         /* now read the rest */
 367         socket->read_definite_and_consume (e->data(), e->size(), 30);
 368
 369         _log->log (String::compose ("Finished remotely-encoded frame %1", _frame));
 370
 371         return e;
 372 }
 373
 374 /** Write this data to a J2K file.
 375  *  @param opt Options.
 376  *  @param frame Frame index.
 377  */
 378 void
 379 EncodedData::write (shared_ptr<const Film> film, SourceFrame frame)
 380 {
 381         string const tmp_j2k = film->frame_out_path (frame, true);
 382
 383         FILE* f = fopen (tmp_j2k.c_str (), "wb");
 384
 385         if (!f) {
 386                 throw WriteFileError (tmp_j2k, errno);
 387         }
 388
 389         fwrite (_data, 1, _size, f);
 390         fclose (f);
 391
 392         string const real_j2k = film->frame_out_path (frame, false);
 393
 394         /* Rename the file from foo.j2c.tmp to foo.j2c now that it is complete */
 395         boost::filesystem::rename (tmp_j2k, real_j2k);
 396
 397         /* Write a file containing the hash */
 398         string const hash = film->hash_out_path (frame, false);
 399         ofstream h (hash.c_str());
 400         h << md5_digest (_data, _size) << "\n";
 401         h.close ();
 402 }
 403
 404 /** Send this data to a socket.
 405  *  @param socket Socket
 406  */
 407 void
 408 EncodedData::send (shared_ptr<Socket> socket)
 409 {
 410         stringstream s;
 411         s << _size;
 412         socket->write ((uint8_t *) s.str().c_str(), s.str().length() + 1, 30);
 413         socket->write (_data, _size, 30);
 414 }
 415
 416 /** @param s Size of data in bytes */
 417 RemotelyEncodedData::RemotelyEncodedData (int s)
 418         : EncodedData (new uint8_t[s], s)
 419 {
 420
 421 }
 422
 423 RemotelyEncodedData::~RemotelyEncodedData ()
 424 {
 425         delete[] _data;
 426 }