src/lib/film.h

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