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