src/lib/video_content.cc

   1 /*
   2     Copyright (C) 2013-2021 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 "video_content.h"
  22 #include "content.h"
  23 #include "video_examiner.h"
  24 #include "compose.hpp"
  25 #include "ratio.h"
  26 #include "config.h"
  27 #include "colour_conversion.h"
  28 #include "util.h"
  29 #include "film.h"
  30 #include "exceptions.h"
  31 #include "frame_rate_change.h"
  32 #include "log.h"
  33 #include "dcpomatic_log.h"
  34 #include <dcp/raw_convert.h>
  35 #include <libcxml/cxml.h>
  36 #include <libxml++/libxml++.h>
  37 #include <iomanip>
  38 #include <iostream>
  39
  40 #include "i18n.h"
  41
  42 int const VideoContentProperty::USE               = 0;
  43 int const VideoContentProperty::SIZE              = 1;
  44 int const VideoContentProperty::FRAME_TYPE        = 2;
  45 int const VideoContentProperty::CROP              = 3;
  46 int const VideoContentProperty::COLOUR_CONVERSION = 4;
  47 int const VideoContentProperty::FADE_IN           = 5;
  48 int const VideoContentProperty::FADE_OUT          = 6;
  49 int const VideoContentProperty::RANGE             = 7;
  50 int const VideoContentProperty::CUSTOM_RATIO      = 8;
  51 int const VideoContentProperty::CUSTOM_SIZE       = 9;
  52 int const VideoContentProperty::BURNT_SUBTITLE_LANGUAGE = 10;
  53
  54 using std::string;
  55 using std::setprecision;
  56 using std::cout;
  57 using std::vector;
  58 using std::min;
  59 using std::max;
  60 using std::fixed;
  61 using std::setprecision;
  62 using std::list;
  63 using std::pair;
  64 using std::shared_ptr;
  65 using std::make_shared;
  66 using boost::optional;
  67 using std::dynamic_pointer_cast;
  68 using dcp::raw_convert;
  69 using namespace dcpomatic;
  70
  71 VideoContent::VideoContent (Content* parent)
  72         : ContentPart (parent)
  73         , _use (true)
  74         , _length (0)
  75         , _frame_type (VideoFrameType::TWO_D)
  76         , _yuv (true)
  77         , _fade_in (0)
  78         , _fade_out (0)
  79         , _range (VideoRange::FULL)
  80 {
  81
  82 }
  83
  84 shared_ptr<VideoContent>
  85 VideoContent::from_xml (Content* parent, cxml::ConstNodePtr node, int version)
  86 {
  87         if (!node->optional_number_child<int> ("VideoWidth")) {
  88                 return {};
  89         }
  90
  91         return make_shared<VideoContent>(parent, node, version);
  92 }
  93
  94 VideoContent::VideoContent (Content* parent, cxml::ConstNodePtr node, int version)
  95         : ContentPart (parent)
  96 {
  97         _size.width = node->number_child<int> ("VideoWidth");
  98         _size.height = node->number_child<int> ("VideoHeight");
  99
 100         /* Backwards compatibility */
 101         auto r = node->optional_number_child<double>("VideoFrameRate");
 102         if (r) {
 103                 _parent->set_video_frame_rate (r.get ());
 104         }
 105
 106         _use = node->optional_bool_child("Use").get_value_or(true);
 107         _length = node->number_child<Frame> ("VideoLength");
 108
 109         if (version <= 34) {
 110                 /* Snapshot of the VideoFrameType enum at version 34 */
 111                 switch (node->number_child<int> ("VideoFrameType")) {
 112                 case 0:
 113                         _frame_type = VideoFrameType::TWO_D;
 114                         break;
 115                 case 1:
 116                         _frame_type = VideoFrameType::THREE_D_LEFT_RIGHT;
 117                         break;
 118                 case 2:
 119                         _frame_type = VideoFrameType::THREE_D_TOP_BOTTOM;
 120                         break;
 121                 case 3:
 122                         _frame_type = VideoFrameType::THREE_D_ALTERNATE;
 123                         break;
 124                 case 4:
 125                         _frame_type = VideoFrameType::THREE_D_LEFT;
 126                         break;
 127                 case 5:
 128                         _frame_type = VideoFrameType::THREE_D_RIGHT;
 129                         break;
 130                 }
 131         } else {
 132                 _frame_type = string_to_video_frame_type (node->string_child ("VideoFrameType"));
 133         }
 134
 135         _sample_aspect_ratio = node->optional_number_child<double> ("SampleAspectRatio");
 136         _crop.left = node->number_child<int> ("LeftCrop");
 137         _crop.right = node->number_child<int> ("RightCrop");
 138         _crop.top = node->number_child<int> ("TopCrop");
 139         _crop.bottom = node->number_child<int> ("BottomCrop");
 140
 141         if (version <= 7) {
 142                 auto r = node->optional_string_child ("Ratio");
 143                 if (r) {
 144                         _legacy_ratio = Ratio::from_id(r.get())->ratio();
 145                 }
 146         } else if (version <= 37) {
 147                 auto ratio = node->node_child("Scale")->optional_string_child("Ratio");
 148                 if (ratio) {
 149                         _legacy_ratio = Ratio::from_id(ratio.get())->ratio();
 150                 }
 151                 auto scale = node->node_child("Scale")->optional_bool_child("Scale");
 152                 if (scale) {
 153                         if (*scale) {
 154                                 /* This is what we used to call "no stretch" */
 155                                 _legacy_ratio = _size.ratio();
 156                         } else {
 157                                 /* This is what we used to call "no scale" */
 158                                 _custom_size = _size;
 159                         }
 160                 }
 161
 162         } else {
 163                 _custom_ratio = node->optional_number_child<float>("CustomRatio");
 164                 if (node->optional_number_child<int>("CustomWidth")) {
 165                         _custom_size = dcp::Size (node->number_child<int>("CustomWidth"), node->number_child<int>("CustomHeight"));
 166                 }
 167         }
 168
 169         if (node->optional_node_child ("ColourConversion")) {
 170                 _colour_conversion = ColourConversion (node->node_child ("ColourConversion"), version);
 171         }
 172
 173         _yuv = node->optional_bool_child("YUV").get_value_or (true);
 174
 175         if (version >= 32) {
 176                 _fade_in = node->number_child<Frame> ("FadeIn");
 177                 _fade_out = node->number_child<Frame> ("FadeOut");
 178         } else {
 179                 _fade_in = _fade_out = 0;
 180         }
 181
 182         _range = VideoRange::FULL;
 183         if (node->optional_string_child("Range").get_value_or("full") == "video") {
 184                 _range = VideoRange::VIDEO;
 185         }
 186
 187         auto burnt = node->optional_string_child("BurntSubtitleLanguage");
 188         if (burnt) {
 189                 _burnt_subtitle_language = dcp::LanguageTag (*burnt);
 190         }
 191
 192 }
 193
 194
 195 VideoContent::VideoContent (Content* parent, vector<shared_ptr<Content> > c)
 196         : ContentPart (parent)
 197         , _length (0)
 198         , _yuv (false)
 199 {
 200         auto ref = c[0]->video;
 201         DCPOMATIC_ASSERT (ref);
 202
 203         for (size_t i = 1; i < c.size(); ++i) {
 204
 205                 if (c[i]->video->use() != ref->use()) {
 206                         throw JoinError (_("Content to be joined must have all its video used or not used."));
 207                 }
 208
 209                 if (c[i]->video->size() != ref->size()) {
 210                         throw JoinError (_("Content to be joined must have the same picture size."));
 211                 }
 212
 213                 if (c[i]->video->frame_type() != ref->frame_type()) {
 214                         throw JoinError (_("Content to be joined must have the same video frame type."));
 215                 }
 216
 217                 if (c[i]->video->crop() != ref->crop()) {
 218                         throw JoinError (_("Content to be joined must have the same crop."));
 219                 }
 220
 221                 if (c[i]->video->custom_ratio() != ref->custom_ratio()) {
 222                         throw JoinError (_("Content to be joined must have the same custom ratio setting."));
 223                 }
 224
 225                 if (c[i]->video->custom_size() != ref->custom_size()) {
 226                         throw JoinError (_("Content to be joined must have the same custom size setting."));
 227                 }
 228
 229                 if (c[i]->video->colour_conversion() != ref->colour_conversion()) {
 230                         throw JoinError (_("Content to be joined must have the same colour conversion."));
 231                 }
 232
 233                 if (c[i]->video->fade_in() != ref->fade_in() || c[i]->video->fade_out() != ref->fade_out()) {
 234                         throw JoinError (_("Content to be joined must have the same fades."));
 235                 }
 236
 237                 if (c[i]->video->burnt_subtitle_language() != ref->burnt_subtitle_language()) {
 238                         throw JoinError (_("Content to be joined must have the same burnt subtitle language."));
 239                 }
 240
 241                 _length += c[i]->video->length ();
 242
 243                 if (c[i]->video->yuv ()) {
 244                         _yuv = true;
 245                 }
 246         }
 247
 248         _use = ref->use ();
 249         _size = ref->size ();
 250         _frame_type = ref->frame_type ();
 251         _crop = ref->crop ();
 252         _custom_ratio = ref->custom_ratio ();
 253         _colour_conversion = ref->colour_conversion ();
 254         _fade_in = ref->fade_in ();
 255         _fade_out = ref->fade_out ();
 256         _range = ref->range ();
 257         _burnt_subtitle_language = ref->burnt_subtitle_language ();
 258 }
 259
 260
 261 void
 262 VideoContent::as_xml (xmlpp::Node* node) const
 263 {
 264         boost::mutex::scoped_lock lm (_mutex);
 265         node->add_child("Use")->add_child_text (_use ? "1" : "0");
 266         node->add_child("VideoLength")->add_child_text (raw_convert<string> (_length));
 267         node->add_child("VideoWidth")->add_child_text (raw_convert<string> (_size.width));
 268         node->add_child("VideoHeight")->add_child_text (raw_convert<string> (_size.height));
 269         node->add_child("VideoFrameType")->add_child_text (video_frame_type_to_string (_frame_type));
 270         if (_sample_aspect_ratio) {
 271                 node->add_child("SampleAspectRatio")->add_child_text (raw_convert<string> (_sample_aspect_ratio.get ()));
 272         }
 273         _crop.as_xml (node);
 274         if (_custom_ratio) {
 275                 node->add_child("CustomRatio")->add_child_text(raw_convert<string>(*_custom_ratio));
 276         }
 277         if (_custom_size) {
 278                 node->add_child("CustomWidth")->add_child_text(raw_convert<string>(_custom_size->width));
 279                 node->add_child("CustomHeight")->add_child_text(raw_convert<string>(_custom_size->height));
 280         }
 281         if (_colour_conversion) {
 282                 _colour_conversion.get().as_xml (node->add_child("ColourConversion"));
 283         }
 284         node->add_child("YUV")->add_child_text (_yuv ? "1" : "0");
 285         node->add_child("FadeIn")->add_child_text (raw_convert<string> (_fade_in));
 286         node->add_child("FadeOut")->add_child_text (raw_convert<string> (_fade_out));
 287         node->add_child("Range")->add_child_text(_range == VideoRange::FULL ? "full" : "video");
 288         if (_burnt_subtitle_language) {
 289                 node->add_child("BurntSubtitleLanguage")->add_child_text(_burnt_subtitle_language->to_string());
 290         }
 291 }
 292
 293 void
 294 VideoContent::take_from_examiner (shared_ptr<VideoExaminer> d)
 295 {
 296         /* These examiner calls could call other content methods which take a lock on the mutex */
 297         auto const vs = d->video_size ();
 298         auto vl = d->video_length ();
 299         auto const ar = d->sample_aspect_ratio ();
 300         auto const yuv = d->yuv ();
 301         auto const range = d->range ();
 302
 303         ContentChangeSignaller cc1 (_parent, VideoContentProperty::SIZE);
 304         ContentChangeSignaller cc2 (_parent, ContentProperty::LENGTH);
 305         ContentChangeSignaller cc3 (_parent, VideoContentProperty::RANGE);
 306
 307         {
 308                 boost::mutex::scoped_lock lm (_mutex);
 309                 _size = vs;
 310                 _length = vl;
 311                 _sample_aspect_ratio = ar;
 312                 _yuv = yuv;
 313                 _range = range;
 314         }
 315
 316         LOG_GENERAL ("Video length obtained from header as %1 frames", _length);
 317
 318         if (d->video_frame_rate()) {
 319                 _parent->set_video_frame_rate (d->video_frame_rate().get());
 320         }
 321 }
 322
 323 /** @return string which includes everything about how this content looks */
 324 string
 325 VideoContent::identifier () const
 326 {
 327         char buffer[256];
 328         snprintf (
 329                 buffer, sizeof(buffer), "%d_%d_%d_%d_%d_%f_%d_%d%" PRId64 "_%" PRId64 "_%d",
 330                 (_use ? 1 : 0),
 331                 crop().left,
 332                 crop().right,
 333                 crop().top,
 334                 crop().bottom,
 335                 _custom_ratio.get_value_or(0),
 336                 _custom_size ? _custom_size->width : 0,
 337                 _custom_size ? _custom_size->height : 0,
 338                 _fade_in,
 339                 _fade_out,
 340                 _range == VideoRange::FULL ? 0 : 1
 341                 );
 342
 343         string s (buffer);
 344
 345         if (colour_conversion()) {
 346                 s += "_" + colour_conversion().get().identifier ();
 347         }
 348
 349         return s;
 350 }
 351
 352 string
 353 VideoContent::technical_summary () const
 354 {
 355         string s = String::compose (
 356                 N_("video: length %1 frames, size %2x%3"),
 357                 length_after_3d_combine(),
 358                 size().width,
 359                 size().height
 360                 );
 361
 362         if (sample_aspect_ratio ()) {
 363                 s += String::compose (N_(", sample aspect ratio %1"), (sample_aspect_ratio().get ()));
 364         }
 365
 366         return s;
 367 }
 368
 369 dcp::Size
 370 VideoContent::size_after_3d_split () const
 371 {
 372         auto const s = size ();
 373         switch (frame_type ()) {
 374         case VideoFrameType::TWO_D:
 375         case VideoFrameType::THREE_D:
 376         case VideoFrameType::THREE_D_ALTERNATE:
 377         case VideoFrameType::THREE_D_LEFT:
 378         case VideoFrameType::THREE_D_RIGHT:
 379                 return s;
 380         case VideoFrameType::THREE_D_LEFT_RIGHT:
 381                 return dcp::Size (s.width / 2, s.height);
 382         case VideoFrameType::THREE_D_TOP_BOTTOM:
 383                 return dcp::Size (s.width, s.height / 2);
 384         }
 385
 386         DCPOMATIC_ASSERT (false);
 387 }
 388
 389 /** @return Video size after 3D split and crop */
 390 dcp::Size
 391 VideoContent::size_after_crop () const
 392 {
 393         return crop().apply (size_after_3d_split ());
 394 }
 395
 396
 397 /** @param f Frame index within the whole (untrimmed) content.
 398  *  @return Fade factor (between 0 and 1) or unset if there is no fade.
 399  */
 400 optional<double>
 401 VideoContent::fade (shared_ptr<const Film> film, Frame f) const
 402 {
 403         DCPOMATIC_ASSERT (f >= 0);
 404
 405         double const vfr = _parent->active_video_frame_rate(film);
 406
 407         auto const ts = _parent->trim_start().frames_round(vfr);
 408         if ((f - ts) < fade_in()) {
 409                 return double (f - ts) / fade_in();
 410         }
 411
 412         auto fade_out_start = length() - _parent->trim_end().frames_round(vfr) - fade_out();
 413         if (f >= fade_out_start) {
 414                 return 1 - double (f - fade_out_start) / fade_out();
 415         }
 416
 417         return optional<double> ();
 418 }
 419
 420 string
 421 VideoContent::processing_description (shared_ptr<const Film> film)
 422 {
 423         string d;
 424         char buffer[256];
 425
 426         if (size().width && size().height) {
 427                 d += String::compose (
 428                         _("Content video is %1x%2"),
 429                         size_after_3d_split().width,
 430                         size_after_3d_split().height
 431                         );
 432
 433
 434                 double ratio = size_after_3d_split().ratio ();
 435
 436                 if (sample_aspect_ratio ()) {
 437                         snprintf (buffer, sizeof(buffer), _(", pixel aspect ratio %.2f:1"), sample_aspect_ratio().get());
 438                         d += buffer;
 439                         ratio *= sample_aspect_ratio().get ();
 440                 }
 441
 442                 snprintf (buffer, sizeof(buffer), _("\nDisplay aspect ratio %.2f:1"), ratio);
 443                 d += buffer;
 444         }
 445
 446         if ((crop().left || crop().right || crop().top || crop().bottom) && size() != dcp::Size (0, 0)) {
 447                 dcp::Size cropped = size_after_crop ();
 448                 d += String::compose (
 449                         _("\nCropped to %1x%2"),
 450                         cropped.width, cropped.height
 451                         );
 452
 453                 snprintf (buffer, sizeof(buffer), " (%.2f:1)", cropped.ratio());
 454                 d += buffer;
 455         }
 456
 457         auto const container_size = film->frame_size ();
 458         auto const scaled = scaled_size (container_size);
 459
 460         if (scaled != size_after_crop ()) {
 461                 d += String::compose (
 462                         _("\nScaled to %1x%2"),
 463                         scaled.width, scaled.height
 464                         );
 465
 466                 snprintf (buffer, sizeof(buffer), _(" (%.2f:1)"), scaled.ratio());
 467                 d += buffer;
 468         }
 469
 470         if (scaled != container_size) {
 471                 d += String::compose (
 472                         _("\nPadded with black to fit container %1 (%2x%3)"),
 473                         film->container()->container_nickname (),
 474                         container_size.width, container_size.height
 475                         );
 476
 477                 snprintf (buffer, sizeof(buffer), _(" (%.2f:1)"), container_size.ratio());
 478                 d += buffer;
 479         }
 480
 481         if (_parent->video_frame_rate()) {
 482                 double const vfr = _parent->video_frame_rate().get ();
 483
 484                 snprintf (buffer, sizeof(buffer), _("\nContent frame rate %.4f\n"), vfr);
 485                 d += buffer;
 486
 487                 FrameRateChange frc (vfr, film->video_frame_rate ());
 488                 d += frc.description ();
 489         }
 490
 491         return d;
 492 }
 493
 494 void
 495 VideoContent::add_properties (list<UserProperty>& p) const
 496 {
 497         p.push_back (UserProperty (UserProperty::VIDEO, _("Length"), length (), _("video frames")));
 498         p.push_back (UserProperty (UserProperty::VIDEO, _("Size"), String::compose ("%1x%2", size().width, size().height)));
 499 }
 500
 501 void
 502 VideoContent::set_length (Frame len)
 503 {
 504         maybe_set (_length, len, ContentProperty::LENGTH);
 505 }
 506
 507 void
 508 VideoContent::set_left_crop (int c)
 509 {
 510         maybe_set (_crop.left, c, VideoContentProperty::CROP);
 511 }
 512
 513 void
 514 VideoContent::set_right_crop (int c)
 515 {
 516         maybe_set (_crop.right, c, VideoContentProperty::CROP);
 517 }
 518
 519 void
 520 VideoContent::set_top_crop (int c)
 521 {
 522         maybe_set (_crop.top, c, VideoContentProperty::CROP);
 523 }
 524
 525 void
 526 VideoContent::set_bottom_crop (int c)
 527 {
 528         maybe_set (_crop.bottom, c, VideoContentProperty::CROP);
 529 }
 530
 531
 532 void
 533 VideoContent::set_frame_type (VideoFrameType t)
 534 {
 535         maybe_set (_frame_type, t, VideoContentProperty::FRAME_TYPE);
 536 }
 537
 538 void
 539 VideoContent::unset_colour_conversion ()
 540 {
 541         maybe_set (_colour_conversion, boost::optional<ColourConversion> (), VideoContentProperty::COLOUR_CONVERSION);
 542 }
 543
 544 void
 545 VideoContent::set_colour_conversion (ColourConversion c)
 546 {
 547         maybe_set (_colour_conversion, c, VideoContentProperty::COLOUR_CONVERSION);
 548 }
 549
 550 void
 551 VideoContent::set_fade_in (Frame t)
 552 {
 553         maybe_set (_fade_in, t, VideoContentProperty::FADE_IN);
 554 }
 555
 556 void
 557 VideoContent::set_fade_out (Frame t)
 558 {
 559         maybe_set (_fade_out, t, VideoContentProperty::FADE_OUT);
 560 }
 561
 562 void
 563 VideoContent::set_range (VideoRange r)
 564 {
 565         maybe_set (_range, r, VideoContentProperty::RANGE);
 566 }
 567
 568 void
 569 VideoContent::set_use (bool u)
 570 {
 571         maybe_set (_use, u, VideoContentProperty::USE);
 572 }
 573
 574
 575 void
 576 VideoContent::set_burnt_subtitle_language (boost::optional<dcp::LanguageTag> language)
 577 {
 578         maybe_set (_burnt_subtitle_language, language, VideoContentProperty::BURNT_SUBTITLE_LANGUAGE);
 579 }
 580
 581
 582 void
 583 VideoContent::take_settings_from (shared_ptr<const VideoContent> c)
 584 {
 585         if (c->_colour_conversion) {
 586                 set_colour_conversion (c->_colour_conversion.get());
 587         } else {
 588                 unset_colour_conversion ();
 589         }
 590         set_use (c->_use);
 591         set_frame_type (c->_frame_type);
 592         set_left_crop (c->_crop.left);
 593         set_right_crop (c->_crop.right);
 594         set_top_crop (c->_crop.top);
 595         set_bottom_crop (c->_crop.bottom);
 596         set_custom_ratio (c->_custom_ratio);
 597         set_custom_size (c->_custom_size);
 598         set_fade_in (c->_fade_in);
 599         set_fade_out (c->_fade_out);
 600         set_burnt_subtitle_language (c->_burnt_subtitle_language);
 601 }
 602
 603
 604 void
 605 VideoContent::modify_position (shared_ptr<const Film> film, DCPTime& pos) const
 606 {
 607         pos = pos.round (film->video_frame_rate());
 608 }
 609
 610 void
 611 VideoContent::modify_trim_start (ContentTime& trim) const
 612 {
 613         if (_parent->video_frame_rate()) {
 614                 trim = trim.round (_parent->video_frame_rate().get());
 615         }
 616 }
 617
 618
 619 /** @param film_container The size of the container for the DCP that we are working on */
 620 dcp::Size
 621 VideoContent::scaled_size (dcp::Size film_container)
 622 {
 623         if (_custom_ratio) {
 624                 return fit_ratio_within(*_custom_ratio, film_container);
 625         }
 626
 627         if (_custom_size) {
 628                 return *_custom_size;
 629         }
 630
 631         auto size = size_after_crop ();
 632         size.width *= _sample_aspect_ratio.get_value_or(1);
 633
 634         /* This is what we will return unless there is any legacy stuff to take into account */
 635         auto auto_size = fit_ratio_within (size.ratio(), film_container);
 636
 637         if (_legacy_ratio) {
 638                 if (fit_ratio_within(*_legacy_ratio, film_container) != auto_size) {
 639                         _custom_ratio = *_legacy_ratio;
 640                         _legacy_ratio = optional<float>();
 641                         return fit_ratio_within(*_custom_ratio, film_container);
 642                 }
 643                 _legacy_ratio = boost::optional<float>();
 644         }
 645
 646         return auto_size;
 647 }
 648
 649
 650 void
 651 VideoContent::set_custom_ratio (optional<float> ratio)
 652 {
 653         maybe_set (_custom_ratio, ratio, VideoContentProperty::CUSTOM_RATIO);
 654 }
 655
 656
 657 void
 658 VideoContent::set_custom_size (optional<dcp::Size> size)
 659 {
 660         maybe_set (_custom_size, size, VideoContentProperty::CUSTOM_SIZE);
 661 }