src/lib/dcp_content.cc

   1 /*
   2     Copyright (C) 2014-2018 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 "dcp_content.h"
  22 #include "video_content.h"
  23 #include "audio_content.h"
  24 #include "dcp_examiner.h"
  25 #include "job.h"
  26 #include "film.h"
  27 #include "config.h"
  28 #include "overlaps.h"
  29 #include "compose.hpp"
  30 #include "dcp_decoder.h"
  31 #include "subtitle_content.h"
  32 #include <dcp/dcp.h>
  33 #include <dcp/raw_convert.h>
  34 #include <dcp/exceptions.h>
  35 #include <dcp/reel_picture_asset.h>
  36 #include <dcp/reel.h>
  37 #include <libxml++/libxml++.h>
  38 #include <boost/foreach.hpp>
  39 #include <iterator>
  40 #include <iostream>
  41
  42 #include "i18n.h"
  43
  44 using std::string;
  45 using std::cout;
  46 using std::distance;
  47 using std::pair;
  48 using std::vector;
  49 using std::list;
  50 using boost::shared_ptr;
  51 using boost::scoped_ptr;
  52 using boost::optional;
  53 using boost::function;
  54 using boost::dynamic_pointer_cast;
  55 using dcp::raw_convert;
  56
  57 int const DCPContentProperty::NEEDS_ASSETS       = 600;
  58 int const DCPContentProperty::NEEDS_KDM          = 601;
  59 int const DCPContentProperty::REFERENCE_VIDEO    = 602;
  60 int const DCPContentProperty::REFERENCE_AUDIO    = 603;
  61 int const DCPContentProperty::REFERENCE_SUBTITLE = 604;
  62 int const DCPContentProperty::NAME               = 605;
  63 int const DCPContentProperty::HAS_SUBTITLES      = 606;
  64
  65 DCPContent::DCPContent (shared_ptr<const Film> film, boost::filesystem::path p)
  66         : Content (film)
  67         , _encrypted (false)
  68         , _needs_assets (false)
  69         , _kdm_valid (false)
  70         , _reference_video (false)
  71         , _reference_audio (false)
  72         , _reference_subtitle (false)
  73         , _three_d (false)
  74 {
  75         video.reset (new VideoContent (this));
  76         audio.reset (new AudioContent (this));
  77
  78         read_directory (p);
  79         set_default_colour_conversion ();
  80 }
  81
  82 DCPContent::DCPContent (shared_ptr<const Film> film, cxml::ConstNodePtr node, int version)
  83         : Content (film, node)
  84 {
  85         video = VideoContent::from_xml (this, node, version);
  86         audio = AudioContent::from_xml (this, node, version);
  87         subtitle = SubtitleContent::from_xml (this, node, version);
  88
  89         audio->set_stream (
  90                 AudioStreamPtr (
  91                         new AudioStream (
  92                                 node->number_child<int> ("AudioFrameRate"),
  93                                 /* AudioLength was not present in some old metadata versions */
  94                                 node->optional_number_child<Frame>("AudioLength").get_value_or (
  95                                         video->length() * node->number_child<int>("AudioFrameRate") / video_frame_rate().get()
  96                                         ),
  97                                 AudioMapping (node->node_child ("AudioMapping"), version)
  98                                 )
  99                         )
 100                 );
 101
 102         _name = node->string_child ("Name");
 103         _encrypted = node->bool_child ("Encrypted");
 104         _needs_assets = node->optional_bool_child("NeedsAssets").get_value_or (false);
 105         if (node->optional_node_child ("KDM")) {
 106                 _kdm = dcp::EncryptedKDM (node->string_child ("KDM"));
 107         }
 108         _kdm_valid = node->bool_child ("KDMValid");
 109         _reference_video = node->optional_bool_child ("ReferenceVideo").get_value_or (false);
 110         _reference_audio = node->optional_bool_child ("ReferenceAudio").get_value_or (false);
 111         _reference_subtitle = node->optional_bool_child ("ReferenceSubtitle").get_value_or (false);
 112         if (node->optional_string_child("Standard")) {
 113                 string const s = node->optional_string_child("Standard").get();
 114                 if (s == "Interop") {
 115                         _standard = dcp::INTEROP;
 116                 } else if (s == "SMPTE") {
 117                         _standard = dcp::SMPTE;
 118                 } else {
 119                         DCPOMATIC_ASSERT (false);
 120                 }
 121         }
 122         _three_d = node->optional_bool_child("ThreeD").get_value_or (false);
 123         _cpl = node->optional_string_child("CPL");
 124         BOOST_FOREACH (cxml::ConstNodePtr i, node->node_children("ReelLength")) {
 125                 _reel_lengths.push_back (raw_convert<int64_t> (i->content ()));
 126         }
 127 }
 128
 129 void
 130 DCPContent::read_directory (boost::filesystem::path p)
 131 {
 132         for (boost::filesystem::directory_iterator i(p); i != boost::filesystem::directory_iterator(); ++i) {
 133                 if (boost::filesystem::is_regular_file (i->path())) {
 134                         _paths.push_back (i->path());
 135                 } else if (boost::filesystem::is_directory (i->path ())) {
 136                         read_directory (i->path());
 137                 }
 138         }
 139 }
 140
 141 void
 142 DCPContent::examine (shared_ptr<Job> job)
 143 {
 144         bool const needed_assets = needs_assets ();
 145         bool const needed_kdm = needs_kdm ();
 146         string const old_name = name ();
 147         bool had_subtitles = static_cast<bool> (subtitle);
 148
 149         if (job) {
 150                 job->set_progress_unknown ();
 151         }
 152         Content::examine (job);
 153
 154         shared_ptr<DCPExaminer> examiner (new DCPExaminer (shared_from_this ()));
 155         video->take_from_examiner (examiner);
 156         set_default_colour_conversion ();
 157
 158         {
 159                 boost::mutex::scoped_lock lm (_mutex);
 160
 161                 AudioStreamPtr as (new AudioStream (examiner->audio_frame_rate(), examiner->audio_length(), examiner->audio_channels()));
 162                 audio->set_stream (as);
 163                 AudioMapping m = as->mapping ();
 164                 film()->make_audio_mapping_default (m);
 165                 as->set_mapping (m);
 166         }
 167
 168         signal_changed (AudioContentProperty::STREAMS);
 169
 170         bool has_subtitles = false;
 171         {
 172                 boost::mutex::scoped_lock lm (_mutex);
 173                 _name = examiner->name ();
 174                 if (examiner->has_subtitles ()) {
 175                         subtitle.reset (new SubtitleContent (this));
 176                 } else {
 177                         subtitle.reset ();
 178                 }
 179                 has_subtitles = static_cast<bool> (subtitle);
 180                 _encrypted = examiner->encrypted ();
 181                 _needs_assets = examiner->needs_assets ();
 182                 _kdm_valid = examiner->kdm_valid ();
 183                 _standard = examiner->standard ();
 184                 _three_d = examiner->three_d ();
 185                 _cpl = examiner->cpl ();
 186                 _reel_lengths = examiner->reel_lengths ();
 187         }
 188
 189         if (had_subtitles != has_subtitles) {
 190                 signal_changed (DCPContentProperty::HAS_SUBTITLES);
 191         }
 192
 193         if (needed_assets != needs_assets ()) {
 194                 signal_changed (DCPContentProperty::NEEDS_ASSETS);
 195         }
 196
 197         if (needed_kdm != needs_kdm ()) {
 198                 signal_changed (DCPContentProperty::NEEDS_KDM);
 199         }
 200
 201         if (old_name != name ()) {
 202                 signal_changed (DCPContentProperty::NAME);
 203         }
 204
 205         video->set_frame_type (_three_d ? VIDEO_FRAME_TYPE_3D : VIDEO_FRAME_TYPE_2D);
 206 }
 207
 208 string
 209 DCPContent::summary () const
 210 {
 211         boost::mutex::scoped_lock lm (_mutex);
 212         return String::compose (_("%1 [DCP]"), _name);
 213 }
 214
 215 string
 216 DCPContent::technical_summary () const
 217 {
 218         return Content::technical_summary() + " - "
 219                 + video->technical_summary() + " - "
 220                 + audio->technical_summary() + " - ";
 221 }
 222
 223 void
 224 DCPContent::as_xml (xmlpp::Node* node, bool with_paths) const
 225 {
 226         node->add_child("Type")->add_child_text ("DCP");
 227
 228         Content::as_xml (node, with_paths);
 229
 230         if (video) {
 231                 video->as_xml (node);
 232         }
 233
 234         if (audio) {
 235                 audio->as_xml (node);
 236                 node->add_child("AudioFrameRate")->add_child_text (raw_convert<string> (audio->stream()->frame_rate()));
 237                 node->add_child("AudioLength")->add_child_text (raw_convert<string> (audio->stream()->length()));
 238                 audio->stream()->mapping().as_xml (node->add_child("AudioMapping"));
 239         }
 240
 241         if (subtitle) {
 242                 subtitle->as_xml (node);
 243         }
 244
 245         boost::mutex::scoped_lock lm (_mutex);
 246         node->add_child("Name")->add_child_text (_name);
 247         node->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
 248         node->add_child("NeedsAssets")->add_child_text (_needs_assets ? "1" : "0");
 249         if (_kdm) {
 250                 node->add_child("KDM")->add_child_text (_kdm->as_xml ());
 251         }
 252         node->add_child("KDMValid")->add_child_text (_kdm_valid ? "1" : "0");
 253         node->add_child("ReferenceVideo")->add_child_text (_reference_video ? "1" : "0");
 254         node->add_child("ReferenceAudio")->add_child_text (_reference_audio ? "1" : "0");
 255         node->add_child("ReferenceSubtitle")->add_child_text (_reference_subtitle ? "1" : "0");
 256         if (_standard) {
 257                 switch (_standard.get ()) {
 258                 case dcp::INTEROP:
 259                         node->add_child("Standard")->add_child_text ("Interop");
 260                         break;
 261                 case dcp::SMPTE:
 262                         node->add_child("Standard")->add_child_text ("SMPTE");
 263                         break;
 264                 default:
 265                         DCPOMATIC_ASSERT (false);
 266                 }
 267         }
 268         node->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
 269         if (_cpl) {
 270                 node->add_child("CPL")->add_child_text (_cpl.get ());
 271         }
 272         BOOST_FOREACH (int64_t i, _reel_lengths) {
 273                 node->add_child("ReelLength")->add_child_text (raw_convert<string> (i));
 274         }
 275 }
 276
 277 DCPTime
 278 DCPContent::full_length () const
 279 {
 280         FrameRateChange const frc (active_video_frame_rate (), film()->video_frame_rate ());
 281         return DCPTime::from_frames (llrint (video->length () * frc.factor ()), film()->video_frame_rate ());
 282 }
 283
 284 string
 285 DCPContent::identifier () const
 286 {
 287         string s = Content::identifier() + "_" + video->identifier() + "_";
 288         if (subtitle) {
 289                 s += subtitle->identifier () + " ";
 290         }
 291
 292         s += string (_reference_video ? "1" : "0") + string (_reference_subtitle ? "1" : "0");
 293         return s;
 294 }
 295
 296 void
 297 DCPContent::add_kdm (dcp::EncryptedKDM k)
 298 {
 299         _kdm = k;
 300 }
 301
 302 void
 303 DCPContent::add_ov (boost::filesystem::path ov)
 304 {
 305         read_directory (ov);
 306 }
 307
 308 bool
 309 DCPContent::can_be_played () const
 310 {
 311         return !needs_kdm() && !needs_assets();
 312 }
 313
 314 bool
 315 DCPContent::needs_kdm () const
 316 {
 317         boost::mutex::scoped_lock lm (_mutex);
 318         return _encrypted && !_kdm_valid;
 319 }
 320
 321 bool
 322 DCPContent::needs_assets () const
 323 {
 324         boost::mutex::scoped_lock lm (_mutex);
 325         return _needs_assets;
 326 }
 327
 328 vector<boost::filesystem::path>
 329 DCPContent::directories () const
 330 {
 331         return dcp::DCP::directories_from_files (paths());
 332 }
 333
 334 void
 335 DCPContent::add_properties (list<UserProperty>& p) const
 336 {
 337         Content::add_properties (p);
 338         video->add_properties (p);
 339         audio->add_properties (p);
 340 }
 341
 342 void
 343 DCPContent::set_default_colour_conversion ()
 344 {
 345         /* Default to no colour conversion for DCPs */
 346         video->unset_colour_conversion ();
 347 }
 348
 349 void
 350 DCPContent::set_reference_video (bool r)
 351 {
 352         {
 353                 boost::mutex::scoped_lock lm (_mutex);
 354                 _reference_video = r;
 355         }
 356
 357         signal_changed (DCPContentProperty::REFERENCE_VIDEO);
 358 }
 359
 360 void
 361 DCPContent::set_reference_audio (bool r)
 362 {
 363         {
 364                 boost::mutex::scoped_lock lm (_mutex);
 365                 _reference_audio = r;
 366         }
 367
 368         signal_changed (DCPContentProperty::REFERENCE_AUDIO);
 369 }
 370
 371 void
 372 DCPContent::set_reference_subtitle (bool r)
 373 {
 374         {
 375                 boost::mutex::scoped_lock lm (_mutex);
 376                 _reference_subtitle = r;
 377         }
 378
 379         signal_changed (DCPContentProperty::REFERENCE_SUBTITLE);
 380 }
 381
 382 list<DCPTimePeriod>
 383 DCPContent::reels () const
 384 {
 385         list<int64_t> reel_lengths = _reel_lengths;
 386         if (reel_lengths.empty ()) {
 387                 /* Old metadata with no reel lengths; get them here instead */
 388                 try {
 389                         scoped_ptr<DCPExaminer> examiner (new DCPExaminer (shared_from_this()));
 390                         reel_lengths = examiner->reel_lengths ();
 391                 } catch (...) {
 392                         /* Could not examine the DCP; guess reels */
 393                         reel_lengths.push_back (length_after_trim().frames_round (film()->video_frame_rate ()));
 394                 }
 395         }
 396
 397         list<DCPTimePeriod> p;
 398
 399         /* This content's frame rate must be the same as the output DCP rate, so we can
 400            convert `directly' from ContentTime to DCPTime.
 401         */
 402
 403         /* The starting point of this content on the timeline */
 404         DCPTime pos = position() - DCPTime (trim_start().get());
 405
 406         BOOST_FOREACH (int64_t i, reel_lengths) {
 407                 /* This reel runs from `pos' to `to' */
 408                 DCPTime const to = pos + DCPTime::from_frames (i, film()->video_frame_rate());
 409                 if (to > position()) {
 410                         p.push_back (DCPTimePeriod (max(position(), pos), min(end(), to)));
 411                         if (to > end()) {
 412                                 break;
 413                         }
 414                 }
 415                 pos = to;
 416         }
 417
 418         return p;
 419 }
 420
 421 list<DCPTime>
 422 DCPContent::reel_split_points () const
 423 {
 424         list<DCPTime> s;
 425         BOOST_FOREACH (DCPTimePeriod i, reels()) {
 426                 s.push_back (i.from);
 427         }
 428         return s;
 429 }
 430
 431 bool
 432 DCPContent::can_reference (function<shared_ptr<ContentPart> (shared_ptr<const Content>)> part, string overlapping, string& why_not) const
 433 {
 434         /* We must be using the same standard as the film */
 435         if (_standard) {
 436                 if (_standard.get() == dcp::INTEROP && !film()->interop()) {
 437                         why_not = _("The film is set to SMPTE and this DCP is Interop.");
 438                         return false;
 439                 } else if (_standard.get() == dcp::SMPTE && film()->interop()) {
 440                         why_not = _("The film is set to Interop and this DCP is SMPTE.");
 441                         return false;
 442                 }
 443         }
 444
 445         /* And the same frame rate */
 446         if (!video_frame_rate() || (lrint(video_frame_rate().get()) != film()->video_frame_rate())) {
 447                 why_not = _("The film has a different frame rate to this DCP.");
 448                 return false;
 449         }
 450
 451         list<DCPTimePeriod> const fr = film()->reels ();
 452
 453         list<DCPTimePeriod> reel_list;
 454         try {
 455                 reel_list = reels ();
 456         } catch (dcp::DCPReadError) {
 457                 /* We couldn't read the DCP; it's probably missing */
 458                 return false;
 459         } catch (dcp::KDMDecryptionError) {
 460                 /* We have an incorrect KDM */
 461                 return false;
 462         }
 463
 464         /* fr must contain reels().  It can also contain other reels, but it must at
 465            least contain reels().
 466         */
 467         BOOST_FOREACH (DCPTimePeriod i, reel_list) {
 468                 if (find (fr.begin(), fr.end(), i) == fr.end ()) {
 469                         why_not = _("The reel lengths in the film differ from those in the DCP; set the reel mode to 'split by video content'.");
 470                         return false;
 471                 }
 472         }
 473
 474         ContentList a = overlaps (film()->content(), part, position(), end());
 475         if (a.size() != 1 || a.front().get() != this) {
 476                 why_not = overlapping;
 477                 return false;
 478         }
 479
 480         return true;
 481 }
 482
 483 bool
 484 DCPContent::can_reference_video (string& why_not) const
 485 {
 486         if (film()->frame_size() != video->size()) {
 487                 why_not = _("The video frame size in the film differs from that in the DCP.");
 488                 return false;
 489         }
 490
 491         return can_reference (bind (&Content::video, _1), _("There is other video content overlapping this DCP; remove it."), why_not);
 492 }
 493
 494 bool
 495 DCPContent::can_reference_audio (string& why_not) const
 496 {
 497         shared_ptr<DCPDecoder> decoder;
 498         try {
 499                 decoder.reset (new DCPDecoder (shared_from_this(), film()->log(), false));
 500         } catch (dcp::DCPReadError) {
 501                 /* We couldn't read the DCP, so it's probably missing */
 502                 return false;
 503         } catch (dcp::KDMDecryptionError) {
 504                 /* We have an incorrect KDM */
 505                 return false;
 506         }
 507
 508         BOOST_FOREACH (shared_ptr<dcp::Reel> i, decoder->reels()) {
 509                 if (!i->main_sound()) {
 510                         why_not = _("The DCP does not have sound in all reels.");
 511                         return false;
 512                 }
 513         }
 514
 515         return can_reference (bind (&Content::audio, _1), _("There is other audio content overlapping this DCP; remove it."), why_not);
 516 }
 517
 518 bool
 519 DCPContent::can_reference_subtitle (string& why_not) const
 520 {
 521         shared_ptr<DCPDecoder> decoder;
 522         try {
 523                 decoder.reset (new DCPDecoder (shared_from_this(), film()->log(), false));
 524         } catch (dcp::DCPReadError) {
 525                 /* We couldn't read the DCP, so it's probably missing */
 526                 return false;
 527         } catch (dcp::KDMDecryptionError) {
 528                 /* We have an incorrect KDM */
 529                 return false;
 530         }
 531
 532         BOOST_FOREACH (shared_ptr<dcp::Reel> i, decoder->reels()) {
 533                 if (!i->main_subtitle()) {
 534                         why_not = _("The DCP does not have subtitles in all reels.");
 535                         return false;
 536                 }
 537         }
 538
 539         return can_reference (bind (&Content::subtitle, _1), _("There is other subtitle content overlapping this DCP; remove it."), why_not);
 540 }
 541
 542 void
 543 DCPContent::take_settings_from (shared_ptr<const Content> c)
 544 {
 545         shared_ptr<const DCPContent> dc = dynamic_pointer_cast<const DCPContent> (c);
 546         if (!dc) {
 547                 return;
 548         }
 549
 550         _reference_video = dc->_reference_video;
 551         _reference_audio = dc->_reference_audio;
 552         _reference_subtitle = dc->_reference_subtitle;
 553 }
 554
 555 void
 556 DCPContent::set_cpl (string id)
 557 {
 558         boost::mutex::scoped_lock lm (_mutex);
 559         _cpl = id;
 560 }