Logging improvements to allow prettier displays in the server GUI.
[dcpomatic.git] / src / lib / dcp_video.cc
index 8ea5cec884a6db4de833e1bde8c1544679615f6b..35cc282fd6f6780ad3730bbf282d01e1e5858415 100644 (file)
@@ -1,5 +1,6 @@
 /*
-    Copyright (C) 2013-2014 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
+    Taken from code Copyright (C) 2010-2011 Terrence Meiczinger
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
 
 */
 
+/** @file  src/dcp_video_frame.cc
+ *  @brief A single frame of video destined for a DCP.
+ *
+ *  Given an Image and some settings, this class knows how to encode
+ *  the image to J2K either on the local host or on a remote server.
+ *
+ *  Objects of this class are used for the queue that we keep
+ *  of images that require encoding.
+ */
+
 #include "dcp_video.h"
+#include "config.h"
+#include "exceptions.h"
+#include "server_description.h"
+#include "dcpomatic_socket.h"
 #include "image.h"
+#include "log.h"
+#include "cross.h"
+#include "player_video.h"
+#include "raw_convert.h"
+#include "data.h"
+#include "compose.hpp"
+#include <libcxml/cxml.h>
+#include <dcp/openjpeg_image.h>
+#include <dcp/rgb_xyz.h>
+#include <dcp/colour_matrix.h>
+#include <libxml++/libxml++.h>
+#include <boost/asio.hpp>
+#include <boost/thread.hpp>
+#include <stdint.h>
+#include <iomanip>
+#include <iostream>
+
+#define LOG_GENERAL(...) _log->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
+#define LOG_DEBUG_ENCODE(...) _log->log (String::compose (__VA_ARGS__), LogEntry::TYPE_DEBUG_ENCODE);
+#define LOG_TIMING(...) _log->log (String::compose (__VA_ARGS__), LogEntry::TYPE_TIMING);
 
+#include "i18n.h"
+
+using std::string;
+using std::cout;
 using boost::shared_ptr;
+using dcp::Size;
 
-/** From ContentVideo:
- *  @param in Image.
- *  @param eyes Eye(s) that the Image is for.
- *
- *  From Content:
- *  @param crop Crop to apply.
- *  @param inter_size
- *  @param out_size
- *  @param scaler Scaler to use.
- *  @param conversion Colour conversion to use.
- *
- *  @param time DCP time.
+#define DCI_COEFFICENT (48.0 / 52.37)
+
+/** Construct a DCP video frame.
+ *  @param frame Input frame.
+ *  @param index Index of the frame within the DCP.
+ *  @param bw J2K bandwidth to use (see Config::j2k_bandwidth ())
+ *  @param l Log to write to.
  */
 DCPVideo::DCPVideo (
-       shared_ptr<const Image> in,
-       Eyes eyes,
-       Crop crop,
-       dcp::Size inter_size,
-       dcp::Size out_size,
-       Scaler const * scaler,
-       ColourConversion conversion,
-       DCPTime time
+       shared_ptr<const PlayerVideo> frame, int index, int dcp_fps, int bw, Resolution r, shared_ptr<Log> l
        )
-       : _in (in)
-       , _eyes (eyes)
-       , _crop (crop)
-       , _inter_size (inter_size)
-       , _out_size (out_size)
-       , _scaler (scaler)
-       , _conversion (conversion)
-       , _time (time)
+       : _frame (frame)
+       , _index (index)
+       , _frames_per_second (dcp_fps)
+       , _j2k_bandwidth (bw)
+       , _resolution (r)
+       , _log (l)
 {
 
 }
 
-void
-DCPVideo::set_subtitle (PositionImage s)
+DCPVideo::DCPVideo (shared_ptr<const PlayerVideo> frame, shared_ptr<const cxml::Node> node, shared_ptr<Log> log)
+       : _frame (frame)
+       , _log (log)
+{
+       _index = node->number_child<int> ("Index");
+       _frames_per_second = node->number_child<int> ("FramesPerSecond");
+       _j2k_bandwidth = node->number_child<int> ("J2KBandwidth");
+       _resolution = Resolution (node->optional_number_child<int>("Resolution").get_value_or (RESOLUTION_2K));
+}
+
+shared_ptr<dcp::OpenJPEGImage>
+DCPVideo::convert_to_xyz (shared_ptr<const PlayerVideo> frame, dcp::NoteHandler note)
 {
-       _subtitle = s;
+       shared_ptr<dcp::OpenJPEGImage> xyz;
+
+       shared_ptr<Image> image = frame->image (AV_PIX_FMT_RGB48LE, note);
+       if (frame->colour_conversion()) {
+               xyz = dcp::rgb_to_xyz (
+                       image->data()[0],
+                       image->size(),
+                       image->stride()[0],
+                       frame->colour_conversion().get(),
+                       note
+                       );
+       } else {
+               xyz = dcp::xyz_to_xyz (image->data()[0], image->size(), image->stride()[0]);
+       }
+
+       return xyz;
 }
 
-shared_ptr<Image>
-DCPVideo::image (AVPixelFormat format, bool aligned) const
+/** J2K-encode this frame on the local host.
+ *  @return Encoded data.
+ */
+Data
+DCPVideo::encode_locally (dcp::NoteHandler note)
 {
-       shared_ptr<Image> out = _in->crop_scale_window (_crop, _inter_size, _out_size, _scaler, format, aligned);
-       
-       Position<int> const container_offset ((_out_size.width - _inter_size.width) / 2, (_out_size.height - _inter_size.width) / 2);
+       shared_ptr<dcp::OpenJPEGImage> xyz = convert_to_xyz (_frame, note);
+
+       /* Set the max image and component sizes based on frame_rate */
+       int max_cs_len = ((float) _j2k_bandwidth) / 8 / _frames_per_second;
+       if (_frame->eyes() == EYES_LEFT || _frame->eyes() == EYES_RIGHT) {
+               /* In 3D we have only half the normal bandwidth per eye */
+               max_cs_len /= 2;
+       }
+       int const max_comp_size = max_cs_len / 1.25;
+
+       /* get a J2K compressor handle */
+       opj_cinfo_t* cinfo = opj_create_compress (CODEC_J2K);
+       if (cinfo == 0) {
+               throw EncodeError (N_("could not create JPEG2000 encoder"));
+       }
+
+       /* Set encoding parameters to default values */
+       opj_cparameters_t parameters;
+       opj_set_default_encoder_parameters (&parameters);
+
+       /* Set default cinema parameters */
+       parameters.tile_size_on = false;
+       parameters.cp_tdx = 1;
+       parameters.cp_tdy = 1;
+
+       /* Tile part */
+       parameters.tp_flag = 'C';
+       parameters.tp_on = 1;
+
+       /* Tile and Image shall be at (0,0) */
+       parameters.cp_tx0 = 0;
+       parameters.cp_ty0 = 0;
+       parameters.image_offset_x0 = 0;
+       parameters.image_offset_y0 = 0;
+
+       /* Codeblock size = 32x32 */
+       parameters.cblockw_init = 32;
+       parameters.cblockh_init = 32;
+       parameters.csty |= 0x01;
+
+       /* The progression order shall be CPRL */
+       parameters.prog_order = CPRL;
+
+       /* No ROI */
+       parameters.roi_compno = -1;
+
+       parameters.subsampling_dx = 1;
+       parameters.subsampling_dy = 1;
+
+       /* 9-7 transform */
+       parameters.irreversible = 1;
+
+       parameters.tcp_rates[0] = 0;
+       parameters.tcp_numlayers++;
+       parameters.cp_disto_alloc = 1;
+       parameters.cp_rsiz = _resolution == RESOLUTION_2K ? CINEMA2K : CINEMA4K;
+       if (_resolution == RESOLUTION_4K) {
+               parameters.numpocs = 2;
+               parameters.POC[0].tile = 1;
+               parameters.POC[0].resno0 = 0;
+               parameters.POC[0].compno0 = 0;
+               parameters.POC[0].layno1 = 1;
+               parameters.POC[0].resno1 = parameters.numresolution - 1;
+               parameters.POC[0].compno1 = 3;
+               parameters.POC[0].prg1 = CPRL;
+               parameters.POC[1].tile = 1;
+               parameters.POC[1].resno0 = parameters.numresolution - 1;
+               parameters.POC[1].compno0 = 0;
+               parameters.POC[1].layno1 = 1;
+               parameters.POC[1].resno1 = parameters.numresolution;
+               parameters.POC[1].compno1 = 3;
+               parameters.POC[1].prg1 = CPRL;
+       }
+
+       parameters.cp_comment = strdup (N_("DCP-o-matic"));
+       parameters.cp_cinema = _resolution == RESOLUTION_2K ? CINEMA2K_24 : CINEMA4K_24;
+
+       /* 3 components, so use MCT */
+       parameters.tcp_mct = 1;
 
-       if (_subtitle.image) {
-               out->alpha_blend (_subtitle.image, _subtitle.position);
+       /* set max image */
+       parameters.max_comp_size = max_comp_size;
+       parameters.tcp_rates[0] = ((float) (3 * xyz->size().width * xyz->size().height * 12)) / (max_cs_len * 8);
+
+       /* Set event manager to null (openjpeg 1.3 bug) */
+       cinfo->event_mgr = 0;
+
+       /* Setup the encoder parameters using the current image and user parameters */
+       opj_setup_encoder (cinfo, &parameters, xyz->opj_image ());
+
+       opj_cio_t* cio = opj_cio_open ((opj_common_ptr) cinfo, 0, 0);
+       if (cio == 0) {
+               opj_destroy_compress (cinfo);
+               throw EncodeError (N_("could not open JPEG2000 stream"));
+       }
+
+       int const r = opj_encode (cinfo, cio, xyz->opj_image(), 0);
+       if (r == 0) {
+               opj_cio_close (cio);
+               opj_destroy_compress (cinfo);
+               throw EncodeError (N_("JPEG2000 encoding failed"));
        }
 
-       return out;
+       switch (_frame->eyes()) {
+       case EYES_BOTH:
+               LOG_DEBUG_ENCODE (N_("Finished locally-encoded frame %1 for mono"), _index);
+               break;
+       case EYES_LEFT:
+               LOG_DEBUG_ENCODE (N_("Finished locally-encoded frame %1 for L"), _index);
+               break;
+       case EYES_RIGHT:
+               LOG_DEBUG_ENCODE (N_("Finished locally-encoded frame %1 for R"), _index);
+               break;
+       default:
+               break;
+       }
+
+       Data enc (cio->buffer, cio_tell (cio));
+
+       opj_cio_close (cio);
+       free (parameters.cp_comment);
+       opj_destroy_compress (cinfo);
+
+       return enc;
+}
+
+/** Send this frame to a remote server for J2K encoding, then read the result.
+ *  @param serv Server to send to.
+ *  @return Encoded data.
+ */
+Data
+DCPVideo::encode_remotely (ServerDescription serv)
+{
+       boost::asio::io_service io_service;
+       boost::asio::ip::tcp::resolver resolver (io_service);
+       boost::asio::ip::tcp::resolver::query query (serv.host_name(), raw_convert<string> (Config::instance()->server_port_base ()));
+       boost::asio::ip::tcp::resolver::iterator endpoint_iterator = resolver.resolve (query);
+
+       shared_ptr<Socket> socket (new Socket);
+
+       socket->connect (*endpoint_iterator);
+
+       /* Collect all XML metadata */
+       xmlpp::Document doc;
+       xmlpp::Element* root = doc.create_root_node ("EncodingRequest");
+       root->add_child("Version")->add_child_text (raw_convert<string> (SERVER_LINK_VERSION));
+       add_metadata (root);
+
+       LOG_DEBUG_ENCODE (N_("Sending frame %1 to remote"), _index);
+
+       /* Send XML metadata */
+       string xml = doc.write_to_string ("UTF-8");
+       socket->write (xml.length() + 1);
+       socket->write ((uint8_t *) xml.c_str(), xml.length() + 1);
+
+       /* Send binary data */
+       LOG_TIMING("start-remote-send thread=%1", boost::this_thread::get_id());
+       _frame->send_binary (socket);
+
+       /* Read the response (JPEG2000-encoded data); this blocks until the data
+          is ready and sent back.
+       */
+       LOG_TIMING("start-remote-encode thread=%1", boost::this_thread::get_id ());
+       Data e (socket->read_uint32 ());
+       LOG_TIMING("start-remote-receive thread=%1", boost::this_thread::get_id ());
+       socket->read (e.data().get(), e.size());
+       LOG_TIMING("finish-remote-receive thread=%1", boost::this_thread::get_id ());
+
+       LOG_DEBUG_ENCODE (N_("Finished remotely-encoded frame %1"), _index);
+
+       return e;
+}
+
+void
+DCPVideo::add_metadata (xmlpp::Element* el) const
+{
+       el->add_child("Index")->add_child_text (raw_convert<string> (_index));
+       el->add_child("FramesPerSecond")->add_child_text (raw_convert<string> (_frames_per_second));
+       el->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
+       el->add_child("Resolution")->add_child_text (raw_convert<string> (int (_resolution)));
+       _frame->add_metadata (el);
 }
 
+Eyes
+DCPVideo::eyes () const
+{
+       return _frame->eyes ();
+}
+
+/** @return true if this DCPVideo is definitely the same as another;
+ *  (apart from the frame index), false if it is probably not.
+ */
+bool
+DCPVideo::same (shared_ptr<const DCPVideo> other) const
+{
+       if (_frames_per_second != other->_frames_per_second ||
+           _j2k_bandwidth != other->_j2k_bandwidth ||
+           _resolution != other->_resolution) {
+               return false;
+       }
+
+       return _frame->same (other->_frame);
+}