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