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 /** Create an image for this frame.
 106  *  @param note Handler for any notes that are made during the process.
 107  *  @param pixel_format Function which is called to decide what pixel format the output image should be;
 108  *  it is passed the pixel format of the input image from the ImageProxy, and should return the desired
 109  *  output pixel format.  Two functions always_rgb and keep_xyz_or_rgb are provided for use here.
 110  *  @param aligned true if the output image should be aligned to 32-byte boundaries.
 111  *  @param fast true to be fast at the expense of quality.
 112  */
 113 shared_ptr<Image>
 114 PlayerVideo::image (dcp::NoteHandler note, function<AVPixelFormat (AVPixelFormat)> pixel_format, bool aligned, bool fast) const
 115 {
 116         pair<shared_ptr<Image>, int> prox = _in->image (optional<dcp::NoteHandler> (note), _inter_size);
 117         shared_ptr<Image> im = prox.first;
 118         int const reduce = prox.second;
 119
 120         Crop total_crop = _crop;
 121         switch (_part) {
 122         case PART_LEFT_HALF:
 123                 total_crop.right += im->size().width / 2;
 124                 break;
 125         case PART_RIGHT_HALF:
 126                 total_crop.left += im->size().width / 2;
 127                 break;
 128         case PART_TOP_HALF:
 129                 total_crop.bottom += im->size().height / 2;
 130                 break;
 131         case PART_BOTTOM_HALF:
 132                 total_crop.top += im->size().height / 2;
 133                 break;
 134         default:
 135                 break;
 136         }
 137
 138         if (reduce > 0) {
 139                 /* Scale the crop down to account for the scaling that has already happened in ImageProxy::image */
 140                 int const r = pow(2, reduce);
 141                 total_crop.left /= r;
 142                 total_crop.right /= r;
 143                 total_crop.top /= r;
 144                 total_crop.bottom /= r;
 145         }
 146
 147         dcp::YUVToRGB yuv_to_rgb = dcp::YUV_TO_RGB_REC601;
 148         if (_colour_conversion) {
 149                 yuv_to_rgb = _colour_conversion.get().yuv_to_rgb();
 150         }
 151
 152         shared_ptr<Image> out = im->crop_scale_window (
 153                 total_crop, _inter_size, _out_size, yuv_to_rgb, pixel_format (im->pixel_format()), aligned, fast
 154                 );
 155
 156         if (_text) {
 157                 out->alpha_blend (Image::ensure_aligned (_text->image), _text->position);
 158         }
 159
 160         if (_fade) {
 161                 out->fade (_fade.get ());
 162         }
 163
 164         return out;
 165 }
 166
 167 void
 168 PlayerVideo::add_metadata (xmlpp::Node* node) const
 169 {
 170         _crop.as_xml (node);
 171         if (_fade) {
 172                 node->add_child("Fade")->add_child_text (raw_convert<string> (_fade.get ()));
 173         }
 174         _in->add_metadata (node->add_child ("In"));
 175         node->add_child("InterWidth")->add_child_text (raw_convert<string> (_inter_size.width));
 176         node->add_child("InterHeight")->add_child_text (raw_convert<string> (_inter_size.height));
 177         node->add_child("OutWidth")->add_child_text (raw_convert<string> (_out_size.width));
 178         node->add_child("OutHeight")->add_child_text (raw_convert<string> (_out_size.height));
 179         node->add_child("Eyes")->add_child_text (raw_convert<string> (static_cast<int> (_eyes)));
 180         node->add_child("Part")->add_child_text (raw_convert<string> (static_cast<int> (_part)));
 181         if (_colour_conversion) {
 182                 _colour_conversion.get().as_xml (node);
 183         }
 184         if (_text) {
 185                 node->add_child ("SubtitleWidth")->add_child_text (raw_convert<string> (_text->image->size().width));
 186                 node->add_child ("SubtitleHeight")->add_child_text (raw_convert<string> (_text->image->size().height));
 187                 node->add_child ("SubtitleX")->add_child_text (raw_convert<string> (_text->position.x));
 188                 node->add_child ("SubtitleY")->add_child_text (raw_convert<string> (_text->position.y));
 189         }
 190 }
 191
 192 void
 193 PlayerVideo::send_binary (shared_ptr<Socket> socket) const
 194 {
 195         _in->send_binary (socket);
 196         if (_text) {
 197                 _text->image->write_to_socket (socket);
 198         }
 199 }
 200
 201 bool
 202 PlayerVideo::has_j2k () const
 203 {
 204         /* XXX: maybe other things */
 205
 206         shared_ptr<const J2KImageProxy> j2k = dynamic_pointer_cast<const J2KImageProxy> (_in);
 207         if (!j2k) {
 208                 return false;
 209         }
 210
 211         return _crop == Crop () && _out_size == j2k->size() && !_text && !_fade && !_colour_conversion;
 212 }
 213
 214 Data
 215 PlayerVideo::j2k () const
 216 {
 217         shared_ptr<const J2KImageProxy> j2k = dynamic_pointer_cast<const J2KImageProxy> (_in);
 218         DCPOMATIC_ASSERT (j2k);
 219         return j2k->j2k ();
 220 }
 221
 222 Position<int>
 223 PlayerVideo::inter_position () const
 224 {
 225         return Position<int> ((_out_size.width - _inter_size.width) / 2, (_out_size.height - _inter_size.height) / 2);
 226 }
 227
 228 /** @return true if this PlayerVideo is definitely the same as another, false if it is probably not */
 229 bool
 230 PlayerVideo::same (shared_ptr<const PlayerVideo> other) const
 231 {
 232         if (_crop != other->_crop ||
 233             _fade.get_value_or(0) != other->_fade.get_value_or(0) ||
 234             _inter_size != other->_inter_size ||
 235             _out_size != other->_out_size ||
 236             _eyes != other->_eyes ||
 237             _part != other->_part ||
 238             _colour_conversion != other->_colour_conversion) {
 239                 return false;
 240         }
 241
 242         if ((!_text && other->_text) || (_text && !other->_text)) {
 243                 /* One has a text and the other doesn't */
 244                 return false;
 245         }
 246
 247         if (_text && other->_text && !_text->same (other->_text.get ())) {
 248                 /* They both have texts but they are different */
 249                 return false;
 250         }
 251
 252         /* Now neither has subtitles */
 253
 254         return _in->same (other->_in);
 255 }
 256
 257 AVPixelFormat
 258 PlayerVideo::always_rgb (AVPixelFormat)
 259 {
 260         return AV_PIX_FMT_RGB24;
 261 }
 262
 263 AVPixelFormat
 264 PlayerVideo::keep_xyz_or_rgb (AVPixelFormat p)
 265 {
 266         return p == AV_PIX_FMT_XYZ12LE ? AV_PIX_FMT_XYZ12LE : AV_PIX_FMT_RGB48LE;
 267 }
 268
 269 void
 270 PlayerVideo::prepare ()
 271 {
 272         _in->prepare (_inter_size);
 273 }
 274
 275 size_t
 276 PlayerVideo::memory_used () const
 277 {
 278         return _in->memory_used();
 279 }
 280
 281 /** @return Shallow copy of this; _in and _text are shared between the original and the copy */
 282 shared_ptr<PlayerVideo>
 283 PlayerVideo::shallow_copy () const
 284 {
 285         return shared_ptr<PlayerVideo>(
 286                 new PlayerVideo(
 287                         _in,
 288                         _crop,
 289                         _fade,
 290                         _inter_size,
 291                         _out_size,
 292                         _eyes,
 293                         _part,
 294                         _colour_conversion,
 295                         _content,
 296                         _video_frame
 297                         )
 298                 );
 299 }
 300
 301 /** Re-read crop, fade, inter/out size and colour conversion from our content.
 302  *  @return true if this was possible, false if not.
 303  */
 304 bool
 305 PlayerVideo::reset_metadata (dcp::Size video_container_size, dcp::Size film_frame_size)
 306 {
 307         shared_ptr<Content> content = _content.lock();
 308         if (!content || !_video_frame) {
 309                 return false;
 310         }
 311
 312         _crop = content->video->crop();
 313         _fade = content->video->fade(_video_frame.get());
 314         _inter_size = content->video->scale().size(content->video, video_container_size, film_frame_size);
 315         _out_size = video_container_size;
 316         _colour_conversion = content->video->colour_conversion();
 317
 318         return true;
 319 }