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"
39 #include "player_video.h"
40 #include "compose.hpp"
41 #include <libcxml/cxml.h>
42 #include <dcp/raw_convert.h>
43 #include <dcp/openjpeg_image.h>
44 #include <dcp/rgb_xyz.h>
46 #include <libxml++/libxml++.h>
47 #include <boost/asio.hpp>
48 #include <boost/thread.hpp>
53 #define LOG_GENERAL(...) _log->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
54 #define LOG_DEBUG_ENCODE(...) _log->log (String::compose (__VA_ARGS__), LogEntry::TYPE_DEBUG_ENCODE);
55 #define LOG_TIMING(...) _log->log (String::compose (__VA_ARGS__), LogEntry::TYPE_TIMING);
61 using boost::shared_ptr;
64 using dcp::raw_convert;
66 #define DCI_COEFFICENT (48.0 / 52.37)
68 /** Construct a DCP video frame.
69 * @param frame Input frame.
70 * @param index Index of the frame within the DCP.
71 * @param bw J2K bandwidth to use (see Config::j2k_bandwidth ())
72 * @param l Log to write to.
75 shared_ptr<const PlayerVideo> frame, int index, int dcp_fps, int bw, Resolution r, shared_ptr<Log> l
79 , _frames_per_second (dcp_fps)
87 DCPVideo::DCPVideo (shared_ptr<const PlayerVideo> frame, shared_ptr<const cxml::Node> node, shared_ptr<Log> log)
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 (note, bind (&PlayerVideo::keep_xyz_or_rgb, _1), true, false);
103 if (frame->colour_conversion()) {
104 xyz = dcp::rgb_to_xyz (
108 frame->colour_conversion().get(),
112 xyz = dcp::xyz_to_xyz (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 (dcp::NoteHandler note)
124 Data enc = compress_j2k (
125 convert_to_xyz (_frame, note),
128 _frame->eyes() == EYES_LEFT || _frame->eyes() == EYES_RIGHT,
129 _resolution == RESOLUTION_4K
132 switch (_frame->eyes()) {
134 LOG_DEBUG_ENCODE (N_("Finished locally-encoded frame %1 for mono"), _index);
137 LOG_DEBUG_ENCODE (N_("Finished locally-encoded frame %1 for L"), _index);
140 LOG_DEBUG_ENCODE (N_("Finished locally-encoded frame %1 for R"), _index);
149 /** Send this frame to a remote server for J2K encoding, then read the result.
150 * @param serv Server to send to.
151 * @param timeout timeout in seconds.
152 * @return Encoded data.
155 DCPVideo::encode_remotely (EncodeServerDescription serv, int timeout)
157 boost::asio::io_service io_service;
158 boost::asio::ip::tcp::resolver resolver (io_service);
159 boost::asio::ip::tcp::resolver::query query (serv.host_name(), raw_convert<string> (Config::instance()->server_port_base ()));
160 boost::asio::ip::tcp::resolver::iterator endpoint_iterator = resolver.resolve (query);
162 shared_ptr<Socket> socket (new Socket (timeout));
164 socket->connect (*endpoint_iterator);
166 /* Collect all XML metadata */
168 xmlpp::Element* root = doc.create_root_node ("EncodingRequest");
169 root->add_child("Version")->add_child_text (raw_convert<string> (SERVER_LINK_VERSION));
172 LOG_DEBUG_ENCODE (N_("Sending frame %1 to remote"), _index);
174 /* Send XML metadata */
175 string xml = doc.write_to_string ("UTF-8");
176 socket->write (xml.length() + 1);
177 socket->write ((uint8_t *) xml.c_str(), xml.length() + 1);
179 /* Send binary data */
180 LOG_TIMING("start-remote-send thread=%1", thread_id ());
181 _frame->send_binary (socket);
183 /* Read the response (JPEG2000-encoded data); this blocks until the data
184 is ready and sent back.
186 LOG_TIMING("start-remote-encode thread=%1", thread_id ());
187 Data e (socket->read_uint32 ());
188 LOG_TIMING("start-remote-receive thread=%1", thread_id ());
189 socket->read (e.data().get(), e.size());
190 LOG_TIMING("finish-remote-receive thread=%1", thread_id ());
192 LOG_DEBUG_ENCODE (N_("Finished remotely-encoded frame %1"), _index);
198 DCPVideo::add_metadata (xmlpp::Element* el) const
200 el->add_child("Index")->add_child_text (raw_convert<string> (_index));
201 el->add_child("FramesPerSecond")->add_child_text (raw_convert<string> (_frames_per_second));
202 el->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
203 el->add_child("Resolution")->add_child_text (raw_convert<string> (int (_resolution)));
204 _frame->add_metadata (el);
208 DCPVideo::eyes () const
210 return _frame->eyes ();
213 /** @return true if this DCPVideo is definitely the same as another;
214 * (apart from the frame index), false if it is probably not.
217 DCPVideo::same (shared_ptr<const DCPVideo> other) const
219 if (_frames_per_second != other->_frames_per_second ||
220 _j2k_bandwidth != other->_j2k_bandwidth ||
221 _resolution != other->_resolution) {
225 return _frame->same (other->_frame);