src/lib/dcp_video.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 <dcp/gamma_lut.h>
  47 #include <dcp/xyz_frame.h>
  48 #include <dcp/rgb_xyz.h>
  49 #include <dcp/colour_matrix.h>
  50 #include <dcp/raw_convert.h>
  51 #include <libcxml/cxml.h>
  52 #include "film.h"
  53 #include "dcp_video.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.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::stringstream;
  70 using std::cout;
  71 using boost::shared_ptr;
  72 using boost::lexical_cast;
  73 using dcp::Size;
  74 using dcp::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 DCPVideo::DCPVideo (
  85         shared_ptr<const PlayerVideo> 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 DCPVideo::DCPVideo (shared_ptr<const PlayerVideo> 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 DCPVideo::encode_locally ()
 112 {
 113         shared_ptr<dcp::GammaLUT> in_lut = dcp::GammaLUT::cache.get (
 114                 12, _frame->colour_conversion().input_gamma, _frame->colour_conversion().input_gamma_linearised
 115                 );
 116
 117         /* XXX: libdcp should probably use boost */
 118
 119         double matrix[3][3];
 120         for (int i = 0; i < 3; ++i) {
 121                 for (int j = 0; j < 3; ++j) {
 122                         matrix[i][j] = _frame->colour_conversion().matrix (i, j);
 123                 }
 124         }
 125
 126         shared_ptr<dcp::XYZFrame> xyz = dcp::rgb_to_xyz (
 127                 _frame->image(),
 128                 in_lut,
 129                 dcp::GammaLUT::cache.get (16, 1 / _frame->colour_conversion().output_gamma, false),
 130                 matrix
 131                 );
 132
 133         /* Set the max image and component sizes based on frame_rate */
 134         int max_cs_len = ((float) _j2k_bandwidth) / 8 / _frames_per_second;
 135         if (_frame->eyes() == EYES_LEFT || _frame->eyes() == EYES_RIGHT) {
 136                 /* In 3D we have only half the normal bandwidth per eye */
 137                 max_cs_len /= 2;
 138         }
 139         int const max_comp_size = max_cs_len / 1.25;
 140
 141         /* get a J2K compressor handle */
 142         opj_cinfo_t* cinfo = opj_create_compress (CODEC_J2K);
 143         if (cinfo == 0) {
 144                 throw EncodeError (N_("could not create JPEG2000 encoder"));
 145         }
 146
 147         /* Set encoding parameters to default values */
 148         opj_cparameters_t parameters;
 149         opj_set_default_encoder_parameters (&parameters);
 150
 151         /* Set default cinema parameters */
 152         parameters.tile_size_on = false;
 153         parameters.cp_tdx = 1;
 154         parameters.cp_tdy = 1;
 155
 156         /* Tile part */
 157         parameters.tp_flag = 'C';
 158         parameters.tp_on = 1;
 159
 160         /* Tile and Image shall be at (0,0) */
 161         parameters.cp_tx0 = 0;
 162         parameters.cp_ty0 = 0;
 163         parameters.image_offset_x0 = 0;
 164         parameters.image_offset_y0 = 0;
 165
 166         /* Codeblock size = 32x32 */
 167         parameters.cblockw_init = 32;
 168         parameters.cblockh_init = 32;
 169         parameters.csty |= 0x01;
 170
 171         /* The progression order shall be CPRL */
 172         parameters.prog_order = CPRL;
 173
 174         /* No ROI */
 175         parameters.roi_compno = -1;
 176
 177         parameters.subsampling_dx = 1;
 178         parameters.subsampling_dy = 1;
 179
 180         /* 9-7 transform */
 181         parameters.irreversible = 1;
 182
 183         parameters.tcp_rates[0] = 0;
 184         parameters.tcp_numlayers++;
 185         parameters.cp_disto_alloc = 1;
 186         parameters.cp_rsiz = _resolution == RESOLUTION_2K ? CINEMA2K : CINEMA4K;
 187         if (_resolution == RESOLUTION_4K) {
 188                 parameters.numpocs = 2;
 189                 parameters.POC[0].tile = 1;
 190                 parameters.POC[0].resno0 = 0;
 191                 parameters.POC[0].compno0 = 0;
 192                 parameters.POC[0].layno1 = 1;
 193                 parameters.POC[0].resno1 = parameters.numresolution - 1;
 194                 parameters.POC[0].compno1 = 3;
 195                 parameters.POC[0].prg1 = CPRL;
 196                 parameters.POC[1].tile = 1;
 197                 parameters.POC[1].resno0 = parameters.numresolution - 1;
 198                 parameters.POC[1].compno0 = 0;
 199                 parameters.POC[1].layno1 = 1;
 200                 parameters.POC[1].resno1 = parameters.numresolution;
 201                 parameters.POC[1].compno1 = 3;
 202                 parameters.POC[1].prg1 = CPRL;
 203         }
 204
 205         parameters.cp_comment = strdup (N_("DCP-o-matic"));
 206         parameters.cp_cinema = _resolution == RESOLUTION_2K ? CINEMA2K_24 : CINEMA4K_24;
 207
 208         /* 3 components, so use MCT */
 209         parameters.tcp_mct = 1;
 210
 211         /* set max image */
 212         parameters.max_comp_size = max_comp_size;
 213         parameters.tcp_rates[0] = ((float) (3 * xyz->size().width * xyz->size().height * 12)) / (max_cs_len * 8);
 214
 215         /* Set event manager to null (openjpeg 1.3 bug) */
 216         cinfo->event_mgr = 0;
 217
 218         /* Setup the encoder parameters using the current image and user parameters */
 219         opj_setup_encoder (cinfo, &parameters, xyz->opj_image ());
 220
 221         opj_cio_t* cio = opj_cio_open ((opj_common_ptr) cinfo, 0, 0);
 222         if (cio == 0) {
 223                 opj_destroy_compress (cinfo);
 224                 throw EncodeError (N_("could not open JPEG2000 stream"));
 225         }
 226
 227         int const r = opj_encode (cinfo, cio, xyz->opj_image(), 0);
 228         if (r == 0) {
 229                 opj_cio_close (cio);
 230                 opj_destroy_compress (cinfo);
 231                 throw EncodeError (N_("JPEG2000 encoding failed"));
 232         }
 233
 234         switch (_frame->eyes()) {
 235         case EYES_BOTH:
 236                 LOG_GENERAL (N_("Finished locally-encoded frame %1 for mono"), _index);
 237                 break;
 238         case EYES_LEFT:
 239                 LOG_GENERAL (N_("Finished locally-encoded frame %1 for L"), _index);
 240                 break;
 241         case EYES_RIGHT:
 242                 LOG_GENERAL (N_("Finished locally-encoded frame %1 for R"), _index);
 243                 break;
 244         default:
 245                 break;
 246         }
 247
 248         shared_ptr<EncodedData> enc (new LocallyEncodedData (cio->buffer, cio_tell (cio)));
 249
 250         opj_cio_close (cio);
 251         free (parameters.cp_comment);
 252         opj_destroy_compress (cinfo);
 253
 254         return enc;
 255 }
 256
 257 /** Send this frame to a remote server for J2K encoding, then read the result.
 258  *  @param serv Server to send to.
 259  *  @return Encoded data.
 260  */
 261 shared_ptr<EncodedData>
 262 DCPVideo::encode_remotely (ServerDescription serv)
 263 {
 264         boost::asio::io_service io_service;
 265         boost::asio::ip::tcp::resolver resolver (io_service);
 266         boost::asio::ip::tcp::resolver::query query (serv.host_name(), raw_convert<string> (Config::instance()->server_port_base ()));
 267         boost::asio::ip::tcp::resolver::iterator endpoint_iterator = resolver.resolve (query);
 268
 269         shared_ptr<Socket> socket (new Socket);
 270
 271         socket->connect (*endpoint_iterator);
 272
 273         /* Collect all XML metadata */
 274         xmlpp::Document doc;
 275         xmlpp::Element* root = doc.create_root_node ("EncodingRequest");
 276         root->add_child("Version")->add_child_text (raw_convert<string> (SERVER_LINK_VERSION));
 277         add_metadata (root);
 278
 279         LOG_GENERAL (N_("Sending frame %1 to remote"), _index);
 280
 281         /* Send XML metadata */
 282         stringstream xml;
 283         doc.write_to_stream (xml, "UTF-8");
 284         socket->write (xml.str().length() + 1);
 285         socket->write ((uint8_t *) xml.str().c_str(), xml.str().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 DCPVideo::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 DCPVideo::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, dcp::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 }