src/lib/player_video.cc

   1 /*
   2     Copyright (C) 2013-2021 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   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.
  10
  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.
  15
  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/>.
  18
  19 */
  20
  21 #include "content.h"
  22 #include "film.h"
  23 #include "image.h"
  24 #include "image_proxy.h"
  25 #include "j2k_image_proxy.h"
  26 #include "player.h"
  27 #include "player_video.h"
  28 #include "video_content.h"
  29 #include <dcp/raw_convert.h>
  30 extern "C" {
  31 #include <libavutil/pixfmt.h>
  32 }
  33 #include <libxml++/libxml++.h>
  34 #include <iostream>
  35
  36 using std::cout;
  37 using std::dynamic_pointer_cast;
  38 using std::make_shared;
  39 using std::shared_ptr;
  40 using std::string;
  41 using std::weak_ptr;
  42 using boost::optional;
  43 using std::function;
  44 using dcp::Data;
  45 using dcp::raw_convert;
  46
  47 PlayerVideo::PlayerVideo (
  48         shared_ptr<const ImageProxy> in,
  49         Crop crop,
  50         boost::optional<double> fade,
  51         dcp::Size inter_size,
  52         dcp::Size out_size,
  53         Eyes eyes,
  54         Part part,
  55         optional<ColourConversion> colour_conversion,
  56         VideoRange video_range,
  57         weak_ptr<Content> content,
  58         optional<Frame> video_frame,
  59         bool error
  60         )
  61         : _in (in)
  62         , _crop (crop)
  63         , _fade (fade)
  64         , _inter_size (inter_size)
  65         , _out_size (out_size)
  66         , _eyes (eyes)
  67         , _part (part)
  68         , _colour_conversion (colour_conversion)
  69         , _video_range (video_range)
  70         , _content (content)
  71         , _video_frame (video_frame)
  72         , _error (error)
  73 {
  74
  75 }
  76
  77 PlayerVideo::PlayerVideo (shared_ptr<cxml::Node> node, shared_ptr<Socket> socket)
  78 {
  79         _crop = Crop (node);
  80         _fade = node->optional_number_child<double> ("Fade");
  81
  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);
  88
  89         /* Assume that the ColourConversion uses the current state version */
  90         _colour_conversion = ColourConversion::from_xml (node, Film::current_state_version);
  91
  92         _in = image_proxy_factory (node->node_child("In"), socket);
  93
  94         if (node->optional_number_child<int>("SubtitleX")) {
  95
  96                 auto image = make_shared<Image> (
  97                         AV_PIX_FMT_BGRA, dcp::Size(node->number_child<int>("SubtitleWidth"), node->number_child<int>("SubtitleHeight")), true
  98                         );
  99
 100                 image->read_from_socket (socket);
 101
 102                 _text = PositionImage (image, Position<int>(node->number_child<int>("SubtitleX"), node->number_child<int>("SubtitleY")));
 103         }
 104 }
 105
 106 void
 107 PlayerVideo::set_text (PositionImage image)
 108 {
 109         _text = image;
 110 }
 111
 112 shared_ptr<Image>
 113 PlayerVideo::image (function<AVPixelFormat (AVPixelFormat)> pixel_format, VideoRange video_range, bool aligned, bool fast) const
 114 {
 115         /* XXX: this assumes that image() and prepare() are only ever called with the same parameters (except crop, inter size, out size, fade) */
 116
 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, aligned, fast);
 120         }
 121         return _image;
 122 }
 123
 124
 125 shared_ptr<Image>
 126 PlayerVideo::raw_image () const
 127 {
 128         return _in->image(_inter_size).image;
 129 }
 130
 131
 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 aligned true if the output image should be aligned to 32-byte boundaries.
 137  *  @param fast true to be fast at the expense of quality.
 138  */
 139 void
 140 PlayerVideo::make_image (function<AVPixelFormat (AVPixelFormat)> pixel_format, VideoRange video_range, bool aligned, bool fast) const
 141 {
 142         _image_crop = _crop;
 143         _image_inter_size = _inter_size;
 144         _image_out_size = _out_size;
 145         _image_fade = _fade;
 146
 147         auto prox = _in->image (_inter_size);
 148         _error = prox.error;
 149
 150         auto total_crop = _crop;
 151         switch (_part) {
 152         case Part::LEFT_HALF:
 153                 total_crop.right += prox.image->size().width / 2;
 154                 break;
 155         case Part::RIGHT_HALF:
 156                 total_crop.left += prox.image->size().width / 2;
 157                 break;
 158         case Part::TOP_HALF:
 159                 total_crop.bottom += prox.image->size().height / 2;
 160                 break;
 161         case Part::BOTTOM_HALF:
 162                 total_crop.top += prox.image->size().height / 2;
 163                 break;
 164         default:
 165                 break;
 166         }
 167
 168         if (prox.log2_scaling > 0) {
 169                 /* Scale the crop down to account for the scaling that has already happened in ImageProxy::image */
 170                 int const r = pow(2, prox.log2_scaling);
 171                 total_crop.left /= r;
 172                 total_crop.right /= r;
 173                 total_crop.top /= r;
 174                 total_crop.bottom /= r;
 175         }
 176
 177         dcp::YUVToRGB yuv_to_rgb = dcp::YUVToRGB::REC601;
 178         if (_colour_conversion) {
 179                 yuv_to_rgb = _colour_conversion.get().yuv_to_rgb();
 180         }
 181
 182         _image = prox.image->crop_scale_window (
 183                 total_crop, _inter_size, _out_size, yuv_to_rgb, _video_range, pixel_format (prox.image->pixel_format()), video_range, aligned, fast
 184                 );
 185
 186         if (_text) {
 187                 _image->alpha_blend (Image::ensure_aligned (_text->image), _text->position);
 188         }
 189
 190         if (_fade) {
 191                 _image->fade (_fade.get ());
 192         }
 193 }
 194
 195 void
 196 PlayerVideo::add_metadata (xmlpp::Node* node) const
 197 {
 198         _crop.as_xml (node);
 199         if (_fade) {
 200                 node->add_child("Fade")->add_child_text (raw_convert<string> (_fade.get ()));
 201         }
 202         _in->add_metadata (node->add_child ("In"));
 203         node->add_child("InterWidth")->add_child_text (raw_convert<string> (_inter_size.width));
 204         node->add_child("InterHeight")->add_child_text (raw_convert<string> (_inter_size.height));
 205         node->add_child("OutWidth")->add_child_text (raw_convert<string> (_out_size.width));
 206         node->add_child("OutHeight")->add_child_text (raw_convert<string> (_out_size.height));
 207         node->add_child("Eyes")->add_child_text (raw_convert<string> (static_cast<int> (_eyes)));
 208         node->add_child("Part")->add_child_text (raw_convert<string> (static_cast<int> (_part)));
 209         node->add_child("VideoRange")->add_child_text(raw_convert<string>(static_cast<int>(_video_range)));
 210         node->add_child("Error")->add_child_text(_error ? "1" : "0");
 211         if (_colour_conversion) {
 212                 _colour_conversion.get().as_xml (node);
 213         }
 214         if (_text) {
 215                 node->add_child ("SubtitleWidth")->add_child_text (raw_convert<string> (_text->image->size().width));
 216                 node->add_child ("SubtitleHeight")->add_child_text (raw_convert<string> (_text->image->size().height));
 217                 node->add_child ("SubtitleX")->add_child_text (raw_convert<string> (_text->position.x));
 218                 node->add_child ("SubtitleY")->add_child_text (raw_convert<string> (_text->position.y));
 219         }
 220 }
 221
 222 void
 223 PlayerVideo::write_to_socket (shared_ptr<Socket> socket) const
 224 {
 225         _in->write_to_socket (socket);
 226         if (_text) {
 227                 _text->image->write_to_socket (socket);
 228         }
 229 }
 230
 231 bool
 232 PlayerVideo::has_j2k () const
 233 {
 234         /* XXX: maybe other things */
 235
 236         auto j2k = dynamic_pointer_cast<const J2KImageProxy> (_in);
 237         if (!j2k) {
 238                 return false;
 239         }
 240
 241         return _crop == Crop() && _out_size == j2k->size() && _inter_size == j2k->size() && !_text && !_fade && !_colour_conversion;
 242 }
 243
 244 shared_ptr<const dcp::Data>
 245 PlayerVideo::j2k () const
 246 {
 247         auto j2k = dynamic_pointer_cast<const J2KImageProxy> (_in);
 248         DCPOMATIC_ASSERT (j2k);
 249         return j2k->j2k ();
 250 }
 251
 252 Position<int>
 253 PlayerVideo::inter_position () const
 254 {
 255         return Position<int> ((_out_size.width - _inter_size.width) / 2, (_out_size.height - _inter_size.height) / 2);
 256 }
 257
 258 /** @return true if this PlayerVideo is definitely the same as another, false if it is probably not */
 259 bool
 260 PlayerVideo::same (shared_ptr<const PlayerVideo> other) const
 261 {
 262         if (_crop != other->_crop ||
 263             _fade != other->_fade ||
 264             _inter_size != other->_inter_size ||
 265             _out_size != other->_out_size ||
 266             _eyes != other->_eyes ||
 267             _part != other->_part ||
 268             _colour_conversion != other->_colour_conversion ||
 269             _video_range != other->_video_range) {
 270                 return false;
 271         }
 272
 273         if ((!_text && other->_text) || (_text && !other->_text)) {
 274                 /* One has a text and the other doesn't */
 275                 return false;
 276         }
 277
 278         if (_text && other->_text && !_text->same (other->_text.get ())) {
 279                 /* They both have texts but they are different */
 280                 return false;
 281         }
 282
 283         /* Now neither has subtitles */
 284
 285         return _in->same (other->_in);
 286 }
 287
 288 AVPixelFormat
 289 PlayerVideo::force (AVPixelFormat, AVPixelFormat force_to)
 290 {
 291         return force_to;
 292 }
 293
 294 AVPixelFormat
 295 PlayerVideo::keep_xyz_or_rgb (AVPixelFormat p)
 296 {
 297         return p == AV_PIX_FMT_XYZ12LE ? AV_PIX_FMT_XYZ12LE : AV_PIX_FMT_RGB48LE;
 298 }
 299
 300 void
 301 PlayerVideo::prepare (function<AVPixelFormat (AVPixelFormat)> pixel_format, VideoRange video_range, bool aligned, bool fast, bool proxy_only)
 302 {
 303         _in->prepare (_inter_size);
 304         boost::mutex::scoped_lock lm (_mutex);
 305         if (!_image && !proxy_only) {
 306                 make_image (pixel_format, video_range, aligned, fast);
 307         }
 308 }
 309
 310 size_t
 311 PlayerVideo::memory_used () const
 312 {
 313         return _in->memory_used();
 314 }
 315
 316 /** @return Shallow copy of this; _in and _text are shared between the original and the copy */
 317 shared_ptr<PlayerVideo>
 318 PlayerVideo::shallow_copy () const
 319 {
 320         return std::make_shared<PlayerVideo>(
 321                 _in,
 322                 _crop,
 323                 _fade,
 324                 _inter_size,
 325                 _out_size,
 326                 _eyes,
 327                 _part,
 328                 _colour_conversion,
 329                 _video_range,
 330                 _content,
 331                 _video_frame,
 332                 _error
 333                 );
 334 }
 335
 336 /** Re-read crop, fade, inter/out size, colour conversion and video range from our content.
 337  *  @return true if this was possible, false if not.
 338  */
 339 bool
 340 PlayerVideo::reset_metadata (shared_ptr<const Film> film, dcp::Size player_video_container_size)
 341 {
 342         auto content = _content.lock();
 343         if (!content || !_video_frame) {
 344                 return false;
 345         }
 346
 347         _crop = content->video->crop();
 348         _fade = content->video->fade(film, _video_frame.get());
 349         _inter_size = scale_for_display(content->video->scaled_size(film->frame_size()), player_video_container_size, film->frame_size());
 350         _out_size = player_video_container_size;
 351         _colour_conversion = content->video->colour_conversion();
 352         _video_range = content->video->range();
 353
 354         return true;
 355 }