src/lib/dcp_video.cc

   1 /*
   2     Copyright (C) 2012-2021 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
  22 /** @file  src/dcp_video_frame.cc
  23  *  @brief A single frame of video destined for a DCP.
  24  *
  25  *  Given an Image and some settings, this class knows how to encode
  26  *  the image to J2K either on the local host or on a remote server.
  27  *
  28  *  Objects of this class are used for the queue that we keep
  29  *  of images that require encoding.
  30  */
  31
  32
  33 #include "compose.hpp"
  34 #include "config.h"
  35 #include "cross.h"
  36 #include "dcp_video.h"
  37 #include "dcpomatic_log.h"
  38 #include "dcpomatic_socket.h"
  39 #include "encode_server_description.h"
  40 #include "exceptions.h"
  41 #include "image.h"
  42 #include "log.h"
  43 #include "player_video.h"
  44 #include "rng.h"
  45 #include <libcxml/cxml.h>
  46 #include <dcp/raw_convert.h>
  47 #include <dcp/openjpeg_image.h>
  48 #include <dcp/rgb_xyz.h>
  49 #include <dcp/j2k_transcode.h>
  50 #include <dcp/warnings.h>
  51 LIBDCP_DISABLE_WARNINGS
  52 #include <libxml++/libxml++.h>
  53 LIBDCP_ENABLE_WARNINGS
  54 #include <boost/asio.hpp>
  55 #include <boost/thread.hpp>
  56 #include <stdint.h>
  57 #include <iomanip>
  58 #include <iostream>
  59
  60 #include "i18n.h"
  61
  62
  63 using std::cout;
  64 using std::make_shared;
  65 using std::shared_ptr;
  66 using std::string;
  67 using dcp::ArrayData;
  68 using dcp::raw_convert;
  69 #if BOOST_VERSION >= 106100
  70 using namespace boost::placeholders;
  71 #endif
  72
  73
  74 /** Construct a DCP video frame.
  75  *  @param frame Input frame.
  76  *  @param index Index of the frame within the DCP.
  77  *  @param bw J2K bandwidth to use (see Config::j2k_bandwidth ())
  78  */
  79 DCPVideo::DCPVideo (
  80         shared_ptr<const PlayerVideo> frame, int index, int dcp_fps, int bw, Resolution r
  81         )
  82         : _frame (frame)
  83         , _index (index)
  84         , _frames_per_second (dcp_fps)
  85         , _j2k_bandwidth (bw)
  86         , _resolution (r)
  87 {
  88
  89 }
  90
  91 DCPVideo::DCPVideo (shared_ptr<const PlayerVideo> frame, shared_ptr<const cxml::Node> node)
  92         : _frame (frame)
  93 {
  94         _index = node->number_child<int> ("Index");
  95         _frames_per_second = node->number_child<int> ("FramesPerSecond");
  96         _j2k_bandwidth = node->number_child<int> ("J2KBandwidth");
  97         _resolution = Resolution (node->optional_number_child<int>("Resolution").get_value_or(static_cast<int>(Resolution::TWO_K)));
  98 }
  99
 100 shared_ptr<dcp::OpenJPEGImage>
 101 DCPVideo::convert_to_xyz (shared_ptr<const PlayerVideo> frame, dcp::NoteHandler note)
 102 {
 103         shared_ptr<dcp::OpenJPEGImage> xyz;
 104
 105         auto image = frame->image (bind(&PlayerVideo::keep_xyz_or_rgb, _1), VideoRange::FULL, false);
 106         if (frame->colour_conversion()) {
 107                 xyz = dcp::rgb_to_xyz (
 108                         image->data()[0],
 109                         image->size(),
 110                         image->stride()[0],
 111                         frame->colour_conversion().get(),
 112                         note
 113                         );
 114         } else {
 115                 xyz = make_shared<dcp::OpenJPEGImage>(image->data()[0], image->size(), image->stride()[0]);
 116         }
 117
 118         return xyz;
 119 }
 120
 121 dcp::Size
 122 DCPVideo::get_size()
 123 {
 124         auto image = _frame->image(bind(&PlayerVideo::keep_xyz_or_rgb, _1), VideoRange::FULL, false);
 125         return image->size();
 126 }
 127
 128
 129 void
 130 DCPVideo::convert_to_xyz(uint16_t* dst) const
 131 {
 132         auto image = _frame->image(bind(&PlayerVideo::keep_xyz_or_rgb, _1), VideoRange::FULL, false);
 133         if (_frame->colour_conversion()) {
 134                 dcp::rgb_to_xyz(
 135                     image->data()[0],
 136                     dst,
 137                     image->size(),
 138                     image->stride()[0],
 139                     _frame->colour_conversion().get());
 140         }
 141 }
 142
 143
 144 /** J2K-encode this frame on the local host.
 145  *  @return Encoded data.
 146  */
 147 ArrayData
 148 DCPVideo::encode_locally () const
 149 {
 150         auto const comment = Config::instance()->dcp_j2k_comment();
 151
 152         ArrayData enc = {};
 153         /* This was empirically derived by a user: see #1902 */
 154         int const minimum_size = 16384;
 155         LOG_DEBUG_ENCODE("Using minimum frame size %1", minimum_size);
 156
 157         auto xyz = convert_to_xyz (_frame, boost::bind(&Log::dcp_log, dcpomatic_log.get(), _1, _2));
 158         int noise_amount = 2;
 159         int pixel_skip = 16;
 160         while (true) {
 161                 enc = dcp::compress_j2k (
 162                         xyz,
 163                         _j2k_bandwidth,
 164                         _frames_per_second,
 165                         _frame->eyes() == Eyes::LEFT || _frame->eyes() == Eyes::RIGHT,
 166                         _resolution == Resolution::FOUR_K,
 167                         comment.empty() ? "libdcp" : comment
 168                 );
 169
 170                 if (enc.size() >= minimum_size) {
 171                         LOG_DEBUG_ENCODE(N_("Frame %1 encoded size was OK (%2)"), _index, enc.size());
 172                         break;
 173                 }
 174
 175                 LOG_GENERAL (N_("Frame %1 encoded size was small (%2); adding noise at level %3 with pixel skip %4"), _index, enc.size(), noise_amount, pixel_skip);
 176
 177                 /* The JPEG2000 is too low-bitrate for some decoders <cough>DSS200</cough> so add some noise
 178                  * and try again.  This is slow but hopefully won't happen too often.  We have to do
 179                  * convert_to_xyz() again because compress_j2k() corrupts its xyz parameter.
 180                  */
 181
 182                 xyz = convert_to_xyz (_frame, boost::bind(&Log::dcp_log, dcpomatic_log.get(), _1, _2));
 183                 auto size = xyz->size ();
 184                 auto pixels = size.width * size.height;
 185                 dcpomatic::RNG rng(42);
 186                 for (auto c = 0; c < 3; ++c) {
 187                         auto p = xyz->data(c);
 188                         auto e = xyz->data(c) + pixels;
 189                         while (p < e) {
 190                                 *p = std::min(4095, std::max(0, *p + (rng.get() % noise_amount)));
 191                                 p += pixel_skip;
 192                         }
 193                 }
 194
 195                 if (pixel_skip > 1) {
 196                         --pixel_skip;
 197                 } else {
 198                         ++noise_amount;
 199                 }
 200                 /* Something's gone badly wrong if this much noise doesn't help */
 201                 DCPOMATIC_ASSERT (noise_amount < 16);
 202         }
 203
 204         switch (_frame->eyes()) {
 205         case Eyes::BOTH:
 206                 LOG_DEBUG_ENCODE (N_("Finished locally-encoded frame %1 for mono"), _index);
 207                 break;
 208         case Eyes::LEFT:
 209                 LOG_DEBUG_ENCODE (N_("Finished locally-encoded frame %1 for L"), _index);
 210                 break;
 211         case Eyes::RIGHT:
 212                 LOG_DEBUG_ENCODE (N_("Finished locally-encoded frame %1 for R"), _index);
 213                 break;
 214         default:
 215                 break;
 216         }
 217
 218         return enc;
 219 }
 220
 221 /** Send this frame to a remote server for J2K encoding, then read the result.
 222  *  @param serv Server to send to.
 223  *  @param timeout timeout in seconds.
 224  *  @return Encoded data.
 225  */
 226 ArrayData
 227 DCPVideo::encode_remotely (EncodeServerDescription serv, int timeout) const
 228 {
 229         boost::asio::io_service io_service;
 230         boost::asio::ip::tcp::resolver resolver (io_service);
 231         boost::asio::ip::tcp::resolver::query query (serv.host_name(), raw_convert<string> (ENCODE_FRAME_PORT));
 232         boost::asio::ip::tcp::resolver::iterator endpoint_iterator = resolver.resolve (query);
 233
 234         auto socket = make_shared<Socket>(timeout);
 235         socket->set_send_buffer_size (512 * 1024);
 236
 237         socket->connect (*endpoint_iterator);
 238
 239         /* Collect all XML metadata */
 240         xmlpp::Document doc;
 241         auto root = doc.create_root_node ("EncodingRequest");
 242         root->add_child("Version")->add_child_text (raw_convert<string> (SERVER_LINK_VERSION));
 243         add_metadata (root);
 244
 245         LOG_DEBUG_ENCODE (N_("Sending frame %1 to remote"), _index);
 246
 247         {
 248                 Socket::WriteDigestScope ds (socket);
 249
 250                 /* Send XML metadata */
 251                 auto xml = doc.write_to_string ("UTF-8");
 252                 socket->write(xml.bytes() + 1);
 253                 socket->write ((uint8_t *) xml.c_str(), xml.bytes() + 1);
 254
 255                 /* Send binary data */
 256                 LOG_TIMING("start-remote-send thread=%1", thread_id ());
 257                 _frame->write_to_socket (socket);
 258         }
 259
 260         /* Read the response (JPEG2000-encoded data); this blocks until the data
 261            is ready and sent back.
 262         */
 263         Socket::ReadDigestScope ds (socket);
 264         LOG_TIMING("start-remote-encode thread=%1", thread_id ());
 265         ArrayData e (socket->read_uint32 ());
 266         LOG_TIMING("start-remote-receive thread=%1", thread_id ());
 267         socket->read (e.data(), e.size());
 268         LOG_TIMING("finish-remote-receive thread=%1", thread_id ());
 269         if (!ds.check()) {
 270                 throw NetworkError ("Checksums do not match");
 271         }
 272
 273         LOG_DEBUG_ENCODE (N_("Finished remotely-encoded frame %1"), _index);
 274
 275         return e;
 276 }
 277
 278 void
 279 DCPVideo::add_metadata (xmlpp::Element* el) const
 280 {
 281         el->add_child("Index")->add_child_text (raw_convert<string> (_index));
 282         el->add_child("FramesPerSecond")->add_child_text (raw_convert<string> (_frames_per_second));
 283         el->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
 284         el->add_child("Resolution")->add_child_text (raw_convert<string> (int (_resolution)));
 285         _frame->add_metadata (el);
 286 }
 287
 288 Eyes
 289 DCPVideo::eyes () const
 290 {
 291         return _frame->eyes ();
 292 }
 293
 294 /** @return true if this DCPVideo is definitely the same as another;
 295  *  (apart from the frame index), false if it is probably not.
 296  */
 297 bool
 298 DCPVideo::same (shared_ptr<const DCPVideo> other) const
 299 {
 300         if (_frames_per_second != other->_frames_per_second ||
 301             _j2k_bandwidth != other->_j2k_bandwidth ||
 302             _resolution != other->_resolution) {
 303                 return false;
 304         }
 305
 306         return _frame->same (other->_frame);
 307 }