src/lib/player_video.cc

   1 /*
   2     Copyright (C) 2013-2020 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 "player_video.h"
  22 #include "content.h"
  23 #include "video_content.h"
  24 #include "image.h"
  25 #include "image_proxy.h"
  26 #include "j2k_image_proxy.h"
  27 #include "film.h"
  28 #include "player.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::string;
  37 using std::cout;
  38 using std::pair;
  39 using boost::shared_ptr;
  40 using boost::weak_ptr;
  41 using boost::dynamic_pointer_cast;
  42 using boost::optional;
  43 using boost::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 = (Eyes) node->number_child<int> ("Eyes");
  85         _part = (Part) node->number_child<int> ("Part");
  86         _video_range = (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                 shared_ptr<Image> image (
  97                         new Image (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 /** Create an image for this frame.  A lock must be held on _mutex.
 125  *  @param pixel_format Function which is called to decide what pixel format the output image should be;
 126  *  it is passed the pixel format of the input image from the ImageProxy, and should return the desired
 127  *  output pixel format.  Two functions force and keep_xyz_or_rgb are provided for use here.
 128  *  @param aligned true if the output image should be aligned to 32-byte boundaries.
 129  *  @param fast true to be fast at the expense of quality.
 130  */
 131 void
 132 PlayerVideo::make_image (function<AVPixelFormat (AVPixelFormat)> pixel_format, VideoRange video_range, bool aligned, bool fast) const
 133 {
 134         _image_crop = _crop;
 135         _image_inter_size = _inter_size;
 136         _image_out_size = _out_size;
 137         _image_fade = _fade;
 138
 139         ImageProxy::Result prox = _in->image (_inter_size);
 140         _error = prox.error;
 141
 142         Crop total_crop = _crop;
 143         switch (_part) {
 144         case PART_LEFT_HALF:
 145                 total_crop.right += prox.image->size().width / 2;
 146                 break;
 147         case PART_RIGHT_HALF:
 148                 total_crop.left += prox.image->size().width / 2;
 149                 break;
 150         case PART_TOP_HALF:
 151                 total_crop.bottom += prox.image->size().height / 2;
 152                 break;
 153         case PART_BOTTOM_HALF:
 154                 total_crop.top += prox.image->size().height / 2;
 155                 break;
 156         default:
 157                 break;
 158         }
 159
 160         if (prox.log2_scaling > 0) {
 161                 /* Scale the crop down to account for the scaling that has already happened in ImageProxy::image */
 162                 int const r = pow(2, prox.log2_scaling);
 163                 total_crop.left /= r;
 164                 total_crop.right /= r;
 165                 total_crop.top /= r;
 166                 total_crop.bottom /= r;
 167         }
 168
 169         dcp::YUVToRGB yuv_to_rgb = dcp::YUV_TO_RGB_REC601;
 170         if (_colour_conversion) {
 171                 yuv_to_rgb = _colour_conversion.get().yuv_to_rgb();
 172         }
 173
 174         _image = prox.image->crop_scale_window (
 175                 total_crop, _inter_size, _out_size, yuv_to_rgb, _video_range, pixel_format (prox.image->pixel_format()), video_range, aligned, fast
 176                 );
 177
 178         if (_text) {
 179                 _image->alpha_blend (Image::ensure_aligned (_text->image), _text->position);
 180         }
 181
 182         if (_fade) {
 183                 _image->fade (_fade.get ());
 184         }
 185 }
 186
 187 void
 188 PlayerVideo::add_metadata (xmlpp::Node* node) const
 189 {
 190         _crop.as_xml (node);
 191         if (_fade) {
 192                 node->add_child("Fade")->add_child_text (raw_convert<string> (_fade.get ()));
 193         }
 194         _in->add_metadata (node->add_child ("In"));
 195         node->add_child("InterWidth")->add_child_text (raw_convert<string> (_inter_size.width));
 196         node->add_child("InterHeight")->add_child_text (raw_convert<string> (_inter_size.height));
 197         node->add_child("OutWidth")->add_child_text (raw_convert<string> (_out_size.width));
 198         node->add_child("OutHeight")->add_child_text (raw_convert<string> (_out_size.height));
 199         node->add_child("Eyes")->add_child_text (raw_convert<string> (static_cast<int> (_eyes)));
 200         node->add_child("Part")->add_child_text (raw_convert<string> (static_cast<int> (_part)));
 201         node->add_child("VideoRange")->add_child_text(raw_convert<string>(static_cast<int>(_video_range)));
 202         node->add_child("Error")->add_child_text(_error ? "1" : "0");
 203         if (_colour_conversion) {
 204                 _colour_conversion.get().as_xml (node);
 205         }
 206         if (_text) {
 207                 node->add_child ("SubtitleWidth")->add_child_text (raw_convert<string> (_text->image->size().width));
 208                 node->add_child ("SubtitleHeight")->add_child_text (raw_convert<string> (_text->image->size().height));
 209                 node->add_child ("SubtitleX")->add_child_text (raw_convert<string> (_text->position.x));
 210                 node->add_child ("SubtitleY")->add_child_text (raw_convert<string> (_text->position.y));
 211         }
 212 }
 213
 214 void
 215 PlayerVideo::write_to_socket (shared_ptr<Socket> socket) const
 216 {
 217         _in->write_to_socket (socket);
 218         if (_text) {
 219                 _text->image->write_to_socket (socket);
 220         }
 221 }
 222
 223 bool
 224 PlayerVideo::has_j2k () const
 225 {
 226         /* XXX: maybe other things */
 227
 228         shared_ptr<const J2KImageProxy> j2k = dynamic_pointer_cast<const J2KImageProxy> (_in);
 229         if (!j2k) {
 230                 return false;
 231         }
 232
 233         return _crop == Crop () && _out_size == j2k->size() && !_text && !_fade && !_colour_conversion;
 234 }
 235
 236 shared_ptr<const dcp::Data>
 237 PlayerVideo::j2k () const
 238 {
 239         shared_ptr<const J2KImageProxy> j2k = dynamic_pointer_cast<const J2KImageProxy> (_in);
 240         DCPOMATIC_ASSERT (j2k);
 241         return j2k->j2k ();
 242 }
 243
 244 Position<int>
 245 PlayerVideo::inter_position () const
 246 {
 247         return Position<int> ((_out_size.width - _inter_size.width) / 2, (_out_size.height - _inter_size.height) / 2);
 248 }
 249
 250 /** @return true if this PlayerVideo is definitely the same as another, false if it is probably not */
 251 bool
 252 PlayerVideo::same (shared_ptr<const PlayerVideo> other) const
 253 {
 254         if (_crop != other->_crop ||
 255             _fade != other->_fade ||
 256             _inter_size != other->_inter_size ||
 257             _out_size != other->_out_size ||
 258             _eyes != other->_eyes ||
 259             _part != other->_part ||
 260             _colour_conversion != other->_colour_conversion ||
 261             _video_range != other->_video_range) {
 262                 return false;
 263         }
 264
 265         if ((!_text && other->_text) || (_text && !other->_text)) {
 266                 /* One has a text and the other doesn't */
 267                 return false;
 268         }
 269
 270         if (_text && other->_text && !_text->same (other->_text.get ())) {
 271                 /* They both have texts but they are different */
 272                 return false;
 273         }
 274
 275         /* Now neither has subtitles */
 276
 277         return _in->same (other->_in);
 278 }
 279
 280 AVPixelFormat
 281 PlayerVideo::force (AVPixelFormat, AVPixelFormat force_to)
 282 {
 283         return force_to;
 284 }
 285
 286 AVPixelFormat
 287 PlayerVideo::keep_xyz_or_rgb (AVPixelFormat p)
 288 {
 289         return p == AV_PIX_FMT_XYZ12LE ? AV_PIX_FMT_XYZ12LE : AV_PIX_FMT_RGB48LE;
 290 }
 291
 292 void
 293 PlayerVideo::prepare (function<AVPixelFormat (AVPixelFormat)> pixel_format, VideoRange video_range, bool aligned, bool fast)
 294 {
 295         _in->prepare (_inter_size);
 296         boost::mutex::scoped_lock lm (_mutex);
 297         if (!_image) {
 298                 make_image (pixel_format, video_range, aligned, fast);
 299         }
 300 }
 301
 302 size_t
 303 PlayerVideo::memory_used () const
 304 {
 305         return _in->memory_used();
 306 }
 307
 308 /** @return Shallow copy of this; _in and _text are shared between the original and the copy */
 309 shared_ptr<PlayerVideo>
 310 PlayerVideo::shallow_copy () const
 311 {
 312         return shared_ptr<PlayerVideo>(
 313                 new PlayerVideo(
 314                         _in,
 315                         _crop,
 316                         _fade,
 317                         _inter_size,
 318                         _out_size,
 319                         _eyes,
 320                         _part,
 321                         _colour_conversion,
 322                         _video_range,
 323                         _content,
 324                         _video_frame,
 325                         _error
 326                         )
 327                 );
 328 }
 329
 330 /** Re-read crop, fade, inter/out size, colour conversion and video range from our content.
 331  *  @return true if this was possible, false if not.
 332  */
 333 bool
 334 PlayerVideo::reset_metadata (shared_ptr<const Film> film, dcp::Size player_video_container_size)
 335 {
 336         shared_ptr<Content> content = _content.lock();
 337         if (!content || !_video_frame) {
 338                 return false;
 339         }
 340
 341         _crop = content->video->crop();
 342         _fade = content->video->fade(film, _video_frame.get());
 343         _inter_size = scale_for_display(content->video->scaled_size(film->frame_size()), player_video_container_size, film->frame_size());
 344         _out_size = player_video_container_size;
 345         _colour_conversion = content->video->colour_conversion();
 346         _video_range = content->video->range();
 347
 348         return true;
 349 }