2 Copyright (C) 2012-2016 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/>.
21 /** @file src/dcp_video_frame.cc
22 * @brief A single frame of video destined for a DCP.
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.
27 * Objects of this class are used for the queue that we keep
28 * of images that require encoding.
31 #include "dcp_video.h"
33 #include "exceptions.h"
34 #include "encode_server_description.h"
35 #include "dcpomatic_socket.h"
38 #include "dcpomatic_log.h"
40 #include "player_video.h"
41 #include "compose.hpp"
43 #include <libcxml/cxml.h>
44 #include <dcp/raw_convert.h>
45 #include <dcp/openjpeg_image.h>
46 #include <dcp/rgb_xyz.h>
48 DCPOMATIC_DISABLE_WARNINGS
49 #include <libxml++/libxml++.h>
50 DCPOMATIC_ENABLE_WARNINGS
51 #include <boost/asio.hpp>
52 #include <boost/thread.hpp>
61 using boost::shared_ptr;
64 using dcp::raw_convert;
65 #if BOOST_VERSION >= 106100
66 using namespace boost::placeholders;
69 #define DCI_COEFFICENT (48.0 / 52.37)
71 /** Construct a DCP video frame.
72 * @param frame Input frame.
73 * @param index Index of the frame within the DCP.
74 * @param bw J2K bandwidth to use (see Config::j2k_bandwidth ())
77 shared_ptr<const PlayerVideo> frame, int index, int dcp_fps, int bw, Resolution r
81 , _frames_per_second (dcp_fps)
88 DCPVideo::DCPVideo (shared_ptr<const PlayerVideo> frame, shared_ptr<const cxml::Node> node)
91 _index = node->number_child<int> ("Index");
92 _frames_per_second = node->number_child<int> ("FramesPerSecond");
93 _j2k_bandwidth = node->number_child<int> ("J2KBandwidth");
94 _resolution = Resolution (node->optional_number_child<int>("Resolution").get_value_or (RESOLUTION_2K));
97 shared_ptr<dcp::OpenJPEGImage>
98 DCPVideo::convert_to_xyz (shared_ptr<const PlayerVideo> frame, dcp::NoteHandler note)
100 shared_ptr<dcp::OpenJPEGImage> xyz;
102 shared_ptr<Image> image = frame->image (bind (&PlayerVideo::keep_xyz_or_rgb, _1), VIDEO_RANGE_FULL, true, false);
103 if (frame->colour_conversion()) {
104 xyz = dcp::rgb_to_xyz (
108 frame->colour_conversion().get(),
112 xyz.reset (new dcp::OpenJPEGImage (image->data()[0], image->size(), image->stride()[0]));
118 /** J2K-encode this frame on the local host.
119 * @return Encoded data.
122 DCPVideo::encode_locally ()
124 string const comment = Config::instance()->dcp_j2k_comment();
126 ArrayData enc = dcp::compress_j2k (
127 convert_to_xyz (_frame, boost::bind(&Log::dcp_log, dcpomatic_log.get(), _1, _2)),
130 _frame->eyes() == EYES_LEFT || _frame->eyes() == EYES_RIGHT,
131 _resolution == RESOLUTION_4K,
132 comment.empty() ? "libdcp" : comment
135 switch (_frame->eyes()) {
137 LOG_DEBUG_ENCODE (N_("Finished locally-encoded frame %1 for mono"), _index);
140 LOG_DEBUG_ENCODE (N_("Finished locally-encoded frame %1 for L"), _index);
143 LOG_DEBUG_ENCODE (N_("Finished locally-encoded frame %1 for R"), _index);
152 /** Send this frame to a remote server for J2K encoding, then read the result.
153 * @param serv Server to send to.
154 * @param timeout timeout in seconds.
155 * @return Encoded data.
158 DCPVideo::encode_remotely (EncodeServerDescription serv, int timeout)
160 boost::asio::io_service io_service;
161 boost::asio::ip::tcp::resolver resolver (io_service);
162 boost::asio::ip::tcp::resolver::query query (serv.host_name(), raw_convert<string> (ENCODE_FRAME_PORT));
163 boost::asio::ip::tcp::resolver::iterator endpoint_iterator = resolver.resolve (query);
165 shared_ptr<Socket> socket (new Socket (timeout));
167 socket->connect (*endpoint_iterator);
169 /* Collect all XML metadata */
171 xmlpp::Element* root = doc.create_root_node ("EncodingRequest");
172 root->add_child("Version")->add_child_text (raw_convert<string> (SERVER_LINK_VERSION));
175 LOG_DEBUG_ENCODE (N_("Sending frame %1 to remote"), _index);
178 Socket::WriteDigestScope ds (socket);
180 /* Send XML metadata */
181 string xml = doc.write_to_string ("UTF-8");
182 socket->write (xml.length() + 1);
183 socket->write ((uint8_t *) xml.c_str(), xml.length() + 1);
185 /* Send binary data */
186 LOG_TIMING("start-remote-send thread=%1", thread_id ());
187 _frame->write_to_socket (socket);
190 /* Read the response (JPEG2000-encoded data); this blocks until the data
191 is ready and sent back.
193 Socket::ReadDigestScope ds (socket);
194 LOG_TIMING("start-remote-encode thread=%1", thread_id ());
195 ArrayData e (socket->read_uint32 ());
196 LOG_TIMING("start-remote-receive thread=%1", thread_id ());
197 socket->read (e.data(), e.size());
198 LOG_TIMING("finish-remote-receive thread=%1", thread_id ());
200 throw NetworkError ("Checksums do not match");
203 LOG_DEBUG_ENCODE (N_("Finished remotely-encoded frame %1"), _index);
209 DCPVideo::add_metadata (xmlpp::Element* el) const
211 el->add_child("Index")->add_child_text (raw_convert<string> (_index));
212 el->add_child("FramesPerSecond")->add_child_text (raw_convert<string> (_frames_per_second));
213 el->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
214 el->add_child("Resolution")->add_child_text (raw_convert<string> (int (_resolution)));
215 _frame->add_metadata (el);
219 DCPVideo::eyes () const
221 return _frame->eyes ();
224 /** @return true if this DCPVideo is definitely the same as another;
225 * (apart from the frame index), false if it is probably not.
228 DCPVideo::same (shared_ptr<const DCPVideo> other) const
230 if (_frames_per_second != other->_frames_per_second ||
231 _j2k_bandwidth != other->_j2k_bandwidth ||
232 _resolution != other->_resolution) {
236 return _frame->same (other->_frame);