2 Copyright (C) 2013-2018 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 "video_content.h"
25 #include "image_proxy.h"
26 #include "j2k_image_proxy.h"
28 #include <dcp/raw_convert.h>
30 #include <libavutil/pixfmt.h>
32 #include <libxml++/libxml++.h>
38 using boost::shared_ptr;
39 using boost::weak_ptr;
40 using boost::dynamic_pointer_cast;
41 using boost::optional;
42 using boost::function;
44 using dcp::raw_convert;
46 PlayerVideo::PlayerVideo (
47 shared_ptr<const ImageProxy> in,
49 boost::optional<double> fade,
54 optional<ColourConversion> colour_conversion,
55 VideoRange video_range,
56 weak_ptr<Content> content,
57 optional<Frame> video_frame
62 , _inter_size (inter_size)
63 , _out_size (out_size)
66 , _colour_conversion (colour_conversion)
67 , _video_range (video_range)
69 , _video_frame (video_frame)
74 PlayerVideo::PlayerVideo (shared_ptr<cxml::Node> node, shared_ptr<Socket> socket)
77 _fade = node->optional_number_child<double> ("Fade");
79 _inter_size = dcp::Size (node->number_child<int> ("InterWidth"), node->number_child<int> ("InterHeight"));
80 _out_size = dcp::Size (node->number_child<int> ("OutWidth"), node->number_child<int> ("OutHeight"));
81 _eyes = (Eyes) node->number_child<int> ("Eyes");
82 _part = (Part) node->number_child<int> ("Part");
83 _video_range = (VideoRange) node->number_child<int>("VideoRange");
85 /* Assume that the ColourConversion uses the current state version */
86 _colour_conversion = ColourConversion::from_xml (node, Film::current_state_version);
88 _in = image_proxy_factory (node->node_child ("In"), socket);
90 if (node->optional_number_child<int> ("SubtitleX")) {
92 shared_ptr<Image> image (
93 new Image (AV_PIX_FMT_BGRA, dcp::Size (node->number_child<int> ("SubtitleWidth"), node->number_child<int> ("SubtitleHeight")), true)
96 image->read_from_socket (socket);
98 _text = PositionImage (image, Position<int> (node->number_child<int> ("SubtitleX"), node->number_child<int> ("SubtitleY")));
103 PlayerVideo::set_text (PositionImage image)
109 PlayerVideo::image (function<AVPixelFormat (AVPixelFormat)> pixel_format, bool aligned, bool fast) const
111 /* XXX: this assumes that image() and prepare() are only ever called with the same parameters (except crop, inter size, out size, fade) */
113 boost::mutex::scoped_lock lm (_mutex);
114 if (!_image || _crop != _image_crop || _inter_size != _image_inter_size || _out_size != _image_out_size || _fade != _image_fade) {
115 make_image (pixel_format, aligned, fast);
120 /** Create an image for this frame. A lock must be held on _mutex.
121 * @param pixel_format Function which is called to decide what pixel format the output image should be;
122 * it is passed the pixel format of the input image from the ImageProxy, and should return the desired
123 * output pixel format. Two functions force and keep_xyz_or_rgb are provided for use here.
124 * @param aligned true if the output image should be aligned to 32-byte boundaries.
125 * @param fast true to be fast at the expense of quality.
128 PlayerVideo::make_image (function<AVPixelFormat (AVPixelFormat)> pixel_format, bool aligned, bool fast) const
131 _image_inter_size = _inter_size;
132 _image_out_size = _out_size;
135 pair<shared_ptr<Image>, int> prox = _in->image (_inter_size);
136 shared_ptr<Image> im = prox.first;
137 int const reduce = prox.second;
139 Crop total_crop = _crop;
142 total_crop.right += im->size().width / 2;
144 case PART_RIGHT_HALF:
145 total_crop.left += im->size().width / 2;
148 total_crop.bottom += im->size().height / 2;
150 case PART_BOTTOM_HALF:
151 total_crop.top += im->size().height / 2;
158 /* Scale the crop down to account for the scaling that has already happened in ImageProxy::image */
159 int const r = pow(2, reduce);
160 total_crop.left /= r;
161 total_crop.right /= r;
163 total_crop.bottom /= r;
166 dcp::YUVToRGB yuv_to_rgb = dcp::YUV_TO_RGB_REC601;
167 if (_colour_conversion) {
168 yuv_to_rgb = _colour_conversion.get().yuv_to_rgb();
171 _image = im->crop_scale_window (
172 total_crop, _inter_size, _out_size, yuv_to_rgb, _video_range, pixel_format (im->pixel_format()), aligned, fast
176 _image->alpha_blend (Image::ensure_aligned (_text->image), _text->position);
180 _image->fade (_fade.get ());
185 PlayerVideo::add_metadata (xmlpp::Node* node) const
189 node->add_child("Fade")->add_child_text (raw_convert<string> (_fade.get ()));
191 _in->add_metadata (node->add_child ("In"));
192 node->add_child("InterWidth")->add_child_text (raw_convert<string> (_inter_size.width));
193 node->add_child("InterHeight")->add_child_text (raw_convert<string> (_inter_size.height));
194 node->add_child("OutWidth")->add_child_text (raw_convert<string> (_out_size.width));
195 node->add_child("OutHeight")->add_child_text (raw_convert<string> (_out_size.height));
196 node->add_child("Eyes")->add_child_text (raw_convert<string> (static_cast<int> (_eyes)));
197 node->add_child("Part")->add_child_text (raw_convert<string> (static_cast<int> (_part)));
198 node->add_child("VideoRange")->add_child_text(raw_convert<string>(static_cast<int>(_video_range)));
199 if (_colour_conversion) {
200 _colour_conversion.get().as_xml (node);
203 node->add_child ("SubtitleWidth")->add_child_text (raw_convert<string> (_text->image->size().width));
204 node->add_child ("SubtitleHeight")->add_child_text (raw_convert<string> (_text->image->size().height));
205 node->add_child ("SubtitleX")->add_child_text (raw_convert<string> (_text->position.x));
206 node->add_child ("SubtitleY")->add_child_text (raw_convert<string> (_text->position.y));
211 PlayerVideo::send_binary (shared_ptr<Socket> socket) const
213 _in->send_binary (socket);
215 _text->image->write_to_socket (socket);
220 PlayerVideo::has_j2k () const
222 /* XXX: maybe other things */
224 shared_ptr<const J2KImageProxy> j2k = dynamic_pointer_cast<const J2KImageProxy> (_in);
229 return _crop == Crop () && _out_size == j2k->size() && !_text && !_fade && !_colour_conversion;
233 PlayerVideo::j2k () const
235 shared_ptr<const J2KImageProxy> j2k = dynamic_pointer_cast<const J2KImageProxy> (_in);
236 DCPOMATIC_ASSERT (j2k);
241 PlayerVideo::inter_position () const
243 return Position<int> ((_out_size.width - _inter_size.width) / 2, (_out_size.height - _inter_size.height) / 2);
246 /** @return true if this PlayerVideo is definitely the same as another, false if it is probably not */
248 PlayerVideo::same (shared_ptr<const PlayerVideo> other) const
250 if (_crop != other->_crop ||
251 _fade != other->_fade ||
252 _inter_size != other->_inter_size ||
253 _out_size != other->_out_size ||
254 _eyes != other->_eyes ||
255 _part != other->_part ||
256 _colour_conversion != other->_colour_conversion ||
257 _video_range != other->_video_range) {
261 if ((!_text && other->_text) || (_text && !other->_text)) {
262 /* One has a text and the other doesn't */
266 if (_text && other->_text && !_text->same (other->_text.get ())) {
267 /* They both have texts but they are different */
271 /* Now neither has subtitles */
273 return _in->same (other->_in);
277 PlayerVideo::force (AVPixelFormat, AVPixelFormat force_to)
283 PlayerVideo::keep_xyz_or_rgb (AVPixelFormat p)
285 return p == AV_PIX_FMT_XYZ12LE ? AV_PIX_FMT_XYZ12LE : AV_PIX_FMT_RGB48LE;
289 PlayerVideo::prepare (function<AVPixelFormat (AVPixelFormat)> pixel_format, bool aligned, bool fast)
291 _in->prepare (_inter_size);
292 boost::mutex::scoped_lock lm (_mutex);
294 make_image (pixel_format, aligned, fast);
299 PlayerVideo::memory_used () const
301 return _in->memory_used();
304 /** @return Shallow copy of this; _in and _text are shared between the original and the copy */
305 shared_ptr<PlayerVideo>
306 PlayerVideo::shallow_copy () const
308 return shared_ptr<PlayerVideo>(
325 /** Re-read crop, fade, inter/out size, colour conversion and video range from our content.
326 * @return true if this was possible, false if not.
329 PlayerVideo::reset_metadata (shared_ptr<const Film> film, dcp::Size video_container_size, dcp::Size film_frame_size)
331 shared_ptr<Content> content = _content.lock();
332 if (!content || !_video_frame) {
336 _crop = content->video->crop();
337 _fade = content->video->fade(film, _video_frame.get());
338 _inter_size = content->video->scale().size(content->video, video_container_size, film_frame_size);
339 _out_size = video_container_size;
340 _colour_conversion = content->video->colour_conversion();
341 _video_range = content->video->range();