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