src/lib/film.h

   1 /*
   2     Copyright (C) 2012-2015 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                 dcp::LocalTime from,
 136                 dcp::LocalTime 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         /** Identifiers for the parts of our state;
 158             used for signalling changes.
 159         */
 160         enum Property {
 161                 NONE,
 162                 NAME,
 163                 USE_ISDCF_NAME,
 164                 /** The playlist's content list has changed (i.e. content has been added or removed) */
 165                 CONTENT,
 166                 /** The order of content in the playlist has changed */
 167                 CONTENT_ORDER,
 168                 DCP_CONTENT_TYPE,
 169                 CONTAINER,
 170                 RESOLUTION,
 171                 SIGNED,
 172                 ENCRYPTED,
 173                 KEY,
 174                 J2K_BANDWIDTH,
 175                 ISDCF_METADATA,
 176                 VIDEO_FRAME_RATE,
 177                 AUDIO_CHANNELS,
 178                 /** The setting of _three_d has changed */
 179                 THREE_D,
 180                 SEQUENCE_VIDEO,
 181                 INTEROP,
 182                 AUDIO_PROCESSOR,
 183                 REEL_TYPE,
 184                 REEL_LENGTH
 185         };
 186
 187
 188         /* GET */
 189
 190         boost::filesystem::path directory () const {
 191                 return _directory;
 192         }
 193
 194         std::string name () const {
 195                 return _name;
 196         }
 197
 198         bool use_isdcf_name () const {
 199                 return _use_isdcf_name;
 200         }
 201
 202         DCPContentType const * dcp_content_type () const {
 203                 return _dcp_content_type;
 204         }
 205
 206         Ratio const * container () const {
 207                 return _container;
 208         }
 209
 210         Resolution resolution () const {
 211                 return _resolution;
 212         }
 213
 214         /* signed is a reserved word */
 215         bool is_signed () const {
 216                 return _signed;
 217         }
 218
 219         bool encrypted () const {
 220                 return _encrypted;
 221         }
 222
 223         dcp::Key key () const {
 224                 return _key;
 225         }
 226
 227         int j2k_bandwidth () const {
 228                 return _j2k_bandwidth;
 229         }
 230
 231         ISDCFMetadata isdcf_metadata () const {
 232                 return _isdcf_metadata;
 233         }
 234
 235         /** @return The frame rate of the DCP */
 236         int video_frame_rate () const {
 237                 return _video_frame_rate;
 238         }
 239
 240         int audio_channels () const {
 241                 return _audio_channels;
 242         }
 243
 244         bool three_d () const {
 245                 return _three_d;
 246         }
 247
 248         bool sequence_video () const {
 249                 return _sequence_video;
 250         }
 251
 252         bool interop () const {
 253                 return _interop;
 254         }
 255
 256         AudioProcessor const * audio_processor () const {
 257                 return _audio_processor;
 258         }
 259
 260         ReelType reel_type () const {
 261                 return _reel_type;
 262         }
 263
 264         int64_t reel_length () const {
 265                 return _reel_length;
 266         }
 267
 268         /* SET */
 269
 270         void set_directory (boost::filesystem::path);
 271         void set_name (std::string);
 272         void set_use_isdcf_name (bool);
 273         void examine_content (boost::shared_ptr<Content>);
 274         void examine_and_add_content (boost::shared_ptr<Content>);
 275         void add_content (boost::shared_ptr<Content>);
 276         void remove_content (boost::shared_ptr<Content>);
 277         void remove_content (ContentList);
 278         void move_content_earlier (boost::shared_ptr<Content>);
 279         void move_content_later (boost::shared_ptr<Content>);
 280         void set_dcp_content_type (DCPContentType const *);
 281         void set_container (Ratio const *);
 282         void set_resolution (Resolution);
 283         void set_signed (bool);
 284         void set_encrypted (bool);
 285         void set_key (dcp::Key key);
 286         void set_j2k_bandwidth (int);
 287         void set_isdcf_metadata (ISDCFMetadata);
 288         void set_video_frame_rate (int);
 289         void set_audio_channels (int);
 290         void set_three_d (bool);
 291         void set_isdcf_date_today ();
 292         void set_sequence_video (bool);
 293         void set_interop (bool);
 294         void set_audio_processor (AudioProcessor const * processor);
 295         void set_reel_type (ReelType);
 296         void set_reel_length (int64_t);
 297
 298         /** Emitted when some property has of the Film has changed */
 299         mutable boost::signals2::signal<void (Property)> Changed;
 300
 301         /** Emitted when some property of our content has changed */
 302         mutable boost::signals2::signal<void (boost::weak_ptr<Content>, int, bool)> ContentChanged;
 303
 304         /** Current version number of the state file */
 305         static int const current_state_version;
 306
 307 private:
 308
 309         friend struct ::isdcf_name_test;
 310
 311         void signal_changed (Property);
 312         std::string video_identifier () const;
 313         void playlist_changed ();
 314         void playlist_order_changed ();
 315         void playlist_content_changed (boost::weak_ptr<Content>, int, bool frequent);
 316         void maybe_add_content (boost::weak_ptr<Job>, boost::weak_ptr<Content>);
 317         void audio_analysis_finished ();
 318
 319         /** Log to write to */
 320         boost::shared_ptr<Log> _log;
 321         boost::shared_ptr<Playlist> _playlist;
 322
 323         /** Complete path to directory containing the film metadata;
 324          *  must not be relative.
 325          */
 326         boost::filesystem::path _directory;
 327
 328         /** Name for DCP-o-matic */
 329         std::string _name;
 330         /** True if a auto-generated ISDCF-compliant name should be used for our DCP */
 331         bool _use_isdcf_name;
 332         /** The type of content that this Film represents (feature, trailer etc.) */
 333         DCPContentType const * _dcp_content_type;
 334         /** The container to put this Film in (flat, scope, etc.) */
 335         Ratio const * _container;
 336         /** DCP resolution (2K or 4K) */
 337         Resolution _resolution;
 338         bool _signed;
 339         bool _encrypted;
 340         dcp::Key _key;
 341         /** bandwidth for J2K files in bits per second */
 342         int _j2k_bandwidth;
 343         /** ISDCF naming stuff */
 344         ISDCFMetadata _isdcf_metadata;
 345         /** Frames per second to run our DCP at */
 346         int _video_frame_rate;
 347         /** The date that we should use in a ISDCF name */
 348         boost::gregorian::date _isdcf_date;
 349         /** Number of audio channels requested for the DCP */
 350         int _audio_channels;
 351         /** If true, the DCP will be written in 3D mode; otherwise in 2D.
 352             This will be regardless of what content is on the playlist.
 353         */
 354         bool _three_d;
 355         bool _sequence_video;
 356         bool _interop;
 357         AudioProcessor const * _audio_processor;
 358         ReelType _reel_type;
 359         /** Desired reel length in bytes, if _reel_type == REELTYPE_BY_LENGTH */
 360         int64_t _reel_length;
 361
 362         int _state_version;
 363
 364         /** true if our state has changed since we last saved it */
 365         mutable bool _dirty;
 366
 367         boost::signals2::scoped_connection _playlist_changed_connection;
 368         boost::signals2::scoped_connection _playlist_order_changed_connection;
 369         boost::signals2::scoped_connection _playlist_content_changed_connection;
 370         std::list<boost::signals2::connection> _job_connections;
 371         std::list<boost::signals2::connection> _audio_analysis_connections;
 372
 373         friend struct paths_test;
 374         friend struct film_metadata_test;
 375 };
 376
 377 #endif