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