src/lib/video_content.cc

   1 /*
   2     Copyright (C) 2013-2015 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 "video_content.h"
  21 #include "video_examiner.h"
  22 #include "compose.hpp"
  23 #include "ratio.h"
  24 #include "config.h"
  25 #include "colour_conversion.h"
  26 #include "util.h"
  27 #include "film.h"
  28 #include "exceptions.h"
  29 #include "frame_rate_change.h"
  30 #include "log.h"
  31 #include "safe_stringstream.h"
  32 #include "raw_convert.h"
  33 #include <libcxml/cxml.h>
  34 #include <dcp/colour_matrix.h>
  35 #include <libxml++/libxml++.h>
  36 #include <iomanip>
  37 #include <iostream>
  38
  39 #include "i18n.h"
  40
  41 #define LOG_GENERAL(...) film()->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
  42
  43 int const VideoContentProperty::VIDEO_SIZE        = 0;
  44 int const VideoContentProperty::VIDEO_FRAME_RATE  = 1;
  45 int const VideoContentProperty::VIDEO_FRAME_TYPE  = 2;
  46 int const VideoContentProperty::VIDEO_CROP        = 3;
  47 int const VideoContentProperty::VIDEO_SCALE       = 4;
  48 int const VideoContentProperty::COLOUR_CONVERSION = 5;
  49 int const VideoContentProperty::VIDEO_FADE_IN     = 6;
  50 int const VideoContentProperty::VIDEO_FADE_OUT    = 7;
  51
  52 using std::string;
  53 using std::setprecision;
  54 using std::cout;
  55 using std::vector;
  56 using std::min;
  57 using std::max;
  58 using std::stringstream;
  59 using std::fixed;
  60 using std::setprecision;
  61 using std::list;
  62 using std::pair;
  63 using boost::shared_ptr;
  64 using boost::optional;
  65 using boost::dynamic_pointer_cast;
  66
  67 VideoContent::VideoContent (shared_ptr<const Film> film)
  68         : Content (film)
  69         , _video_length (0)
  70         , _video_frame_type (VIDEO_FRAME_TYPE_2D)
  71         , _scale (VideoContentScale (Ratio::from_id ("178")))
  72         , _fade_in (0)
  73         , _fade_out (0)
  74 {
  75         set_default_colour_conversion ();
  76 }
  77
  78 VideoContent::VideoContent (shared_ptr<const Film> film, DCPTime s, Frame len)
  79         : Content (film, s)
  80         , _video_length (len)
  81         , _video_frame_type (VIDEO_FRAME_TYPE_2D)
  82         , _scale (VideoContentScale (Ratio::from_id ("178")))
  83         , _fade_in (0)
  84         , _fade_out (0)
  85 {
  86         set_default_colour_conversion ();
  87 }
  88
  89 VideoContent::VideoContent (shared_ptr<const Film> film, boost::filesystem::path p)
  90         : Content (film, p)
  91         , _video_length (0)
  92         , _video_frame_type (VIDEO_FRAME_TYPE_2D)
  93         , _scale (VideoContentScale (Ratio::from_id ("178")))
  94         , _fade_in (0)
  95         , _fade_out (0)
  96 {
  97         set_default_colour_conversion ();
  98 }
  99
 100 VideoContent::VideoContent (shared_ptr<const Film> film, cxml::ConstNodePtr node, int version)
 101         : Content (film, node)
 102 {
 103         _video_size.width = node->number_child<int> ("VideoWidth");
 104         _video_size.height = node->number_child<int> ("VideoHeight");
 105         _video_frame_rate = node->optional_number_child<double> ("VideoFrameRate");
 106         _video_length = node->number_child<Frame> ("VideoLength");
 107         _video_frame_type = static_cast<VideoFrameType> (node->number_child<int> ("VideoFrameType"));
 108         _sample_aspect_ratio = node->optional_number_child<double> ("SampleAspectRatio");
 109         _crop.left = node->number_child<int> ("LeftCrop");
 110         _crop.right = node->number_child<int> ("RightCrop");
 111         _crop.top = node->number_child<int> ("TopCrop");
 112         _crop.bottom = node->number_child<int> ("BottomCrop");
 113
 114         if (version <= 7) {
 115                 optional<string> r = node->optional_string_child ("Ratio");
 116                 if (r) {
 117                         _scale = VideoContentScale (Ratio::from_id (r.get ()));
 118                 }
 119         } else {
 120                 _scale = VideoContentScale (node->node_child ("Scale"));
 121         }
 122
 123
 124         if (node->optional_node_child ("ColourConversion")) {
 125                 _colour_conversion = ColourConversion (node->node_child ("ColourConversion"), version);
 126         }
 127         if (version >= 32) {
 128                 _fade_in = node->number_child<Frame> ("FadeIn");
 129                 _fade_out = node->number_child<Frame> ("FadeOut");
 130         } else {
 131                 _fade_in = _fade_out = 0;
 132         }
 133 }
 134
 135 VideoContent::VideoContent (shared_ptr<const Film> film, vector<shared_ptr<Content> > c)
 136         : Content (film, c)
 137         , _video_length (0)
 138 {
 139         shared_ptr<VideoContent> ref = dynamic_pointer_cast<VideoContent> (c[0]);
 140         DCPOMATIC_ASSERT (ref);
 141
 142         for (size_t i = 0; i < c.size(); ++i) {
 143                 shared_ptr<VideoContent> vc = dynamic_pointer_cast<VideoContent> (c[i]);
 144
 145                 if (vc->video_size() != ref->video_size()) {
 146                         throw JoinError (_("Content to be joined must have the same picture size."));
 147                 }
 148
 149                 if (vc->video_frame_rate() != ref->video_frame_rate()) {
 150                         throw JoinError (_("Content to be joined must have the same video frame rate."));
 151                 }
 152
 153                 if (vc->video_frame_type() != ref->video_frame_type()) {
 154                         throw JoinError (_("Content to be joined must have the same video frame type."));
 155                 }
 156
 157                 if (vc->crop() != ref->crop()) {
 158                         throw JoinError (_("Content to be joined must have the same crop."));
 159                 }
 160
 161                 if (vc->scale() != ref->scale()) {
 162                         throw JoinError (_("Content to be joined must have the same scale setting."));
 163                 }
 164
 165                 if (vc->colour_conversion() != ref->colour_conversion()) {
 166                         throw JoinError (_("Content to be joined must have the same colour conversion."));
 167                 }
 168
 169                 if (vc->fade_in() != ref->fade_in() || vc->fade_out() != ref->fade_out()) {
 170                         throw JoinError (_("Content to be joined must have the same fades."));
 171                 }
 172
 173                 _video_length += vc->video_length ();
 174         }
 175
 176         _video_size = ref->video_size ();
 177         _video_frame_rate = ref->video_frame_rate ();
 178         _video_frame_type = ref->video_frame_type ();
 179         _crop = ref->crop ();
 180         _scale = ref->scale ();
 181         _colour_conversion = ref->colour_conversion ();
 182         _fade_in = ref->fade_in ();
 183         _fade_out = ref->fade_out ();
 184 }
 185
 186 void
 187 VideoContent::as_xml (xmlpp::Node* node) const
 188 {
 189         boost::mutex::scoped_lock lm (_mutex);
 190         node->add_child("VideoLength")->add_child_text (raw_convert<string> (_video_length));
 191         node->add_child("VideoWidth")->add_child_text (raw_convert<string> (_video_size.width));
 192         node->add_child("VideoHeight")->add_child_text (raw_convert<string> (_video_size.height));
 193         if (_video_frame_rate) {
 194                 node->add_child("VideoFrameRate")->add_child_text (raw_convert<string> (_video_frame_rate.get()));
 195         }
 196         node->add_child("VideoFrameType")->add_child_text (raw_convert<string> (static_cast<int> (_video_frame_type)));
 197         if (_sample_aspect_ratio) {
 198                 node->add_child("SampleAspectRatio")->add_child_text (raw_convert<string> (_sample_aspect_ratio.get ()));
 199         }
 200         _crop.as_xml (node);
 201         _scale.as_xml (node->add_child("Scale"));
 202         if (_colour_conversion) {
 203                 _colour_conversion.get().as_xml (node->add_child("ColourConversion"));
 204         }
 205         node->add_child("FadeIn")->add_child_text (raw_convert<string> (_fade_in));
 206         node->add_child("FadeOut")->add_child_text (raw_convert<string> (_fade_out));
 207 }
 208
 209 void
 210 VideoContent::set_default_colour_conversion ()
 211 {
 212         /* If there's no better offer we'll use Rec. 709 */
 213         boost::mutex::scoped_lock lm (_mutex);
 214         _colour_conversion = PresetColourConversion::from_id ("rec709").conversion;
 215 }
 216
 217 void
 218 VideoContent::take_from_video_examiner (shared_ptr<VideoExaminer> d)
 219 {
 220         /* These examiner calls could call other content methods which take a lock on the mutex */
 221         dcp::Size const vs = d->video_size ();
 222         optional<double> const vfr = d->video_frame_rate ();
 223         Frame vl = d->video_length ();
 224         optional<double> const ar = d->sample_aspect_ratio ();
 225
 226         {
 227                 boost::mutex::scoped_lock lm (_mutex);
 228                 _video_size = vs;
 229                 _video_frame_rate = vfr;
 230                 _video_length = vl;
 231                 _sample_aspect_ratio = ar;
 232
 233                 /* Guess correct scale from size and sample aspect ratio */
 234                 _scale = VideoContentScale (
 235                         Ratio::nearest_from_ratio (double (_video_size.width) * ar.get_value_or (1) / _video_size.height)
 236                         );
 237         }
 238
 239         LOG_GENERAL ("Video length obtained from header as %1 frames", _video_length);
 240
 241         set_default_colour_conversion ();
 242
 243         signal_changed (VideoContentProperty::VIDEO_SIZE);
 244         signal_changed (VideoContentProperty::VIDEO_FRAME_RATE);
 245         signal_changed (VideoContentProperty::VIDEO_SCALE);
 246         signal_changed (ContentProperty::LENGTH);
 247 }
 248
 249 void
 250 VideoContent::set_left_crop (int c)
 251 {
 252         {
 253                 boost::mutex::scoped_lock lm (_mutex);
 254
 255                 if (_crop.left == c) {
 256                         return;
 257                 }
 258
 259                 _crop.left = c;
 260         }
 261
 262         signal_changed (VideoContentProperty::VIDEO_CROP);
 263 }
 264
 265 void
 266 VideoContent::set_right_crop (int c)
 267 {
 268         {
 269                 boost::mutex::scoped_lock lm (_mutex);
 270                 if (_crop.right == c) {
 271                         return;
 272                 }
 273
 274                 _crop.right = c;
 275         }
 276
 277         signal_changed (VideoContentProperty::VIDEO_CROP);
 278 }
 279
 280 void
 281 VideoContent::set_top_crop (int c)
 282 {
 283         {
 284                 boost::mutex::scoped_lock lm (_mutex);
 285                 if (_crop.top == c) {
 286                         return;
 287                 }
 288
 289                 _crop.top = c;
 290         }
 291
 292         signal_changed (VideoContentProperty::VIDEO_CROP);
 293 }
 294
 295 void
 296 VideoContent::set_bottom_crop (int c)
 297 {
 298         {
 299                 boost::mutex::scoped_lock lm (_mutex);
 300                 if (_crop.bottom == c) {
 301                         return;
 302                 }
 303
 304                 _crop.bottom = c;
 305         }
 306
 307         signal_changed (VideoContentProperty::VIDEO_CROP);
 308 }
 309
 310 void
 311 VideoContent::set_scale (VideoContentScale s)
 312 {
 313         {
 314                 boost::mutex::scoped_lock lm (_mutex);
 315                 if (_scale == s) {
 316                         return;
 317                 }
 318
 319                 _scale = s;
 320         }
 321
 322         signal_changed (VideoContentProperty::VIDEO_SCALE);
 323 }
 324
 325 /** @return string which includes everything about how this content looks */
 326 string
 327 VideoContent::identifier () const
 328 {
 329         SafeStringStream s;
 330         s << Content::identifier()
 331           << "_" << crop().left
 332           << "_" << crop().right
 333           << "_" << crop().top
 334           << "_" << crop().bottom
 335           << "_" << scale().id()
 336           << "_" << _fade_in
 337           << "_" << _fade_out;
 338
 339         if (colour_conversion()) {
 340                 s << "_" << colour_conversion().get().identifier ();
 341         }
 342
 343         return s.str ();
 344 }
 345
 346 void
 347 VideoContent::set_video_frame_type (VideoFrameType t)
 348 {
 349         {
 350                 boost::mutex::scoped_lock lm (_mutex);
 351                 _video_frame_type = t;
 352         }
 353
 354         signal_changed (VideoContentProperty::VIDEO_FRAME_TYPE);
 355 }
 356
 357 string
 358 VideoContent::technical_summary () const
 359 {
 360         string s = String::compose (
 361                 N_("video: length %1 frames, size %2x%3, rate %4"),
 362                 video_length_after_3d_combine(),
 363                 video_size().width,
 364                 video_size().height,
 365                 video_frame_rate()
 366                 );
 367
 368         if (sample_aspect_ratio ()) {
 369                 s += String::compose (N_(", sample aspect ratio %1"), (sample_aspect_ratio().get ()));
 370         }
 371
 372         return s;
 373 }
 374
 375 dcp::Size
 376 VideoContent::video_size_after_3d_split () const
 377 {
 378         dcp::Size const s = video_size ();
 379         switch (video_frame_type ()) {
 380         case VIDEO_FRAME_TYPE_2D:
 381         case VIDEO_FRAME_TYPE_3D_ALTERNATE:
 382         case VIDEO_FRAME_TYPE_3D_LEFT:
 383         case VIDEO_FRAME_TYPE_3D_RIGHT:
 384                 return s;
 385         case VIDEO_FRAME_TYPE_3D_LEFT_RIGHT:
 386                 return dcp::Size (s.width / 2, s.height);
 387         case VIDEO_FRAME_TYPE_3D_TOP_BOTTOM:
 388                 return dcp::Size (s.width, s.height / 2);
 389         }
 390
 391         DCPOMATIC_ASSERT (false);
 392 }
 393
 394 void
 395 VideoContent::unset_colour_conversion ()
 396 {
 397         {
 398                 boost::mutex::scoped_lock lm (_mutex);
 399                 _colour_conversion = boost::optional<ColourConversion> ();
 400         }
 401
 402         signal_changed (VideoContentProperty::COLOUR_CONVERSION);
 403 }
 404
 405 void
 406 VideoContent::set_colour_conversion (ColourConversion c)
 407 {
 408         {
 409                 boost::mutex::scoped_lock lm (_mutex);
 410                 _colour_conversion = c;
 411         }
 412
 413         signal_changed (VideoContentProperty::COLOUR_CONVERSION);
 414 }
 415
 416 void
 417 VideoContent::set_fade_in (Frame t)
 418 {
 419         {
 420                 boost::mutex::scoped_lock lm (_mutex);
 421                 _fade_in = t;
 422         }
 423
 424         signal_changed (VideoContentProperty::VIDEO_FADE_IN);
 425 }
 426
 427 void
 428 VideoContent::set_fade_out (Frame t)
 429 {
 430         {
 431                 boost::mutex::scoped_lock lm (_mutex);
 432                 _fade_out = t;
 433         }
 434
 435         signal_changed (VideoContentProperty::VIDEO_FADE_OUT);
 436 }
 437
 438 /** @return Video size after 3D split and crop */
 439 dcp::Size
 440 VideoContent::video_size_after_crop () const
 441 {
 442         return crop().apply (video_size_after_3d_split ());
 443 }
 444
 445 void
 446 VideoContent::scale_and_crop_to_fit_width ()
 447 {
 448         set_scale (VideoContentScale (film()->container ()));
 449
 450         int const crop = max (0, int (video_size().height - double (film()->frame_size().height) * video_size().width / film()->frame_size().width));
 451         set_top_crop (crop / 2);
 452         set_bottom_crop (crop / 2);
 453 }
 454
 455 void
 456 VideoContent::scale_and_crop_to_fit_height ()
 457 {
 458         set_scale (VideoContentScale (film()->container ()));
 459
 460         int const crop = max (0, int (video_size().width - double (film()->frame_size().width) * video_size().height / film()->frame_size().height));
 461         set_left_crop (crop / 2);
 462         set_right_crop (crop / 2);
 463 }
 464
 465 void
 466 VideoContent::set_video_frame_rate (double r)
 467 {
 468         {
 469                 boost::mutex::scoped_lock lm (_mutex);
 470                 if (_video_frame_rate == r) {
 471                         return;
 472                 }
 473
 474                 _video_frame_rate = r;
 475         }
 476
 477         signal_changed (VideoContentProperty::VIDEO_FRAME_RATE);
 478 }
 479
 480 optional<double>
 481 VideoContent::fade (Frame f) const
 482 {
 483         DCPOMATIC_ASSERT (f >= 0);
 484
 485         if (f < fade_in()) {
 486                 return double (f) / fade_in();
 487         }
 488
 489         Frame fade_out_start = video_length() - fade_out();
 490         if (f >= fade_out_start) {
 491                 return 1 - double (f - fade_out_start) / fade_out();
 492         }
 493
 494         return optional<double> ();
 495 }
 496
 497 string
 498 VideoContent::processing_description () const
 499 {
 500         /* stringstream is OK here as this string is just for presentation to the user */
 501         stringstream d;
 502
 503         if (video_size().width && video_size().height) {
 504                 d << String::compose (
 505                         _("Content video is %1x%2"),
 506                         video_size_after_3d_split().width,
 507                         video_size_after_3d_split().height
 508                         );
 509
 510
 511                 double ratio = video_size_after_3d_split().ratio ();
 512
 513                 if (sample_aspect_ratio ()) {
 514                         d << ", " << _("pixel aspect ratio") << " " << fixed << setprecision(2) << sample_aspect_ratio().get () << ":1";
 515                         ratio *= sample_aspect_ratio().get ();
 516                 }
 517
 518                 d << "\n" << _("Display aspect ratio") << " " << fixed << setprecision(2) << ratio << ":1\n";
 519         }
 520
 521         if ((crop().left || crop().right || crop().top || crop().bottom) && video_size() != dcp::Size (0, 0)) {
 522                 dcp::Size cropped = video_size_after_crop ();
 523                 d << String::compose (
 524                         _("Cropped to %1x%2"),
 525                         cropped.width, cropped.height
 526                         );
 527
 528                 d << " (" << fixed << setprecision(2) << cropped.ratio () << ":1)\n";
 529         }
 530
 531         dcp::Size const container_size = film()->frame_size ();
 532         dcp::Size const scaled = scale().size (dynamic_pointer_cast<const VideoContent> (shared_from_this ()), container_size, container_size);
 533
 534         if (scaled != video_size_after_crop ()) {
 535                 d << String::compose (
 536                         _("Scaled to %1x%2"),
 537                         scaled.width, scaled.height
 538                         );
 539
 540                 d << " (" << fixed << setprecision(2) << scaled.ratio() << ":1)\n";
 541         }
 542
 543         if (scaled != container_size) {
 544                 d << String::compose (
 545                         _("Padded with black to fit container %1 (%2x%3)"),
 546                         film()->container()->nickname (),
 547                         container_size.width, container_size.height
 548                         );
 549
 550                 d << " (" << fixed << setprecision(2) << container_size.ratio () << ":1)\n";
 551         }
 552
 553         d << _("Content frame rate");
 554         d << " " << fixed << setprecision(4) << video_frame_rate() << "\n";
 555
 556         FrameRateChange frc (video_frame_rate(), film()->video_frame_rate ());
 557         d << frc.description () << "\n";
 558
 559         return d.str ();
 560 }
 561
 562 void
 563 VideoContent::add_properties (list<pair<string, string> >& p) const
 564 {
 565         p.push_back (make_pair (_("Video length"), raw_convert<string> (video_length ()) + " " + _("video frames")));
 566         p.push_back (make_pair (_("Video size"), raw_convert<string> (video_size().width) + "x" + raw_convert<string> (video_size().height)));
 567         p.push_back (make_pair (_("Video frame rate"), raw_convert<string> (video_frame_rate()) + " " + _("frames per second")));
 568 }
 569
 570 list<DCPTime>
 571 VideoContent::reel_split_points () const
 572 {
 573         list<DCPTime> t;
 574         /* XXX: this is questionable; perhaps the position should be forced to be on a frame boundary */
 575         t.push_back (position().round_up (film()->video_frame_rate()));
 576         return t;
 577 }
 578
 579 double
 580 VideoContent::video_frame_rate () const
 581 {
 582         boost::mutex::scoped_lock lm (_mutex);
 583         return _video_frame_rate.get_value_or (film()->video_frame_rate ());
 584 }