src/lib/film.h

   1 /*
   2     Copyright (C) 2012-2020 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 /** @file  src/film.h
  22  *  @brief A representation of some audio and video content, and details of
  23  *  how they should be presented in a DCP.
  24  */
  25
  26 #ifndef DCPOMATIC_FILM_H
  27 #define DCPOMATIC_FILM_H
  28
  29 #include "util.h"
  30 #include "types.h"
  31 #include "isdcf_metadata.h"
  32 #include "frame_rate_change.h"
  33 #include "signaller.h"
  34 #include "dcp_text_track.h"
  35 #include <dcp/key.h>
  36 #include <dcp/encrypted_kdm.h>
  37 #include <boost/signals2.hpp>
  38 #include <boost/enable_shared_from_this.hpp>
  39 #include <boost/thread.hpp>
  40 #include <boost/filesystem.hpp>
  41 #include <boost/thread/mutex.hpp>
  42 #include <string>
  43 #include <vector>
  44 #include <inttypes.h>
  45
  46 namespace xmlpp {
  47         class Document;
  48 }
  49
  50 namespace dcpomatic {
  51         class Screen;
  52 }
  53
  54 class DCPContentType;
  55 class Log;
  56 class Content;
  57 class Playlist;
  58 class AudioContent;
  59 class AudioProcessor;
  60 class Ratio;
  61 class Job;
  62 class Film;
  63 struct isdcf_name_test;
  64
  65 class InfoFileHandle
  66 {
  67 public:
  68         ~InfoFileHandle ();
  69
  70         FILE* get () const {
  71                 return _handle;
  72         }
  73
  74         boost::filesystem::path file () const {
  75                 return _file;
  76         }
  77
  78 private:
  79         friend class Film;
  80
  81         InfoFileHandle (boost::mutex& mutex, boost::filesystem::path file, bool read);
  82
  83         boost::mutex::scoped_lock _lock;
  84         FILE* _handle;
  85         boost::filesystem::path _file;
  86 };
  87
  88 /** @class Film
  89  *
  90  *  @brief A representation of some audio, video, subtitle and closed-caption content,
  91  *  and details of how they should be presented in a DCP.
  92  *
  93  *  The content of a Film is held in a Playlist (created and managed by the Film).
  94  */
  95 class Film : public boost::enable_shared_from_this<Film>, public Signaller, public boost::noncopyable
  96 {
  97 public:
  98         explicit Film (boost::optional<boost::filesystem::path> dir);
  99         ~Film ();
 100
 101         boost::shared_ptr<InfoFileHandle> info_file_handle (dcpomatic::DCPTimePeriod period, bool read) const;
 102         boost::filesystem::path j2c_path (int, Frame, Eyes, bool) const;
 103         boost::filesystem::path internal_video_asset_dir () const;
 104         boost::filesystem::path internal_video_asset_filename (dcpomatic::DCPTimePeriod p) const;
 105
 106         boost::filesystem::path audio_analysis_path (boost::shared_ptr<const Playlist>) const;
 107         boost::filesystem::path subtitle_analysis_path (boost::shared_ptr<const Content>) const;
 108
 109         void send_dcp_to_tms ();
 110         void make_dcp (bool gui = false, bool check = true);
 111
 112         /** @return Logger.
 113          *  It is safe to call this from any thread.
 114          */
 115         boost::shared_ptr<Log> log () const {
 116                 return _log;
 117         }
 118
 119         boost::filesystem::path file (boost::filesystem::path f) const;
 120         boost::filesystem::path dir (boost::filesystem::path d, bool create = true) const;
 121
 122         void use_template (std::string name);
 123         std::list<std::string> read_metadata (boost::optional<boost::filesystem::path> path = boost::optional<boost::filesystem::path> ());
 124         void write_metadata () const;
 125         void write_metadata (boost::filesystem::path path) const;
 126         void write_template (boost::filesystem::path path) const;
 127         boost::shared_ptr<xmlpp::Document> metadata (bool with_content_paths = true) const;
 128
 129         void copy_from (boost::shared_ptr<const Film> film);
 130
 131         std::string isdcf_name (bool if_created_now) const;
 132         std::string dcp_name (bool if_created_now = false) const;
 133
 134         /** @return true if our state has changed since we last saved it */
 135         bool dirty () const {
 136                 return _dirty;
 137         }
 138
 139         dcp::Size full_frame () const;
 140         dcp::Size frame_size () const;
 141
 142         std::vector<CPLSummary> cpls () const;
 143
 144         int audio_frame_rate () const;
 145
 146         std::list<DCPTextTrack> closed_caption_tracks () const;
 147
 148         uint64_t required_disk_space () const;
 149         bool should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const;
 150
 151         /* Proxies for some Playlist methods */
 152
 153         ContentList content () const;
 154         dcpomatic::DCPTime length () const;
 155         int best_video_frame_rate () const;
 156         FrameRateChange active_frame_rate_change (dcpomatic::DCPTime) const;
 157         std::pair<double, double> speed_up_range (int dcp_frame_rate) const;
 158
 159         dcp::EncryptedKDM make_kdm (
 160                 dcp::Certificate recipient,
 161                 std::vector<std::string> trusted_devices,
 162                 boost::filesystem::path cpl_file,
 163                 dcp::LocalTime from,
 164                 dcp::LocalTime until,
 165                 dcp::Formulation formulation,
 166                 bool disable_forensic_marking_picture,
 167                 boost::optional<int> disable_forensic_marking_audio
 168                 ) const;
 169
 170         int state_version () const {
 171                 return _state_version;
 172         }
 173
 174         std::string subtitle_language () const;
 175
 176         std::vector<std::string> audio_output_names () const;
 177
 178         void repeat_content (ContentList, int);
 179
 180         boost::shared_ptr<const Playlist> playlist () const {
 181                 return _playlist;
 182         }
 183
 184         std::list<dcpomatic::DCPTimePeriod> reels () const;
 185         std::list<int> mapped_audio_channels () const;
 186
 187         std::string content_summary (dcpomatic::DCPTimePeriod period) const;
 188
 189         bool references_dcp_video () const;
 190         bool references_dcp_audio () const;
 191
 192         void set_tolerant (bool t) {
 193                 _tolerant = t;
 194         }
 195
 196         bool tolerant () const {
 197                 return _tolerant;
 198         }
 199
 200         /** Identifiers for the parts of our state;
 201             used for signalling changes.
 202         */
 203         enum Property {
 204                 NONE,
 205                 NAME,
 206                 USE_ISDCF_NAME,
 207                 /** The playlist's content list has changed (i.e. content has been added or removed) */
 208                 CONTENT,
 209                 /** The order of content in the playlist has changed */
 210                 CONTENT_ORDER,
 211                 DCP_CONTENT_TYPE,
 212                 CONTAINER,
 213                 RESOLUTION,
 214                 SIGNED,
 215                 ENCRYPTED,
 216                 KEY,
 217                 J2K_BANDWIDTH,
 218                 ISDCF_METADATA,
 219                 VIDEO_FRAME_RATE,
 220                 AUDIO_CHANNELS,
 221                 /** The setting of _three_d has changed */
 222                 THREE_D,
 223                 SEQUENCE,
 224                 INTEROP,
 225                 AUDIO_PROCESSOR,
 226                 REEL_TYPE,
 227                 REEL_LENGTH,
 228                 UPLOAD_AFTER_MAKE_DCP,
 229                 REENCODE_J2K,
 230                 MARKERS,
 231                 RATINGS,
 232                 CONTENT_VERSION
 233         };
 234
 235
 236         /* GET */
 237
 238         boost::optional<boost::filesystem::path> directory () const {
 239                 return _directory;
 240         }
 241
 242         std::string name () const {
 243                 return _name;
 244         }
 245
 246         bool use_isdcf_name () const {
 247                 return _use_isdcf_name;
 248         }
 249
 250         DCPContentType const * dcp_content_type () const {
 251                 return _dcp_content_type;
 252         }
 253
 254         Ratio const * container () const {
 255                 return _container;
 256         }
 257
 258         Resolution resolution () const {
 259                 return _resolution;
 260         }
 261
 262         /* signed is a reserved word */
 263         bool is_signed () const {
 264                 return _signed;
 265         }
 266
 267         bool encrypted () const {
 268                 return _encrypted;
 269         }
 270
 271         dcp::Key key () const {
 272                 return _key;
 273         }
 274
 275         int j2k_bandwidth () const {
 276                 return _j2k_bandwidth;
 277         }
 278
 279         ISDCFMetadata isdcf_metadata () const {
 280                 return _isdcf_metadata;
 281         }
 282
 283         /** @return The frame rate of the DCP */
 284         int video_frame_rate () const {
 285                 return _video_frame_rate;
 286         }
 287
 288         int audio_channels () const {
 289                 return _audio_channels;
 290         }
 291
 292         bool three_d () const {
 293                 return _three_d;
 294         }
 295
 296         bool sequence () const {
 297                 return _sequence;
 298         }
 299
 300         bool interop () const {
 301                 return _interop;
 302         }
 303
 304         AudioProcessor const * audio_processor () const {
 305                 return _audio_processor;
 306         }
 307
 308         ReelType reel_type () const {
 309                 return _reel_type;
 310         }
 311
 312         int64_t reel_length () const {
 313                 return _reel_length;
 314         }
 315
 316         bool upload_after_make_dcp () const {
 317                 return _upload_after_make_dcp;
 318         }
 319
 320         std::string context_id () const {
 321                 return _context_id;
 322         }
 323
 324         bool reencode_j2k () const {
 325                 return _reencode_j2k;
 326         }
 327
 328         boost::optional<dcpomatic::DCPTime> marker (dcp::Marker type) const;
 329         std::map<dcp::Marker, dcpomatic::DCPTime> markers () const {
 330                 return _markers;
 331         }
 332
 333         std::vector<dcp::Rating> ratings () const {
 334                 return _ratings;
 335         }
 336
 337         std::string content_version () const {
 338                 return _content_version;
 339         }
 340
 341         /* SET */
 342
 343         void set_directory (boost::filesystem::path);
 344         void set_name (std::string);
 345         void set_use_isdcf_name (bool);
 346         void examine_and_add_content (boost::shared_ptr<Content> content, bool disable_audio_analysis = false);
 347         void add_content (boost::shared_ptr<Content>);
 348         void remove_content (boost::shared_ptr<Content>);
 349         void remove_content (ContentList);
 350         void move_content_earlier (boost::shared_ptr<Content>);
 351         void move_content_later (boost::shared_ptr<Content>);
 352         void set_dcp_content_type (DCPContentType const *);
 353         void set_container (Ratio const *, bool user_explicit = true);
 354         void set_resolution (Resolution, bool user_explicit = true);
 355         void set_signed (bool);
 356         void set_encrypted (bool);
 357         void set_key (dcp::Key key);
 358         void set_j2k_bandwidth (int);
 359         void set_isdcf_metadata (ISDCFMetadata);
 360         void set_video_frame_rate (int rate, bool user_explicit = false);
 361         void set_audio_channels (int);
 362         void set_three_d (bool);
 363         void set_isdcf_date_today ();
 364         void set_sequence (bool);
 365         void set_interop (bool);
 366         void set_audio_processor (AudioProcessor const * processor);
 367         void set_reel_type (ReelType);
 368         void set_reel_length (int64_t);
 369         void set_upload_after_make_dcp (bool);
 370         void set_reencode_j2k (bool);
 371         void set_marker (dcp::Marker type, dcpomatic::DCPTime time);
 372         void unset_marker (dcp::Marker type);
 373         void clear_markers ();
 374         void set_ratings (std::vector<dcp::Rating> r);
 375         void set_content_version (std::string v);
 376
 377         /** Emitted when some property has of the Film is about to change or has changed */
 378         mutable boost::signals2::signal<void (ChangeType, Property)> Change;
 379
 380         /** Emitted when some property of our content has changed */
 381         mutable boost::signals2::signal<void (ChangeType, boost::weak_ptr<Content>, int, bool)> ContentChange;
 382
 383         /** Emitted when the film's length might have changed; this is not like a normal
 384             property as its value is derived from the playlist, so it has its own signal.
 385         */
 386         mutable boost::signals2::signal<void ()> LengthChange;
 387
 388         /** Emitted when we have something important to tell the user */
 389         boost::signals2::signal<void (std::string)> Message;
 390
 391         /** Current version number of the state file */
 392         static int const current_state_version;
 393
 394 private:
 395
 396         friend struct ::isdcf_name_test;
 397         template <typename> friend class ChangeSignaller;
 398
 399         boost::filesystem::path info_file (dcpomatic::DCPTimePeriod p) const;
 400
 401         void signal_change (ChangeType, Property);
 402         void signal_change (ChangeType, int);
 403         std::string video_identifier () const;
 404         void playlist_change (ChangeType);
 405         void playlist_order_changed ();
 406         void playlist_content_change (ChangeType type, boost::weak_ptr<Content>, int, bool frequent);
 407         void playlist_length_change ();
 408         void maybe_add_content (boost::weak_ptr<Job>, boost::weak_ptr<Content>, bool disable_audio_analysis);
 409         void audio_analysis_finished ();
 410         void check_settings_consistency ();
 411         void maybe_set_container_and_resolution ();
 412
 413         static std::string const metadata_file;
 414
 415         /** Log to write to */
 416         boost::shared_ptr<Log> _log;
 417         boost::shared_ptr<Playlist> _playlist;
 418
 419         /** Complete path to directory containing the film metadata;
 420          *  must not be relative.
 421          */
 422         boost::optional<boost::filesystem::path> _directory;
 423
 424         /** Name for DCP-o-matic */
 425         std::string _name;
 426         /** True if a auto-generated ISDCF-compliant name should be used for our DCP */
 427         bool _use_isdcf_name;
 428         /** The type of content that this Film represents (feature, trailer etc.) */
 429         DCPContentType const * _dcp_content_type;
 430         /** The container to put this Film in (flat, scope, etc.) */
 431         Ratio const * _container;
 432         /** DCP resolution (2K or 4K) */
 433         Resolution _resolution;
 434         bool _signed;
 435         bool _encrypted;
 436         dcp::Key _key;
 437         /** context ID used when encrypting picture assets; we keep it so that we can
 438          *  re-start picture MXF encodes.
 439          */
 440         std::string _context_id;
 441         /** bandwidth for J2K files in bits per second */
 442         int _j2k_bandwidth;
 443         /** ISDCF naming stuff */
 444         ISDCFMetadata _isdcf_metadata;
 445         /** Frames per second to run our DCP at */
 446         int _video_frame_rate;
 447         /** The date that we should use in a ISDCF name */
 448         boost::gregorian::date _isdcf_date;
 449         /** Number of audio channels requested for the DCP */
 450         int _audio_channels;
 451         /** If true, the DCP will be written in 3D mode; otherwise in 2D.
 452             This will be regardless of what content is on the playlist.
 453         */
 454         bool _three_d;
 455         bool _sequence;
 456         bool _interop;
 457         AudioProcessor const * _audio_processor;
 458         ReelType _reel_type;
 459         /** Desired reel length in bytes, if _reel_type == REELTYPE_BY_LENGTH */
 460         int64_t _reel_length;
 461         bool _upload_after_make_dcp;
 462         bool _reencode_j2k;
 463         /** true if the user has ever explicitly set the video frame rate of this film */
 464         bool _user_explicit_video_frame_rate;
 465         bool _user_explicit_container;
 466         bool _user_explicit_resolution;
 467         std::map<dcp::Marker, dcpomatic::DCPTime> _markers;
 468         std::vector<dcp::Rating> _ratings;
 469         std::string _content_version;
 470
 471         int _state_version;
 472
 473         /** true if our state has changed since we last saved it */
 474         mutable bool _dirty;
 475         /** film being used as a template, or 0 */
 476         boost::shared_ptr<Film> _template_film;
 477
 478         /** Be tolerant of errors in content (currently applies to DCP only).
 479             Not saved as state.
 480         */
 481         bool _tolerant;
 482
 483         mutable boost::mutex _info_file_mutex;
 484
 485         boost::signals2::scoped_connection _playlist_change_connection;
 486         boost::signals2::scoped_connection _playlist_order_changed_connection;
 487         boost::signals2::scoped_connection _playlist_content_change_connection;
 488         boost::signals2::scoped_connection _playlist_length_change_connection;
 489         std::list<boost::signals2::connection> _job_connections;
 490         std::list<boost::signals2::connection> _audio_analysis_connections;
 491
 492         friend struct paths_test;
 493         friend struct film_metadata_test;
 494 };
 495
 496 #endif