X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Flib%2Ffilm.h;h=51db8ce00729219c44e4f98077efaeedd6d34596;hb=4616b19fb5241a54c9d57f7a91bb975f41aed14b;hp=71a3b1c34b68cd226525d02611d665b363a4b14b;hpb=4910d44f346cd9dfa239b5bfaca6cbda84be1e08;p=dcpomatic.git diff --git a/src/lib/film.h b/src/lib/film.h index 71a3b1c34..178fd9002 100644 --- a/src/lib/film.h +++ b/src/lib/film.h @@ -1,5 +1,5 @@ /* - Copyright (C) 2012 Carl Hetherington + Copyright (C) 2012-2014 Carl Hetherington This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -28,49 +28,49 @@ #include #include #include -#include -#include #include #include +#include +#include +#include +#include #include "util.h" -#include "dci_metadata.h" #include "types.h" -#include "ffmpeg_content.h" -#include "playlist.h" +#include "isdcf_metadata.h" +#include "frame_rate_change.h" class DCPContentType; -class Container; -class Job; -class Filter; class Log; -class ExamineContentJob; -class AnalyseAudioJob; -class ExternalAudioStream; class Content; class Player; +class Playlist; +class AudioContent; +class Scaler; +class Screen; +class isdcf_name_test; /** @class Film + * * @brief A representation of some audio and video content, and details of * how they should be presented in a DCP. + * + * The content of a Film is held in a Playlist (created and managed by the Film). */ -class Film : public boost::enable_shared_from_this +class Film : public boost::enable_shared_from_this, public boost::noncopyable { public: - Film (std::string d, bool must_exist = true); - Film (Film const &); + Film (boost::filesystem::path, bool log = true); - std::string info_dir () const; - std::string j2c_path (int f, bool t) const; - std::string info_path (int f) const; - std::string internal_video_mxf_dir () const; - std::string internal_video_mxf_filename () const; - std::string audio_analysis_path () const; + boost::filesystem::path info_dir () const; + boost::filesystem::path j2c_path (int, Eyes, bool) const; + boost::filesystem::path info_path (int, Eyes) const; + boost::filesystem::path internal_video_mxf_dir () const; + boost::filesystem::path internal_video_mxf_filename () const; + boost::filesystem::path audio_analysis_dir () const; - void examine_content (boost::shared_ptr); - std::string dcp_video_mxf_filename () const; - std::string dcp_audio_mxf_filename () const; + boost::filesystem::path video_mxf_filename () const; + boost::filesystem::path audio_mxf_filename () const; - void analyse_audio (); void send_dcp_to_tms (); void make_dcp (); @@ -83,12 +83,14 @@ public: int encoded_frames () const; - std::string file (std::string f) const; - std::string dir (std::string d) const; + boost::filesystem::path file (boost::filesystem::path f) const; + boost::filesystem::path dir (boost::filesystem::path d) const; + std::list read_metadata (); void write_metadata () const; + boost::shared_ptr metadata () const; - std::string dci_name (bool if_created_now) const; + std::string isdcf_name (bool if_created_now) const; std::string dcp_name (bool if_created_now = false) const; /** @return true if our state has changed since we last saved it */ @@ -96,28 +98,50 @@ public: return _dirty; } - bool have_dcp () const; + dcp::Size full_frame () const; + dcp::Size frame_size () const; - boost::shared_ptr player () const; - boost::shared_ptr playlist () const; + std::vector cpls () const; - OutputAudioFrame dcp_audio_frame_rate () const; + boost::shared_ptr make_player () const; + boost::shared_ptr playlist () const; - OutputAudioFrame time_to_audio_frames (Time) const; - OutputVideoFrame time_to_video_frames (Time) const; - Time video_frames_to_time (OutputVideoFrame) const; - Time audio_frames_to_time (OutputAudioFrame) const; + int audio_frame_rate () const; + uint64_t required_disk_space () const; + bool should_be_enough_disk_space (double &, double &) const; + /* Proxies for some Playlist methods */ - Playlist::ContentList content () const; - - Time length () const; - bool has_subtitles () const; - OutputVideoFrame best_dcp_video_frame_rate () const; + ContentList content () const; + DCPTime length () const; + int best_video_frame_rate () const; + FrameRateChange active_frame_rate_change (DCPTime) const; + + dcp::EncryptedKDM + make_kdm ( + boost::shared_ptr target, + boost::filesystem::path cpl_file, + dcp::LocalTime from, + dcp::LocalTime until, + dcp::Formulation formulation + ) const; + + std::list make_kdms ( + std::list >, + boost::filesystem::path cpl_file, + dcp::LocalTime from, + dcp::LocalTime until, + dcp::Formulation formulation + ) const; + + dcp::Key key () const { + return _key; + } - void set_loop (int); - int loop () const; + int state_version () const { + return _state_version; + } /** Identifiers for the parts of our state; used for signalling changes. @@ -125,123 +149,119 @@ public: enum Property { NONE, NAME, - USE_DCI_NAME, - /** The playlist's content list has changed (i.e. content has been added, moved around or removed) */ + USE_ISDCF_NAME, + /** The playlist's content list has changed (i.e. content has been added or removed) */ CONTENT, - LOOP, DCP_CONTENT_TYPE, CONTAINER, - FILTERS, + RESOLUTION, SCALER, - AB, - WITH_SUBTITLES, - SUBTITLE_OFFSET, - SUBTITLE_SCALE, - COLOUR_LUT, + SIGNED, + ENCRYPTED, J2K_BANDWIDTH, - DCI_METADATA, - DCP_VIDEO_FRAME_RATE, + ISDCF_METADATA, + VIDEO_FRAME_RATE, + AUDIO_CHANNELS, + /** The setting of _three_d has been changed */ + THREE_D, + SEQUENCE_VIDEO, + INTEROP, }; /* GET */ - std::string directory () const { - boost::mutex::scoped_lock lm (_directory_mutex); + boost::filesystem::path directory () const { return _directory; } std::string name () const { - boost::mutex::scoped_lock lm (_state_mutex); return _name; } - bool use_dci_name () const { - boost::mutex::scoped_lock lm (_state_mutex); - return _use_dci_name; + bool use_isdcf_name () const { + return _use_isdcf_name; } DCPContentType const * dcp_content_type () const { - boost::mutex::scoped_lock lm (_state_mutex); return _dcp_content_type; } - Container const * container () const { - boost::mutex::scoped_lock lm (_state_mutex); + Ratio const * container () const { return _container; } - std::vector filters () const { - boost::mutex::scoped_lock lm (_state_mutex); - return _filters; + Resolution resolution () const { + return _resolution; } Scaler const * scaler () const { - boost::mutex::scoped_lock lm (_state_mutex); return _scaler; } - bool ab () const { - boost::mutex::scoped_lock lm (_state_mutex); - return _ab; + /* signed is a reserved word */ + bool is_signed () const { + return _signed; + } + + bool encrypted () const { + return _encrypted; } - bool with_subtitles () const { - boost::mutex::scoped_lock lm (_state_mutex); - return _with_subtitles; + int j2k_bandwidth () const { + return _j2k_bandwidth; } - int subtitle_offset () const { - boost::mutex::scoped_lock lm (_state_mutex); - return _subtitle_offset; + ISDCFMetadata isdcf_metadata () const { + return _isdcf_metadata; } - float subtitle_scale () const { - boost::mutex::scoped_lock lm (_state_mutex); - return _subtitle_scale; + /** @return The frame rate of the DCP */ + int video_frame_rate () const { + return _video_frame_rate; } - int colour_lut () const { - boost::mutex::scoped_lock lm (_state_mutex); - return _colour_lut; + int audio_channels () const { + return _audio_channels; } - int j2k_bandwidth () const { - boost::mutex::scoped_lock lm (_state_mutex); - return _j2k_bandwidth; + bool three_d () const { + return _three_d; } - DCIMetadata dci_metadata () const { - boost::mutex::scoped_lock lm (_state_mutex); - return _dci_metadata; + bool sequence_video () const { + return _sequence_video; } - /* XXX: -> "video_frame_rate" */ - int dcp_video_frame_rate () const { - boost::mutex::scoped_lock lm (_state_mutex); - return _dcp_video_frame_rate; + bool interop () const { + return _interop; } + /* SET */ - void set_directory (std::string); + void set_directory (boost::filesystem::path); void set_name (std::string); - void set_use_dci_name (bool); + void set_use_isdcf_name (bool); + void examine_and_add_content (boost::shared_ptr); void add_content (boost::shared_ptr); void remove_content (boost::shared_ptr); + void move_content_earlier (boost::shared_ptr); + void move_content_later (boost::shared_ptr); void set_dcp_content_type (DCPContentType const *); - void set_container (Container const *); - void set_filters (std::vector); + void set_container (Ratio const *); + void set_resolution (Resolution); void set_scaler (Scaler const *); - void set_ab (bool); - void set_with_subtitles (bool); - void set_subtitle_offset (int); - void set_subtitle_scale (float); - void set_colour_lut (int); + void set_signed (bool); + void set_encrypted (bool); void set_j2k_bandwidth (int); - void set_dci_metadata (DCIMetadata); - void set_dcp_video_frame_rate (int); - void set_dci_date_today (); + void set_isdcf_metadata (ISDCFMetadata); + void set_video_frame_rate (int); + void set_audio_channels (int); + void set_three_d (bool); + void set_isdcf_date_today (); + void set_sequence_video (bool); + void set_interop (bool); /** Emitted when some property has of the Film has changed */ mutable boost::signals2::signal Changed; @@ -249,79 +269,66 @@ public: /** Emitted when some property of our content has changed */ mutable boost::signals2::signal, int)> ContentChanged; - boost::signals2::signal AudioAnalysisSucceeded; - /** Current version number of the state file */ - static int const state_version; + static int const current_state_version; private: - + + friend class ::isdcf_name_test; + void signal_changed (Property); - void analyse_audio_finished (); - std::string video_state_identifier () const; - void read_metadata (); + std::string video_identifier () const; void playlist_changed (); void playlist_content_changed (boost::weak_ptr, int); std::string filename_safe_name () const; + void maybe_add_content (boost::weak_ptr, boost::weak_ptr); /** Log to write to */ boost::shared_ptr _log; - /** Any running AnalyseAudioJob, or 0 */ - boost::shared_ptr _analyse_audio_job; boost::shared_ptr _playlist; /** Complete path to directory containing the film metadata; * must not be relative. */ - std::string _directory; - /** Mutex for _directory */ - mutable boost::mutex _directory_mutex; + boost::filesystem::path _directory; /** Name for DCP-o-matic */ std::string _name; - /** True if a auto-generated DCI-compliant name should be used for our DCP */ - bool _use_dci_name; + /** True if a auto-generated ISDCF-compliant name should be used for our DCP */ + bool _use_isdcf_name; /** The type of content that this Film represents (feature, trailer etc.) */ DCPContentType const * _dcp_content_type; /** The container to put this Film in (flat, scope, etc.) */ - Container const * _container; - /** Video filters that should be used when generating DCPs */ - std::vector _filters; + Ratio const * _container; + /** DCP resolution (2K or 4K) */ + Resolution _resolution; /** Scaler algorithm to use */ Scaler const * _scaler; - /** true to create an A/B comparison DCP, where the left half of the image - is the video without any filters or post-processing, and the right half - has the specified filters and post-processing. - */ - bool _ab; - /** True if subtitles should be shown for this film */ - bool _with_subtitles; - /** y offset for placing subtitles, in source pixels; +ve is further down - the frame, -ve is further up. - */ - int _subtitle_offset; - /** scale factor to apply to subtitles */ - float _subtitle_scale; - /** index of colour LUT to use when converting RGB to XYZ. - * 0: sRGB - * 1: Rec 709 - */ - int _colour_lut; + bool _signed; + bool _encrypted; /** bandwidth for J2K files in bits per second */ int _j2k_bandwidth; - /** DCI naming stuff */ - DCIMetadata _dci_metadata; + /** ISDCF naming stuff */ + ISDCFMetadata _isdcf_metadata; /** Frames per second to run our DCP at */ - int _dcp_video_frame_rate; - /** The date that we should use in a DCI name */ - boost::gregorian::date _dci_date; + int _video_frame_rate; + /** The date that we should use in a ISDCF name */ + boost::gregorian::date _isdcf_date; + /** Number of audio channels to put in the DCP */ + int _audio_channels; + /** If true, the DCP will be written in 3D mode; otherwise in 2D. + This will be regardless of what content is on the playlist. + */ + bool _three_d; + bool _sequence_video; + bool _interop; + dcp::Key _key; + + int _state_version; /** true if our state has changed since we last saved it */ mutable bool _dirty; - /** Mutex for all state except _directory */ - mutable boost::mutex _state_mutex; - friend class paths_test; friend class film_metadata_test; };