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 = ColourConversion (dcp::ColourConversion::srgb_to_xyz ());
 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 void
 253 VideoContent::set_left_crop (int c)
 254 {
 255         {
 256                 boost::mutex::scoped_lock lm (_mutex);
 257
 258                 if (_crop.left == c) {
 259                         return;
 260                 }
 261
 262                 _crop.left = c;
 263         }
 264
 265         signal_changed (VideoContentProperty::VIDEO_CROP);
 266 }
 267
 268 void
 269 VideoContent::set_right_crop (int c)
 270 {
 271         {
 272                 boost::mutex::scoped_lock lm (_mutex);
 273                 if (_crop.right == c) {
 274                         return;
 275                 }
 276
 277                 _crop.right = c;
 278         }
 279
 280         signal_changed (VideoContentProperty::VIDEO_CROP);
 281 }
 282
 283 void
 284 VideoContent::set_top_crop (int c)
 285 {
 286         {
 287                 boost::mutex::scoped_lock lm (_mutex);
 288                 if (_crop.top == c) {
 289                         return;
 290                 }
 291
 292                 _crop.top = c;
 293         }
 294
 295         signal_changed (VideoContentProperty::VIDEO_CROP);
 296 }
 297
 298 void
 299 VideoContent::set_bottom_crop (int c)
 300 {
 301         {
 302                 boost::mutex::scoped_lock lm (_mutex);
 303                 if (_crop.bottom == c) {
 304                         return;
 305                 }
 306
 307                 _crop.bottom = c;
 308         }
 309
 310         signal_changed (VideoContentProperty::VIDEO_CROP);
 311 }
 312
 313 void
 314 VideoContent::set_scale (VideoContentScale s)
 315 {
 316         {
 317                 boost::mutex::scoped_lock lm (_mutex);
 318                 if (_scale == s) {
 319                         return;
 320                 }
 321
 322                 _scale = s;
 323         }
 324
 325         signal_changed (VideoContentProperty::VIDEO_SCALE);
 326 }
 327
 328 /** @return string which includes everything about how this content looks */
 329 string
 330 VideoContent::identifier () const
 331 {
 332         SafeStringStream s;
 333         s << Content::identifier()
 334           << "_" << crop().left
 335           << "_" << crop().right
 336           << "_" << crop().top
 337           << "_" << crop().bottom
 338           << "_" << scale().id();
 339
 340         if (colour_conversion()) {
 341                 s << "_" << colour_conversion().get().identifier ();
 342         }
 343
 344         return s.str ();
 345 }
 346
 347 void
 348 VideoContent::set_video_frame_type (VideoFrameType t)
 349 {
 350         {
 351                 boost::mutex::scoped_lock lm (_mutex);
 352                 _video_frame_type = t;
 353         }
 354
 355         signal_changed (VideoContentProperty::VIDEO_FRAME_TYPE);
 356 }
 357
 358 string
 359 VideoContent::technical_summary () const
 360 {
 361         string s = String::compose (
 362                 "video: length %1, size %2x%3, rate %4",
 363                 video_length_after_3d_combine().seconds(),
 364                 video_size().width,
 365                 video_size().height,
 366                 video_frame_rate()
 367                 );
 368
 369         if (sample_aspect_ratio ()) {
 370                 s += String::compose (_(", sample aspect ratio %1"), (sample_aspect_ratio().get ()));
 371         }
 372
 373         return s;
 374 }
 375
 376 dcp::Size
 377 VideoContent::video_size_after_3d_split () const
 378 {
 379         dcp::Size const s = video_size ();
 380         switch (video_frame_type ()) {
 381         case VIDEO_FRAME_TYPE_2D:
 382         case VIDEO_FRAME_TYPE_3D_ALTERNATE:
 383         case VIDEO_FRAME_TYPE_3D_LEFT:
 384         case VIDEO_FRAME_TYPE_3D_RIGHT:
 385                 return s;
 386         case VIDEO_FRAME_TYPE_3D_LEFT_RIGHT:
 387                 return dcp::Size (s.width / 2, s.height);
 388         case VIDEO_FRAME_TYPE_3D_TOP_BOTTOM:
 389                 return dcp::Size (s.width, s.height / 2);
 390         }
 391
 392         DCPOMATIC_ASSERT (false);
 393 }
 394
 395 void
 396 VideoContent::unset_colour_conversion ()
 397 {
 398         {
 399                 boost::mutex::scoped_lock lm (_mutex);
 400                 _colour_conversion = boost::optional<ColourConversion> ();
 401         }
 402
 403         signal_changed (VideoContentProperty::COLOUR_CONVERSION);
 404 }
 405
 406 void
 407 VideoContent::set_colour_conversion (ColourConversion c)
 408 {
 409         {
 410                 boost::mutex::scoped_lock lm (_mutex);
 411                 _colour_conversion = c;
 412         }
 413
 414         signal_changed (VideoContentProperty::COLOUR_CONVERSION);
 415 }
 416
 417 void
 418 VideoContent::set_fade_in (ContentTime t)
 419 {
 420         {
 421                 boost::mutex::scoped_lock lm (_mutex);
 422                 _fade_in = t;
 423         }
 424
 425         signal_changed (VideoContentProperty::VIDEO_FADE_IN);
 426 }
 427
 428 void
 429 VideoContent::set_fade_out (ContentTime t)
 430 {
 431         {
 432                 boost::mutex::scoped_lock lm (_mutex);
 433                 _fade_out = t;
 434         }
 435
 436         signal_changed (VideoContentProperty::VIDEO_FADE_OUT);
 437 }
 438
 439 /** @return Video size after 3D split and crop */
 440 dcp::Size
 441 VideoContent::video_size_after_crop () const
 442 {
 443         return crop().apply (video_size_after_3d_split ());
 444 }
 445
 446 /** @param t A time offset from the start of this piece of content.
 447  *  @return Corresponding time with respect to the content.
 448  */
 449 ContentTime
 450 VideoContent::dcp_time_to_content_time (DCPTime t) const
 451 {
 452         shared_ptr<const Film> film = _film.lock ();
 453         DCPOMATIC_ASSERT (film);
 454         return ContentTime (t, FrameRateChange (video_frame_rate(), film->video_frame_rate()));
 455 }
 456
 457 void
 458 VideoContent::scale_and_crop_to_fit_width ()
 459 {
 460         shared_ptr<const Film> film = _film.lock ();
 461         DCPOMATIC_ASSERT (film);
 462
 463         set_scale (VideoContentScale (film->container ()));
 464
 465         int const crop = max (0, int (video_size().height - double (film->frame_size().height) * video_size().width / film->frame_size().width));
 466         set_top_crop (crop / 2);
 467         set_bottom_crop (crop / 2);
 468 }
 469
 470 void
 471 VideoContent::scale_and_crop_to_fit_height ()
 472 {
 473         shared_ptr<const Film> film = _film.lock ();
 474         DCPOMATIC_ASSERT (film);
 475
 476         set_scale (VideoContentScale (film->container ()));
 477
 478         int const crop = max (0, int (video_size().width - double (film->frame_size().width) * video_size().height / film->frame_size().height));
 479         set_left_crop (crop / 2);
 480         set_right_crop (crop / 2);
 481 }
 482
 483 void
 484 VideoContent::set_video_frame_rate (float r)
 485 {
 486         {
 487                 boost::mutex::scoped_lock lm (_mutex);
 488                 if (_video_frame_rate == r) {
 489                         return;
 490                 }
 491
 492                 _video_frame_rate = r;
 493         }
 494
 495         signal_changed (VideoContentProperty::VIDEO_FRAME_RATE);
 496 }
 497
 498 optional<float>
 499 VideoContent::fade (VideoFrame f) const
 500 {
 501         DCPOMATIC_ASSERT (f >= 0);
 502
 503         if (f < fade_in().frames (video_frame_rate ())) {
 504                 return float (f) / _fade_in.frames (video_frame_rate ());
 505         }
 506
 507         VideoFrame fade_out_start = ContentTime (video_length() - fade_out()).frames (video_frame_rate ());
 508         if (f >= fade_out_start) {
 509                 return 1 - float (f - fade_out_start) / fade_out().frames (video_frame_rate ());
 510         }
 511
 512         return optional<float> ();
 513 }
 514
 515 string
 516 VideoContent::processing_description () const
 517 {
 518         /* stringstream is OK here as this string is just for presentation to the user */
 519         stringstream d;
 520
 521         if (video_size().width && video_size().height) {
 522                 d << String::compose (
 523                         _("Content video is %1x%2"),
 524                         video_size_after_3d_split().width,
 525                         video_size_after_3d_split().height
 526                         );
 527
 528                 d << " (" << fixed << setprecision(2) << video_size_after_3d_split().ratio() << ":1)\n";
 529         }
 530
 531         if ((crop().left || crop().right || crop().top || crop().bottom) && video_size() != dcp::Size (0, 0)) {
 532                 dcp::Size cropped = video_size_after_crop ();
 533                 d << String::compose (
 534                         _("Cropped to %1x%2"),
 535                         cropped.width, cropped.height
 536                         );
 537
 538                 d << " (" << fixed << setprecision(2) << cropped.ratio () << ":1)\n";
 539         }
 540
 541         shared_ptr<const Film> film = _film.lock ();
 542         DCPOMATIC_ASSERT (film);
 543
 544         dcp::Size const container_size = film->frame_size ();
 545         dcp::Size const scaled = scale().size (dynamic_pointer_cast<const VideoContent> (shared_from_this ()), container_size, container_size, 1);
 546
 547         if (scaled != video_size_after_crop ()) {
 548                 d << String::compose (
 549                         _("Scaled to %1x%2"),
 550                         scaled.width, scaled.height
 551                         );
 552
 553                 d << " (" << fixed << setprecision(2) << scaled.ratio() << ":1)\n";
 554         }
 555
 556         if (scaled != container_size) {
 557                 d << String::compose (
 558                         _("Padded with black to %1x%2"),
 559                         container_size.width, container_size.height
 560                         );
 561
 562                 d << " (" << fixed << setprecision(2) << container_size.ratio () << ":1)\n";
 563         }
 564
 565         d << _("Content frame rate");
 566         d << " " << fixed << setprecision(4) << video_frame_rate() << "\n";
 567
 568         FrameRateChange frc (video_frame_rate(), film->video_frame_rate ());
 569         d << frc.description () << "\n";
 570
 571         return d.str ();
 572 }