src/lib/dcp_video_frame.cc

   1 /*
   2     Copyright (C) 2012 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 <libdcp/rec709_linearised_gamma_lut.h>
  47 #include <libdcp/srgb_linearised_gamma_lut.h>
  48 #include <libdcp/gamma_lut.h>
  49 #include <libdcp/xyz_frame.h>
  50 #include <libdcp/rgb_xyz.h>
  51 #include <libdcp/colour_matrix.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
  62 #include "i18n.h"
  63
  64 using std::string;
  65 using std::stringstream;
  66 using std::ofstream;
  67 using std::cout;
  68 using boost::shared_ptr;
  69 using libdcp::Size;
  70
  71 #define DCI_COEFFICENT (48.0 / 52.37)
  72
  73 /** Construct a DCP video frame.
  74  *  @param input Input image.
  75  *  @param f 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 DCPVideoFrame::DCPVideoFrame (
  80         shared_ptr<const Image> image, int f, int dcp_fps, int bw, shared_ptr<Log> l
  81         )
  82         : _image (image)
  83         , _frame (f)
  84         , _frames_per_second (dcp_fps)
  85         , _j2k_bandwidth (bw)
  86         , _log (l)
  87         , _parameters (0)
  88         , _cinfo (0)
  89         , _cio (0)
  90 {
  91
  92 }
  93
  94 DCPVideoFrame::~DCPVideoFrame ()
  95 {
  96         if (_cio) {
  97                 opj_cio_close (_cio);
  98         }
  99
 100         if (_cinfo) {
 101                 opj_destroy_compress (_cinfo);
 102         }
 103
 104         if (_parameters) {
 105                 free (_parameters->cp_comment);
 106         }
 107
 108         delete _parameters;
 109 }
 110
 111 /** J2K-encode this frame on the local host.
 112  *  @return Encoded data.
 113  */
 114 shared_ptr<EncodedData>
 115 DCPVideoFrame::encode_locally ()
 116 {
 117         shared_ptr<libdcp::XYZFrame> xyz = libdcp::rgb_to_xyz (
 118                 _image,
 119                 libdcp::SRGBLinearisedGammaLUT::cache.get (12, 2.4),
 120                 libdcp::GammaLUT::cache.get (16, 1 / 2.6),
 121                 libdcp::colour_matrix::srgb_to_xyz
 122                 );
 123
 124         /* Set the max image and component sizes based on frame_rate */
 125         int const max_cs_len = ((float) _j2k_bandwidth) / 8 / _frames_per_second;
 126         int const max_comp_size = max_cs_len / 1.25;
 127
 128         /* Set encoding parameters to default values */
 129         _parameters = new opj_cparameters_t;
 130         opj_set_default_encoder_parameters (_parameters);
 131
 132         /* Set default cinema parameters */
 133         _parameters->tile_size_on = false;
 134         _parameters->cp_tdx = 1;
 135         _parameters->cp_tdy = 1;
 136
 137         /* Tile part */
 138         _parameters->tp_flag = 'C';
 139         _parameters->tp_on = 1;
 140
 141         /* Tile and Image shall be at (0,0) */
 142         _parameters->cp_tx0 = 0;
 143         _parameters->cp_ty0 = 0;
 144         _parameters->image_offset_x0 = 0;
 145         _parameters->image_offset_y0 = 0;
 146
 147         /* Codeblock size = 32x32 */
 148         _parameters->cblockw_init = 32;
 149         _parameters->cblockh_init = 32;
 150         _parameters->csty |= 0x01;
 151
 152         /* The progression order shall be CPRL */
 153         _parameters->prog_order = CPRL;
 154
 155         /* No ROI */
 156         _parameters->roi_compno = -1;
 157
 158         _parameters->subsampling_dx = 1;
 159         _parameters->subsampling_dy = 1;
 160
 161         /* 9-7 transform */
 162         _parameters->irreversible = 1;
 163
 164         _parameters->tcp_rates[0] = 0;
 165         _parameters->tcp_numlayers++;
 166         _parameters->cp_disto_alloc = 1;
 167         _parameters->cp_rsiz = CINEMA2K;
 168         _parameters->cp_comment = strdup (N_("DCP-o-matic"));
 169         _parameters->cp_cinema = CINEMA2K_24;
 170
 171         /* 3 components, so use MCT */
 172         _parameters->tcp_mct = 1;
 173
 174         /* set max image */
 175         _parameters->max_comp_size = max_comp_size;
 176         _parameters->tcp_rates[0] = ((float) (3 * xyz->size().width * xyz->size().height * 12)) / (max_cs_len * 8);
 177
 178         /* get a J2K compressor handle */
 179         _cinfo = opj_create_compress (CODEC_J2K);
 180         if (_cinfo == 0) {
 181                 throw EncodeError (N_("could not create JPEG2000 encoder"));
 182         }
 183
 184         /* Set event manager to null (openjpeg 1.3 bug) */
 185         _cinfo->event_mgr = 0;
 186
 187         /* Setup the encoder parameters using the current image and user parameters */
 188         opj_setup_encoder (_cinfo, _parameters, xyz->opj_image ());
 189
 190         _cio = opj_cio_open ((opj_common_ptr) _cinfo, 0, 0);
 191         if (_cio == 0) {
 192                 throw EncodeError (N_("could not open JPEG2000 stream"));
 193         }
 194
 195         int const r = opj_encode (_cinfo, _cio, xyz->opj_image(), 0);
 196         if (r == 0) {
 197                 throw EncodeError (N_("JPEG2000 encoding failed"));
 198         }
 199
 200         _log->log (String::compose (N_("Finished locally-encoded frame %1"), _frame));
 201
 202         return shared_ptr<EncodedData> (new LocallyEncodedData (_cio->buffer, cio_tell (_cio)));
 203 }
 204
 205 /** Send this frame to a remote server for J2K encoding, then read the result.
 206  *  @param serv Server to send to.
 207  *  @return Encoded data.
 208  */
 209 shared_ptr<EncodedData>
 210 DCPVideoFrame::encode_remotely (ServerDescription const * serv)
 211 {
 212         boost::asio::io_service io_service;
 213         boost::asio::ip::tcp::resolver resolver (io_service);
 214         boost::asio::ip::tcp::resolver::query query (serv->host_name(), boost::lexical_cast<string> (Config::instance()->server_port ()));
 215         boost::asio::ip::tcp::resolver::iterator endpoint_iterator = resolver.resolve (query);
 216
 217         shared_ptr<Socket> socket (new Socket);
 218
 219         socket->connect (*endpoint_iterator);
 220
 221         stringstream s;
 222         s << N_("encode please\n")
 223           << N_("width ") << _image->size().width << N_("\n")
 224           << N_("height ") << _image->size().height << N_("\n")
 225           << N_("frame ") << _frame << N_("\n")
 226           << N_("frames_per_second ") << _frames_per_second << N_("\n")
 227           << N_("j2k_bandwidth ") << _j2k_bandwidth << N_("\n");
 228
 229         _log->log (String::compose (
 230                            N_("Sending to remote; pixel format %1, components %2, lines (%3,%4,%5), line sizes (%6,%7,%8)"),
 231                            _image->pixel_format(), _image->components(),
 232                            _image->lines(0), _image->lines(1), _image->lines(2),
 233                            _image->line_size()[0], _image->line_size()[1], _image->line_size()[2]
 234                            ));
 235
 236         socket->write (s.str().length() + 1);
 237         socket->write ((uint8_t *) s.str().c_str(), s.str().length() + 1);
 238
 239         _image->write_to_socket (socket);
 240
 241         shared_ptr<EncodedData> e (new RemotelyEncodedData (socket->read_uint32 ()));
 242         socket->read (e->data(), e->size());
 243
 244         _log->log (String::compose (N_("Finished remotely-encoded frame %1"), _frame));
 245
 246         return e;
 247 }
 248
 249 EncodedData::EncodedData (int s)
 250         : _data (new uint8_t[s])
 251         , _size (s)
 252 {
 253
 254 }
 255
 256 EncodedData::EncodedData (string file)
 257 {
 258         _size = boost::filesystem::file_size (file);
 259         _data = new uint8_t[_size];
 260
 261         FILE* f = fopen (file.c_str(), N_("rb"));
 262         if (!f) {
 263                 throw FileError (_("could not open file for reading"), file);
 264         }
 265
 266         size_t const r = fread (_data, 1, _size, f);
 267         if (r != size_t (_size)) {
 268                 throw FileError (_("could not read encoded data"), file);
 269         }
 270
 271         fclose (f);
 272 }
 273
 274
 275 EncodedData::~EncodedData ()
 276 {
 277         delete[] _data;
 278 }
 279
 280 /** Write this data to a J2K file.
 281  *  @param Film Film.
 282  *  @param frame DCP frame index.
 283  */
 284 void
 285 EncodedData::write (shared_ptr<const Film> film, int frame) const
 286 {
 287         string const tmp_j2c = film->j2c_path (frame, true);
 288
 289         FILE* f = fopen (tmp_j2c.c_str (), N_("wb"));
 290
 291         if (!f) {
 292                 throw WriteFileError (tmp_j2c, errno);
 293         }
 294
 295         fwrite (_data, 1, _size, f);
 296         fclose (f);
 297
 298         string const real_j2c = film->j2c_path (frame, false);
 299
 300         /* Rename the file from foo.j2c.tmp to foo.j2c now that it is complete */
 301         boost::filesystem::rename (tmp_j2c, real_j2c);
 302 }
 303
 304 void
 305 EncodedData::write_info (shared_ptr<const Film> film, int frame, libdcp::FrameInfo fin) const
 306 {
 307         string const info = film->info_path (frame);
 308         ofstream h (info.c_str());
 309         fin.write (h);
 310 }
 311
 312 /** Send this data to a socket.
 313  *  @param socket Socket
 314  */
 315 void
 316 EncodedData::send (shared_ptr<Socket> socket)
 317 {
 318         socket->write (_size);
 319         socket->write (_data, _size);
 320 }
 321
 322 LocallyEncodedData::LocallyEncodedData (uint8_t* d, int s)
 323         : EncodedData (s)
 324 {
 325         memcpy (_data, d, s);
 326 }
 327
 328 /** @param s Size of data in bytes */
 329 RemotelyEncodedData::RemotelyEncodedData (int s)
 330         : EncodedData (s)
 331 {
 332
 333 }