src/lib/film.h

   1 /*
   2     Copyright (C) 2012 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 <string>
  29 #include <vector>
  30 #include <inttypes.h>
  31 #include <boost/signals2.hpp>
  32 #include <boost/enable_shared_from_this.hpp>
  33 #include <boost/filesystem.hpp>
  34 #include <libdcp/key.h>
  35 #include <libdcp/kdm.h>
  36 #include "util.h"
  37 #include "types.h"
  38 #include "dci_metadata.h"
  39 #include "frame_rate_change.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
  50 /** @class Film
  51  *
  52  *  @brief A representation of some audio and video content, and details of
  53  *  how they should be presented in a DCP.
  54  *
  55  *  The content of a Film is held in a Playlist (created and managed by the Film).
  56  */
  57 class Film : public boost::enable_shared_from_this<Film>, public boost::noncopyable
  58 {
  59 public:
  60         Film (boost::filesystem::path, bool log = true);
  61
  62         boost::filesystem::path info_dir () const;
  63         boost::filesystem::path j2c_path (int, Eyes, bool) const;
  64         boost::filesystem::path info_path (int, Eyes) const;
  65         boost::filesystem::path internal_video_mxf_dir () const;
  66         boost::filesystem::path internal_video_mxf_filename () const;
  67         boost::filesystem::path audio_analysis_dir () const;
  68
  69         boost::filesystem::path video_mxf_filename () const;
  70         boost::filesystem::path audio_mxf_filename () const;
  71
  72         void send_dcp_to_tms ();
  73         void make_dcp ();
  74
  75         /** @return Logger.
  76          *  It is safe to call this from any thread.
  77          */
  78         boost::shared_ptr<Log> log () const {
  79                 return _log;
  80         }
  81
  82         int encoded_frames () const;
  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 dci_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         libdcp::Size full_frame () const;
 100         libdcp::Size frame_size () const;
 101
 102         std::vector<CPLSummary> cpls () const;
 103
 104         boost::shared_ptr<Player> make_player () const;
 105         boost::shared_ptr<Playlist> playlist () const;
 106
 107         OutputAudioFrame audio_frame_rate () const;
 108
 109         OutputAudioFrame time_to_audio_frames (Time) const;
 110         OutputVideoFrame time_to_video_frames (Time) const;
 111         Time video_frames_to_time (OutputVideoFrame) const;
 112         Time audio_frames_to_time (OutputAudioFrame) const;
 113
 114         uint64_t required_disk_space () const;
 115         bool should_be_enough_disk_space (double &, double &) const;
 116
 117         /* Proxies for some Playlist methods */
 118
 119         ContentList content () const;
 120         Time length () const;
 121         bool has_subtitles () const;
 122         OutputVideoFrame best_video_frame_rate () const;
 123         FrameRateChange active_frame_rate_change (Time) const;
 124
 125         libdcp::KDM
 126         make_kdm (
 127                 boost::shared_ptr<libdcp::Certificate> target,
 128                 boost::filesystem::path cpl_file,
 129                 boost::posix_time::ptime from,
 130                 boost::posix_time::ptime until
 131                 ) const;
 132
 133         std::list<libdcp::KDM> make_kdms (
 134                 std::list<boost::shared_ptr<Screen> >,
 135                 boost::filesystem::path cpl_file,
 136                 boost::posix_time::ptime from,
 137                 boost::posix_time::ptime until
 138                 ) const;
 139
 140         libdcp::Key key () const {
 141                 return _key;
 142         }
 143
 144         int state_version () const {
 145                 return _state_version;
 146         }
 147
 148         /** Identifiers for the parts of our state;
 149             used for signalling changes.
 150         */
 151         enum Property {
 152                 NONE,
 153                 NAME,
 154                 USE_DCI_NAME,
 155                 /** The playlist's content list has changed (i.e. content has been added, moved around or removed) */
 156                 CONTENT,
 157                 DCP_CONTENT_TYPE,
 158                 CONTAINER,
 159                 RESOLUTION,
 160                 SCALER,
 161                 WITH_SUBTITLES,
 162                 SIGNED,
 163                 ENCRYPTED,
 164                 J2K_BANDWIDTH,
 165                 DCI_METADATA,
 166                 VIDEO_FRAME_RATE,
 167                 AUDIO_CHANNELS,
 168                 /** The setting of _three_d has been changed */
 169                 THREE_D,
 170                 SEQUENCE_VIDEO,
 171                 INTEROP,
 172         };
 173
 174
 175         /* GET */
 176
 177         boost::filesystem::path directory () const {
 178                 return _directory;
 179         }
 180
 181         std::string name () const {
 182                 return _name;
 183         }
 184
 185         bool use_dci_name () const {
 186                 return _use_dci_name;
 187         }
 188
 189         DCPContentType const * dcp_content_type () const {
 190                 return _dcp_content_type;
 191         }
 192
 193         Ratio const * container () const {
 194                 return _container;
 195         }
 196
 197         Resolution resolution () const {
 198                 return _resolution;
 199         }
 200
 201         Scaler const * scaler () const {
 202                 return _scaler;
 203         }
 204
 205         bool with_subtitles () const {
 206                 return _with_subtitles;
 207         }
 208
 209         /* signed is a reserved word */
 210         bool is_signed () const {
 211                 return _signed;
 212         }
 213
 214         bool encrypted () const {
 215                 return _encrypted;
 216         }
 217
 218         int j2k_bandwidth () const {
 219                 return _j2k_bandwidth;
 220         }
 221
 222         DCIMetadata dci_metadata () const {
 223                 return _dci_metadata;
 224         }
 225
 226         /** @return The frame rate of the DCP */
 227         int video_frame_rate () const {
 228                 return _video_frame_rate;
 229         }
 230
 231         int audio_channels () const {
 232                 return _audio_channels;
 233         }
 234
 235         bool three_d () const {
 236                 return _three_d;
 237         }
 238
 239         bool sequence_video () const {
 240                 return _sequence_video;
 241         }
 242
 243         bool interop () const {
 244                 return _interop;
 245         }
 246
 247
 248         /* SET */
 249
 250         void set_directory (boost::filesystem::path);
 251         void set_name (std::string);
 252         void set_use_dci_name (bool);
 253         void examine_and_add_content (boost::shared_ptr<Content>);
 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_with_subtitles (bool);
 263         void set_signed (bool);
 264         void set_encrypted (bool);
 265         void set_j2k_bandwidth (int);
 266         void set_dci_metadata (DCIMetadata);
 267         void set_video_frame_rate (int);
 268         void set_audio_channels (int);
 269         void set_three_d (bool);
 270         void set_dci_date_today ();
 271         void set_sequence_video (bool);
 272         void set_interop (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         void signal_changed (Property);
 286         std::string video_identifier () const;
 287         void playlist_changed ();
 288         void playlist_content_changed (boost::weak_ptr<Content>, int);
 289         std::string filename_safe_name () const;
 290         void maybe_add_content (boost::weak_ptr<Job>, boost::weak_ptr<Content>);
 291
 292         /** Log to write to */
 293         boost::shared_ptr<Log> _log;
 294         boost::shared_ptr<Playlist> _playlist;
 295
 296         /** Complete path to directory containing the film metadata;
 297          *  must not be relative.
 298          */
 299         boost::filesystem::path _directory;
 300
 301         /** Name for DCP-o-matic */
 302         std::string _name;
 303         /** True if a auto-generated DCI-compliant name should be used for our DCP */
 304         bool _use_dci_name;
 305         /** The type of content that this Film represents (feature, trailer etc.) */
 306         DCPContentType const * _dcp_content_type;
 307         /** The container to put this Film in (flat, scope, etc.) */
 308         Ratio const * _container;
 309         /** DCP resolution (2K or 4K) */
 310         Resolution _resolution;
 311         /** Scaler algorithm to use */
 312         Scaler const * _scaler;
 313         /** True if subtitles should be shown for this film */
 314         bool _with_subtitles;
 315         bool _signed;
 316         bool _encrypted;
 317         /** bandwidth for J2K files in bits per second */
 318         int _j2k_bandwidth;
 319         /** DCI naming stuff */
 320         DCIMetadata _dci_metadata;
 321         /** Frames per second to run our DCP at */
 322         int _video_frame_rate;
 323         /** The date that we should use in a DCI name */
 324         boost::gregorian::date _dci_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         libdcp::Key _key;
 334
 335         int _state_version;
 336
 337         /** true if our state has changed since we last saved it */
 338         mutable bool _dirty;
 339
 340         friend class paths_test;
 341         friend class film_metadata_test;
 342 };
 343
 344 #endif