src/lib/dcp_video_frame.cc

   1 /*
   2     Copyright (C) 2012-2014 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 <openssl/md5.h>
  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>
  52 #include <libdcp/raw_convert.h>
  53 #include <libcxml/cxml.h>
  54 #include "film.h"
  55 #include "dcp_video_frame.h"
  56 #include "config.h"
  57 #include "exceptions.h"
  58 #include "server.h"
  59 #include "util.h"
  60 #include "scaler.h"
  61 #include "image.h"
  62 #include "log.h"
  63 #include "cross.h"
  64 #include "player_video_frame.h"
  65
  66 #define LOG_GENERAL(...) _log->log (String::compose (__VA_ARGS__), Log::GENERAL);
  67
  68 #include "i18n.h"
  69
  70 using std::string;
  71 using std::stringstream;
  72 using std::cout;
  73 using boost::shared_ptr;
  74 using libdcp::Size;
  75 using libdcp::raw_convert;
  76
  77 #define DCI_COEFFICENT (48.0 / 52.37)
  78
  79 /** Construct a DCP video frame.
  80  *  @param frame Input frame.
  81  *  @param index Index of the frame within the DCP.
  82  *  @param bw J2K bandwidth to use (see Config::j2k_bandwidth ())
  83  *  @param l Log to write to.
  84  */
  85 DCPVideoFrame::DCPVideoFrame (
  86         shared_ptr<const PlayerVideoFrame> frame, int index, int dcp_fps, int bw, Resolution r, shared_ptr<Log> l
  87         )
  88         : _frame (frame)
  89         , _index (index)
  90         , _frames_per_second (dcp_fps)
  91         , _j2k_bandwidth (bw)
  92         , _resolution (r)
  93         , _log (l)
  94 {
  95
  96 }
  97
  98 DCPVideoFrame::DCPVideoFrame (shared_ptr<const PlayerVideoFrame> frame, shared_ptr<const cxml::Node> node, shared_ptr<Log> log)
  99         : _frame (frame)
 100         , _log (log)
 101 {
 102         _index = node->number_child<int> ("Index");
 103         _frames_per_second = node->number_child<int> ("FramesPerSecond");
 104         _j2k_bandwidth = node->number_child<int> ("J2KBandwidth");
 105         _resolution = Resolution (node->optional_number_child<int>("Resolution").get_value_or (RESOLUTION_2K));
 106 }
 107
 108 /** J2K-encode this frame on the local host.
 109  *  @return Encoded data.
 110  */
 111 shared_ptr<EncodedData>
 112 DCPVideoFrame::encode_locally ()
 113 {
 114         shared_ptr<libdcp::LUT> in_lut;
 115         if (_frame->colour_conversion().input_gamma_linearised) {
 116                 in_lut = libdcp::SRGBLinearisedGammaLUT::cache.get (12, _frame->colour_conversion().input_gamma);
 117         } else {
 118                 in_lut = libdcp::GammaLUT::cache.get (12, _frame->colour_conversion().input_gamma);
 119         }
 120
 121         /* XXX: libdcp should probably use boost */
 122
 123         double matrix[3][3];
 124         for (int i = 0; i < 3; ++i) {
 125                 for (int j = 0; j < 3; ++j) {
 126                         matrix[i][j] = _frame->colour_conversion().matrix (i, j);
 127                 }
 128         }
 129
 130         shared_ptr<libdcp::XYZFrame> xyz = libdcp::rgb_to_xyz (
 131                 _frame->image(),
 132                 in_lut,
 133                 libdcp::GammaLUT::cache.get (16, 1 / _frame->colour_conversion().output_gamma),
 134                 matrix
 135                 );
 136
 137         {
 138                 MD5_CTX md5_context;
 139                 MD5_Init (&md5_context);
 140                 MD5_Update (&md5_context, xyz->data(0), 1998 * 1080 * 4);
 141                 MD5_Update (&md5_context, xyz->data(1), 1998 * 1080 * 4);
 142                 MD5_Update (&md5_context, xyz->data(2), 1998 * 1080 * 4);
 143                 unsigned char digest[MD5_DIGEST_LENGTH];
 144                 MD5_Final (digest, &md5_context);
 145
 146                 stringstream s;
 147                 for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
 148                         s << std::hex << std::setfill('0') << std::setw(2) << ((int) digest[i]);
 149                 }
 150         }
 151
 152         /* Set the max image and component sizes based on frame_rate */
 153         int max_cs_len = ((float) _j2k_bandwidth) / 8 / _frames_per_second;
 154         if (_frame->eyes() == EYES_LEFT || _frame->eyes() == EYES_RIGHT) {
 155                 /* In 3D we have only half the normal bandwidth per eye */
 156                 max_cs_len /= 2;
 157         }
 158         int const max_comp_size = max_cs_len / 1.25;
 159
 160         /* get a J2K compressor handle */
 161         opj_cinfo_t* cinfo = opj_create_compress (CODEC_J2K);
 162         if (cinfo == 0) {
 163                 throw EncodeError (N_("could not create JPEG2000 encoder"));
 164         }
 165
 166         /* Set encoding parameters to default values */
 167         opj_cparameters_t parameters;
 168         opj_set_default_encoder_parameters (&parameters);
 169
 170         /* Set default cinema parameters */
 171         parameters.tile_size_on = false;
 172         parameters.cp_tdx = 1;
 173         parameters.cp_tdy = 1;
 174
 175         /* Tile part */
 176         parameters.tp_flag = 'C';
 177         parameters.tp_on = 1;
 178
 179         /* Tile and Image shall be at (0,0) */
 180         parameters.cp_tx0 = 0;
 181         parameters.cp_ty0 = 0;
 182         parameters.image_offset_x0 = 0;
 183         parameters.image_offset_y0 = 0;
 184
 185         /* Codeblock size = 32x32 */
 186         parameters.cblockw_init = 32;
 187         parameters.cblockh_init = 32;
 188         parameters.csty |= 0x01;
 189
 190         /* The progression order shall be CPRL */
 191         parameters.prog_order = CPRL;
 192
 193         /* No ROI */
 194         parameters.roi_compno = -1;
 195
 196         parameters.subsampling_dx = 1;
 197         parameters.subsampling_dy = 1;
 198
 199         /* 9-7 transform */
 200         parameters.irreversible = 1;
 201
 202         parameters.tcp_rates[0] = 0;
 203         parameters.tcp_numlayers++;
 204         parameters.cp_disto_alloc = 1;
 205         parameters.cp_rsiz = _resolution == RESOLUTION_2K ? CINEMA2K : CINEMA4K;
 206         if (_resolution == RESOLUTION_4K) {
 207                 parameters.numpocs = 2;
 208                 parameters.POC[0].tile = 1;
 209                 parameters.POC[0].resno0 = 0;
 210                 parameters.POC[0].compno0 = 0;
 211                 parameters.POC[0].layno1 = 1;
 212                 parameters.POC[0].resno1 = parameters.numresolution - 1;
 213                 parameters.POC[0].compno1 = 3;
 214                 parameters.POC[0].prg1 = CPRL;
 215                 parameters.POC[1].tile = 1;
 216                 parameters.POC[1].resno0 = parameters.numresolution - 1;
 217                 parameters.POC[1].compno0 = 0;
 218                 parameters.POC[1].layno1 = 1;
 219                 parameters.POC[1].resno1 = parameters.numresolution;
 220                 parameters.POC[1].compno1 = 3;
 221                 parameters.POC[1].prg1 = CPRL;
 222         }
 223
 224         parameters.cp_comment = strdup (N_("DCP-o-matic"));
 225         parameters.cp_cinema = _resolution == RESOLUTION_2K ? CINEMA2K_24 : CINEMA4K_24;
 226
 227         /* 3 components, so use MCT */
 228         parameters.tcp_mct = 1;
 229
 230         /* set max image */
 231         parameters.max_comp_size = max_comp_size;
 232         parameters.tcp_rates[0] = ((float) (3 * xyz->size().width * xyz->size().height * 12)) / (max_cs_len * 8);
 233
 234         /* Set event manager to null (openjpeg 1.3 bug) */
 235         cinfo->event_mgr = 0;
 236
 237         /* Setup the encoder parameters using the current image and user parameters */
 238         opj_setup_encoder (cinfo, &parameters, xyz->opj_image ());
 239
 240         opj_cio_t* cio = opj_cio_open ((opj_common_ptr) cinfo, 0, 0);
 241         if (cio == 0) {
 242                 opj_destroy_compress (cinfo);
 243                 throw EncodeError (N_("could not open JPEG2000 stream"));
 244         }
 245
 246         int const r = opj_encode (cinfo, cio, xyz->opj_image(), 0);
 247         if (r == 0) {
 248                 opj_cio_close (cio);
 249                 opj_destroy_compress (cinfo);
 250                 throw EncodeError (N_("JPEG2000 encoding failed"));
 251         }
 252
 253         switch (_frame->eyes()) {
 254         case EYES_BOTH:
 255                 LOG_GENERAL (N_("Finished locally-encoded frame %1 for mono"), _index);
 256                 break;
 257         case EYES_LEFT:
 258                 LOG_GENERAL (N_("Finished locally-encoded frame %1 for L"), _index);
 259                 break;
 260         case EYES_RIGHT:
 261                 LOG_GENERAL (N_("Finished locally-encoded frame %1 for R"), _index);
 262                 break;
 263         default:
 264                 break;
 265         }
 266
 267         shared_ptr<EncodedData> enc (new LocallyEncodedData (cio->buffer, cio_tell (cio)));
 268
 269         opj_cio_close (cio);
 270         free (parameters.cp_comment);
 271         opj_destroy_compress (cinfo);
 272
 273         return enc;
 274 }
 275
 276 /** Send this frame to a remote server for J2K encoding, then read the result.
 277  *  @param serv Server to send to.
 278  *  @return Encoded data.
 279  */
 280 shared_ptr<EncodedData>
 281 DCPVideoFrame::encode_remotely (ServerDescription serv)
 282 {
 283         boost::asio::io_service io_service;
 284         boost::asio::ip::tcp::resolver resolver (io_service);
 285         boost::asio::ip::tcp::resolver::query query (serv.host_name(), raw_convert<string> (Config::instance()->server_port_base ()));
 286         boost::asio::ip::tcp::resolver::iterator endpoint_iterator = resolver.resolve (query);
 287
 288         shared_ptr<Socket> socket (new Socket);
 289
 290         socket->connect (*endpoint_iterator);
 291
 292         /* Collect all XML metadata */
 293         xmlpp::Document doc;
 294         xmlpp::Element* root = doc.create_root_node ("EncodingRequest");
 295         root->add_child("Version")->add_child_text (raw_convert<string> (SERVER_LINK_VERSION));
 296         add_metadata (root);
 297
 298         LOG_GENERAL (N_("Sending frame %1 to remote"), _index);
 299
 300         /* Send XML metadata */
 301         stringstream xml;
 302         doc.write_to_stream (xml, "UTF-8");
 303         socket->write (xml.str().length() + 1);
 304         socket->write ((uint8_t *) xml.str().c_str(), xml.str().length() + 1);
 305
 306         /* Send binary data */
 307         _frame->send_binary (socket);
 308
 309         /* Read the response (JPEG2000-encoded data); this blocks until the data
 310            is ready and sent back.
 311         */
 312         shared_ptr<EncodedData> e (new RemotelyEncodedData (socket->read_uint32 ()));
 313         socket->read (e->data(), e->size());
 314
 315         LOG_GENERAL (N_("Finished remotely-encoded frame %1"), _index);
 316
 317         return e;
 318 }
 319
 320 void
 321 DCPVideoFrame::add_metadata (xmlpp::Element* el) const
 322 {
 323         el->add_child("Index")->add_child_text (raw_convert<string> (_index));
 324         el->add_child("FramesPerSecond")->add_child_text (raw_convert<string> (_frames_per_second));
 325         el->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
 326         el->add_child("Resolution")->add_child_text (raw_convert<string> (int (_resolution)));
 327         _frame->add_metadata (el);
 328 }
 329
 330 Eyes
 331 DCPVideoFrame::eyes () const
 332 {
 333         return _frame->eyes ();
 334 }
 335
 336 EncodedData::EncodedData (int s)
 337         : _data (new uint8_t[s])
 338         , _size (s)
 339 {
 340
 341 }
 342
 343 EncodedData::EncodedData (boost::filesystem::path file)
 344 {
 345         _size = boost::filesystem::file_size (file);
 346         _data = new uint8_t[_size];
 347
 348         FILE* f = fopen_boost (file, "rb");
 349         if (!f) {
 350                 throw FileError (_("could not open file for reading"), file);
 351         }
 352
 353         size_t const r = fread (_data, 1, _size, f);
 354         if (r != size_t (_size)) {
 355                 fclose (f);
 356                 throw FileError (_("could not read encoded data"), file);
 357         }
 358
 359         fclose (f);
 360 }
 361
 362
 363 EncodedData::~EncodedData ()
 364 {
 365         delete[] _data;
 366 }
 367
 368 /** Write this data to a J2K file.
 369  *  @param Film Film.
 370  *  @param frame DCP frame index.
 371  */
 372 void
 373 EncodedData::write (shared_ptr<const Film> film, int frame, Eyes eyes) const
 374 {
 375         boost::filesystem::path const tmp_j2c = film->j2c_path (frame, eyes, true);
 376
 377         FILE* f = fopen_boost (tmp_j2c, "wb");
 378
 379         if (!f) {
 380                 throw WriteFileError (tmp_j2c, errno);
 381         }
 382
 383         fwrite (_data, 1, _size, f);
 384         fclose (f);
 385
 386         boost::filesystem::path const real_j2c = film->j2c_path (frame, eyes, false);
 387
 388         /* Rename the file from foo.j2c.tmp to foo.j2c now that it is complete */
 389         boost::filesystem::rename (tmp_j2c, real_j2c);
 390 }
 391
 392 void
 393 EncodedData::write_info (shared_ptr<const Film> film, int frame, Eyes eyes, libdcp::FrameInfo fin) const
 394 {
 395         boost::filesystem::path const info = film->info_path (frame, eyes);
 396         FILE* h = fopen_boost (info, "w");
 397         fin.write (h);
 398         fclose (h);
 399 }
 400
 401 /** Send this data to a socket.
 402  *  @param socket Socket
 403  */
 404 void
 405 EncodedData::send (shared_ptr<Socket> socket)
 406 {
 407         socket->write (_size);
 408         socket->write (_data, _size);
 409 }
 410
 411 LocallyEncodedData::LocallyEncodedData (uint8_t* d, int s)
 412         : EncodedData (s)
 413 {
 414         memcpy (_data, d, s);
 415 }
 416
 417 /** @param s Size of data in bytes */
 418 RemotelyEncodedData::RemotelyEncodedData (int s)
 419         : EncodedData (s)
 420 {
 421
 422 }