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