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/>.
25 #include "image_proxy.h"
26 #include "j2k_image_proxy.h"
28 #include "player_video.h"
29 #include "video_content.h"
30 #include <dcp/raw_convert.h>
32 #include <libavutil/pixfmt.h>
34 #include <libxml++/libxml++.h>
39 using std::dynamic_pointer_cast;
41 using std::make_shared;
42 using std::shared_ptr;
45 using boost::optional;
47 using dcp::raw_convert;
48 using namespace dcpomatic;
51 PlayerVideo::PlayerVideo (
52 shared_ptr<const ImageProxy> in,
54 boost::optional<double> fade,
59 optional<ColourConversion> colour_conversion,
60 VideoRange video_range,
61 weak_ptr<Content> content,
62 optional<ContentTime> video_time,
68 , _inter_size (inter_size)
69 , _out_size (out_size)
72 , _colour_conversion (colour_conversion)
73 , _video_range (video_range)
75 , _video_time(video_time)
82 PlayerVideo::PlayerVideo (shared_ptr<cxml::Node> node, shared_ptr<Socket> socket)
85 _fade = node->optional_number_child<double> ("Fade");
87 _inter_size = dcp::Size (node->number_child<int> ("InterWidth"), node->number_child<int> ("InterHeight"));
88 _out_size = dcp::Size (node->number_child<int> ("OutWidth"), node->number_child<int> ("OutHeight"));
89 _eyes = static_cast<Eyes>(node->number_child<int>("Eyes"));
90 _part = static_cast<Part>(node->number_child<int>("Part"));
91 _video_range = static_cast<VideoRange>(node->number_child<int>("VideoRange"));
92 _error = node->optional_bool_child("Error").get_value_or (false);
94 /* Assume that the ColourConversion uses the current state version */
95 _colour_conversion = ColourConversion::from_xml (node, Film::current_state_version);
97 _in = image_proxy_factory (node->node_child("In"), socket);
99 if (node->optional_number_child<int>("SubtitleX")) {
101 auto image = make_shared<Image> (
102 AV_PIX_FMT_BGRA, dcp::Size(node->number_child<int>("SubtitleWidth"), node->number_child<int>("SubtitleHeight")), Image::Alignment::PADDED
105 image->read_from_socket (socket);
107 _text = PositionImage (image, Position<int>(node->number_child<int>("SubtitleX"), node->number_child<int>("SubtitleY")));
113 PlayerVideo::set_text (PositionImage image)
120 PlayerVideo::image (function<AVPixelFormat (AVPixelFormat)> pixel_format, VideoRange video_range, bool fast) const
122 /* XXX: this assumes that image() and prepare() are only ever called with the same parameters (except crop, inter size, out size, fade) */
124 boost::mutex::scoped_lock lm (_mutex);
125 if (!_image || _crop != _image_crop || _inter_size != _image_inter_size || _out_size != _image_out_size || _fade != _image_fade) {
126 make_image (pixel_format, video_range, fast);
132 shared_ptr<const Image>
133 PlayerVideo::raw_image () const
135 return _in->image(Image::Alignment::COMPACT, _inter_size).image;
139 /** Create an image for this frame. A lock must be held on _mutex.
140 * @param pixel_format Function which is called to decide what pixel format the output image should be;
141 * it is passed the pixel format of the input image from the ImageProxy, and should return the desired
142 * output pixel format. Two functions force and keep_xyz_or_rgb are provided for use here.
143 * @param fast true to be fast at the expense of quality.
146 PlayerVideo::make_image (function<AVPixelFormat (AVPixelFormat)> pixel_format, VideoRange video_range, bool fast) const
149 _image_inter_size = _inter_size;
150 _image_out_size = _out_size;
153 auto prox = _in->image (Image::Alignment::PADDED, _inter_size);
156 auto total_crop = _crop;
158 case Part::LEFT_HALF:
159 total_crop.right += prox.image->size().width / 2;
161 case Part::RIGHT_HALF:
162 total_crop.left += prox.image->size().width / 2;
165 total_crop.bottom += prox.image->size().height / 2;
167 case Part::BOTTOM_HALF:
168 total_crop.top += prox.image->size().height / 2;
174 if (prox.log2_scaling > 0) {
175 /* Scale the crop down to account for the scaling that has already happened in ImageProxy::image */
176 int const r = pow(2, prox.log2_scaling);
177 total_crop.left /= r;
178 total_crop.right /= r;
180 total_crop.bottom /= r;
183 dcp::YUVToRGB yuv_to_rgb = dcp::YUVToRGB::REC601;
184 if (_colour_conversion) {
185 yuv_to_rgb = _colour_conversion.get().yuv_to_rgb();
188 _image = prox.image->crop_scale_window (
189 total_crop, _inter_size, _out_size, yuv_to_rgb, _video_range, pixel_format (prox.image->pixel_format()), video_range, Image::Alignment::COMPACT, fast
193 _image->alpha_blend (_text->image, _text->position);
197 _image->fade (_fade.get ());
203 PlayerVideo::add_metadata (xmlpp::Node* node) const
207 node->add_child("Fade")->add_child_text (raw_convert<string> (_fade.get ()));
209 _in->add_metadata (node->add_child ("In"));
210 node->add_child("InterWidth")->add_child_text (raw_convert<string> (_inter_size.width));
211 node->add_child("InterHeight")->add_child_text (raw_convert<string> (_inter_size.height));
212 node->add_child("OutWidth")->add_child_text (raw_convert<string> (_out_size.width));
213 node->add_child("OutHeight")->add_child_text (raw_convert<string> (_out_size.height));
214 node->add_child("Eyes")->add_child_text (raw_convert<string> (static_cast<int> (_eyes)));
215 node->add_child("Part")->add_child_text (raw_convert<string> (static_cast<int> (_part)));
216 node->add_child("VideoRange")->add_child_text(raw_convert<string>(static_cast<int>(_video_range)));
217 node->add_child("Error")->add_child_text(_error ? "1" : "0");
218 if (_colour_conversion) {
219 _colour_conversion.get().as_xml (node);
222 node->add_child ("SubtitleWidth")->add_child_text (raw_convert<string> (_text->image->size().width));
223 node->add_child ("SubtitleHeight")->add_child_text (raw_convert<string> (_text->image->size().height));
224 node->add_child ("SubtitleX")->add_child_text (raw_convert<string> (_text->position.x));
225 node->add_child ("SubtitleY")->add_child_text (raw_convert<string> (_text->position.y));
231 PlayerVideo::write_to_socket (shared_ptr<Socket> socket) const
233 _in->write_to_socket (socket);
235 _text->image->write_to_socket (socket);
241 PlayerVideo::has_j2k () const
243 /* XXX: maybe other things */
245 auto j2k = dynamic_pointer_cast<const J2KImageProxy> (_in);
250 return _crop == Crop() && _out_size == j2k->size() && _inter_size == j2k->size() && !_text && !_fade && !_colour_conversion;
254 shared_ptr<const dcp::Data>
255 PlayerVideo::j2k () const
257 auto j2k = dynamic_pointer_cast<const J2KImageProxy> (_in);
258 DCPOMATIC_ASSERT (j2k);
264 PlayerVideo::inter_position () const
266 return Position<int> ((_out_size.width - _inter_size.width) / 2, (_out_size.height - _inter_size.height) / 2);
270 /** @return true if this PlayerVideo is definitely the same as another, false if it is probably not */
272 PlayerVideo::same (shared_ptr<const PlayerVideo> other) const
274 if (_crop != other->_crop ||
275 _fade != other->_fade ||
276 _inter_size != other->_inter_size ||
277 _out_size != other->_out_size ||
278 _eyes != other->_eyes ||
279 _part != other->_part ||
280 _colour_conversion != other->_colour_conversion ||
281 _video_range != other->_video_range) {
285 if ((!_text && other->_text) || (_text && !other->_text)) {
286 /* One has a text and the other doesn't */
290 if (_text && other->_text && !_text->same (other->_text.get ())) {
291 /* They both have texts but they are different */
295 /* Now neither has subtitles */
297 return _in->same (other->_in);
302 PlayerVideo::force (AVPixelFormat force_to)
308 PlayerVideo::keep_xyz_or_rgb (AVPixelFormat p)
310 return p == AV_PIX_FMT_XYZ12LE ? AV_PIX_FMT_XYZ12LE : AV_PIX_FMT_RGB48LE;
315 PlayerVideo::prepare (function<AVPixelFormat (AVPixelFormat)> pixel_format, VideoRange video_range, Image::Alignment alignment, bool fast, bool proxy_only)
317 _in->prepare (alignment, _inter_size);
318 boost::mutex::scoped_lock lm (_mutex);
319 if (!_image && !proxy_only) {
320 make_image (pixel_format, video_range, fast);
326 PlayerVideo::memory_used () const
328 return _in->memory_used();
332 /** @return Shallow copy of this; _in and _text are shared between the original and the copy */
333 shared_ptr<PlayerVideo>
334 PlayerVideo::shallow_copy () const
336 return std::make_shared<PlayerVideo>(
353 /** Re-read crop, fade, inter/out size, colour conversion and video range from our content.
354 * @return true if this was possible, false if not.
357 PlayerVideo::reset_metadata (shared_ptr<const Film> film, dcp::Size player_video_container_size)
359 auto content = _content.lock();
360 if (!content || !_video_time) {
364 _crop = content->video->actual_crop();
365 _fade = content->video->fade(film, _video_time.get());
366 _inter_size = scale_for_display(
367 content->video->scaled_size(film->frame_size()),
368 player_video_container_size,
370 content->video->pixel_quanta()
372 _out_size = player_video_container_size;
373 _colour_conversion = content->video->colour_conversion();
374 _video_range = content->video->range();