src/lib/film.h

   1 /*
   2     Copyright (C) 2012-2021 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 "change_signaller.h"
  30 #include "dcp_text_track.h"
  31 #include "frame_rate_change.h"
  32 #include "signaller.h"
  33 #include "types.h"
  34 #include "util.h"
  35 #include <dcp/encrypted_kdm.h>
  36 #include <dcp/key.h>
  37 #include <dcp/language_tag.h>
  38 #include <boost/filesystem.hpp>
  39 #include <boost/signals2.hpp>
  40 #include <boost/thread.hpp>
  41 #include <boost/thread/mutex.hpp>
  42 #include <inttypes.h>
  43 #include <string>
  44 #include <vector>
  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
  97 {
  98 public:
  99         explicit Film (boost::optional<boost::filesystem::path> dir);
 100         ~Film ();
 101
 102         Film (Film const&) = delete;
 103         Film& operator= (Film const&) = delete;
 104
 105         std::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 (std::shared_ptr<const Playlist>) const;
 111         boost::filesystem::path subtitle_analysis_path (std::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         std::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         std::shared_ptr<xmlpp::Document> metadata (bool with_content_paths = true) const;
 132
 133         void copy_from (std::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::vector<NamedChannel> audio_output_names () const;
 180
 181         void repeat_content (ContentList, int);
 182
 183         std::shared_ptr<const Playlist> playlist () const {
 184                 return _playlist;
 185         }
 186
 187         std::list<dcpomatic::DCPTimePeriod> reels () const;
 188         std::list<int> mapped_audio_channels () const;
 189         std::vector<dcp::LanguageTag> audio_languages () const;
 190         std::pair<boost::optional<dcp::LanguageTag>, std::vector<dcp::LanguageTag>> subtitle_languages () 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 class 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                 VIDEO_FRAME_RATE,
 223                 AUDIO_CHANNELS,
 224                 /** The setting of _three_d has changed */
 225                 THREE_D,
 226                 SEQUENCE,
 227                 INTEROP,
 228                 AUDIO_PROCESSOR,
 229                 REEL_TYPE,
 230                 REEL_LENGTH,
 231                 REENCODE_J2K,
 232                 MARKERS,
 233                 RATINGS,
 234                 CONTENT_VERSIONS,
 235                 NAME_LANGUAGE,
 236                 AUDIO_LANGUAGE,
 237                 RELEASE_TERRITORY,
 238                 VERSION_NUMBER,
 239                 STATUS,
 240                 CHAIN,
 241                 DISTRIBUTOR,
 242                 FACILITY,
 243                 STUDIO,
 244                 TEMP_VERSION,
 245                 PRE_RELEASE,
 246                 RED_BAND,
 247                 TWO_D_VERSION_OF_THREE_D,
 248                 LUMINANCE,
 249         };
 250
 251
 252         /* GET */
 253
 254         boost::optional<boost::filesystem::path> directory () const {
 255                 return _directory;
 256         }
 257
 258         std::string name () const {
 259                 return _name;
 260         }
 261
 262         bool use_isdcf_name () const {
 263                 return _use_isdcf_name;
 264         }
 265
 266         DCPContentType const * dcp_content_type () const {
 267                 return _dcp_content_type;
 268         }
 269
 270         Ratio const * container () const {
 271                 return _container;
 272         }
 273
 274         Resolution resolution () const {
 275                 return _resolution;
 276         }
 277
 278         bool encrypted () const {
 279                 return _encrypted;
 280         }
 281
 282         dcp::Key key () const {
 283                 return _key;
 284         }
 285
 286         int j2k_bandwidth () const {
 287                 return _j2k_bandwidth;
 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         typedef std::map<dcp::Marker, dcpomatic::DCPTime> Markers;
 332
 333         boost::optional<dcpomatic::DCPTime> marker (dcp::Marker type) const;
 334         Markers markers () const {
 335                 return _markers;
 336         }
 337
 338         std::vector<dcp::Rating> ratings () const {
 339                 return _ratings;
 340         }
 341
 342         std::vector<std::string> content_versions () const {
 343                 return _content_versions;
 344         }
 345
 346         dcp::LanguageTag name_language () const {
 347                 return _name_language;
 348         }
 349
 350         boost::optional<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         boost::optional<std::string> chain () const {
 363                 return _chain;
 364         }
 365
 366         boost::optional<std::string> distributor () const {
 367                 return _distributor;
 368         }
 369
 370         boost::optional<std::string> facility () const {
 371                 return _facility;
 372         }
 373
 374         boost::optional<std::string> studio () const {
 375                 return _studio;
 376         }
 377
 378         bool temp_version () const {
 379                 return _temp_version;
 380         }
 381
 382         bool pre_release () const {
 383                 return _pre_release;
 384         }
 385
 386         bool red_band () const {
 387                 return _red_band;
 388         }
 389
 390         bool two_d_version_of_three_d () const {
 391                 return _two_d_version_of_three_d;
 392         }
 393
 394         boost::optional<dcp::Luminance> luminance () const {
 395                 return _luminance;
 396         }
 397
 398         /* SET */
 399
 400         void set_directory (boost::filesystem::path);
 401         void set_name (std::string);
 402         void set_use_isdcf_name (bool);
 403         void examine_and_add_content (std::shared_ptr<Content> content, bool disable_audio_analysis = false);
 404         void add_content (std::shared_ptr<Content>);
 405         void remove_content (std::shared_ptr<Content>);
 406         void remove_content (ContentList);
 407         void move_content_earlier (std::shared_ptr<Content>);
 408         void move_content_later (std::shared_ptr<Content>);
 409         void set_dcp_content_type (DCPContentType const *);
 410         void set_container (Ratio const *, bool user_explicit = true);
 411         void set_resolution (Resolution, bool user_explicit = true);
 412         void set_encrypted (bool);
 413         void set_j2k_bandwidth (int);
 414         void set_video_frame_rate (int rate, bool user_explicit = false);
 415         void set_audio_channels (int);
 416         void set_three_d (bool);
 417         void set_isdcf_date_today ();
 418         void set_sequence (bool);
 419         void set_interop (bool);
 420         void set_audio_processor (AudioProcessor const * processor);
 421         void set_reel_type (ReelType);
 422         void set_reel_length (int64_t);
 423         void set_reencode_j2k (bool);
 424         void set_marker (dcp::Marker type, dcpomatic::DCPTime time);
 425         void unset_marker (dcp::Marker type);
 426         void clear_markers ();
 427         void set_ratings (std::vector<dcp::Rating> r);
 428         void set_content_versions (std::vector<std::string> v);
 429         void set_name_language (dcp::LanguageTag lang);
 430         void set_release_territory (boost::optional<dcp::LanguageTag::RegionSubtag> region = boost::none);
 431         void set_version_number (int v);
 432         void set_status (dcp::Status s);
 433         void set_chain (boost::optional<std::string> c = boost::none);
 434         void set_facility (boost::optional<std::string> f = boost::none);
 435         void set_studio (boost::optional<std::string> s = boost::none);
 436         void set_temp_version (bool t);
 437         void set_pre_release (bool p);
 438         void set_red_band (bool r);
 439         void set_two_d_version_of_three_d (bool t);
 440         void set_distributor (boost::optional<std::string> d = boost::none);
 441         void set_luminance (boost::optional<dcp::Luminance> l = boost::none);
 442
 443         void add_ffoc_lfoc (Markers& markers) const;
 444
 445         /** Emitted when some property has of the Film is about to change or has changed */
 446         mutable boost::signals2::signal<void (ChangeType, Property)> Change;
 447
 448         /** Emitted when some property of our content has changed */
 449         mutable boost::signals2::signal<void (ChangeType, std::weak_ptr<Content>, int, bool)> ContentChange;
 450
 451         /** Emitted when the film's length might have changed; this is not like a normal
 452             property as its value is derived from the playlist, so it has its own signal.
 453         */
 454         mutable boost::signals2::signal<void ()> LengthChange;
 455
 456         /** Emitted when we have something important to tell the user */
 457         boost::signals2::signal<void (std::string)> Message;
 458
 459         /** Current version number of the state file */
 460         static int const current_state_version;
 461
 462 private:
 463
 464         friend struct ::isdcf_name_test;
 465         friend struct ::recover_test_2d_encrypted;
 466         friend struct ::atmos_encrypted_passthrough_test;
 467         template <class, class> friend class ChangeSignaller;
 468
 469         boost::filesystem::path info_file (dcpomatic::DCPTimePeriod p) const;
 470
 471         void signal_change (ChangeType, Property);
 472         void signal_change (ChangeType, int);
 473         std::string video_identifier () const;
 474         void playlist_change (ChangeType);
 475         void playlist_order_changed ();
 476         void playlist_content_change (ChangeType type, std::weak_ptr<Content>, int, bool frequent);
 477         void playlist_length_change ();
 478         void maybe_add_content (std::weak_ptr<Job>, std::weak_ptr<Content>, bool disable_audio_analysis);
 479         void audio_analysis_finished ();
 480         void check_settings_consistency ();
 481         void maybe_set_container_and_resolution ();
 482
 483         static std::string const metadata_file;
 484
 485         /** Log to write to */
 486         std::shared_ptr<Log> _log;
 487         std::shared_ptr<Playlist> _playlist;
 488
 489         /** Complete path to directory containing the film metadata;
 490          *  must not be relative.
 491          */
 492         boost::optional<boost::filesystem::path> _directory;
 493
 494         /** Name for DCP-o-matic */
 495         std::string _name;
 496         /** True if a auto-generated ISDCF-compliant name should be used for our DCP */
 497         bool _use_isdcf_name;
 498         /** The type of content that this Film represents (feature, trailer etc.) */
 499         DCPContentType const * _dcp_content_type;
 500         /** The container to put this Film in (flat, scope, etc.) */
 501         Ratio const * _container;
 502         /** DCP resolution (2K or 4K) */
 503         Resolution _resolution;
 504         bool _encrypted;
 505         dcp::Key _key;
 506         /** context ID used when encrypting picture assets; we keep it so that we can
 507          *  re-start picture MXF encodes.
 508          */
 509         std::string _context_id;
 510         /** bandwidth for J2K files in bits per second */
 511         int _j2k_bandwidth;
 512         /** Frames per second to run our DCP at */
 513         int _video_frame_rate;
 514         /** The date that we should use in a ISDCF name */
 515         boost::gregorian::date _isdcf_date;
 516         /** Number of audio channels requested for the DCP */
 517         int _audio_channels;
 518         /** If true, the DCP will be written in 3D mode; otherwise in 2D.
 519             This will be regardless of what content is on the playlist.
 520         */
 521         bool _three_d;
 522         bool _sequence;
 523         bool _interop;
 524         AudioProcessor const * _audio_processor;
 525         ReelType _reel_type;
 526         /** Desired reel length in bytes, if _reel_type == REELTYPE_BY_LENGTH */
 527         int64_t _reel_length;
 528         bool _reencode_j2k;
 529         /** true if the user has ever explicitly set the video frame rate of this film */
 530         bool _user_explicit_video_frame_rate;
 531         bool _user_explicit_container;
 532         bool _user_explicit_resolution;
 533         std::map<dcp::Marker, dcpomatic::DCPTime> _markers;
 534         std::vector<dcp::Rating> _ratings;
 535         std::vector<std::string> _content_versions;
 536         dcp::LanguageTag _name_language;
 537         boost::optional<dcp::LanguageTag::RegionSubtag> _release_territory;
 538         int _version_number;
 539         dcp::Status _status;
 540         boost::optional<std::string> _chain;
 541         boost::optional<std::string> _distributor;
 542         boost::optional<std::string> _facility;
 543         boost::optional<std::string> _studio;
 544         bool _temp_version = false;
 545         bool _pre_release = false;
 546         bool _red_band = false;
 547         bool _two_d_version_of_three_d = false;
 548         boost::optional<dcp::Luminance> _luminance;
 549
 550         int _state_version;
 551
 552         /** true if our state has changed since we last saved it */
 553         mutable bool _dirty;
 554         /** film being used as a template, or 0 */
 555         std::shared_ptr<Film> _template_film;
 556
 557         /** Be tolerant of errors in content (currently applies to DCP only).
 558             Not saved as state.
 559         */
 560         bool _tolerant;
 561
 562         mutable boost::mutex _info_file_mutex;
 563
 564         boost::signals2::scoped_connection _playlist_change_connection;
 565         boost::signals2::scoped_connection _playlist_order_changed_connection;
 566         boost::signals2::scoped_connection _playlist_content_change_connection;
 567         boost::signals2::scoped_connection _playlist_length_change_connection;
 568         std::list<boost::signals2::connection> _job_connections;
 569         std::list<boost::signals2::connection> _audio_analysis_connections;
 570
 571         friend struct paths_test;
 572         friend struct film_metadata_test;
 573 };
 574
 575
 576 typedef ChangeSignaller<Film, Film::Property> FilmChangeSignaller;
 577
 578
 579 #endif