src/lib/film.h

   1 /*
   2     Copyright (C) 2012-2020 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 /** @file  src/film.h
  22  *  @brief A representation of some audio and video content, and details of
  23  *  how they should be presented in a DCP.
  24  */
  25
  26 #ifndef DCPOMATIC_FILM_H
  27 #define DCPOMATIC_FILM_H
  28
  29 #include "util.h"
  30 #include "types.h"
  31 #include "isdcf_metadata.h"
  32 #include "frame_rate_change.h"
  33 #include "signaller.h"
  34 #include "dcp_text_track.h"
  35 #include <dcp/language_tag.h>
  36 #include <dcp/key.h>
  37 #include <dcp/encrypted_kdm.h>
  38 #include <boost/signals2.hpp>
  39 #include <boost/thread.hpp>
  40 #include <boost/filesystem.hpp>
  41 #include <boost/thread/mutex.hpp>
  42 #include <string>
  43 #include <vector>
  44 #include <inttypes.h>
  45
  46 namespace xmlpp {
  47         class Document;
  48 }
  49
  50 namespace dcpomatic {
  51         class Screen;
  52 }
  53
  54 class DCPContentType;
  55 class Log;
  56 class Content;
  57 class Playlist;
  58 class AudioContent;
  59 class AudioProcessor;
  60 class Ratio;
  61 class Job;
  62 class Film;
  63 struct isdcf_name_test;
  64 struct recover_test_2d_encrypted;
  65 struct atmos_encrypted_passthrough_test;
  66
  67 class InfoFileHandle
  68 {
  69 public:
  70         InfoFileHandle (boost::mutex& mutex, boost::filesystem::path file, bool read);
  71         ~InfoFileHandle ();
  72
  73         FILE* get () const {
  74                 return _handle;
  75         }
  76
  77         boost::filesystem::path file () const {
  78                 return _file;
  79         }
  80
  81 private:
  82         friend class Film;
  83
  84         boost::mutex::scoped_lock _lock;
  85         FILE* _handle;
  86         boost::filesystem::path _file;
  87 };
  88
  89 /** @class Film
  90  *
  91  *  @brief A representation of some audio, video, subtitle and closed-caption content,
  92  *  and details of how they should be presented in a DCP.
  93  *
  94  *  The content of a Film is held in a Playlist (created and managed by the Film).
  95  */
  96 class Film : public std::enable_shared_from_this<Film>, public Signaller, public boost::noncopyable
  97 {
  98 public:
  99         explicit Film (boost::optional<boost::filesystem::path> dir);
 100         ~Film ();
 101
 102         std::shared_ptr<InfoFileHandle> info_file_handle (dcpomatic::DCPTimePeriod period, bool read) const;
 103         boost::filesystem::path j2c_path (int, Frame, Eyes, bool) const;
 104         boost::filesystem::path internal_video_asset_dir () const;
 105         boost::filesystem::path internal_video_asset_filename (dcpomatic::DCPTimePeriod p) const;
 106
 107         boost::filesystem::path audio_analysis_path (std::shared_ptr<const Playlist>) const;
 108         boost::filesystem::path subtitle_analysis_path (std::shared_ptr<const Content>) const;
 109
 110         void send_dcp_to_tms ();
 111         void make_dcp (bool gui = false, bool check = true);
 112
 113         /** @return Logger.
 114          *  It is safe to call this from any thread.
 115          */
 116         std::shared_ptr<Log> log () const {
 117                 return _log;
 118         }
 119
 120         boost::filesystem::path file (boost::filesystem::path f) const;
 121         boost::filesystem::path dir (boost::filesystem::path d, bool create = true) const;
 122
 123         void use_template (std::string name);
 124         std::list<std::string> read_metadata (boost::optional<boost::filesystem::path> path = boost::optional<boost::filesystem::path> ());
 125         void write_metadata () const;
 126         void write_metadata (boost::filesystem::path path) const;
 127         void write_template (boost::filesystem::path path) const;
 128         std::shared_ptr<xmlpp::Document> metadata (bool with_content_paths = true) const;
 129
 130         void copy_from (std::shared_ptr<const Film> film);
 131
 132         std::string isdcf_name (bool if_created_now) const;
 133         std::string dcp_name (bool if_created_now = false) const;
 134
 135         /** @return true if our state has changed since we last saved it */
 136         bool dirty () const {
 137                 return _dirty;
 138         }
 139
 140         dcp::Size full_frame () const;
 141         dcp::Size frame_size () const;
 142         dcp::Size active_area () const;
 143
 144         std::vector<CPLSummary> cpls () const;
 145
 146         int audio_frame_rate () const;
 147
 148         std::list<DCPTextTrack> closed_caption_tracks () const;
 149
 150         uint64_t required_disk_space () const;
 151         bool should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const;
 152
 153         /* Proxies for some Playlist methods */
 154
 155         ContentList content () const;
 156         dcpomatic::DCPTime length () const;
 157         int best_video_frame_rate () const;
 158         FrameRateChange active_frame_rate_change (dcpomatic::DCPTime) const;
 159         std::pair<double, double> speed_up_range (int dcp_frame_rate) const;
 160
 161         dcp::EncryptedKDM make_kdm (
 162                 dcp::Certificate recipient,
 163                 std::vector<std::string> trusted_devices,
 164                 boost::filesystem::path cpl_file,
 165                 dcp::LocalTime from,
 166                 dcp::LocalTime until,
 167                 dcp::Formulation formulation,
 168                 bool disable_forensic_marking_picture,
 169                 boost::optional<int> disable_forensic_marking_audio
 170                 ) const;
 171
 172         int state_version () const {
 173                 return _state_version;
 174         }
 175
 176         std::vector<NamedChannel> audio_output_names () const;
 177
 178         void repeat_content (ContentList, int);
 179
 180         std::shared_ptr<const Playlist> playlist () const {
 181                 return _playlist;
 182         }
 183
 184         std::list<dcpomatic::DCPTimePeriod> reels () const;
 185         std::list<int> mapped_audio_channels () const;
 186
 187         std::string content_summary (dcpomatic::DCPTimePeriod period) const;
 188
 189         bool references_dcp_video () const;
 190         bool references_dcp_audio () const;
 191         bool contains_atmos_content () const;
 192
 193         void set_tolerant (bool t) {
 194                 _tolerant = t;
 195         }
 196
 197         bool tolerant () const {
 198                 return _tolerant;
 199         }
 200
 201         /** Identifiers for the parts of our state;
 202             used for signalling changes.
 203         */
 204         enum Property {
 205                 NONE,
 206                 NAME,
 207                 USE_ISDCF_NAME,
 208                 /** The playlist's content list has changed (i.e. content has been added or removed) */
 209                 CONTENT,
 210                 /** The order of content in the playlist has changed */
 211                 CONTENT_ORDER,
 212                 DCP_CONTENT_TYPE,
 213                 CONTAINER,
 214                 RESOLUTION,
 215                 ENCRYPTED,
 216                 J2K_BANDWIDTH,
 217                 ISDCF_METADATA,
 218                 VIDEO_FRAME_RATE,
 219                 AUDIO_CHANNELS,
 220                 /** The setting of _three_d has changed */
 221                 THREE_D,
 222                 SEQUENCE,
 223                 INTEROP,
 224                 AUDIO_PROCESSOR,
 225                 REEL_TYPE,
 226                 REEL_LENGTH,
 227                 REENCODE_J2K,
 228                 MARKERS,
 229                 RATINGS,
 230                 CONTENT_VERSIONS,
 231                 NAME_LANGUAGE,
 232                 AUDIO_LANGUAGE,
 233                 RELEASE_TERRITORY,
 234                 VERSION_NUMBER,
 235                 STATUS,
 236                 CHAIN,
 237                 DISTRIBUTOR,
 238                 FACILITY,
 239                 LUMINANCE,
 240                 SUBTITLE_LANGUAGES
 241         };
 242
 243
 244         /* GET */
 245
 246         boost::optional<boost::filesystem::path> directory () const {
 247                 return _directory;
 248         }
 249
 250         std::string name () const {
 251                 return _name;
 252         }
 253
 254         bool use_isdcf_name () const {
 255                 return _use_isdcf_name;
 256         }
 257
 258         DCPContentType const * dcp_content_type () const {
 259                 return _dcp_content_type;
 260         }
 261
 262         Ratio const * container () const {
 263                 return _container;
 264         }
 265
 266         Resolution resolution () const {
 267                 return _resolution;
 268         }
 269
 270         bool encrypted () const {
 271                 return _encrypted;
 272         }
 273
 274         dcp::Key key () const {
 275                 return _key;
 276         }
 277
 278         int j2k_bandwidth () const {
 279                 return _j2k_bandwidth;
 280         }
 281
 282         ISDCFMetadata isdcf_metadata () const {
 283                 return _isdcf_metadata;
 284         }
 285
 286         /** @return The frame rate of the DCP */
 287         int video_frame_rate () const {
 288                 return _video_frame_rate;
 289         }
 290
 291         int audio_channels () const {
 292                 return _audio_channels;
 293         }
 294
 295         bool three_d () const {
 296                 return _three_d;
 297         }
 298
 299         bool sequence () const {
 300                 return _sequence;
 301         }
 302
 303         bool interop () const {
 304                 return _interop;
 305         }
 306
 307         AudioProcessor const * audio_processor () const {
 308                 return _audio_processor;
 309         }
 310
 311         ReelType reel_type () const {
 312                 return _reel_type;
 313         }
 314
 315         int64_t reel_length () const {
 316                 return _reel_length;
 317         }
 318
 319         std::string context_id () const {
 320                 return _context_id;
 321         }
 322
 323         bool reencode_j2k () const {
 324                 return _reencode_j2k;
 325         }
 326
 327         typedef std::map<dcp::Marker, dcpomatic::DCPTime> Markers;
 328
 329         boost::optional<dcpomatic::DCPTime> marker (dcp::Marker type) const;
 330         Markers markers () const {
 331                 return _markers;
 332         }
 333
 334         std::vector<dcp::Rating> ratings () const {
 335                 return _ratings;
 336         }
 337
 338         std::vector<std::string> content_versions () const {
 339                 return _content_versions;
 340         }
 341
 342         dcp::LanguageTag name_language () const {
 343                 return _name_language;
 344         }
 345
 346         dcp::LanguageTag audio_language () const {
 347                 return _audio_language;
 348         }
 349
 350         dcp::LanguageTag::RegionSubtag release_territory () const {
 351                 return _release_territory;
 352         }
 353
 354         int version_number () const {
 355                 return _version_number;
 356         }
 357
 358         dcp::Status status () const {
 359                 return _status;
 360         }
 361
 362         std::string chain () const {
 363                 return _chain;
 364         }
 365
 366         std::string distributor () const {
 367                 return _distributor;
 368         }
 369
 370         std::string facility () const {
 371                 return _facility;
 372         }
 373
 374         dcp::Luminance luminance () const {
 375                 return _luminance;
 376         }
 377
 378         std::vector<dcp::LanguageTag> subtitle_languages () const {
 379                 return _subtitle_languages;
 380         }
 381
 382         /* SET */
 383
 384         void set_directory (boost::filesystem::path);
 385         void set_name (std::string);
 386         void set_use_isdcf_name (bool);
 387         void examine_and_add_content (std::shared_ptr<Content> content, bool disable_audio_analysis = false);
 388         void add_content (std::shared_ptr<Content>);
 389         void remove_content (std::shared_ptr<Content>);
 390         void remove_content (ContentList);
 391         void move_content_earlier (std::shared_ptr<Content>);
 392         void move_content_later (std::shared_ptr<Content>);
 393         void set_dcp_content_type (DCPContentType const *);
 394         void set_container (Ratio const *, bool user_explicit = true);
 395         void set_resolution (Resolution, bool user_explicit = true);
 396         void set_encrypted (bool);
 397         void set_j2k_bandwidth (int);
 398         void set_isdcf_metadata (ISDCFMetadata);
 399         void set_video_frame_rate (int rate, bool user_explicit = false);
 400         void set_audio_channels (int);
 401         void set_three_d (bool);
 402         void set_isdcf_date_today ();
 403         void set_sequence (bool);
 404         void set_interop (bool);
 405         void set_audio_processor (AudioProcessor const * processor);
 406         void set_reel_type (ReelType);
 407         void set_reel_length (int64_t);
 408         void set_reencode_j2k (bool);
 409         void set_marker (dcp::Marker type, dcpomatic::DCPTime time);
 410         void unset_marker (dcp::Marker type);
 411         void clear_markers ();
 412         void set_ratings (std::vector<dcp::Rating> r);
 413         void set_content_versions (std::vector<std::string> v);
 414         void set_name_language (dcp::LanguageTag lang);
 415         void set_audio_language (dcp::LanguageTag lang);
 416         void set_release_territory (dcp::LanguageTag::RegionSubtag region);
 417         void set_version_number (int v);
 418         void set_status (dcp::Status s);
 419         void set_chain (std::string c);
 420         void set_facility (std::string f);
 421         void set_distributor (std::string d);
 422         void set_luminance (dcp::Luminance l);
 423         void set_subtitle_language (dcp::LanguageTag language);
 424         void unset_subtitle_language ();
 425         void set_subtitle_languages (std::vector<dcp::LanguageTag> languages);
 426
 427         void add_ffoc_lfoc (Markers& markers) const;
 428
 429         /** Emitted when some property has of the Film is about to change or has changed */
 430         mutable boost::signals2::signal<void (ChangeType, Property)> Change;
 431
 432         /** Emitted when some property of our content has changed */
 433         mutable boost::signals2::signal<void (ChangeType, std::weak_ptr<Content>, int, bool)> ContentChange;
 434
 435         /** Emitted when the film's length might have changed; this is not like a normal
 436             property as its value is derived from the playlist, so it has its own signal.
 437         */
 438         mutable boost::signals2::signal<void ()> LengthChange;
 439
 440         /** Emitted when we have something important to tell the user */
 441         boost::signals2::signal<void (std::string)> Message;
 442
 443         /** Current version number of the state file */
 444         static int const current_state_version;
 445
 446 private:
 447
 448         friend struct ::isdcf_name_test;
 449         friend struct ::recover_test_2d_encrypted;
 450         friend struct ::atmos_encrypted_passthrough_test;
 451         template <typename> friend class ChangeSignaller;
 452
 453         boost::filesystem::path info_file (dcpomatic::DCPTimePeriod p) const;
 454
 455         void signal_change (ChangeType, Property);
 456         void signal_change (ChangeType, int);
 457         std::string video_identifier () const;
 458         void playlist_change (ChangeType);
 459         void playlist_order_changed ();
 460         void playlist_content_change (ChangeType type, std::weak_ptr<Content>, int, bool frequent);
 461         void playlist_length_change ();
 462         void maybe_add_content (std::weak_ptr<Job>, std::weak_ptr<Content>, bool disable_audio_analysis);
 463         void audio_analysis_finished ();
 464         void check_settings_consistency ();
 465         void maybe_set_container_and_resolution ();
 466
 467         static std::string const metadata_file;
 468
 469         /** Log to write to */
 470         std::shared_ptr<Log> _log;
 471         std::shared_ptr<Playlist> _playlist;
 472
 473         /** Complete path to directory containing the film metadata;
 474          *  must not be relative.
 475          */
 476         boost::optional<boost::filesystem::path> _directory;
 477
 478         /** Name for DCP-o-matic */
 479         std::string _name;
 480         /** True if a auto-generated ISDCF-compliant name should be used for our DCP */
 481         bool _use_isdcf_name;
 482         /** The type of content that this Film represents (feature, trailer etc.) */
 483         DCPContentType const * _dcp_content_type;
 484         /** The container to put this Film in (flat, scope, etc.) */
 485         Ratio const * _container;
 486         /** DCP resolution (2K or 4K) */
 487         Resolution _resolution;
 488         bool _encrypted;
 489         dcp::Key _key;
 490         /** context ID used when encrypting picture assets; we keep it so that we can
 491          *  re-start picture MXF encodes.
 492          */
 493         std::string _context_id;
 494         /** bandwidth for J2K files in bits per second */
 495         int _j2k_bandwidth;
 496         /** ISDCF naming stuff */
 497         ISDCFMetadata _isdcf_metadata;
 498         /** Frames per second to run our DCP at */
 499         int _video_frame_rate;
 500         /** The date that we should use in a ISDCF name */
 501         boost::gregorian::date _isdcf_date;
 502         /** Number of audio channels requested for the DCP */
 503         int _audio_channels;
 504         /** If true, the DCP will be written in 3D mode; otherwise in 2D.
 505             This will be regardless of what content is on the playlist.
 506         */
 507         bool _three_d;
 508         bool _sequence;
 509         bool _interop;
 510         AudioProcessor const * _audio_processor;
 511         ReelType _reel_type;
 512         /** Desired reel length in bytes, if _reel_type == REELTYPE_BY_LENGTH */
 513         int64_t _reel_length;
 514         bool _reencode_j2k;
 515         /** true if the user has ever explicitly set the video frame rate of this film */
 516         bool _user_explicit_video_frame_rate;
 517         bool _user_explicit_container;
 518         bool _user_explicit_resolution;
 519         std::map<dcp::Marker, dcpomatic::DCPTime> _markers;
 520         std::vector<dcp::Rating> _ratings;
 521         std::vector<std::string> _content_versions;
 522         dcp::LanguageTag _name_language;
 523         dcp::LanguageTag _audio_language;
 524         dcp::LanguageTag::RegionSubtag _release_territory;
 525         int _version_number;
 526         dcp::Status _status;
 527         std::string _chain;
 528         std::string _distributor;
 529         std::string _facility;
 530         dcp::Luminance _luminance;
 531         std::vector<dcp::LanguageTag> _subtitle_languages;
 532
 533         int _state_version;
 534
 535         /** true if our state has changed since we last saved it */
 536         mutable bool _dirty;
 537         /** film being used as a template, or 0 */
 538         std::shared_ptr<Film> _template_film;
 539
 540         /** Be tolerant of errors in content (currently applies to DCP only).
 541             Not saved as state.
 542         */
 543         bool _tolerant;
 544
 545         mutable boost::mutex _info_file_mutex;
 546
 547         boost::signals2::scoped_connection _playlist_change_connection;
 548         boost::signals2::scoped_connection _playlist_order_changed_connection;
 549         boost::signals2::scoped_connection _playlist_content_change_connection;
 550         boost::signals2::scoped_connection _playlist_length_change_connection;
 551         std::list<boost::signals2::connection> _job_connections;
 552         std::list<boost::signals2::connection> _audio_analysis_connections;
 553
 554         friend struct paths_test;
 555         friend struct film_metadata_test;
 556 };
 557
 558 #endif