src/lib/film.h

   1 /*
   2     Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 /** @file  src/film.h
  22  *  @brief A representation of some audio and video content, and details of
  23  *  how they should be presented in a DCP.
  24  */
  25
  26 #ifndef DCPOMATIC_FILM_H
  27 #define DCPOMATIC_FILM_H
  28
  29 #include "util.h"
  30 #include "types.h"
  31 #include "isdcf_metadata.h"
  32 #include "frame_rate_change.h"
  33 #include "signaller.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 namespace xmlpp {
  44         class Document;
  45 }
  46
  47 class DCPContentType;
  48 class Log;
  49 class Content;
  50 class Playlist;
  51 class AudioContent;
  52 class Screen;
  53 class AudioProcessor;
  54 class AudioMapping;
  55 class Ratio;
  56 class Job;
  57 class ScreenKDM;
  58 struct isdcf_name_test;
  59
  60 /** @class Film
  61  *
  62  *  @brief A representation of some audio and video content, and details of
  63  *  how they should be presented in a DCP.
  64  *
  65  *  The content of a Film is held in a Playlist (created and managed by the Film).
  66  */
  67 class Film : public boost::enable_shared_from_this<Film>, public Signaller, public boost::noncopyable
  68 {
  69 public:
  70         Film (boost::optional<boost::filesystem::path> dir);
  71         ~Film ();
  72
  73         boost::filesystem::path info_file (DCPTimePeriod p) const;
  74         boost::filesystem::path j2c_path (int, Frame, Eyes, bool) const;
  75         boost::filesystem::path internal_video_asset_dir () const;
  76         boost::filesystem::path internal_video_asset_filename (DCPTimePeriod p) const;
  77
  78         boost::filesystem::path audio_analysis_path (boost::shared_ptr<const Playlist>) const;
  79
  80         void send_dcp_to_tms ();
  81         void make_dcp ();
  82
  83         /** @return Logger.
  84          *  It is safe to call this from any thread.
  85          */
  86         boost::shared_ptr<Log> log () const {
  87                 return _log;
  88         }
  89
  90         boost::filesystem::path file (boost::filesystem::path f) const;
  91         boost::filesystem::path dir (boost::filesystem::path d, bool create = true) const;
  92
  93         void use_template (std::string name);
  94         std::list<std::string> read_metadata (boost::optional<boost::filesystem::path> path = boost::optional<boost::filesystem::path> ());
  95         void write_metadata () const;
  96         void write_template (boost::filesystem::path path) const;
  97         boost::shared_ptr<xmlpp::Document> metadata (bool with_content_paths = true) const;
  98
  99         std::string isdcf_name (bool if_created_now) const;
 100         std::string dcp_name (bool if_created_now = false) const;
 101
 102         /** @return true if our state has changed since we last saved it */
 103         bool dirty () const {
 104                 return _dirty;
 105         }
 106
 107         dcp::Size full_frame () const;
 108         dcp::Size frame_size () const;
 109
 110         std::vector<CPLSummary> cpls () const;
 111
 112         int audio_frame_rate () const;
 113
 114         uint64_t required_disk_space () const;
 115         bool should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const;
 116
 117         /* Proxies for some Playlist methods */
 118
 119         ContentList content () const;
 120         DCPTime length () const;
 121         int best_video_frame_rate () const;
 122         FrameRateChange active_frame_rate_change (DCPTime) const;
 123         std::pair<double, double> speed_up_range (int dcp_frame_rate) const;
 124
 125         dcp::EncryptedKDM make_kdm (
 126                 dcp::Certificate recipient,
 127                 std::vector<dcp::Certificate> trusted_devices,
 128                 boost::filesystem::path cpl_file,
 129                 dcp::LocalTime from,
 130                 dcp::LocalTime until,
 131                 dcp::Formulation formulation
 132                 ) const;
 133
 134         std::list<ScreenKDM> make_kdms (
 135                 std::list<boost::shared_ptr<Screen> > screens,
 136                 boost::filesystem::path cpl_file,
 137                 boost::posix_time::ptime from,
 138                 boost::posix_time::ptime until,
 139                 dcp::Formulation formulation
 140                 ) const;
 141
 142         int state_version () const {
 143                 return _state_version;
 144         }
 145
 146         std::string subtitle_language () const;
 147
 148         void make_audio_mapping_default (
 149                 AudioMapping & mapping,
 150                 boost::optional<boost::filesystem::path> filename = boost::optional<boost::filesystem::path> ()
 151                 ) const;
 152
 153         std::vector<std::string> audio_output_names () const;
 154
 155         void repeat_content (ContentList, int);
 156
 157         boost::shared_ptr<const Playlist> playlist () const {
 158                 return _playlist;
 159         }
 160
 161         std::list<DCPTimePeriod> reels () const;
 162         std::list<int> mapped_audio_channels () const;
 163
 164         std::string content_summary (DCPTimePeriod period) const;
 165
 166         std::list<std::string> fix_conflicting_settings ();
 167
 168         /** Identifiers for the parts of our state;
 169             used for signalling changes.
 170         */
 171         enum Property {
 172                 NONE,
 173                 NAME,
 174                 USE_ISDCF_NAME,
 175                 /** The playlist's content list has changed (i.e. content has been added or removed) */
 176                 CONTENT,
 177                 /** The order of content in the playlist has changed */
 178                 CONTENT_ORDER,
 179                 DCP_CONTENT_TYPE,
 180                 CONTAINER,
 181                 RESOLUTION,
 182                 SIGNED,
 183                 ENCRYPTED,
 184                 KEY,
 185                 J2K_BANDWIDTH,
 186                 ISDCF_METADATA,
 187                 VIDEO_FRAME_RATE,
 188                 AUDIO_CHANNELS,
 189                 /** The setting of _three_d has changed */
 190                 THREE_D,
 191                 SEQUENCE,
 192                 INTEROP,
 193                 AUDIO_PROCESSOR,
 194                 REEL_TYPE,
 195                 REEL_LENGTH,
 196                 UPLOAD_AFTER_MAKE_DCP
 197         };
 198
 199
 200         /* GET */
 201
 202         boost::optional<boost::filesystem::path> directory () const {
 203                 return _directory;
 204         }
 205
 206         std::string name () const {
 207                 return _name;
 208         }
 209
 210         bool use_isdcf_name () const {
 211                 return _use_isdcf_name;
 212         }
 213
 214         DCPContentType const * dcp_content_type () const {
 215                 return _dcp_content_type;
 216         }
 217
 218         Ratio const * container () const {
 219                 return _container;
 220         }
 221
 222         Resolution resolution () const {
 223                 return _resolution;
 224         }
 225
 226         /* signed is a reserved word */
 227         bool is_signed () const {
 228                 return _signed;
 229         }
 230
 231         bool encrypted () const {
 232                 return _encrypted;
 233         }
 234
 235         dcp::Key key () const {
 236                 return _key;
 237         }
 238
 239         int j2k_bandwidth () const {
 240                 return _j2k_bandwidth;
 241         }
 242
 243         ISDCFMetadata isdcf_metadata () const {
 244                 return _isdcf_metadata;
 245         }
 246
 247         /** @return The frame rate of the DCP */
 248         int video_frame_rate () const {
 249                 return _video_frame_rate;
 250         }
 251
 252         int audio_channels () const {
 253                 return _audio_channels;
 254         }
 255
 256         bool three_d () const {
 257                 return _three_d;
 258         }
 259
 260         bool sequence () const {
 261                 return _sequence;
 262         }
 263
 264         bool interop () const {
 265                 return _interop;
 266         }
 267
 268         AudioProcessor const * audio_processor () const {
 269                 return _audio_processor;
 270         }
 271
 272         ReelType reel_type () const {
 273                 return _reel_type;
 274         }
 275
 276         int64_t reel_length () const {
 277                 return _reel_length;
 278         }
 279
 280         bool upload_after_make_dcp () const {
 281                 return _upload_after_make_dcp;
 282         }
 283
 284         std::string context_id () const {
 285                 return _context_id;
 286         }
 287
 288
 289         /* SET */
 290
 291         void set_directory (boost::filesystem::path);
 292         void set_name (std::string);
 293         void set_use_isdcf_name (bool);
 294         void examine_and_add_content (boost::shared_ptr<Content>);
 295         void add_content (boost::shared_ptr<Content>);
 296         void remove_content (boost::shared_ptr<Content>);
 297         void remove_content (ContentList);
 298         void move_content_earlier (boost::shared_ptr<Content>);
 299         void move_content_later (boost::shared_ptr<Content>);
 300         void set_dcp_content_type (DCPContentType const *);
 301         void set_container (Ratio const *);
 302         void set_resolution (Resolution);
 303         void set_signed (bool);
 304         void set_encrypted (bool);
 305         void set_key (dcp::Key key);
 306         void set_j2k_bandwidth (int);
 307         void set_isdcf_metadata (ISDCFMetadata);
 308         void set_video_frame_rate (int);
 309         void set_audio_channels (int);
 310         void set_three_d (bool);
 311         void set_isdcf_date_today ();
 312         void set_sequence (bool);
 313         void set_interop (bool);
 314         void set_audio_processor (AudioProcessor const * processor);
 315         void set_reel_type (ReelType);
 316         void set_reel_length (int64_t);
 317         void set_upload_after_make_dcp (bool);
 318
 319         /** Emitted when some property has of the Film has changed */
 320         mutable boost::signals2::signal<void (Property)> Changed;
 321
 322         /** Emitted when some property of our content has changed */
 323         mutable boost::signals2::signal<void (boost::weak_ptr<Content>, int, bool)> ContentChanged;
 324
 325         /** Current version number of the state file */
 326         static int const current_state_version;
 327
 328 private:
 329
 330         friend struct ::isdcf_name_test;
 331
 332         void signal_changed (Property);
 333         std::string video_identifier () const;
 334         void playlist_changed ();
 335         void playlist_order_changed ();
 336         void playlist_content_changed (boost::weak_ptr<Content>, int, bool frequent);
 337         void maybe_add_content (boost::weak_ptr<Job>, boost::weak_ptr<Content>);
 338         void audio_analysis_finished ();
 339
 340         /** Log to write to */
 341         boost::shared_ptr<Log> _log;
 342         boost::shared_ptr<Playlist> _playlist;
 343
 344         /** Complete path to directory containing the film metadata;
 345          *  must not be relative.
 346          */
 347         boost::optional<boost::filesystem::path> _directory;
 348
 349         /** Name for DCP-o-matic */
 350         std::string _name;
 351         /** True if a auto-generated ISDCF-compliant name should be used for our DCP */
 352         bool _use_isdcf_name;
 353         /** The type of content that this Film represents (feature, trailer etc.) */
 354         DCPContentType const * _dcp_content_type;
 355         /** The container to put this Film in (flat, scope, etc.) */
 356         Ratio const * _container;
 357         /** DCP resolution (2K or 4K) */
 358         Resolution _resolution;
 359         bool _signed;
 360         bool _encrypted;
 361         dcp::Key _key;
 362         /** context ID used when encrypting picture assets; we keep it so that we can
 363          *  re-start picture MXF encodes.
 364          */
 365         std::string _context_id;
 366         /** bandwidth for J2K files in bits per second */
 367         int _j2k_bandwidth;
 368         /** ISDCF naming stuff */
 369         ISDCFMetadata _isdcf_metadata;
 370         /** Frames per second to run our DCP at */
 371         int _video_frame_rate;
 372         /** The date that we should use in a ISDCF name */
 373         boost::gregorian::date _isdcf_date;
 374         /** Number of audio channels requested for the DCP */
 375         int _audio_channels;
 376         /** If true, the DCP will be written in 3D mode; otherwise in 2D.
 377             This will be regardless of what content is on the playlist.
 378         */
 379         bool _three_d;
 380         bool _sequence;
 381         bool _interop;
 382         AudioProcessor const * _audio_processor;
 383         ReelType _reel_type;
 384         /** Desired reel length in bytes, if _reel_type == REELTYPE_BY_LENGTH */
 385         int64_t _reel_length;
 386         bool _upload_after_make_dcp;
 387
 388         int _state_version;
 389
 390         /** true if our state has changed since we last saved it */
 391         mutable bool _dirty;
 392         /** film being used as a template, or 0 */
 393         boost::shared_ptr<Film> _template_film;
 394
 395         boost::signals2::scoped_connection _playlist_changed_connection;
 396         boost::signals2::scoped_connection _playlist_order_changed_connection;
 397         boost::signals2::scoped_connection _playlist_content_changed_connection;
 398         std::list<boost::signals2::connection> _job_connections;
 399         std::list<boost::signals2::connection> _audio_analysis_connections;
 400
 401         friend struct paths_test;
 402         friend struct film_metadata_test;
 403 };
 404
 405 #endif