src/lib/video_content.cc

   1 /*
   2     Copyright (C) 2013-2014 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #include <iomanip>
  21 #include <libcxml/cxml.h>
  22 #include <libdcp/colour_matrix.h>
  23 #include <libdcp/raw_convert.h>
  24 #include "video_content.h"
  25 #include "video_examiner.h"
  26 #include "compose.hpp"
  27 #include "ratio.h"
  28 #include "config.h"
  29 #include "colour_conversion.h"
  30 #include "util.h"
  31 #include "film.h"
  32 #include "exceptions.h"
  33 #include "frame_rate_change.h"
  34
  35 #include "i18n.h"
  36
  37 int const VideoContentProperty::VIDEO_SIZE        = 0;
  38 int const VideoContentProperty::VIDEO_FRAME_RATE  = 1;
  39 int const VideoContentProperty::VIDEO_FRAME_TYPE  = 2;
  40 int const VideoContentProperty::VIDEO_CROP        = 3;
  41 int const VideoContentProperty::VIDEO_SCALE       = 4;
  42 int const VideoContentProperty::COLOUR_CONVERSION = 5;
  43
  44 using std::string;
  45 using std::stringstream;
  46 using std::setprecision;
  47 using std::cout;
  48 using std::vector;
  49 using std::min;
  50 using std::max;
  51 using boost::shared_ptr;
  52 using boost::optional;
  53 using boost::dynamic_pointer_cast;
  54 using libdcp::raw_convert;
  55
  56 vector<VideoContentScale> VideoContentScale::_scales;
  57
  58 VideoContent::VideoContent (shared_ptr<const Film> f)
  59         : Content (f)
  60         , _video_length (0)
  61         , _video_frame_rate (0)
  62         , _video_frame_type (VIDEO_FRAME_TYPE_2D)
  63         , _scale (Ratio::from_id ("185"))
  64 {
  65         setup_default_colour_conversion ();
  66 }
  67
  68 VideoContent::VideoContent (shared_ptr<const Film> f, Time s, VideoContent::Frame len)
  69         : Content (f, s)
  70         , _video_length (len)
  71         , _video_frame_rate (0)
  72         , _video_frame_type (VIDEO_FRAME_TYPE_2D)
  73         , _scale (Ratio::from_id ("185"))
  74 {
  75         setup_default_colour_conversion ();
  76 }
  77
  78 VideoContent::VideoContent (shared_ptr<const Film> f, boost::filesystem::path p)
  79         : Content (f, p)
  80         , _video_length (0)
  81         , _video_frame_rate (0)
  82         , _video_frame_type (VIDEO_FRAME_TYPE_2D)
  83         , _scale (Ratio::from_id ("185"))
  84 {
  85         setup_default_colour_conversion ();
  86 }
  87
  88 VideoContent::VideoContent (shared_ptr<const Film> f, shared_ptr<const cxml::Node> node, int version)
  89         : Content (f, node)
  90 {
  91         _video_length = node->number_child<VideoContent::Frame> ("VideoLength");
  92         _video_size.width = node->number_child<int> ("VideoWidth");
  93         _video_size.height = node->number_child<int> ("VideoHeight");
  94         _video_frame_rate = node->number_child<float> ("VideoFrameRate");
  95         _video_frame_type = static_cast<VideoFrameType> (node->number_child<int> ("VideoFrameType"));
  96         _crop.left = node->number_child<int> ("LeftCrop");
  97         _crop.right = node->number_child<int> ("RightCrop");
  98         _crop.top = node->number_child<int> ("TopCrop");
  99         _crop.bottom = node->number_child<int> ("BottomCrop");
 100
 101         if (version <= 7) {
 102                 optional<string> r = node->optional_string_child ("Ratio");
 103                 if (r) {
 104                         _scale = VideoContentScale (Ratio::from_id (r.get ()));
 105                 }
 106         } else {
 107                 _scale = VideoContentScale (node->node_child ("Scale"));
 108         }
 109
 110         _colour_conversion = ColourConversion (node->node_child ("ColourConversion"));
 111 }
 112
 113 VideoContent::VideoContent (shared_ptr<const Film> f, vector<shared_ptr<Content> > c)
 114         : Content (f, c)
 115         , _video_length (0)
 116 {
 117         shared_ptr<VideoContent> ref = dynamic_pointer_cast<VideoContent> (c[0]);
 118         assert (ref);
 119
 120         for (size_t i = 0; i < c.size(); ++i) {
 121                 shared_ptr<VideoContent> vc = dynamic_pointer_cast<VideoContent> (c[i]);
 122
 123                 if (vc->video_size() != ref->video_size()) {
 124                         throw JoinError (_("Content to be joined must have the same picture size."));
 125                 }
 126
 127                 if (vc->video_frame_rate() != ref->video_frame_rate()) {
 128                         throw JoinError (_("Content to be joined must have the same video frame rate."));
 129                 }
 130
 131                 if (vc->video_frame_type() != ref->video_frame_type()) {
 132                         throw JoinError (_("Content to be joined must have the same video frame type."));
 133                 }
 134
 135                 if (vc->crop() != ref->crop()) {
 136                         throw JoinError (_("Content to be joined must have the same crop."));
 137                 }
 138
 139                 if (vc->scale() != ref->scale()) {
 140                         throw JoinError (_("Content to be joined must have the same scale setting."));
 141                 }
 142
 143                 if (vc->colour_conversion() != ref->colour_conversion()) {
 144                         throw JoinError (_("Content to be joined must have the same colour conversion."));
 145                 }
 146
 147                 _video_length += vc->video_length ();
 148         }
 149
 150         _video_size = ref->video_size ();
 151         _video_frame_rate = ref->video_frame_rate ();
 152         _video_frame_type = ref->video_frame_type ();
 153         _crop = ref->crop ();
 154         _scale = ref->scale ();
 155         _colour_conversion = ref->colour_conversion ();
 156 }
 157
 158 void
 159 VideoContent::as_xml (xmlpp::Node* node) const
 160 {
 161         boost::mutex::scoped_lock lm (_mutex);
 162         node->add_child("VideoLength")->add_child_text (raw_convert<string> (_video_length));
 163         node->add_child("VideoWidth")->add_child_text (raw_convert<string> (_video_size.width));
 164         node->add_child("VideoHeight")->add_child_text (raw_convert<string> (_video_size.height));
 165         node->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate));
 166         node->add_child("VideoFrameType")->add_child_text (raw_convert<string> (static_cast<int> (_video_frame_type)));
 167         _crop.as_xml (node);
 168         _scale.as_xml (node->add_child("Scale"));
 169         _colour_conversion.as_xml (node->add_child("ColourConversion"));
 170 }
 171
 172 void
 173 VideoContent::setup_default_colour_conversion ()
 174 {
 175         _colour_conversion = PresetColourConversion (_("sRGB"), 2.4, true, libdcp::colour_matrix::srgb_to_xyz, 2.6).conversion;
 176 }
 177
 178 void
 179 VideoContent::take_from_video_examiner (shared_ptr<VideoExaminer> d)
 180 {
 181         /* These examiner calls could call other content methods which take a lock on the mutex */
 182         libdcp::Size const vs = d->video_size ();
 183         float const vfr = d->video_frame_rate ();
 184
 185         {
 186                 boost::mutex::scoped_lock lm (_mutex);
 187                 _video_size = vs;
 188                 _video_frame_rate = vfr;
 189         }
 190
 191         signal_changed (VideoContentProperty::VIDEO_SIZE);
 192         signal_changed (VideoContentProperty::VIDEO_FRAME_RATE);
 193 }
 194
 195
 196 string
 197 VideoContent::information () const
 198 {
 199         if (video_size().width == 0 || video_size().height == 0) {
 200                 return "";
 201         }
 202
 203         stringstream s;
 204
 205         s << String::compose (
 206                 _("%1x%2 pixels (%3:1)"),
 207                 video_size().width,
 208                 video_size().height,
 209                 setprecision (3), video_size().ratio ()
 210                 );
 211
 212         return s.str ();
 213 }
 214
 215 void
 216 VideoContent::set_left_crop (int c)
 217 {
 218         {
 219                 boost::mutex::scoped_lock lm (_mutex);
 220
 221                 if (_crop.left == c) {
 222                         return;
 223                 }
 224
 225                 _crop.left = c;
 226         }
 227
 228         signal_changed (VideoContentProperty::VIDEO_CROP);
 229 }
 230
 231 void
 232 VideoContent::set_right_crop (int c)
 233 {
 234         {
 235                 boost::mutex::scoped_lock lm (_mutex);
 236                 if (_crop.right == c) {
 237                         return;
 238                 }
 239
 240                 _crop.right = c;
 241         }
 242
 243         signal_changed (VideoContentProperty::VIDEO_CROP);
 244 }
 245
 246 void
 247 VideoContent::set_top_crop (int c)
 248 {
 249         {
 250                 boost::mutex::scoped_lock lm (_mutex);
 251                 if (_crop.top == c) {
 252                         return;
 253                 }
 254
 255                 _crop.top = c;
 256         }
 257
 258         signal_changed (VideoContentProperty::VIDEO_CROP);
 259 }
 260
 261 void
 262 VideoContent::set_bottom_crop (int c)
 263 {
 264         {
 265                 boost::mutex::scoped_lock lm (_mutex);
 266                 if (_crop.bottom == c) {
 267                         return;
 268                 }
 269
 270                 _crop.bottom = c;
 271         }
 272
 273         signal_changed (VideoContentProperty::VIDEO_CROP);
 274 }
 275
 276 void
 277 VideoContent::set_scale (VideoContentScale s)
 278 {
 279         {
 280                 boost::mutex::scoped_lock lm (_mutex);
 281                 if (_scale == s) {
 282                         return;
 283                 }
 284
 285                 _scale = s;
 286         }
 287
 288         signal_changed (VideoContentProperty::VIDEO_SCALE);
 289 }
 290
 291 /** @return string which includes everything about how this content looks */
 292 string
 293 VideoContent::identifier () const
 294 {
 295         stringstream s;
 296         s << Content::identifier()
 297           << "_" << crop().left
 298           << "_" << crop().right
 299           << "_" << crop().top
 300           << "_" << crop().bottom
 301           << "_" << scale().id()
 302           << "_" << colour_conversion().identifier ();
 303
 304         return s.str ();
 305 }
 306
 307 void
 308 VideoContent::set_video_frame_type (VideoFrameType t)
 309 {
 310         {
 311                 boost::mutex::scoped_lock lm (_mutex);
 312                 _video_frame_type = t;
 313         }
 314
 315         signal_changed (VideoContentProperty::VIDEO_FRAME_TYPE);
 316 }
 317
 318 string
 319 VideoContent::technical_summary () const
 320 {
 321         return String::compose (
 322                 "video: length %1, size %2x%3, rate %4",
 323                 video_length_after_3d_combine(), video_size().width, video_size().height, video_frame_rate()
 324                 );
 325 }
 326
 327 libdcp::Size
 328 VideoContent::video_size_after_3d_split () const
 329 {
 330         libdcp::Size const s = video_size ();
 331         switch (video_frame_type ()) {
 332         case VIDEO_FRAME_TYPE_2D:
 333         case VIDEO_FRAME_TYPE_3D_ALTERNATE:
 334         case VIDEO_FRAME_TYPE_3D_LEFT:
 335         case VIDEO_FRAME_TYPE_3D_RIGHT:
 336                 return s;
 337         case VIDEO_FRAME_TYPE_3D_LEFT_RIGHT:
 338                 return libdcp::Size (s.width / 2, s.height);
 339         case VIDEO_FRAME_TYPE_3D_TOP_BOTTOM:
 340                 return libdcp::Size (s.width, s.height / 2);
 341         }
 342
 343         assert (false);
 344 }
 345
 346 void
 347 VideoContent::set_colour_conversion (ColourConversion c)
 348 {
 349         {
 350                 boost::mutex::scoped_lock lm (_mutex);
 351                 _colour_conversion = c;
 352         }
 353
 354         signal_changed (VideoContentProperty::COLOUR_CONVERSION);
 355 }
 356
 357 /** @return Video size after 3D split and crop */
 358 libdcp::Size
 359 VideoContent::video_size_after_crop () const
 360 {
 361         return crop().apply (video_size_after_3d_split ());
 362 }
 363
 364 /** @param t A time offset from the start of this piece of content.
 365  *  @return Corresponding frame index.
 366  */
 367 VideoContent::Frame
 368 VideoContent::time_to_content_video_frames (Time t) const
 369 {
 370         shared_ptr<const Film> film = _film.lock ();
 371         assert (film);
 372
 373         FrameRateChange frc (video_frame_rate(), film->video_frame_rate());
 374
 375         /* Here we are converting from time (in the DCP) to a frame number in the content.
 376            Hence we need to use the DCP's frame rate and the double/skip correction, not
 377            the source's rate.
 378         */
 379         return t * film->video_frame_rate() / (frc.factor() * TIME_HZ);
 380 }
 381
 382 void
 383 VideoContent::scale_and_crop_to_fit_width ()
 384 {
 385         shared_ptr<const Film> film = _film.lock ();
 386         assert (film);
 387
 388         set_scale (VideoContentScale (film->container ()));
 389
 390         int const crop = max (0, int (video_size().height - double (film->frame_size().height) * video_size().width / film->frame_size().width));
 391         set_top_crop (crop / 2);
 392         set_bottom_crop (crop / 2);
 393 }
 394
 395 void
 396 VideoContent::scale_and_crop_to_fit_height ()
 397 {
 398         shared_ptr<const Film> film = _film.lock ();
 399         assert (film);
 400
 401         set_scale (VideoContentScale (film->container ()));
 402
 403         int const crop = max (0, int (video_size().width - double (film->frame_size().width) * video_size().height / film->frame_size().height));
 404         set_left_crop (crop / 2);
 405         set_right_crop (crop / 2);
 406 }
 407
 408 VideoContentScale::VideoContentScale (Ratio const * r)
 409         : _ratio (r)
 410         , _scale (true)
 411 {
 412
 413 }
 414
 415 VideoContentScale::VideoContentScale ()
 416         : _ratio (0)
 417         , _scale (false)
 418 {
 419
 420 }
 421
 422 VideoContentScale::VideoContentScale (bool scale)
 423         : _ratio (0)
 424         , _scale (scale)
 425 {
 426
 427 }
 428
 429 VideoContentScale::VideoContentScale (shared_ptr<cxml::Node> node)
 430         : _ratio (0)
 431         , _scale (true)
 432 {
 433         optional<string> r = node->optional_string_child ("Ratio");
 434         if (r) {
 435                 _ratio = Ratio::from_id (r.get ());
 436         } else {
 437                 _scale = node->bool_child ("Scale");
 438         }
 439 }
 440
 441 void
 442 VideoContentScale::as_xml (xmlpp::Node* node) const
 443 {
 444         if (_ratio) {
 445                 node->add_child("Ratio")->add_child_text (_ratio->id ());
 446         } else {
 447                 node->add_child("Scale")->add_child_text (_scale ? "1" : "0");
 448         }
 449 }
 450
 451 string
 452 VideoContentScale::id () const
 453 {
 454         stringstream s;
 455
 456         if (_ratio) {
 457                 s << _ratio->id () << "_";
 458         } else {
 459                 s << (_scale ? "S1" : "S0");
 460         }
 461
 462         return s.str ();
 463 }
 464
 465 string
 466 VideoContentScale::name () const
 467 {
 468         if (_ratio) {
 469                 return _ratio->nickname ();
 470         }
 471
 472         if (_scale) {
 473                 return _("No stretch");
 474         }
 475
 476         return _("No scale");
 477 }
 478
 479 /** @param display_container Size of the container that we are displaying this content in.
 480  *  @param film_container The size of the film's image.
 481  */
 482 libdcp::Size
 483 VideoContentScale::size (shared_ptr<const VideoContent> c, libdcp::Size display_container, libdcp::Size film_container) const
 484 {
 485         if (_ratio) {
 486                 return fit_ratio_within (_ratio->ratio (), display_container);
 487         }
 488
 489         libdcp::Size const ac = c->video_size_after_crop ();
 490
 491         /* Force scale if the film_container is smaller than the content's image */
 492         if (_scale || film_container.width < ac.width || film_container.height < ac.height) {
 493                 return fit_ratio_within (ac.ratio (), display_container);
 494         }
 495
 496         /* Scale the image so that it will be in the right place in film_container, even if display_container is a
 497            different size.
 498         */
 499         return libdcp::Size (
 500                 c->video_size().width  * float(display_container.width)  / film_container.width,
 501                 c->video_size().height * float(display_container.height) / film_container.height
 502                 );
 503 }
 504
 505 void
 506 VideoContentScale::setup_scales ()
 507 {
 508         vector<Ratio const *> ratios = Ratio::all ();
 509         for (vector<Ratio const *>::const_iterator i = ratios.begin(); i != ratios.end(); ++i) {
 510                 _scales.push_back (VideoContentScale (*i));
 511         }
 512
 513         _scales.push_back (VideoContentScale (true));
 514         _scales.push_back (VideoContentScale (false));
 515 }
 516
 517 bool
 518 operator== (VideoContentScale const & a, VideoContentScale const & b)
 519 {
 520         return (a.ratio() == b.ratio() && a.scale() == b.scale());
 521 }
 522
 523 bool
 524 operator!= (VideoContentScale const & a, VideoContentScale const & b)
 525 {
 526         return (a.ratio() != b.ratio() || a.scale() != b.scale());
 527 }