2 Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
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.
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.
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/>.
22 /** @file src/dcp_video_frame.cc
23 * @brief A single frame of video destined for a DCP.
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.
28 * Objects of this class are used for the queue that we keep
29 * of images that require encoding.
33 #include "compose.hpp"
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"
43 #include "player_video.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>
64 using std::make_shared;
65 using std::shared_ptr;
68 using dcp::raw_convert;
69 #if BOOST_VERSION >= 106100
70 using namespace boost::placeholders;
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 ())
80 shared_ptr<const PlayerVideo> frame, int index, int dcp_fps, int bw, Resolution r
84 , _frames_per_second (dcp_fps)
91 DCPVideo::DCPVideo (shared_ptr<const PlayerVideo> frame, shared_ptr<const cxml::Node> node)
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)));
100 shared_ptr<dcp::OpenJPEGImage>
101 DCPVideo::convert_to_xyz (shared_ptr<const PlayerVideo> frame)
103 shared_ptr<dcp::OpenJPEGImage> xyz;
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 (
111 frame->colour_conversion().get()
114 xyz = make_shared<dcp::OpenJPEGImage>(image->data()[0], image->size(), image->stride()[0]);
120 /** J2K-encode this frame on the local host.
121 * @return Encoded data.
124 DCPVideo::encode_locally () const
126 auto const comment = Config::instance()->dcp_j2k_comment();
129 /* This was empirically derived by a user: see #1902 */
130 int const minimum_size = 16384;
131 LOG_DEBUG_ENCODE("Using minimum frame size %1", minimum_size);
133 auto xyz = convert_to_xyz(_frame);
134 int noise_amount = 2;
137 enc = dcp::compress_j2k (
141 _frame->eyes() == Eyes::LEFT || _frame->eyes() == Eyes::RIGHT,
142 _resolution == Resolution::FOUR_K,
143 comment.empty() ? "libdcp" : comment
146 if (enc.size() >= minimum_size) {
147 LOG_DEBUG_ENCODE(N_("Frame %1 encoded size was OK (%2)"), _index, enc.size());
151 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 /* The JPEG2000 is too low-bitrate for some decoders <cough>DSS200</cough> so add some noise
154 * and try again. This is slow but hopefully won't happen too often. We have to do
155 * convert_to_xyz() again because compress_j2k() corrupts its xyz parameter.
158 xyz = convert_to_xyz(_frame);
159 auto size = xyz->size ();
160 auto pixels = size.width * size.height;
161 dcpomatic::RNG rng(42);
162 for (auto c = 0; c < 3; ++c) {
163 auto p = xyz->data(c);
164 auto e = xyz->data(c) + pixels;
166 *p = std::min(4095, std::max(0, *p + (rng.get() % noise_amount)));
171 if (pixel_skip > 1) {
176 /* Something's gone badly wrong if this much noise doesn't help */
177 DCPOMATIC_ASSERT (noise_amount < 16);
180 switch (_frame->eyes()) {
182 LOG_DEBUG_ENCODE (N_("Finished locally-encoded frame %1 for mono"), _index);
185 LOG_DEBUG_ENCODE (N_("Finished locally-encoded frame %1 for L"), _index);
188 LOG_DEBUG_ENCODE (N_("Finished locally-encoded frame %1 for R"), _index);
197 /** Send this frame to a remote server for J2K encoding, then read the result.
198 * @param serv Server to send to.
199 * @param timeout timeout in seconds.
200 * @return Encoded data.
203 DCPVideo::encode_remotely (EncodeServerDescription serv, int timeout) const
205 boost::asio::io_service io_service;
206 boost::asio::ip::tcp::resolver resolver (io_service);
207 boost::asio::ip::tcp::resolver::query query (serv.host_name(), raw_convert<string> (ENCODE_FRAME_PORT));
208 boost::asio::ip::tcp::resolver::iterator endpoint_iterator = resolver.resolve (query);
210 auto socket = make_shared<Socket>(timeout);
211 socket->set_send_buffer_size (512 * 1024);
213 socket->connect (*endpoint_iterator);
215 /* Collect all XML metadata */
217 auto root = doc.create_root_node ("EncodingRequest");
218 root->add_child("Version")->add_child_text (raw_convert<string> (SERVER_LINK_VERSION));
221 LOG_DEBUG_ENCODE (N_("Sending frame %1 to remote"), _index);
224 Socket::WriteDigestScope ds (socket);
226 /* Send XML metadata */
227 auto xml = doc.write_to_string ("UTF-8");
228 socket->write(xml.bytes() + 1);
229 socket->write ((uint8_t *) xml.c_str(), xml.bytes() + 1);
231 /* Send binary data */
232 LOG_TIMING("start-remote-send thread=%1", thread_id ());
233 _frame->write_to_socket (socket);
236 /* Read the response (JPEG2000-encoded data); this blocks until the data
237 is ready and sent back.
239 Socket::ReadDigestScope ds (socket);
240 LOG_TIMING("start-remote-encode thread=%1", thread_id ());
241 ArrayData e (socket->read_uint32 ());
242 LOG_TIMING("start-remote-receive thread=%1", thread_id ());
243 socket->read (e.data(), e.size());
244 LOG_TIMING("finish-remote-receive thread=%1", thread_id ());
246 throw NetworkError ("Checksums do not match");
249 LOG_DEBUG_ENCODE (N_("Finished remotely-encoded frame %1"), _index);
255 DCPVideo::add_metadata (xmlpp::Element* el) const
257 el->add_child("Index")->add_child_text (raw_convert<string> (_index));
258 el->add_child("FramesPerSecond")->add_child_text (raw_convert<string> (_frames_per_second));
259 el->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
260 el->add_child("Resolution")->add_child_text (raw_convert<string> (int (_resolution)));
261 _frame->add_metadata (el);
265 DCPVideo::eyes () const
267 return _frame->eyes ();
270 /** @return true if this DCPVideo is definitely the same as another;
271 * (apart from the frame index), false if it is probably not.
274 DCPVideo::same (shared_ptr<const DCPVideo> other) const
276 if (_frames_per_second != other->_frames_per_second ||
277 _j2k_bandwidth != other->_j2k_bandwidth ||
278 _resolution != other->_resolution) {
282 return _frame->same (other->_frame);