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