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