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