2 Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 /** @file src/dcp_video_frame.cc
21 * @brief A single frame of video destined for a DCP.
23 * Given an Image and some settings, this class knows how to encode
24 * the image to J2K either on the local host or on a remote server.
26 * Objects of this class are used for the queue that we keep
27 * of images that require encoding.
30 #include "dcp_video.h"
32 #include "exceptions.h"
33 #include "encode_server_description.h"
34 #include "dcpomatic_socket.h"
38 #include "player_video.h"
39 #include "raw_convert.h"
40 #include "compose.hpp"
41 #include "jpeg2000_encoder.h"
42 #include <libcxml/cxml.h>
43 #include <dcp/openjpeg_image.h>
44 #include <dcp/rgb_xyz.h>
46 #include <dcp/colour_matrix.h>
47 #include <libxml++/libxml++.h>
48 #include <boost/asio.hpp>
49 #include <boost/thread.hpp>
54 #define LOG_GENERAL(...) _log->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
55 #define LOG_DEBUG_ENCODE(...) _log->log (String::compose (__VA_ARGS__), LogEntry::TYPE_DEBUG_ENCODE);
56 #define LOG_TIMING(...) _log->log (String::compose (__VA_ARGS__), LogEntry::TYPE_TIMING);
62 using boost::shared_ptr;
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);
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 shared_ptr<JPEG2000Encoder> encoder;
125 if (Config::instance()->encoder ()) {
126 encoder = JPEG2000Encoder::from_id (Config::instance()->encoder().get ());
130 encoder = JPEG2000Encoder::all().front ();
133 Data enc = encoder->encode (
134 xyz, _j2k_bandwidth, _frames_per_second, _resolution, _frame->eyes() == EYES_LEFT || _frame->eyes() == EYES_RIGHT
137 switch (_frame->eyes()) {
139 LOG_DEBUG_ENCODE (N_("Finished locally-encoded frame %1 for mono"), _index);
142 LOG_DEBUG_ENCODE (N_("Finished locally-encoded frame %1 for L"), _index);
145 LOG_DEBUG_ENCODE (N_("Finished locally-encoded frame %1 for R"), _index);
154 /** Send this frame to a remote server for J2K encoding, then read the result.
155 * @param serv Server to send to.
156 * @return Encoded data.
159 DCPVideo::encode_remotely (EncodeServerDescription serv, int timeout)
161 boost::asio::io_service io_service;
162 boost::asio::ip::tcp::resolver resolver (io_service);
163 boost::asio::ip::tcp::resolver::query query (serv.host_name(), raw_convert<string> (Config::instance()->server_port_base ()));
164 boost::asio::ip::tcp::resolver::iterator endpoint_iterator = resolver.resolve (query);
166 shared_ptr<Socket> socket (new Socket (timeout));
168 socket->connect (*endpoint_iterator);
170 /* Collect all XML metadata */
172 xmlpp::Element* root = doc.create_root_node ("EncodingRequest");
173 root->add_child("Version")->add_child_text (raw_convert<string> (SERVER_LINK_VERSION));
176 LOG_DEBUG_ENCODE (N_("Sending frame %1 to remote"), _index);
178 /* Send XML metadata */
179 string xml = doc.write_to_string ("UTF-8");
180 socket->write (xml.length() + 1);
181 socket->write ((uint8_t *) xml.c_str(), xml.length() + 1);
183 /* Send binary data */
184 LOG_TIMING("start-remote-send thread=%1", boost::this_thread::get_id());
185 _frame->send_binary (socket);
187 /* Read the response (JPEG2000-encoded data); this blocks until the data
188 is ready and sent back.
190 LOG_TIMING("start-remote-encode thread=%1", boost::this_thread::get_id ());
191 Data e (socket->read_uint32 ());
192 LOG_TIMING("start-remote-receive thread=%1", boost::this_thread::get_id ());
193 socket->read (e.data().get(), e.size());
194 LOG_TIMING("finish-remote-receive thread=%1", boost::this_thread::get_id ());
196 LOG_DEBUG_ENCODE (N_("Finished remotely-encoded frame %1"), _index);
202 DCPVideo::add_metadata (xmlpp::Element* el) const
204 el->add_child("Index")->add_child_text (raw_convert<string> (_index));
205 el->add_child("FramesPerSecond")->add_child_text (raw_convert<string> (_frames_per_second));
206 el->add_child("J2KBandwidth")->add_child_text (raw_convert<string> (_j2k_bandwidth));
207 el->add_child("Resolution")->add_child_text (raw_convert<string> (int (_resolution)));
208 _frame->add_metadata (el);
212 DCPVideo::eyes () const
214 return _frame->eyes ();
217 /** @return true if this DCPVideo is definitely the same as another;
218 * (apart from the frame index), false if it is probably not.
221 DCPVideo::same (shared_ptr<const DCPVideo> other) const
223 if (_frames_per_second != other->_frames_per_second ||
224 _j2k_bandwidth != other->_j2k_bandwidth ||
225 _resolution != other->_resolution) {
229 return _frame->same (other->_frame);