src/lib/dcp_video.cc

   1 /*
   2     Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  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 "encode_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 "compose.hpp"
  42 #include <libcxml/cxml.h>
  43 #include <dcp/openjpeg_image.h>
  44 #include <dcp/rgb_xyz.h>
  45 #include <dcp/j2k.h>
  46 #include <dcp/colour_matrix.h>
  47 #include <libxml++/libxml++.h>
  48 #include <boost/asio.hpp>
  49 #include <boost/thread.hpp>
  50 #include <boost/make_shared.hpp>
  51 #include <stdint.h>
  52 #include <iomanip>
  53 #include <iostream>
  54
  55 #define LOG_GENERAL(...) _log->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
  56 #define LOG_DEBUG_ENCODE(...) _log->log (String::compose (__VA_ARGS__), LogEntry::TYPE_DEBUG_ENCODE);
  57 #define LOG_TIMING(...) _log->log (String::compose (__VA_ARGS__), LogEntry::TYPE_TIMING);
  58
  59 #include "i18n.h"
  60
  61 using std::string;
  62 using std::cout;
  63 using boost::shared_ptr;
  64 using boost::make_shared;
  65 using dcp::Size;
  66 using dcp::Data;
  67
  68 #define DCI_COEFFICENT (48.0 / 52.37)
  69
  70 /** Construct a DCP video frame.
  71  *  @param frame Input frame.
  72  *  @param index Index of the frame within the DCP.
  73  *  @param bw J2K bandwidth to use (see Config::j2k_bandwidth ())
  74  *  @param l Log to write to.
  75  */
  76 DCPVideo::DCPVideo (
  77         shared_ptr<const PlayerVideo> frame, int index, int dcp_fps, int bw, Resolution r, shared_ptr<Log> l
  78         )
  79         : _frame (frame)
  80         , _index (index)
  81         , _frames_per_second (dcp_fps)
  82         , _j2k_bandwidth (bw)
  83         , _resolution (r)
  84         , _log (l)
  85 {
  86
  87 }
  88
  89 DCPVideo::DCPVideo (shared_ptr<const PlayerVideo> frame, shared_ptr<const cxml::Node> node, shared_ptr<Log> log)
  90         : _frame (frame)
  91         , _log (log)
  92 {
  93         _index = node->number_child<int> ("Index");
  94         _frames_per_second = node->number_child<int> ("FramesPerSecond");
  95         _j2k_bandwidth = node->number_child<int> ("J2KBandwidth");
  96         _resolution = Resolution (node->optional_number_child<int>("Resolution").get_value_or (RESOLUTION_2K));
  97 }
  98
  99 shared_ptr<dcp::OpenJPEGImage>
 100 DCPVideo::convert_to_xyz (shared_ptr<const PlayerVideo> frame, dcp::NoteHandler note)
 101 {
 102         shared_ptr<dcp::OpenJPEGImage> xyz;
 103
 104         shared_ptr<Image> image = frame->image (note, bind (&PlayerVideo::keep_xyz_or_rgb, _1), true, false);
 105         if (frame->colour_conversion()) {
 106                 xyz = dcp::rgb_to_xyz (
 107                         image->data()[0],
 108                         image->size(),
 109                         image->stride()[0],
 110                         frame->colour_conversion().get(),
 111                         note
 112                         );
 113         } else {
 114                 xyz = dcp::xyz_to_xyz (image->data()[0], image->size(), image->stride()[0]);
 115         }
 116
 117         return xyz;
 118 }
 119
 120 /** J2K-encode this frame on the local host.
 121  *  @return Encoded data.
 122  */
 123 Data
 124 DCPVideo::encode_locally (dcp::NoteHandler note)
 125 {
 126         Data enc = compress_j2k (
 127                 convert_to_xyz (_frame, note),
 128                 _j2k_bandwidth,
 129                 _frames_per_second,
 130                 _frame->eyes() == EYES_LEFT || _frame->eyes() == EYES_RIGHT,
 131                 _resolution == RESOLUTION_4K
 132                 );
 133
 134         switch (_frame->eyes()) {
 135         case EYES_BOTH:
 136                 LOG_DEBUG_ENCODE (N_("Finished locally-encoded frame %1 for mono"), _index);
 137                 break;
 138         case EYES_LEFT:
 139                 LOG_DEBUG_ENCODE (N_("Finished locally-encoded frame %1 for L"), _index);
 140                 break;
 141         case EYES_RIGHT:
 142                 LOG_DEBUG_ENCODE (N_("Finished locally-encoded frame %1 for R"), _index);
 143                 break;
 144         default:
 145                 break;
 146         }
 147
 148         return enc;
 149 }
 150
 151 /** Send this frame to a remote server for J2K encoding, then read the result.
 152  *  @param serv Server to send to.
 153  *  @return Encoded data.
 154  */
 155 Data
 156 DCPVideo::encode_remotely (EncodeServerDescription serv, int timeout)
 157 {
 158         boost::asio::io_service io_service;
 159         boost::asio::ip::tcp::resolver resolver (io_service);
 160         boost::asio::ip::tcp::resolver::query query (serv.host_name(), raw_convert<string> (Config::instance()->server_port_base ()));
 161         boost::asio::ip::tcp::resolver::iterator endpoint_iterator = resolver.resolve (query);
 162
 163         shared_ptr<Socket> socket = make_shared<Socket> (timeout);
 164
 165         socket->connect (*endpoint_iterator);
 166
 167         /* Collect all XML metadata */
 168         xmlpp::Document doc;
 169         xmlpp::Element* root = doc.create_root_node ("EncodingRequest");
 170         root->add_child("Version")->add_child_text (raw_convert<string> (SERVER_LINK_VERSION));
 171         add_metadata (root);
 172
 173         LOG_DEBUG_ENCODE (N_("Sending frame %1 to remote"), _index);
 174
 175         /* Send XML metadata */
 176         string xml = doc.write_to_string ("UTF-8");
 177         socket->write (xml.length() + 1);
 178         socket->write ((uint8_t *) xml.c_str(), xml.length() + 1);
 179
 180         /* Send binary data */
 181         LOG_TIMING("start-remote-send thread=%1", boost::this_thread::get_id());
 182         _frame->send_binary (socket);
 183
 184         /* Read the response (JPEG2000-encoded data); this blocks until the data
 185            is ready and sent back.
 186         */
 187         LOG_TIMING("start-remote-encode thread=%1", boost::this_thread::get_id ());
 188         Data e (socket->read_uint32 ());
 189         LOG_TIMING("start-remote-receive thread=%1", boost::this_thread::get_id ());
 190         socket->read (e.data().get(), e.size());
 191         LOG_TIMING("finish-remote-receive thread=%1", boost::this_thread::get_id ());
 192
 193         LOG_DEBUG_ENCODE (N_("Finished remotely-encoded frame %1"), _index);
 194
 195         return e;
 196 }
 197
 198 void
 199 DCPVideo::add_metadata (xmlpp::Element* el) const
 200 {
 201         el->add_child("Index")->add_child_text (raw_convert<string> (_index));
 202         el->add_child("FramesPerSecond")->add_child_text (raw_convert<string> (_frames_per_second));
 203         el->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
 204         el->add_child("Resolution")->add_child_text (raw_convert<string> (int (_resolution)));
 205         _frame->add_metadata (el);
 206 }
 207
 208 Eyes
 209 DCPVideo::eyes () const
 210 {
 211         return _frame->eyes ();
 212 }
 213
 214 /** @return true if this DCPVideo is definitely the same as another;
 215  *  (apart from the frame index), false if it is probably not.
 216  */
 217 bool
 218 DCPVideo::same (shared_ptr<const DCPVideo> other) const
 219 {
 220         if (_frames_per_second != other->_frames_per_second ||
 221             _j2k_bandwidth != other->_j2k_bandwidth ||
 222             _resolution != other->_resolution) {
 223                 return false;
 224         }
 225
 226         return _frame->same (other->_frame);
 227 }