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