src/lib/dcp_video.cc

   1 /*
   2     Copyright (C) 2012-2015 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 "dcp_video.h"
  32 #include "config.h"
  33 #include "exceptions.h"
  34 #include "server.h"
  35 #include "dcpomatic_socket.h"
  36 #include "image.h"
  37 #include "log.h"
  38 #include "cross.h"
  39 #include "player_video.h"
  40 #include "raw_convert.h"
  41 #include "data.h"
  42 #include <libcxml/cxml.h>
  43 #include <dcp/xyz_image.h>
  44 #include <dcp/rgb_xyz.h>
  45 #include <dcp/colour_matrix.h>
  46 #include <boost/array.hpp>
  47 #include <boost/asio.hpp>
  48 #include <boost/filesystem.hpp>
  49 #include <boost/lexical_cast.hpp>
  50 #include <stdint.h>
  51 #include <cstring>
  52 #include <cstdlib>
  53 #include <stdexcept>
  54 #include <cstdio>
  55 #include <iomanip>
  56 #include <iostream>
  57 #include <fstream>
  58 #include <unistd.h>
  59 #include <errno.h>
  60
  61 #define LOG_GENERAL(...) _log->log (String::compose (__VA_ARGS__), Log::TYPE_GENERAL);
  62
  63 #include "i18n.h"
  64
  65 using std::string;
  66 using std::cout;
  67 using boost::shared_ptr;
  68 using boost::lexical_cast;
  69 using dcp::Size;
  70
  71 #define DCI_COEFFICENT (48.0 / 52.37)
  72
  73 /** Construct a DCP video frame.
  74  *  @param frame Input frame.
  75  *  @param index Index of the frame within the DCP.
  76  *  @param bw J2K bandwidth to use (see Config::j2k_bandwidth ())
  77  *  @param l Log to write to.
  78  */
  79 DCPVideo::DCPVideo (
  80         shared_ptr<const PlayerVideo> frame, int index, int dcp_fps, int bw, Resolution r, bool b, shared_ptr<Log> l
  81         )
  82         : _frame (frame)
  83         , _index (index)
  84         , _frames_per_second (dcp_fps)
  85         , _j2k_bandwidth (bw)
  86         , _resolution (r)
  87         , _burn_subtitles (b)
  88         , _log (l)
  89 {
  90
  91 }
  92
  93 DCPVideo::DCPVideo (shared_ptr<const PlayerVideo> frame, shared_ptr<const cxml::Node> node, shared_ptr<Log> log)
  94         : _frame (frame)
  95         , _log (log)
  96 {
  97         _index = node->number_child<int> ("Index");
  98         _frames_per_second = node->number_child<int> ("FramesPerSecond");
  99         _j2k_bandwidth = node->number_child<int> ("J2KBandwidth");
 100         _resolution = Resolution (node->optional_number_child<int>("Resolution").get_value_or (RESOLUTION_2K));
 101         _burn_subtitles = node->bool_child ("BurnSubtitles");
 102 }
 103
 104 /** J2K-encode this frame on the local host.
 105  *  @return Encoded data.
 106  */
 107 shared_ptr<Data>
 108 DCPVideo::encode_locally (dcp::NoteHandler note)
 109 {
 110         shared_ptr<dcp::XYZImage> xyz;
 111
 112         shared_ptr<Image> image = _frame->image (AV_PIX_FMT_RGB48LE, _burn_subtitles, note);
 113         if (_frame->colour_conversion()) {
 114                 xyz = dcp::rgb_to_xyz (
 115                         image->data()[0],
 116                         image->size(),
 117                         image->stride()[0],
 118                         _frame->colour_conversion().get()
 119                         );
 120         } else {
 121                 xyz = dcp::xyz_to_xyz (image->data()[0], image->size(), image->stride()[0]);
 122         }
 123
 124         /* Set the max image and component sizes based on frame_rate */
 125         int max_cs_len = ((float) _j2k_bandwidth) / 8 / _frames_per_second;
 126         if (_frame->eyes() == EYES_LEFT || _frame->eyes() == EYES_RIGHT) {
 127                 /* In 3D we have only half the normal bandwidth per eye */
 128                 max_cs_len /= 2;
 129         }
 130         int const max_comp_size = max_cs_len / 1.25;
 131
 132         /* get a J2K compressor handle */
 133         opj_cinfo_t* cinfo = opj_create_compress (CODEC_J2K);
 134         if (cinfo == 0) {
 135                 throw EncodeError (N_("could not create JPEG2000 encoder"));
 136         }
 137
 138         /* Set encoding parameters to default values */
 139         opj_cparameters_t parameters;
 140         opj_set_default_encoder_parameters (&parameters);
 141
 142         /* Set default cinema parameters */
 143         parameters.tile_size_on = false;
 144         parameters.cp_tdx = 1;
 145         parameters.cp_tdy = 1;
 146
 147         /* Tile part */
 148         parameters.tp_flag = 'C';
 149         parameters.tp_on = 1;
 150
 151         /* Tile and Image shall be at (0,0) */
 152         parameters.cp_tx0 = 0;
 153         parameters.cp_ty0 = 0;
 154         parameters.image_offset_x0 = 0;
 155         parameters.image_offset_y0 = 0;
 156
 157         /* Codeblock size = 32x32 */
 158         parameters.cblockw_init = 32;
 159         parameters.cblockh_init = 32;
 160         parameters.csty |= 0x01;
 161
 162         /* The progression order shall be CPRL */
 163         parameters.prog_order = CPRL;
 164
 165         /* No ROI */
 166         parameters.roi_compno = -1;
 167
 168         parameters.subsampling_dx = 1;
 169         parameters.subsampling_dy = 1;
 170
 171         /* 9-7 transform */
 172         parameters.irreversible = 1;
 173
 174         parameters.tcp_rates[0] = 0;
 175         parameters.tcp_numlayers++;
 176         parameters.cp_disto_alloc = 1;
 177         parameters.cp_rsiz = _resolution == RESOLUTION_2K ? CINEMA2K : CINEMA4K;
 178         if (_resolution == RESOLUTION_4K) {
 179                 parameters.numpocs = 2;
 180                 parameters.POC[0].tile = 1;
 181                 parameters.POC[0].resno0 = 0;
 182                 parameters.POC[0].compno0 = 0;
 183                 parameters.POC[0].layno1 = 1;
 184                 parameters.POC[0].resno1 = parameters.numresolution - 1;
 185                 parameters.POC[0].compno1 = 3;
 186                 parameters.POC[0].prg1 = CPRL;
 187                 parameters.POC[1].tile = 1;
 188                 parameters.POC[1].resno0 = parameters.numresolution - 1;
 189                 parameters.POC[1].compno0 = 0;
 190                 parameters.POC[1].layno1 = 1;
 191                 parameters.POC[1].resno1 = parameters.numresolution;
 192                 parameters.POC[1].compno1 = 3;
 193                 parameters.POC[1].prg1 = CPRL;
 194         }
 195
 196         parameters.cp_comment = strdup (N_("DCP-o-matic"));
 197         parameters.cp_cinema = _resolution == RESOLUTION_2K ? CINEMA2K_24 : CINEMA4K_24;
 198
 199         /* 3 components, so use MCT */
 200         parameters.tcp_mct = 1;
 201
 202         /* set max image */
 203         parameters.max_comp_size = max_comp_size;
 204         parameters.tcp_rates[0] = ((float) (3 * xyz->size().width * xyz->size().height * 12)) / (max_cs_len * 8);
 205
 206         /* Set event manager to null (openjpeg 1.3 bug) */
 207         cinfo->event_mgr = 0;
 208
 209         /* Setup the encoder parameters using the current image and user parameters */
 210         opj_setup_encoder (cinfo, &parameters, xyz->opj_image ());
 211
 212         opj_cio_t* cio = opj_cio_open ((opj_common_ptr) cinfo, 0, 0);
 213         if (cio == 0) {
 214                 opj_destroy_compress (cinfo);
 215                 throw EncodeError (N_("could not open JPEG2000 stream"));
 216         }
 217
 218         int const r = opj_encode (cinfo, cio, xyz->opj_image(), 0);
 219         if (r == 0) {
 220                 opj_cio_close (cio);
 221                 opj_destroy_compress (cinfo);
 222                 throw EncodeError (N_("JPEG2000 encoding failed"));
 223         }
 224
 225         switch (_frame->eyes()) {
 226         case EYES_BOTH:
 227                 LOG_GENERAL (N_("Finished locally-encoded frame %1 for mono"), _index);
 228                 break;
 229         case EYES_LEFT:
 230                 LOG_GENERAL (N_("Finished locally-encoded frame %1 for L"), _index);
 231                 break;
 232         case EYES_RIGHT:
 233                 LOG_GENERAL (N_("Finished locally-encoded frame %1 for R"), _index);
 234                 break;
 235         default:
 236                 break;
 237         }
 238
 239         shared_ptr<Data> enc (new Data (cio->buffer, cio_tell (cio)));
 240
 241         opj_cio_close (cio);
 242         free (parameters.cp_comment);
 243         opj_destroy_compress (cinfo);
 244
 245         return enc;
 246 }
 247
 248 /** Send this frame to a remote server for J2K encoding, then read the result.
 249  *  @param serv Server to send to.
 250  *  @return Encoded data.
 251  */
 252 shared_ptr<Data>
 253 DCPVideo::encode_remotely (ServerDescription serv)
 254 {
 255         boost::asio::io_service io_service;
 256         boost::asio::ip::tcp::resolver resolver (io_service);
 257         boost::asio::ip::tcp::resolver::query query (serv.host_name(), raw_convert<string> (Config::instance()->server_port_base ()));
 258         boost::asio::ip::tcp::resolver::iterator endpoint_iterator = resolver.resolve (query);
 259
 260         shared_ptr<Socket> socket (new Socket);
 261
 262         socket->connect (*endpoint_iterator);
 263
 264         /* Collect all XML metadata */
 265         xmlpp::Document doc;
 266         xmlpp::Element* root = doc.create_root_node ("EncodingRequest");
 267         root->add_child("Version")->add_child_text (raw_convert<string> (SERVER_LINK_VERSION));
 268         add_metadata (root);
 269
 270         LOG_GENERAL (N_("Sending frame %1 to remote"), _index);
 271
 272         /* Send XML metadata */
 273         string xml = doc.write_to_string ("UTF-8");
 274         socket->write (xml.length() + 1);
 275         socket->write ((uint8_t *) xml.c_str(), xml.length() + 1);
 276
 277         /* Send binary data */
 278         _frame->send_binary (socket, _burn_subtitles);
 279
 280         /* Read the response (JPEG2000-encoded data); this blocks until the data
 281            is ready and sent back.
 282         */
 283         shared_ptr<Data> e (new Data (socket->read_uint32 ()));
 284         socket->read (e->data().get(), e->size());
 285
 286         LOG_GENERAL (N_("Finished remotely-encoded frame %1"), _index);
 287
 288         return e;
 289 }
 290
 291 void
 292 DCPVideo::add_metadata (xmlpp::Element* el) const
 293 {
 294         el->add_child("Index")->add_child_text (raw_convert<string> (_index));
 295         el->add_child("FramesPerSecond")->add_child_text (raw_convert<string> (_frames_per_second));
 296         el->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
 297         el->add_child("Resolution")->add_child_text (raw_convert<string> (int (_resolution)));
 298         el->add_child("BurnSubtitles")->add_child_text (_burn_subtitles ? "1" : "0");
 299         _frame->add_metadata (el, _burn_subtitles);
 300 }
 301
 302 Eyes
 303 DCPVideo::eyes () const
 304 {
 305         return _frame->eyes ();
 306 }
 307
 308 /** @return true if this DCPVideo is definitely the same as another;
 309  *  (apart from the frame index), false if it is probably not.
 310  */
 311 bool
 312 DCPVideo::same (shared_ptr<const DCPVideo> other) const
 313 {
 314         if (_frames_per_second != other->_frames_per_second ||
 315             _j2k_bandwidth != other->_j2k_bandwidth ||
 316             _resolution != other->_resolution ||
 317             _burn_subtitles != other->_burn_subtitles) {
 318                 return false;
 319         }
 320
 321         return _frame->same (other->_frame);
 322 }