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 "dcpomatic_log.h"
  39 #include "cross.h"
  40 #include "player_video.h"
  41 #include "compose.hpp"
  42 #include "warnings.h"
  43 #include <libcxml/cxml.h>
  44 #include <dcp/raw_convert.h>
  45 #include <dcp/openjpeg_image.h>
  46 #include <dcp/rgb_xyz.h>
  47 #include <dcp/j2k.h>
  48 DCPOMATIC_DISABLE_WARNINGS
  49 #include <libxml++/libxml++.h>
  50 DCPOMATIC_ENABLE_WARNINGS
  51 #include <boost/asio.hpp>
  52 #include <boost/thread.hpp>
  53 #include <stdint.h>
  54 #include <iomanip>
  55 #include <iostream>
  56
  57 #include "i18n.h"
  58
  59 using std::cout;
  60 using std::make_shared;
  61 using std::shared_ptr;
  62 using std::string;
  63 using dcp::Size;
  64 using dcp::ArrayData;
  65 using dcp::raw_convert;
  66 #if BOOST_VERSION >= 106100
  67 using namespace boost::placeholders;
  68 #endif
  69
  70 #define DCI_COEFFICENT (48.0 / 52.37)
  71
  72 /** Construct a DCP video frame.
  73  *  @param frame Input frame.
  74  *  @param index Index of the frame within the DCP.
  75  *  @param bw J2K bandwidth to use (see Config::j2k_bandwidth ())
  76  */
  77 DCPVideo::DCPVideo (
  78         shared_ptr<const PlayerVideo> frame, int index, int dcp_fps, int bw, Resolution r
  79         )
  80         : _frame (frame)
  81         , _index (index)
  82         , _frames_per_second (dcp_fps)
  83         , _j2k_bandwidth (bw)
  84         , _resolution (r)
  85 {
  86
  87 }
  88
  89 DCPVideo::DCPVideo (shared_ptr<const PlayerVideo> frame, shared_ptr<const cxml::Node> node)
  90         : _frame (frame)
  91 {
  92         _index = node->number_child<int> ("Index");
  93         _frames_per_second = node->number_child<int> ("FramesPerSecond");
  94         _j2k_bandwidth = node->number_child<int> ("J2KBandwidth");
  95         _resolution = Resolution (node->optional_number_child<int>("Resolution").get_value_or(static_cast<int>(Resolution::TWO_K)));
  96 }
  97
  98 shared_ptr<dcp::OpenJPEGImage>
  99 DCPVideo::convert_to_xyz (shared_ptr<const PlayerVideo> frame, dcp::NoteHandler note)
 100 {
 101         shared_ptr<dcp::OpenJPEGImage> xyz;
 102
 103         auto image = frame->image (bind(&PlayerVideo::keep_xyz_or_rgb, _1), VideoRange::FULL, true, false);
 104         if (frame->colour_conversion()) {
 105                 xyz = dcp::rgb_to_xyz (
 106                         image->data()[0],
 107                         image->size(),
 108                         image->stride()[0],
 109                         frame->colour_conversion().get(),
 110                         note
 111                         );
 112         } else {
 113                 xyz = make_shared<dcp::OpenJPEGImage>(image->data()[0], image->size(), image->stride()[0]);
 114         }
 115
 116         return xyz;
 117 }
 118
 119 /** J2K-encode this frame on the local host.
 120  *  @return Encoded data.
 121  */
 122 ArrayData
 123 DCPVideo::encode_locally ()
 124 {
 125         auto const comment = Config::instance()->dcp_j2k_comment();
 126
 127         ArrayData enc = {};
 128         int constexpr minimum_size = 65536;
 129
 130         auto xyz = convert_to_xyz (_frame, boost::bind(&Log::dcp_log, dcpomatic_log.get(), _1, _2));
 131         int noise_amount = 2;
 132         while (true) {
 133                 enc = dcp::compress_j2k (
 134                         xyz,
 135                         _j2k_bandwidth,
 136                         _frames_per_second,
 137                         _frame->eyes() == Eyes::LEFT || _frame->eyes() == Eyes::RIGHT,
 138                         _resolution == Resolution::FOUR_K,
 139                         comment.empty() ? "libdcp" : comment
 140                 );
 141
 142                 if (enc.size() >= minimum_size) {
 143                         break;
 144                 }
 145
 146                 /* The JPEG2000 is too low-bitrate for some decoders <cough>DSS200</cough> so add some noise
 147                  * and try again.  This is slow but hopefully won't happen too often.  We have to do
 148                  * convert_to_xyz() again because compress_j2k() corrupts its xyz parameter.
 149                  */
 150
 151                 xyz = convert_to_xyz (_frame, boost::bind(&Log::dcp_log, dcpomatic_log.get(), _1, _2));
 152                 auto size = xyz->size ();
 153                 auto pixels = size.width * size.height;
 154                 for (auto c = 0; c < 3; ++c) {
 155                         auto p = xyz->data(c);
 156                         for (auto i = 0; i < pixels; ++i) {
 157                                 *p = std::min(4095, std::max(0, *p + rand() % noise_amount));
 158                                 ++p;
 159                         }
 160                 }
 161
 162                 ++noise_amount;
 163                 /* Something's gone badly wrong if this much noise doesn't help */
 164                 DCPOMATIC_ASSERT (noise_amount < 16);
 165         }
 166
 167         switch (_frame->eyes()) {
 168         case Eyes::BOTH:
 169                 LOG_DEBUG_ENCODE (N_("Finished locally-encoded frame %1 for mono"), _index);
 170                 break;
 171         case Eyes::LEFT:
 172                 LOG_DEBUG_ENCODE (N_("Finished locally-encoded frame %1 for L"), _index);
 173                 break;
 174         case Eyes::RIGHT:
 175                 LOG_DEBUG_ENCODE (N_("Finished locally-encoded frame %1 for R"), _index);
 176                 break;
 177         default:
 178                 break;
 179         }
 180
 181         return enc;
 182 }
 183
 184 /** Send this frame to a remote server for J2K encoding, then read the result.
 185  *  @param serv Server to send to.
 186  *  @param timeout timeout in seconds.
 187  *  @return Encoded data.
 188  */
 189 ArrayData
 190 DCPVideo::encode_remotely (EncodeServerDescription serv, int timeout)
 191 {
 192         boost::asio::io_service io_service;
 193         boost::asio::ip::tcp::resolver resolver (io_service);
 194         boost::asio::ip::tcp::resolver::query query (serv.host_name(), raw_convert<string> (ENCODE_FRAME_PORT));
 195         boost::asio::ip::tcp::resolver::iterator endpoint_iterator = resolver.resolve (query);
 196
 197         auto socket = make_shared<Socket>(timeout);
 198
 199         socket->connect (*endpoint_iterator);
 200
 201         /* Collect all XML metadata */
 202         xmlpp::Document doc;
 203         auto root = doc.create_root_node ("EncodingRequest");
 204         root->add_child("Version")->add_child_text (raw_convert<string> (SERVER_LINK_VERSION));
 205         add_metadata (root);
 206
 207         LOG_DEBUG_ENCODE (N_("Sending frame %1 to remote"), _index);
 208
 209         {
 210                 Socket::WriteDigestScope ds (socket);
 211
 212                 /* Send XML metadata */
 213                 auto xml = doc.write_to_string ("UTF-8");
 214                 socket->write (xml.length() + 1);
 215                 socket->write ((uint8_t *) xml.c_str(), xml.length() + 1);
 216
 217                 /* Send binary data */
 218                 LOG_TIMING("start-remote-send thread=%1", thread_id ());
 219                 _frame->write_to_socket (socket);
 220         }
 221
 222         /* Read the response (JPEG2000-encoded data); this blocks until the data
 223            is ready and sent back.
 224         */
 225         Socket::ReadDigestScope ds (socket);
 226         LOG_TIMING("start-remote-encode thread=%1", thread_id ());
 227         ArrayData e (socket->read_uint32 ());
 228         LOG_TIMING("start-remote-receive thread=%1", thread_id ());
 229         socket->read (e.data(), e.size());
 230         LOG_TIMING("finish-remote-receive thread=%1", thread_id ());
 231         if (!ds.check()) {
 232                 throw NetworkError ("Checksums do not match");
 233         }
 234
 235         LOG_DEBUG_ENCODE (N_("Finished remotely-encoded frame %1"), _index);
 236
 237         return e;
 238 }
 239
 240 void
 241 DCPVideo::add_metadata (xmlpp::Element* el) const
 242 {
 243         el->add_child("Index")->add_child_text (raw_convert<string> (_index));
 244         el->add_child("FramesPerSecond")->add_child_text (raw_convert<string> (_frames_per_second));
 245         el->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
 246         el->add_child("Resolution")->add_child_text (raw_convert<string> (int (_resolution)));
 247         _frame->add_metadata (el);
 248 }
 249
 250 Eyes
 251 DCPVideo::eyes () const
 252 {
 253         return _frame->eyes ();
 254 }
 255
 256 /** @return true if this DCPVideo is definitely the same as another;
 257  *  (apart from the frame index), false if it is probably not.
 258  */
 259 bool
 260 DCPVideo::same (shared_ptr<const DCPVideo> other) const
 261 {
 262         if (_frames_per_second != other->_frames_per_second ||
 263             _j2k_bandwidth != other->_j2k_bandwidth ||
 264             _resolution != other->_resolution) {
 265                 return false;
 266         }
 267
 268         return _frame->same (other->_frame);
 269 }