src/lib/dcp_content.cc

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