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 /** J2K-encode this frame on the local host.
 122  *  @return Encoded data.
 123  */
 124 ArrayData
 125 DCPVideo::encode_locally () const
 126 {
 127         auto const comment = Config::instance()->dcp_j2k_comment();
 128
 129         ArrayData enc = {};
 130         /* This was empirically derived by a user: see #1902 */
 131         int const minimum_size = 16384;
 132         LOG_DEBUG_ENCODE("Using minimum frame size %1", minimum_size);
 133
 134         auto xyz = convert_to_xyz (_frame, boost::bind(&Log::dcp_log, dcpomatic_log.get(), _1, _2));
 135         int noise_amount = 2;
 136         int pixel_skip = 16;
 137         while (true) {
 138                 enc = dcp::compress_j2k (
 139                         xyz,
 140                         _j2k_bandwidth,
 141                         _frames_per_second,
 142                         _frame->eyes() == Eyes::LEFT || _frame->eyes() == Eyes::RIGHT,
 143                         _resolution == Resolution::FOUR_K,
 144                         comment.empty() ? "libdcp" : comment
 145                 );
 146
 147                 if (enc.size() >= minimum_size) {
 148                         LOG_DEBUG_ENCODE(N_("Frame %1 encoded size was OK (%2)"), _index, enc.size());
 149                         break;
 150                 }
 151
 152                 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);
 153
 154                 /* The JPEG2000 is too low-bitrate for some decoders <cough>DSS200</cough> so add some noise
 155                  * and try again.  This is slow but hopefully won't happen too often.  We have to do
 156                  * convert_to_xyz() again because compress_j2k() corrupts its xyz parameter.
 157                  */
 158
 159                 xyz = convert_to_xyz (_frame, boost::bind(&Log::dcp_log, dcpomatic_log.get(), _1, _2));
 160                 auto size = xyz->size ();
 161                 auto pixels = size.width * size.height;
 162                 dcpomatic::RNG rng(42);
 163                 for (auto c = 0; c < 3; ++c) {
 164                         auto p = xyz->data(c);
 165                         auto e = xyz->data(c) + pixels;
 166                         while (p < e) {
 167                                 *p = std::min(4095, std::max(0, *p + (rng.get() % noise_amount)));
 168                                 p += pixel_skip;
 169                         }
 170                 }
 171
 172                 if (pixel_skip > 1) {
 173                         --pixel_skip;
 174                 } else {
 175                         ++noise_amount;
 176                 }
 177                 /* Something's gone badly wrong if this much noise doesn't help */
 178                 DCPOMATIC_ASSERT (noise_amount < 16);
 179         }
 180
 181         switch (_frame->eyes()) {
 182         case Eyes::BOTH:
 183                 LOG_DEBUG_ENCODE (N_("Finished locally-encoded frame %1 for mono"), _index);
 184                 break;
 185         case Eyes::LEFT:
 186                 LOG_DEBUG_ENCODE (N_("Finished locally-encoded frame %1 for L"), _index);
 187                 break;
 188         case Eyes::RIGHT:
 189                 LOG_DEBUG_ENCODE (N_("Finished locally-encoded frame %1 for R"), _index);
 190                 break;
 191         default:
 192                 break;
 193         }
 194
 195         return enc;
 196 }
 197
 198 /** Send this frame to a remote server for J2K encoding, then read the result.
 199  *  @param serv Server to send to.
 200  *  @param timeout timeout in seconds.
 201  *  @return Encoded data.
 202  */
 203 ArrayData
 204 DCPVideo::encode_remotely (EncodeServerDescription serv, int timeout) const
 205 {
 206         boost::asio::io_service io_service;
 207         boost::asio::ip::tcp::resolver resolver (io_service);
 208         boost::asio::ip::tcp::resolver::query query (serv.host_name(), raw_convert<string> (ENCODE_FRAME_PORT));
 209         boost::asio::ip::tcp::resolver::iterator endpoint_iterator = resolver.resolve (query);
 210
 211         auto socket = make_shared<Socket>(timeout);
 212         socket->set_send_buffer_size (512 * 1024);
 213
 214         socket->connect (*endpoint_iterator);
 215
 216         /* Collect all XML metadata */
 217         xmlpp::Document doc;
 218         auto root = doc.create_root_node ("EncodingRequest");
 219         root->add_child("Version")->add_child_text (raw_convert<string> (SERVER_LINK_VERSION));
 220         add_metadata (root);
 221
 222         LOG_DEBUG_ENCODE (N_("Sending frame %1 to remote"), _index);
 223
 224         {
 225                 Socket::WriteDigestScope ds (socket);
 226
 227                 /* Send XML metadata */
 228                 auto xml = doc.write_to_string ("UTF-8");
 229                 socket->write(xml.bytes() + 1);
 230                 socket->write ((uint8_t *) xml.c_str(), xml.bytes() + 1);
 231
 232                 /* Send binary data */
 233                 LOG_TIMING("start-remote-send thread=%1", thread_id ());
 234                 _frame->write_to_socket (socket);
 235         }
 236
 237         /* Read the response (JPEG2000-encoded data); this blocks until the data
 238            is ready and sent back.
 239         */
 240         Socket::ReadDigestScope ds (socket);
 241         LOG_TIMING("start-remote-encode thread=%1", thread_id ());
 242         ArrayData e (socket->read_uint32 ());
 243         LOG_TIMING("start-remote-receive thread=%1", thread_id ());
 244         socket->read (e.data(), e.size());
 245         LOG_TIMING("finish-remote-receive thread=%1", thread_id ());
 246         if (!ds.check()) {
 247                 throw NetworkError ("Checksums do not match");
 248         }
 249
 250         LOG_DEBUG_ENCODE (N_("Finished remotely-encoded frame %1"), _index);
 251
 252         return e;
 253 }
 254
 255 void
 256 DCPVideo::add_metadata (xmlpp::Element* el) const
 257 {
 258         el->add_child("Index")->add_child_text (raw_convert<string> (_index));
 259         el->add_child("FramesPerSecond")->add_child_text (raw_convert<string> (_frames_per_second));
 260         el->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
 261         el->add_child("Resolution")->add_child_text (raw_convert<string> (int (_resolution)));
 262         _frame->add_metadata (el);
 263 }
 264
 265 Eyes
 266 DCPVideo::eyes () const
 267 {
 268         return _frame->eyes ();
 269 }
 270
 271 /** @return true if this DCPVideo is definitely the same as another;
 272  *  (apart from the frame index), false if it is probably not.
 273  */
 274 bool
 275 DCPVideo::same (shared_ptr<const DCPVideo> other) const
 276 {
 277         if (_frames_per_second != other->_frames_per_second ||
 278             _j2k_bandwidth != other->_j2k_bandwidth ||
 279             _resolution != other->_resolution) {
 280                 return false;
 281         }
 282
 283         return _frame->same (other->_frame);
 284 }