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