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