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