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