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<std::string> 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         std::vector<std::string> audio_output_names () const;
 159
 160         void repeat_content (ContentList, int);
 161
 162         boost::shared_ptr<const Playlist> playlist () const {
 163                 return _playlist;
 164         }
 165
 166         std::list<DCPTimePeriod> reels () const;
 167         std::list<int> mapped_audio_channels () const;
 168
 169         std::string content_summary (DCPTimePeriod period) const;
 170
 171         bool references_dcp_video () const;
 172         bool references_dcp_audio () const;
 173
 174         /** Identifiers for the parts of our state;
 175             used for signalling changes.
 176         */
 177         enum Property {
 178                 NONE,
 179                 NAME,
 180                 USE_ISDCF_NAME,
 181                 /** The playlist's content list has changed (i.e. content has been added or removed) */
 182                 CONTENT,
 183                 /** The order of content in the playlist has changed */
 184                 CONTENT_ORDER,
 185                 DCP_CONTENT_TYPE,
 186                 CONTAINER,
 187                 RESOLUTION,
 188                 SIGNED,
 189                 ENCRYPTED,
 190                 KEY,
 191                 J2K_BANDWIDTH,
 192                 ISDCF_METADATA,
 193                 VIDEO_FRAME_RATE,
 194                 AUDIO_CHANNELS,
 195                 /** The setting of _three_d has changed */
 196                 THREE_D,
 197                 SEQUENCE,
 198                 INTEROP,
 199                 AUDIO_PROCESSOR,
 200                 REEL_TYPE,
 201                 REEL_LENGTH,
 202                 UPLOAD_AFTER_MAKE_DCP,
 203                 REENCODE_J2K
 204         };
 205
 206
 207         /* GET */
 208
 209         boost::optional<boost::filesystem::path> directory () const {
 210                 return _directory;
 211         }
 212
 213         std::string name () const {
 214                 return _name;
 215         }
 216
 217         bool use_isdcf_name () const {
 218                 return _use_isdcf_name;
 219         }
 220
 221         DCPContentType const * dcp_content_type () const {
 222                 return _dcp_content_type;
 223         }
 224
 225         Ratio const * container () const {
 226                 return _container;
 227         }
 228
 229         Resolution resolution () const {
 230                 return _resolution;
 231         }
 232
 233         /* signed is a reserved word */
 234         bool is_signed () const {
 235                 return _signed;
 236         }
 237
 238         bool encrypted () const {
 239                 return _encrypted;
 240         }
 241
 242         dcp::Key key () const {
 243                 return _key;
 244         }
 245
 246         int j2k_bandwidth () const {
 247                 return _j2k_bandwidth;
 248         }
 249
 250         ISDCFMetadata isdcf_metadata () const {
 251                 return _isdcf_metadata;
 252         }
 253
 254         /** @return The frame rate of the DCP */
 255         int video_frame_rate () const {
 256                 return _video_frame_rate;
 257         }
 258
 259         int audio_channels () const {
 260                 return _audio_channels;
 261         }
 262
 263         bool three_d () const {
 264                 return _three_d;
 265         }
 266
 267         bool sequence () const {
 268                 return _sequence;
 269         }
 270
 271         bool interop () const {
 272                 return _interop;
 273         }
 274
 275         AudioProcessor const * audio_processor () const {
 276                 return _audio_processor;
 277         }
 278
 279         ReelType reel_type () const {
 280                 return _reel_type;
 281         }
 282
 283         int64_t reel_length () const {
 284                 return _reel_length;
 285         }
 286
 287         bool upload_after_make_dcp () const {
 288                 return _upload_after_make_dcp;
 289         }
 290
 291         std::string context_id () const {
 292                 return _context_id;
 293         }
 294
 295         bool reencode_j2k () const {
 296                 return _reencode_j2k;
 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         void set_reencode_j2k (bool);
 330
 331         /** Emitted when some property has of the Film is about to change or has changed */
 332         mutable boost::signals2::signal<void (ChangeType, Property)> Change;
 333
 334         /** Emitted when some property of our content has changed */
 335         mutable boost::signals2::signal<void (ChangeType, boost::weak_ptr<Content>, int, bool)> ContentChange;
 336
 337         /** Current version number of the state file */
 338         static int const current_state_version;
 339
 340 private:
 341
 342         friend struct ::isdcf_name_test;
 343         template <typename> friend class ChangeSignaller;
 344
 345         void signal_change (ChangeType, Property);
 346         void signal_change (ChangeType, int);
 347         std::string video_identifier () const;
 348         void playlist_change (ChangeType);
 349         void playlist_order_changed ();
 350         void playlist_content_change (ChangeType type, boost::weak_ptr<Content>, int, bool frequent);
 351         void maybe_add_content (boost::weak_ptr<Job>, boost::weak_ptr<Content>, bool disable_audio_analysis);
 352         void audio_analysis_finished ();
 353
 354         static std::string const metadata_file;
 355
 356         /** Log to write to */
 357         boost::shared_ptr<Log> _log;
 358         boost::shared_ptr<Playlist> _playlist;
 359
 360         /** Complete path to directory containing the film metadata;
 361          *  must not be relative.
 362          */
 363         boost::optional<boost::filesystem::path> _directory;
 364
 365         /** Name for DCP-o-matic */
 366         std::string _name;
 367         /** True if a auto-generated ISDCF-compliant name should be used for our DCP */
 368         bool _use_isdcf_name;
 369         /** The type of content that this Film represents (feature, trailer etc.) */
 370         DCPContentType const * _dcp_content_type;
 371         /** The container to put this Film in (flat, scope, etc.) */
 372         Ratio const * _container;
 373         /** DCP resolution (2K or 4K) */
 374         Resolution _resolution;
 375         bool _signed;
 376         bool _encrypted;
 377         dcp::Key _key;
 378         /** context ID used when encrypting picture assets; we keep it so that we can
 379          *  re-start picture MXF encodes.
 380          */
 381         std::string _context_id;
 382         /** bandwidth for J2K files in bits per second */
 383         int _j2k_bandwidth;
 384         /** ISDCF naming stuff */
 385         ISDCFMetadata _isdcf_metadata;
 386         /** Frames per second to run our DCP at */
 387         int _video_frame_rate;
 388         /** The date that we should use in a ISDCF name */
 389         boost::gregorian::date _isdcf_date;
 390         /** Number of audio channels requested for the DCP */
 391         int _audio_channels;
 392         /** If true, the DCP will be written in 3D mode; otherwise in 2D.
 393             This will be regardless of what content is on the playlist.
 394         */
 395         bool _three_d;
 396         bool _sequence;
 397         bool _interop;
 398         AudioProcessor const * _audio_processor;
 399         ReelType _reel_type;
 400         /** Desired reel length in bytes, if _reel_type == REELTYPE_BY_LENGTH */
 401         int64_t _reel_length;
 402         bool _upload_after_make_dcp;
 403         bool _reencode_j2k;
 404
 405         int _state_version;
 406
 407         /** true if our state has changed since we last saved it */
 408         mutable bool _dirty;
 409         /** film being used as a template, or 0 */
 410         boost::shared_ptr<Film> _template_film;
 411
 412         boost::signals2::scoped_connection _playlist_change_connection;
 413         boost::signals2::scoped_connection _playlist_order_changed_connection;
 414         boost::signals2::scoped_connection _playlist_content_change_connection;
 415         std::list<boost::signals2::connection> _job_connections;
 416         std::list<boost::signals2::connection> _audio_analysis_connections;
 417
 418         friend struct paths_test;
 419         friend struct film_metadata_test;
 420 };
 421
 422 #endif