src/lib/player_video.cc

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