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