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