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