src/lib/film.h

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