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