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