src/lib/film.h

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