2 Copyright (C) 2013-2015 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 #include "player_video.h"
23 #include "image_proxy.h"
24 #include "j2k_image_proxy.h"
26 #include <dcp/raw_convert.h>
28 #include <libavutil/pixfmt.h>
30 #include <libxml++/libxml++.h>
35 using boost::shared_ptr;
36 using boost::dynamic_pointer_cast;
37 using boost::optional;
38 using boost::function;
40 using dcp::raw_convert;
42 PlayerVideo::PlayerVideo (
43 shared_ptr<const ImageProxy> in,
45 boost::optional<double> fade,
50 optional<ColourConversion> colour_conversion
55 , _inter_size (inter_size)
56 , _out_size (out_size)
59 , _colour_conversion (colour_conversion)
64 PlayerVideo::PlayerVideo (shared_ptr<cxml::Node> node, shared_ptr<Socket> socket)
67 _fade = node->optional_number_child<double> ("Fade");
69 _inter_size = dcp::Size (node->number_child<int> ("InterWidth"), node->number_child<int> ("InterHeight"));
70 _out_size = dcp::Size (node->number_child<int> ("OutWidth"), node->number_child<int> ("OutHeight"));
71 _eyes = (Eyes) node->number_child<int> ("Eyes");
72 _part = (Part) node->number_child<int> ("Part");
74 /* Assume that the ColourConversion uses the current state version */
75 _colour_conversion = ColourConversion::from_xml (node, Film::current_state_version);
77 _in = image_proxy_factory (node->node_child ("In"), socket);
79 if (node->optional_number_child<int> ("SubtitleX")) {
81 shared_ptr<Image> image (
82 new Image (AV_PIX_FMT_BGRA, dcp::Size (node->number_child<int> ("SubtitleWidth"), node->number_child<int> ("SubtitleHeight")), true)
85 image->read_from_socket (socket);
87 _subtitle = PositionImage (image, Position<int> (node->number_child<int> ("SubtitleX"), node->number_child<int> ("SubtitleY")));
92 PlayerVideo::set_subtitle (PositionImage image)
97 /** Create an image for this frame.
98 * @param note Handler for any notes that are made during the process.
99 * @param pixel_format Function which is called to decide what pixel format the output image should be;
100 * it is passed the pixel format of the input image from the ImageProxy, and should return the desired
101 * output pixel format. Two functions always_rgb and keep_xyz_or_rgb are provided for use here.
102 * @param aligned true if the output image should be aligned to 32-byte boundaries.
103 * @param fast true to be fast at the expense of quality.
106 PlayerVideo::image (dcp::NoteHandler note, function<AVPixelFormat (AVPixelFormat)> pixel_format, bool aligned, bool fast) const
108 shared_ptr<Image> im = _in->image (optional<dcp::NoteHandler> (note), _inter_size);
110 Crop total_crop = _crop;
113 total_crop.right += im->size().width / 2;
115 case PART_RIGHT_HALF:
116 total_crop.left += im->size().width / 2;
119 total_crop.bottom += im->size().height / 2;
121 case PART_BOTTOM_HALF:
122 total_crop.top += im->size().height / 2;
128 dcp::YUVToRGB yuv_to_rgb = dcp::YUV_TO_RGB_REC601;
129 if (_colour_conversion) {
130 yuv_to_rgb = _colour_conversion.get().yuv_to_rgb();
133 shared_ptr<Image> out = im->crop_scale_window (
134 total_crop, _inter_size, _out_size, yuv_to_rgb, pixel_format (_in->pixel_format()), aligned, fast
138 out->alpha_blend (Image::ensure_aligned (_subtitle->image), _subtitle->position);
142 out->fade (_fade.get ());
149 PlayerVideo::add_metadata (xmlpp::Node* node) const
153 node->add_child("Fade")->add_child_text (raw_convert<string> (_fade.get ()));
155 _in->add_metadata (node->add_child ("In"));
156 node->add_child("InterWidth")->add_child_text (raw_convert<string> (_inter_size.width));
157 node->add_child("InterHeight")->add_child_text (raw_convert<string> (_inter_size.height));
158 node->add_child("OutWidth")->add_child_text (raw_convert<string> (_out_size.width));
159 node->add_child("OutHeight")->add_child_text (raw_convert<string> (_out_size.height));
160 node->add_child("Eyes")->add_child_text (raw_convert<string> (static_cast<int> (_eyes)));
161 node->add_child("Part")->add_child_text (raw_convert<string> (static_cast<int> (_part)));
162 if (_colour_conversion) {
163 _colour_conversion.get().as_xml (node);
166 node->add_child ("SubtitleWidth")->add_child_text (raw_convert<string> (_subtitle->image->size().width));
167 node->add_child ("SubtitleHeight")->add_child_text (raw_convert<string> (_subtitle->image->size().height));
168 node->add_child ("SubtitleX")->add_child_text (raw_convert<string> (_subtitle->position.x));
169 node->add_child ("SubtitleY")->add_child_text (raw_convert<string> (_subtitle->position.y));
174 PlayerVideo::send_binary (shared_ptr<Socket> socket) const
176 _in->send_binary (socket);
178 _subtitle->image->write_to_socket (socket);
183 PlayerVideo::has_j2k () const
185 /* XXX: maybe other things */
187 shared_ptr<const J2KImageProxy> j2k = dynamic_pointer_cast<const J2KImageProxy> (_in);
192 return _crop == Crop () && _out_size == j2k->size() && !_subtitle && !_fade && !_colour_conversion;
196 PlayerVideo::j2k () const
198 shared_ptr<const J2KImageProxy> j2k = dynamic_pointer_cast<const J2KImageProxy> (_in);
199 DCPOMATIC_ASSERT (j2k);
204 PlayerVideo::inter_position () const
206 return Position<int> ((_out_size.width - _inter_size.width) / 2, (_out_size.height - _inter_size.height) / 2);
209 /** @return true if this PlayerVideo is definitely the same as another, false if it is probably not */
211 PlayerVideo::same (shared_ptr<const PlayerVideo> other) const
213 if (_crop != other->_crop ||
214 _fade.get_value_or(0) != other->_fade.get_value_or(0) ||
215 _inter_size != other->_inter_size ||
216 _out_size != other->_out_size ||
217 _eyes != other->_eyes ||
218 _part != other->_part ||
219 _colour_conversion != other->_colour_conversion) {
223 if ((!_subtitle && other->_subtitle) || (_subtitle && !other->_subtitle)) {
224 /* One has a subtitle and the other doesn't */
228 if (_subtitle && other->_subtitle && !_subtitle->same (other->_subtitle.get ())) {
229 /* They both have subtitles but they are different */
233 /* Now neither has subtitles */
235 return _in->same (other->_in);
239 PlayerVideo::always_rgb (AVPixelFormat)
241 return AV_PIX_FMT_RGB24;
245 PlayerVideo::keep_xyz_or_rgb (AVPixelFormat p)
247 return p == AV_PIX_FMT_XYZ12LE ? AV_PIX_FMT_XYZ12LE : AV_PIX_FMT_RGB48LE;
251 PlayerVideo::prepare ()
253 _in->prepare (_inter_size);
257 PlayerVideo::memory_used () const
259 return _in->memory_used();
262 /** @return Shallow copy of this; _in and _subtitle are shared between the original and the copy */
263 shared_ptr<PlayerVideo>
264 PlayerVideo::shallow_copy () const
266 return shared_ptr<PlayerVideo>(