src/lib/dcp_content.cc

   1 /*
   2     Copyright (C) 2014-2016 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/exceptions.h>
  34 #include <dcp/reel_picture_asset.h>
  35 #include <dcp/reel.h>
  36 #include <libxml++/libxml++.h>
  37 #include <boost/foreach.hpp>
  38 #include <iterator>
  39 #include <iostream>
  40
  41 #include "i18n.h"
  42
  43 using std::string;
  44 using std::cout;
  45 using std::distance;
  46 using std::pair;
  47 using std::vector;
  48 using std::list;
  49 using boost::shared_ptr;
  50 using boost::scoped_ptr;
  51 using boost::optional;
  52 using boost::function;
  53 using dcp::raw_convert;
  54
  55 int const DCPContentProperty::CAN_BE_PLAYED      = 600;
  56 int const DCPContentProperty::REFERENCE_VIDEO    = 601;
  57 int const DCPContentProperty::REFERENCE_AUDIO    = 602;
  58 int const DCPContentProperty::REFERENCE_SUBTITLE = 603;
  59
  60 DCPContent::DCPContent (shared_ptr<const Film> film, boost::filesystem::path p)
  61         : Content (film)
  62         , _encrypted (false)
  63         , _kdm_valid (false)
  64         , _reference_video (false)
  65         , _reference_audio (false)
  66         , _reference_subtitle (false)
  67         , _three_d (false)
  68 {
  69         video.reset (new VideoContent (this));
  70         audio.reset (new AudioContent (this));
  71
  72         read_directory (p);
  73         set_default_colour_conversion ();
  74 }
  75
  76 DCPContent::DCPContent (shared_ptr<const Film> film, cxml::ConstNodePtr node, int version)
  77         : Content (film, node)
  78 {
  79         video = VideoContent::from_xml (this, node, version);
  80         audio = AudioContent::from_xml (this, node, version);
  81         subtitle = SubtitleContent::from_xml (this, node, version);
  82
  83         audio->set_stream (
  84                 AudioStreamPtr (
  85                         new AudioStream (
  86                                 node->number_child<int> ("AudioFrameRate"),
  87                                 node->number_child<Frame> ("AudioLength"),
  88                                 AudioMapping (node->node_child ("AudioMapping"), version)
  89                                 )
  90                         )
  91                 );
  92
  93         _name = node->string_child ("Name");
  94
  95         _encrypted = node->bool_child ("Encrypted");
  96         if (node->optional_node_child ("KDM")) {
  97                 _kdm = dcp::EncryptedKDM (node->string_child ("KDM"));
  98         }
  99         _kdm_valid = node->bool_child ("KDMValid");
 100         _reference_video = node->optional_bool_child ("ReferenceVideo").get_value_or (false);
 101         _reference_audio = node->optional_bool_child ("ReferenceAudio").get_value_or (false);
 102         _reference_subtitle = node->optional_bool_child ("ReferenceSubtitle").get_value_or (false);
 103         if (node->optional_string_child("Standard")) {
 104                 string const s = node->optional_string_child("Standard").get();
 105                 if (s == "Interop") {
 106                         _standard = dcp::INTEROP;
 107                 } else if (s == "SMPTE") {
 108                         _standard = dcp::SMPTE;
 109                 } else {
 110                         DCPOMATIC_ASSERT (false);
 111                 }
 112         }
 113         _three_d = node->optional_bool_child("ThreeD").get_value_or (false);
 114 }
 115
 116 void
 117 DCPContent::read_directory (boost::filesystem::path p)
 118 {
 119         for (boost::filesystem::directory_iterator i(p); i != boost::filesystem::directory_iterator(); ++i) {
 120                 if (boost::filesystem::is_regular_file (i->path ())) {
 121                         _paths.push_back (i->path ());
 122                 } else if (boost::filesystem::is_directory (i->path ())) {
 123                         read_directory (i->path ());
 124                 }
 125         }
 126 }
 127
 128 void
 129 DCPContent::examine (shared_ptr<Job> job)
 130 {
 131         bool const could_be_played = can_be_played ();
 132
 133         job->set_progress_unknown ();
 134         Content::examine (job);
 135
 136         shared_ptr<DCPExaminer> examiner (new DCPExaminer (shared_from_this ()));
 137         video->take_from_examiner (examiner);
 138         set_default_colour_conversion ();
 139
 140         {
 141                 boost::mutex::scoped_lock lm (_mutex);
 142
 143                 AudioStreamPtr as (new AudioStream (examiner->audio_frame_rate(), examiner->audio_length(), examiner->audio_channels()));
 144                 audio->set_stream (as);
 145                 AudioMapping m = as->mapping ();
 146                 film()->make_audio_mapping_default (m);
 147                 as->set_mapping (m);
 148         }
 149
 150         signal_changed (AudioContentProperty::STREAMS);
 151
 152         {
 153                 boost::mutex::scoped_lock lm (_mutex);
 154                 _name = examiner->name ();
 155                 if (examiner->has_subtitles ()) {
 156                         subtitle.reset (new SubtitleContent (this));
 157                 }
 158                 _encrypted = examiner->encrypted ();
 159                 _kdm_valid = examiner->kdm_valid ();
 160                 _standard = examiner->standard ();
 161                 _three_d = examiner->three_d ();
 162         }
 163
 164         if (could_be_played != can_be_played ()) {
 165                 signal_changed (DCPContentProperty::CAN_BE_PLAYED);
 166         }
 167
 168         video->set_frame_type (_three_d ? VIDEO_FRAME_TYPE_3D : VIDEO_FRAME_TYPE_2D);
 169 }
 170
 171 string
 172 DCPContent::summary () const
 173 {
 174         boost::mutex::scoped_lock lm (_mutex);
 175         return String::compose (_("%1 [DCP]"), _name);
 176 }
 177
 178 string
 179 DCPContent::technical_summary () const
 180 {
 181         return Content::technical_summary() + " - "
 182                 + video->technical_summary() + " - "
 183                 + audio->technical_summary() + " - ";
 184 }
 185
 186 void
 187 DCPContent::as_xml (xmlpp::Node* node) const
 188 {
 189         node->add_child("Type")->add_child_text ("DCP");
 190
 191         Content::as_xml (node);
 192
 193         if (video) {
 194                 video->as_xml (node);
 195         }
 196
 197         if (audio) {
 198                 audio->as_xml (node);
 199                 node->add_child("AudioFrameRate")->add_child_text (raw_convert<string> (audio->stream()->frame_rate()));
 200                 node->add_child("AudioLength")->add_child_text (raw_convert<string> (audio->stream()->length()));
 201                 audio->stream()->mapping().as_xml (node->add_child("AudioMapping"));
 202         }
 203
 204         if (subtitle) {
 205                 subtitle->as_xml (node);
 206         }
 207
 208         boost::mutex::scoped_lock lm (_mutex);
 209         node->add_child("Name")->add_child_text (_name);
 210         node->add_child("Encrypted")->add_child_text (_encrypted ? "1" : "0");
 211         if (_kdm) {
 212                 node->add_child("KDM")->add_child_text (_kdm->as_xml ());
 213         }
 214         node->add_child("KDMValid")->add_child_text (_kdm_valid ? "1" : "0");
 215         node->add_child("ReferenceVideo")->add_child_text (_reference_video ? "1" : "0");
 216         node->add_child("ReferenceAudio")->add_child_text (_reference_audio ? "1" : "0");
 217         node->add_child("ReferenceSubtitle")->add_child_text (_reference_subtitle ? "1" : "0");
 218         if (_standard) {
 219                 switch (_standard.get ()) {
 220                 case dcp::INTEROP:
 221                         node->add_child("Standard")->add_child_text ("Interop");
 222                         break;
 223                 case dcp::SMPTE:
 224                         node->add_child("Standard")->add_child_text ("SMPTE");
 225                         break;
 226                 default:
 227                         DCPOMATIC_ASSERT (false);
 228                 }
 229         }
 230         node->add_child("ThreeD")->add_child_text (_three_d ? "1" : "0");
 231 }
 232
 233 DCPTime
 234 DCPContent::full_length () const
 235 {
 236         FrameRateChange const frc (active_video_frame_rate (), film()->video_frame_rate ());
 237         return DCPTime::from_frames (llrint (video->length () * frc.factor ()), film()->video_frame_rate ());
 238 }
 239
 240 string
 241 DCPContent::identifier () const
 242 {
 243         string s = Content::identifier() + "_" + video->identifier() + "_";
 244         if (subtitle) {
 245                 s += subtitle->identifier () + " ";
 246         }
 247
 248         s += string (_reference_video ? "1" : "0") + string (_reference_subtitle ? "1" : "0");
 249         return s;
 250 }
 251
 252 void
 253 DCPContent::add_kdm (dcp::EncryptedKDM k)
 254 {
 255         _kdm = k;
 256 }
 257
 258 bool
 259 DCPContent::can_be_played () const
 260 {
 261         boost::mutex::scoped_lock lm (_mutex);
 262         return !_encrypted || _kdm_valid;
 263 }
 264
 265 boost::filesystem::path
 266 DCPContent::directory () const
 267 {
 268         optional<size_t> smallest;
 269         boost::filesystem::path dir;
 270         for (size_t i = 0; i < number_of_paths(); ++i) {
 271                 boost::filesystem::path const p = path (i).parent_path ();
 272                 size_t const d = distance (p.begin(), p.end());
 273                 if (!smallest || d < smallest.get ()) {
 274                         dir = p;
 275                 }
 276         }
 277
 278         return dir;
 279 }
 280
 281 void
 282 DCPContent::add_properties (list<UserProperty>& p) const
 283 {
 284         Content::add_properties (p);
 285         video->add_properties (p);
 286         audio->add_properties (p);
 287 }
 288
 289 void
 290 DCPContent::set_default_colour_conversion ()
 291 {
 292         /* Default to no colour conversion for DCPs */
 293         video->unset_colour_conversion ();
 294 }
 295
 296 void
 297 DCPContent::set_reference_video (bool r)
 298 {
 299         {
 300                 boost::mutex::scoped_lock lm (_mutex);
 301                 _reference_video = r;
 302         }
 303
 304         signal_changed (DCPContentProperty::REFERENCE_VIDEO);
 305 }
 306
 307 void
 308 DCPContent::set_reference_audio (bool r)
 309 {
 310         {
 311                 boost::mutex::scoped_lock lm (_mutex);
 312                 _reference_audio = r;
 313         }
 314
 315         signal_changed (DCPContentProperty::REFERENCE_AUDIO);
 316 }
 317
 318 void
 319 DCPContent::set_reference_subtitle (bool r)
 320 {
 321         {
 322                 boost::mutex::scoped_lock lm (_mutex);
 323                 _reference_subtitle = r;
 324         }
 325
 326         signal_changed (DCPContentProperty::REFERENCE_SUBTITLE);
 327 }
 328
 329 list<DCPTimePeriod>
 330 DCPContent::reels () const
 331 {
 332         list<DCPTimePeriod> p;
 333         scoped_ptr<DCPDecoder> decoder;
 334         try {
 335                 decoder.reset (new DCPDecoder (shared_from_this(), film()->log()));
 336         } catch (...) {
 337                 /* Could not load the DCP; guess reels */
 338                 list<DCPTimePeriod> p;
 339                 p.push_back (DCPTimePeriod (position(), end()));
 340                 return p;
 341         }
 342
 343         DCPTime from = position ();
 344         BOOST_FOREACH (shared_ptr<dcp::Reel> i, decoder->reels()) {
 345                 DCPTime const to = from + DCPTime::from_frames (i->main_picture()->duration(), film()->video_frame_rate());
 346                 p.push_back (DCPTimePeriod (from, to));
 347                 from = to;
 348         }
 349
 350         return p;
 351 }
 352
 353 list<DCPTime>
 354 DCPContent::reel_split_points () const
 355 {
 356         list<DCPTime> s;
 357         BOOST_FOREACH (DCPTimePeriod i, reels()) {
 358                 s.push_back (i.from);
 359         }
 360         return s;
 361 }
 362
 363 bool
 364 DCPContent::can_reference (function<shared_ptr<ContentPart> (shared_ptr<const Content>)> part, string overlapping, list<string>& why_not) const
 365 {
 366         /* We must be using the same standard as the film */
 367         if (_standard) {
 368                 if (_standard.get() == dcp::INTEROP && !film()->interop()) {
 369                         why_not.push_back (_("The film is set to SMPTE and this DCP is Interop."));
 370                         return false;
 371                 } else if (_standard.get() == dcp::SMPTE && film()->interop()) {
 372                         why_not.push_back (_("The film is set to Interop and this DCP is SMPTE."));
 373                         return false;
 374                 }
 375         }
 376
 377         list<DCPTimePeriod> const fr = film()->reels ();
 378         /* fr must contain reels().  It can also contain other reels, but it must at
 379            least contain reels().
 380         */
 381         BOOST_FOREACH (DCPTimePeriod i, reels()) {
 382                 if (find (fr.begin(), fr.end(), i) == fr.end ()) {
 383                         why_not.push_back (_("Reel lengths in the film differ from those in the DCP; set the reel mode to 'split by video content'."));
 384                         return false;
 385                 }
 386         }
 387
 388         ContentList a = overlaps (film()->content(), part, position(), end());
 389         if (a.size() != 1 || a.front().get() != this) {
 390                 why_not.push_back (overlapping);
 391                 return false;
 392         }
 393
 394         return true;
 395 }
 396
 397 bool
 398 DCPContent::can_reference_video (list<string>& why_not) const
 399 {
 400         return can_reference (bind (&Content::video, _1), _("There is other video content overlapping this DCP; remove it."), why_not);
 401 }
 402
 403 bool
 404 DCPContent::can_reference_audio (list<string>& why_not) const
 405 {
 406         DCPDecoder decoder (shared_from_this(), film()->log());
 407         BOOST_FOREACH (shared_ptr<dcp::Reel> i, decoder.reels()) {
 408                 if (!i->main_sound()) {
 409                         why_not.push_back (_("The DCP does not have sound in all reels."));
 410                         return false;
 411                 }
 412         }
 413
 414         return can_reference (bind (&Content::audio, _1),   _("There is other audio content overlapping this DCP; remove it."), why_not);
 415 }
 416
 417 bool
 418 DCPContent::can_reference_subtitle (list<string>& why_not) const
 419 {
 420         DCPDecoder decoder (shared_from_this(), film()->log());
 421         BOOST_FOREACH (shared_ptr<dcp::Reel> i, decoder.reels()) {
 422                 if (!i->main_subtitle()) {
 423                         why_not.push_back (_("The DCP does not have subtitles in all reels."));
 424                         return false;
 425                 }
 426         }
 427
 428         return can_reference (bind (&Content::subtitle, _1), _("There is other subtitle content overlapping this DCP; remove it."), why_not);
 429 }