2 Copyright (C) 2013-2021 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/>.
24 #include "image_proxy.h"
25 #include "j2k_image_proxy.h"
27 #include "player_video.h"
28 #include "video_content.h"
29 #include <dcp/raw_convert.h>
31 #include <libavutil/pixfmt.h>
33 #include <libxml++/libxml++.h>
37 using std::dynamic_pointer_cast;
38 using std::make_shared;
39 using std::shared_ptr;
42 using boost::optional;
45 using dcp::raw_convert;
47 PlayerVideo::PlayerVideo (
48 shared_ptr<const ImageProxy> in,
50 boost::optional<double> fade,
55 optional<ColourConversion> colour_conversion,
56 VideoRange video_range,
57 weak_ptr<Content> content,
58 optional<Frame> video_frame,
64 , _inter_size (inter_size)
65 , _out_size (out_size)
68 , _colour_conversion (colour_conversion)
69 , _video_range (video_range)
71 , _video_frame (video_frame)
77 PlayerVideo::PlayerVideo (shared_ptr<cxml::Node> node, shared_ptr<Socket> socket)
80 _fade = node->optional_number_child<double> ("Fade");
82 _inter_size = dcp::Size (node->number_child<int> ("InterWidth"), node->number_child<int> ("InterHeight"));
83 _out_size = dcp::Size (node->number_child<int> ("OutWidth"), node->number_child<int> ("OutHeight"));
84 _eyes = static_cast<Eyes>(node->number_child<int>("Eyes"));
85 _part = static_cast<Part>(node->number_child<int>("Part"));
86 _video_range = static_cast<VideoRange>(node->number_child<int>("VideoRange"));
87 _error = node->optional_bool_child("Error").get_value_or (false);
89 /* Assume that the ColourConversion uses the current state version */
90 _colour_conversion = ColourConversion::from_xml (node, Film::current_state_version);
92 _in = image_proxy_factory (node->node_child("In"), socket);
94 if (node->optional_number_child<int>("SubtitleX")) {
96 auto image = make_shared<Image> (
97 AV_PIX_FMT_BGRA, dcp::Size(node->number_child<int>("SubtitleWidth"), node->number_child<int>("SubtitleHeight")), Image::Alignment::PADDED
100 image->read_from_socket (socket);
102 _text = PositionImage (image, Position<int>(node->number_child<int>("SubtitleX"), node->number_child<int>("SubtitleY")));
107 PlayerVideo::set_text (PositionImage image)
113 PlayerVideo::image (function<AVPixelFormat (AVPixelFormat)> pixel_format, VideoRange video_range, bool fast) const
115 /* XXX: this assumes that image() and prepare() are only ever called with the same parameters (except crop, inter size, out size, fade) */
117 boost::mutex::scoped_lock lm (_mutex);
118 if (!_image || _crop != _image_crop || _inter_size != _image_inter_size || _out_size != _image_out_size || _fade != _image_fade) {
119 make_image (pixel_format, video_range, fast);
125 shared_ptr<const Image>
126 PlayerVideo::raw_image () const
128 return _in->image(Image::Alignment::COMPACT, _inter_size).image;
132 /** Create an image for this frame. A lock must be held on _mutex.
133 * @param pixel_format Function which is called to decide what pixel format the output image should be;
134 * it is passed the pixel format of the input image from the ImageProxy, and should return the desired
135 * output pixel format. Two functions force and keep_xyz_or_rgb are provided for use here.
136 * @param fast true to be fast at the expense of quality.
139 PlayerVideo::make_image (function<AVPixelFormat (AVPixelFormat)> pixel_format, VideoRange video_range, bool fast) const
142 _image_inter_size = _inter_size;
143 _image_out_size = _out_size;
146 auto prox = _in->image (Image::Alignment::PADDED, _inter_size);
149 auto total_crop = _crop;
151 case Part::LEFT_HALF:
152 total_crop.right += prox.image->size().width / 2;
154 case Part::RIGHT_HALF:
155 total_crop.left += prox.image->size().width / 2;
158 total_crop.bottom += prox.image->size().height / 2;
160 case Part::BOTTOM_HALF:
161 total_crop.top += prox.image->size().height / 2;
167 if (prox.log2_scaling > 0) {
168 /* Scale the crop down to account for the scaling that has already happened in ImageProxy::image */
169 int const r = pow(2, prox.log2_scaling);
170 total_crop.left /= r;
171 total_crop.right /= r;
173 total_crop.bottom /= r;
176 dcp::YUVToRGB yuv_to_rgb = dcp::YUVToRGB::REC601;
177 if (_colour_conversion) {
178 yuv_to_rgb = _colour_conversion.get().yuv_to_rgb();
181 _image = prox.image->crop_scale_window (
182 total_crop, _inter_size, _out_size, yuv_to_rgb, _video_range, pixel_format (prox.image->pixel_format()), video_range, Image::Alignment::COMPACT, fast
186 _image->alpha_blend (_text->image, _text->position);
190 _image->fade (_fade.get ());
195 PlayerVideo::add_metadata (xmlpp::Node* node) const
199 node->add_child("Fade")->add_child_text (raw_convert<string> (_fade.get ()));
201 _in->add_metadata (node->add_child ("In"));
202 node->add_child("InterWidth")->add_child_text (raw_convert<string> (_inter_size.width));
203 node->add_child("InterHeight")->add_child_text (raw_convert<string> (_inter_size.height));
204 node->add_child("OutWidth")->add_child_text (raw_convert<string> (_out_size.width));
205 node->add_child("OutHeight")->add_child_text (raw_convert<string> (_out_size.height));
206 node->add_child("Eyes")->add_child_text (raw_convert<string> (static_cast<int> (_eyes)));
207 node->add_child("Part")->add_child_text (raw_convert<string> (static_cast<int> (_part)));
208 node->add_child("VideoRange")->add_child_text(raw_convert<string>(static_cast<int>(_video_range)));
209 node->add_child("Error")->add_child_text(_error ? "1" : "0");
210 if (_colour_conversion) {
211 _colour_conversion.get().as_xml (node);
214 node->add_child ("SubtitleWidth")->add_child_text (raw_convert<string> (_text->image->size().width));
215 node->add_child ("SubtitleHeight")->add_child_text (raw_convert<string> (_text->image->size().height));
216 node->add_child ("SubtitleX")->add_child_text (raw_convert<string> (_text->position.x));
217 node->add_child ("SubtitleY")->add_child_text (raw_convert<string> (_text->position.y));
222 PlayerVideo::write_to_socket (shared_ptr<Socket> socket) const
224 _in->write_to_socket (socket);
226 _text->image->write_to_socket (socket);
231 PlayerVideo::has_j2k () const
233 /* XXX: maybe other things */
235 auto j2k = dynamic_pointer_cast<const J2KImageProxy> (_in);
240 return _crop == Crop() && _out_size == j2k->size() && _inter_size == j2k->size() && !_text && !_fade && !_colour_conversion;
243 shared_ptr<const dcp::Data>
244 PlayerVideo::j2k () const
246 auto j2k = dynamic_pointer_cast<const J2KImageProxy> (_in);
247 DCPOMATIC_ASSERT (j2k);
252 PlayerVideo::inter_position () const
254 return Position<int> ((_out_size.width - _inter_size.width) / 2, (_out_size.height - _inter_size.height) / 2);
257 /** @return true if this PlayerVideo is definitely the same as another, false if it is probably not */
259 PlayerVideo::same (shared_ptr<const PlayerVideo> other) const
261 if (_crop != other->_crop ||
262 _fade != other->_fade ||
263 _inter_size != other->_inter_size ||
264 _out_size != other->_out_size ||
265 _eyes != other->_eyes ||
266 _part != other->_part ||
267 _colour_conversion != other->_colour_conversion ||
268 _video_range != other->_video_range) {
272 if ((!_text && other->_text) || (_text && !other->_text)) {
273 /* One has a text and the other doesn't */
277 if (_text && other->_text && !_text->same (other->_text.get ())) {
278 /* They both have texts but they are different */
282 /* Now neither has subtitles */
284 return _in->same (other->_in);
288 PlayerVideo::force (AVPixelFormat, AVPixelFormat force_to)
294 PlayerVideo::keep_xyz_or_rgb (AVPixelFormat p)
296 return p == AV_PIX_FMT_XYZ12LE ? AV_PIX_FMT_XYZ12LE : AV_PIX_FMT_RGB48LE;
300 PlayerVideo::prepare (function<AVPixelFormat (AVPixelFormat)> pixel_format, VideoRange video_range, Image::Alignment alignment, bool fast, bool proxy_only)
302 _in->prepare (alignment, _inter_size);
303 boost::mutex::scoped_lock lm (_mutex);
304 if (!_image && !proxy_only) {
305 make_image (pixel_format, video_range, fast);
310 PlayerVideo::memory_used () const
312 return _in->memory_used();
315 /** @return Shallow copy of this; _in and _text are shared between the original and the copy */
316 shared_ptr<PlayerVideo>
317 PlayerVideo::shallow_copy () const
319 return std::make_shared<PlayerVideo>(
335 /** Re-read crop, fade, inter/out size, colour conversion and video range from our content.
336 * @return true if this was possible, false if not.
339 PlayerVideo::reset_metadata (shared_ptr<const Film> film, dcp::Size player_video_container_size)
341 auto content = _content.lock();
342 if (!content || !_video_frame) {
346 _crop = content->video->actual_crop();
347 _fade = content->video->fade(film, _video_frame.get());
348 _inter_size = scale_for_display(
349 content->video->scaled_size(film->frame_size()),
350 player_video_container_size,
352 content->video->pixel_quanta()
354 _out_size = player_video_container_size;
355 _colour_conversion = content->video->colour_conversion();
356 _video_range = content->video->range();