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