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