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