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