src/lib/video_content.cc

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