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