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