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 "ratio.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 class DCPContentType;
  43 class Log;
  44 class Content;
  45 class Player;
  46 class Playlist;
  47 class AudioContent;
  48 class Scaler;
  49 class Screen;
  50 struct isdcf_name_test;
  51
  52 /** @class Film
  53  *
  54  *  @brief A representation of some audio and video content, and details of
  55  *  how they should be presented in a DCP.
  56  *
  57  *  The content of a Film is held in a Playlist (created and managed by the Film).
  58  */
  59 class Film : public boost::enable_shared_from_this<Film>, public boost::noncopyable
  60 {
  61 public:
  62         Film (boost::filesystem::path, bool log = true);
  63         ~Film ();
  64
  65         boost::filesystem::path info_dir () const;
  66         boost::filesystem::path j2c_path (int, Eyes, bool) const;
  67         boost::filesystem::path info_path (int, Eyes) const;
  68         boost::filesystem::path internal_video_mxf_dir () const;
  69         boost::filesystem::path internal_video_mxf_filename () const;
  70         boost::filesystem::path audio_analysis_dir () const;
  71
  72         boost::filesystem::path video_mxf_filename () const;
  73         boost::filesystem::path audio_mxf_filename () const;
  74         boost::filesystem::path subtitle_xml_filename () const;
  75
  76         void send_dcp_to_tms ();
  77         void make_dcp ();
  78
  79         /** @return Logger.
  80          *  It is safe to call this from any thread.
  81          */
  82         boost::shared_ptr<Log> log () const {
  83                 return _log;
  84         }
  85
  86         int encoded_frames () const;
  87
  88         boost::filesystem::path file (boost::filesystem::path f) const;
  89         boost::filesystem::path dir (boost::filesystem::path d) const;
  90
  91         std::list<std::string> read_metadata ();
  92         void write_metadata () const;
  93         boost::shared_ptr<xmlpp::Document> metadata () const;
  94
  95         std::string isdcf_name (bool if_created_now) const;
  96         std::string dcp_name (bool if_created_now = false) const;
  97
  98         /** @return true if our state has changed since we last saved it */
  99         bool dirty () const {
 100                 return _dirty;
 101         }
 102
 103         dcp::Size full_frame () const;
 104         dcp::Size frame_size () const;
 105
 106         std::vector<CPLSummary> cpls () const;
 107
 108         boost::shared_ptr<Player> make_player () const;
 109         boost::shared_ptr<Playlist> playlist () const;
 110
 111         int audio_frame_rate () const;
 112
 113         uint64_t required_disk_space () const;
 114         bool should_be_enough_disk_space (double &, double &) const;
 115
 116         /* Proxies for some Playlist methods */
 117
 118         ContentList content () const;
 119         DCPTime length () const;
 120         int best_video_frame_rate () const;
 121         FrameRateChange active_frame_rate_change (DCPTime) const;
 122
 123         dcp::EncryptedKDM
 124         make_kdm (
 125                 dcp::Certificate target,
 126                 boost::filesystem::path cpl_file,
 127                 dcp::LocalTime from,
 128                 dcp::LocalTime until,
 129                 dcp::Formulation formulation
 130                 ) const;
 131
 132         std::list<dcp::EncryptedKDM> 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         dcp::Key key () const {
 141                 return _key;
 142         }
 143
 144         int state_version () const {
 145                 return _state_version;
 146         }
 147
 148         std::string subtitle_language () const;
 149
 150         /** Identifiers for the parts of our state;
 151             used for signalling changes.
 152         */
 153         enum Property {
 154                 NONE,
 155                 NAME,
 156                 USE_ISDCF_NAME,
 157                 /** The playlist's content list has changed (i.e. content has been added or removed) */
 158                 CONTENT,
 159                 DCP_CONTENT_TYPE,
 160                 CONTAINER,
 161                 RESOLUTION,
 162                 SCALER,
 163                 SIGNED,
 164                 ENCRYPTED,
 165                 J2K_BANDWIDTH,
 166                 ISDCF_METADATA,
 167                 VIDEO_FRAME_RATE,
 168                 AUDIO_CHANNELS,
 169                 /** The setting of _three_d has changed */
 170                 THREE_D,
 171                 SEQUENCE_VIDEO,
 172                 INTEROP,
 173                 /** The setting of _burn_subtitles has changed */
 174                 BURN_SUBTITLES,
 175         };
 176
 177
 178         /* GET */
 179
 180         boost::filesystem::path directory () const {
 181                 return _directory;
 182         }
 183
 184         std::string name () const {
 185                 return _name;
 186         }
 187
 188         bool use_isdcf_name () const {
 189                 return _use_isdcf_name;
 190         }
 191
 192         DCPContentType const * dcp_content_type () const {
 193                 return _dcp_content_type;
 194         }
 195
 196         Ratio const * container () const {
 197                 return _container;
 198         }
 199
 200         Resolution resolution () const {
 201                 return _resolution;
 202         }
 203
 204         Scaler const * scaler () const {
 205                 return _scaler;
 206         }
 207
 208         /* signed is a reserved word */
 209         bool is_signed () const {
 210                 return _signed;
 211         }
 212
 213         bool encrypted () const {
 214                 return _encrypted;
 215         }
 216
 217         int j2k_bandwidth () const {
 218                 return _j2k_bandwidth;
 219         }
 220
 221         ISDCFMetadata isdcf_metadata () const {
 222                 return _isdcf_metadata;
 223         }
 224
 225         /** @return The frame rate of the DCP */
 226         int video_frame_rate () const {
 227                 return _video_frame_rate;
 228         }
 229
 230         int audio_channels () const {
 231                 return _audio_channels;
 232         }
 233
 234         bool three_d () const {
 235                 return _three_d;
 236         }
 237
 238         bool sequence_video () const {
 239                 return _sequence_video;
 240         }
 241
 242         bool interop () const {
 243                 return _interop;
 244         }
 245
 246         bool burn_subtitles () const {
 247                 return _burn_subtitles;
 248         }
 249
 250
 251         /* SET */
 252
 253         void set_directory (boost::filesystem::path);
 254         void set_name (std::string);
 255         void set_use_isdcf_name (bool);
 256         void examine_content (boost::shared_ptr<Content>);
 257         void examine_and_add_content (boost::shared_ptr<Content>);
 258         void add_content (boost::shared_ptr<Content>);
 259         void remove_content (boost::shared_ptr<Content>);
 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_scaler (Scaler const *);
 266         void set_signed (bool);
 267         void set_encrypted (bool);
 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
 278         /** Emitted when some property has of the Film has changed */
 279         mutable boost::signals2::signal<void (Property)> Changed;
 280
 281         /** Emitted when some property of our content has changed */
 282         mutable boost::signals2::signal<void (boost::weak_ptr<Content>, int)> ContentChanged;
 283
 284         /** Current version number of the state file */
 285         static int const current_state_version;
 286
 287 private:
 288
 289         friend struct ::isdcf_name_test;
 290
 291         void signal_changed (Property);
 292         std::string video_identifier () const;
 293         void playlist_changed ();
 294         void playlist_content_changed (boost::weak_ptr<Content>, int);
 295         std::string filename_safe_name () const;
 296         void maybe_add_content (boost::weak_ptr<Job>, boost::weak_ptr<Content>);
 297
 298         /** Log to write to */
 299         boost::shared_ptr<Log> _log;
 300         boost::shared_ptr<Playlist> _playlist;
 301
 302         /** Complete path to directory containing the film metadata;
 303          *  must not be relative.
 304          */
 305         boost::filesystem::path _directory;
 306
 307         /** Name for DCP-o-matic */
 308         std::string _name;
 309         /** True if a auto-generated ISDCF-compliant name should be used for our DCP */
 310         bool _use_isdcf_name;
 311         /** The type of content that this Film represents (feature, trailer etc.) */
 312         DCPContentType const * _dcp_content_type;
 313         /** The container to put this Film in (flat, scope, etc.) */
 314         Ratio const * _container;
 315         /** DCP resolution (2K or 4K) */
 316         Resolution _resolution;
 317         /** Scaler algorithm to use */
 318         Scaler const * _scaler;
 319         bool _signed;
 320         bool _encrypted;
 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 to put in 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         dcp::Key _key;
 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