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