src/lib/film.h

   1 /*
   2     Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 /** @file  src/film.h
  21  *  @brief A representation of some audio and video content, and details of
  22  *  how they should be presented in a DCP.
  23  */
  24
  25 #ifndef DCPOMATIC_FILM_H
  26 #define DCPOMATIC_FILM_H
  27
  28 #include "util.h"
  29 #include "types.h"
  30 #include "isdcf_metadata.h"
  31 #include "frame_rate_change.h"
  32 #include "signaller.h"
  33 #include <dcp/key.h>
  34 #include <dcp/encrypted_kdm.h>
  35 #include <boost/signals2.hpp>
  36 #include <boost/enable_shared_from_this.hpp>
  37 #include <boost/filesystem.hpp>
  38 #include <string>
  39 #include <vector>
  40 #include <inttypes.h>
  41
  42 namespace xmlpp {
  43         class Document;
  44 }
  45
  46 class DCPContentType;
  47 class Log;
  48 class Content;
  49 class Player;
  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::filesystem::path, bool log = true);
  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) const;
  92
  93         std::list<std::string> read_metadata ();
  94         void write_metadata () const;
  95         boost::shared_ptr<xmlpp::Document> metadata () const;
  96
  97         std::string isdcf_name (bool if_created_now) const;
  98         std::string dcp_name (bool if_created_now = false) const;
  99
 100         /** @return true if our state has changed since we last saved it */
 101         bool dirty () const {
 102                 return _dirty;
 103         }
 104
 105         dcp::Size full_frame () const;
 106         dcp::Size frame_size () const;
 107
 108         std::vector<CPLSummary> cpls () const;
 109
 110         int audio_frame_rate () const;
 111
 112         uint64_t required_disk_space () const;
 113         bool should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const;
 114
 115         /* Proxies for some Playlist methods */
 116
 117         ContentList content () const;
 118         DCPTime length () const;
 119         int best_video_frame_rate () const;
 120         FrameRateChange active_frame_rate_change (DCPTime) const;
 121
 122         dcp::EncryptedKDM
 123         make_kdm (
 124                 dcp::Certificate recipient,
 125                 std::vector<dcp::Certificate> trusted_devices,
 126                 boost::filesystem::path cpl_file,
 127                 dcp::LocalTime from,
 128                 dcp::LocalTime until,
 129                 dcp::Formulation formulation
 130                 ) const;
 131
 132         std::list<ScreenKDM> make_kdms (
 133                 std::list<boost::shared_ptr<Screen> >,
 134                 boost::filesystem::path cpl_file,
 135                 boost::posix_time::ptime from,
 136                 boost::posix_time::ptime until,
 137                 dcp::Formulation formulation
 138                 ) const;
 139
 140         int state_version () const {
 141                 return _state_version;
 142         }
 143
 144         std::string subtitle_language () const;
 145
 146         void make_audio_mapping_default (AudioMapping & mapping) const;
 147         std::vector<std::string> audio_output_names () const;
 148
 149         void repeat_content (ContentList, int);
 150
 151         boost::shared_ptr<const Playlist> playlist () const {
 152                 return _playlist;
 153         }
 154
 155         std::list<DCPTimePeriod> reels () const;
 156
 157         std::list<int> mapped_audio_channels () const;
 158
 159         /** Identifiers for the parts of our state;
 160             used for signalling changes.
 161         */
 162         enum Property {
 163                 NONE,
 164                 NAME,
 165                 USE_ISDCF_NAME,
 166                 /** The playlist's content list has changed (i.e. content has been added or removed) */
 167                 CONTENT,
 168                 /** The order of content in the playlist has changed */
 169                 CONTENT_ORDER,
 170                 DCP_CONTENT_TYPE,
 171                 CONTAINER,
 172                 RESOLUTION,
 173                 SIGNED,
 174                 ENCRYPTED,
 175                 KEY,
 176                 J2K_BANDWIDTH,
 177                 ISDCF_METADATA,
 178                 VIDEO_FRAME_RATE,
 179                 AUDIO_CHANNELS,
 180                 /** The setting of _three_d has changed */
 181                 THREE_D,
 182                 SEQUENCE,
 183                 INTEROP,
 184                 AUDIO_PROCESSOR,
 185                 REEL_TYPE,
 186                 REEL_LENGTH,
 187                 UPLOAD_AFTER_MAKE_DCP
 188         };
 189
 190
 191         /* GET */
 192
 193         boost::filesystem::path directory () const {
 194                 return _directory;
 195         }
 196
 197         std::string name () const {
 198                 return _name;
 199         }
 200
 201         bool use_isdcf_name () const {
 202                 return _use_isdcf_name;
 203         }
 204
 205         DCPContentType const * dcp_content_type () const {
 206                 return _dcp_content_type;
 207         }
 208
 209         Ratio const * container () const {
 210                 return _container;
 211         }
 212
 213         Resolution resolution () const {
 214                 return _resolution;
 215         }
 216
 217         /* signed is a reserved word */
 218         bool is_signed () const {
 219                 return _signed;
 220         }
 221
 222         bool encrypted () const {
 223                 return _encrypted;
 224         }
 225
 226         dcp::Key key () const {
 227                 return _key;
 228         }
 229
 230         int j2k_bandwidth () const {
 231                 return _j2k_bandwidth;
 232         }
 233
 234         ISDCFMetadata isdcf_metadata () const {
 235                 return _isdcf_metadata;
 236         }
 237
 238         /** @return The frame rate of the DCP */
 239         int video_frame_rate () const {
 240                 return _video_frame_rate;
 241         }
 242
 243         int audio_channels () const {
 244                 return _audio_channels;
 245         }
 246
 247         bool three_d () const {
 248                 return _three_d;
 249         }
 250
 251         bool sequence () const {
 252                 return _sequence;
 253         }
 254
 255         bool interop () const {
 256                 return _interop;
 257         }
 258
 259         AudioProcessor const * audio_processor () const {
 260                 return _audio_processor;
 261         }
 262
 263         ReelType reel_type () const {
 264                 return _reel_type;
 265         }
 266
 267         int64_t reel_length () const {
 268                 return _reel_length;
 269         }
 270
 271         bool upload_after_make_dcp () const {
 272                 return _upload_after_make_dcp;
 273         }
 274
 275         /* SET */
 276
 277         void set_directory (boost::filesystem::path);
 278         void set_name (std::string);
 279         void set_use_isdcf_name (bool);
 280         void examine_content (boost::shared_ptr<Content>);
 281         void examine_and_add_content (boost::shared_ptr<Content>);
 282         void add_content (boost::shared_ptr<Content>);
 283         void remove_content (boost::shared_ptr<Content>);
 284         void remove_content (ContentList);
 285         void move_content_earlier (boost::shared_ptr<Content>);
 286         void move_content_later (boost::shared_ptr<Content>);
 287         void set_dcp_content_type (DCPContentType const *);
 288         void set_container (Ratio const *);
 289         void set_resolution (Resolution);
 290         void set_signed (bool);
 291         void set_encrypted (bool);
 292         void set_key (dcp::Key key);
 293         void set_j2k_bandwidth (int);
 294         void set_isdcf_metadata (ISDCFMetadata);
 295         void set_video_frame_rate (int);
 296         void set_audio_channels (int);
 297         void set_three_d (bool);
 298         void set_isdcf_date_today ();
 299         void set_sequence (bool);
 300         void set_interop (bool);
 301         void set_audio_processor (AudioProcessor const * processor);
 302         void set_reel_type (ReelType);
 303         void set_reel_length (int64_t);
 304         void set_upload_after_make_dcp (bool);
 305
 306         /** Emitted when some property has of the Film has changed */
 307         mutable boost::signals2::signal<void (Property)> Changed;
 308
 309         /** Emitted when some property of our content has changed */
 310         mutable boost::signals2::signal<void (boost::weak_ptr<Content>, int, bool)> ContentChanged;
 311
 312         /** Current version number of the state file */
 313         static int const current_state_version;
 314
 315 private:
 316
 317         friend struct ::isdcf_name_test;
 318
 319         void signal_changed (Property);
 320         std::string video_identifier () const;
 321         void playlist_changed ();
 322         void playlist_order_changed ();
 323         void playlist_content_changed (boost::weak_ptr<Content>, int, bool frequent);
 324         void maybe_add_content (boost::weak_ptr<Job>, boost::weak_ptr<Content>);
 325         void audio_analysis_finished ();
 326
 327         /** Log to write to */
 328         boost::shared_ptr<Log> _log;
 329         boost::shared_ptr<Playlist> _playlist;
 330
 331         /** Complete path to directory containing the film metadata;
 332          *  must not be relative.
 333          */
 334         boost::filesystem::path _directory;
 335
 336         /** Name for DCP-o-matic */
 337         std::string _name;
 338         /** True if a auto-generated ISDCF-compliant name should be used for our DCP */
 339         bool _use_isdcf_name;
 340         /** The type of content that this Film represents (feature, trailer etc.) */
 341         DCPContentType const * _dcp_content_type;
 342         /** The container to put this Film in (flat, scope, etc.) */
 343         Ratio const * _container;
 344         /** DCP resolution (2K or 4K) */
 345         Resolution _resolution;
 346         bool _signed;
 347         bool _encrypted;
 348         dcp::Key _key;
 349         /** bandwidth for J2K files in bits per second */
 350         int _j2k_bandwidth;
 351         /** ISDCF naming stuff */
 352         ISDCFMetadata _isdcf_metadata;
 353         /** Frames per second to run our DCP at */
 354         int _video_frame_rate;
 355         /** The date that we should use in a ISDCF name */
 356         boost::gregorian::date _isdcf_date;
 357         /** Number of audio channels requested for the DCP */
 358         int _audio_channels;
 359         /** If true, the DCP will be written in 3D mode; otherwise in 2D.
 360             This will be regardless of what content is on the playlist.
 361         */
 362         bool _three_d;
 363         bool _sequence;
 364         bool _interop;
 365         AudioProcessor const * _audio_processor;
 366         ReelType _reel_type;
 367         /** Desired reel length in bytes, if _reel_type == REELTYPE_BY_LENGTH */
 368         int64_t _reel_length;
 369         bool _upload_after_make_dcp;
 370
 371         int _state_version;
 372
 373         /** true if our state has changed since we last saved it */
 374         mutable bool _dirty;
 375
 376         boost::signals2::scoped_connection _playlist_changed_connection;
 377         boost::signals2::scoped_connection _playlist_order_changed_connection;
 378         boost::signals2::scoped_connection _playlist_content_changed_connection;
 379         std::list<boost::signals2::connection> _job_connections;
 380         std::list<boost::signals2::connection> _audio_analysis_connections;
 381
 382         friend struct paths_test;
 383         friend struct film_metadata_test;
 384 };
 385
 386 #endif