X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Flib%2Ffilm.h;h=dd0a83d94e473f5da6d5b9e98d1378e247c0c3eb;hb=1738f2e7336734190bed7e94ce3d691d4a9c9e4c;hp=af1f49e2ef56534dc847123f7183ea3eb1694e3a;hpb=3d9b5186aa39150e53aef3bab09f4350f85cb885;p=dcpomatic.git diff --git a/src/lib/film.h b/src/lib/film.h index af1f49e2e..dd0a83d94 100644 --- a/src/lib/film.h +++ b/src/lib/film.h @@ -38,17 +38,20 @@ extern "C" { #include "dcp_content_type.h" #include "util.h" #include "stream.h" +#include "dci_metadata.h" class Format; class Job; class Filter; class Log; class ExamineContentJob; +class AnalyseAudioJob; +class ExternalAudioStream; /** @class Film - * @brief A representation of a video with sound. + * @brief A representation of a video, maybe with sound. * - * A representation of a piece of video (with sound), including naming, + * A representation of a piece of video (maybe with sound), including naming, * the source content file, and how it should be presented in a DCP. */ class Film : public boost::enable_shared_from_this @@ -58,20 +61,26 @@ public: Film (Film const &); ~Film (); - std::string j2k_dir () const; - std::vector audio_files () const; - std::pair thumb_subtitle (int) const; + 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; + + std::string dcp_video_mxf_filename () const; + std::string dcp_audio_mxf_filename () const; void examine_content (); + void analyse_audio (); void send_dcp_to_tms (); - void copy_from_dvd (); - void make_dcp (bool); + void make_dcp (); /** @return Logger. * It is safe to call this from any thread. */ - Log* log () const { + boost::shared_ptr log () const { return _log; } @@ -83,22 +92,16 @@ public: std::string content_path () const; ContentType content_type () const; - bool content_is_dvd () const; - - std::string thumb_file (int) const; - std::string thumb_base (int) const; - SourceFrame thumb_frame (int) const; - int target_audio_sample_rate () const; void write_metadata () const; void read_metadata (); - Size cropped_size (Size) const; - boost::optional dcp_length () const; - std::string dci_name () const; - std::string dcp_name () const; + libdcp::Size cropped_size (libdcp::Size) const; + std::string dci_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 */ bool dirty () const { return _dirty; } @@ -107,22 +110,34 @@ public: void set_dci_date_today (); + bool have_dcp () const; + + enum TrimType { + CPL, + ENCODE + }; + + /** Identifiers for the parts of our state; + used for signalling changes. + */ enum Property { NONE, NAME, USE_DCI_NAME, CONTENT, + TRUST_CONTENT_HEADER, DCP_CONTENT_TYPE, FORMAT, CROP, FILTERS, SCALER, - DCP_TRIM_START, - DCP_TRIM_END, + TRIM_START, + TRIM_END, + TRIM_TYPE, DCP_AB, - USE_SOURCE_AUDIO, - AUDIO_STREAM, + CONTENT_AUDIO_STREAM, EXTERNAL_AUDIO, + USE_CONTENT_AUDIO, AUDIO_GAIN, AUDIO_DELAY, STILL_DURATION, @@ -130,13 +145,15 @@ public: WITH_SUBTITLES, SUBTITLE_OFFSET, SUBTITLE_SCALE, + COLOUR_LUT, + J2K_BANDWIDTH, DCI_METADATA, - THUMBS, SIZE, LENGTH, - AUDIO_STREAMS, + CONTENT_AUDIO_STREAMS, SUBTITLE_STREAMS, - FRAMES_PER_SECOND, + SOURCE_FRAME_RATE, + DCP_FRAME_RATE }; @@ -162,6 +179,11 @@ public: return _content; } + bool trust_content_header () const { + boost::mutex::scoped_lock lm (_state_mutex); + return _trust_content_header; + } + DCPContentType const * dcp_content_type () const { boost::mutex::scoped_lock lm (_state_mutex); return _dcp_content_type; @@ -187,35 +209,40 @@ public: return _scaler; } - SourceFrame dcp_trim_start () const { + int trim_start () const { boost::mutex::scoped_lock lm (_state_mutex); - return _dcp_trim_start; + return _trim_start; } - SourceFrame dcp_trim_end () const { + int trim_end () const { boost::mutex::scoped_lock lm (_state_mutex); - return _dcp_trim_end; + return _trim_end; } - - bool dcp_ab () const { + + TrimType trim_type () const { boost::mutex::scoped_lock lm (_state_mutex); - return _dcp_ab; + return _trim_type; } - bool use_source_audio () const { + bool dcp_ab () const { boost::mutex::scoped_lock lm (_state_mutex); - return _use_source_audio; + return _dcp_ab; } - boost::optional audio_stream () const { + boost::shared_ptr content_audio_stream () const { boost::mutex::scoped_lock lm (_state_mutex); - return _audio_stream; + return _content_audio_stream; } std::vector external_audio () const { boost::mutex::scoped_lock lm (_state_mutex); return _external_audio; } + + bool use_content_audio () const { + boost::mutex::scoped_lock lm (_state_mutex); + return _use_content_audio; + } float audio_gain () const { boost::mutex::scoped_lock lm (_state_mutex); @@ -232,7 +259,9 @@ public: return _still_duration; } - boost::optional subtitle_stream () const { + int still_duration_in_frames () const; + + boost::shared_ptr subtitle_stream () const { boost::mutex::scoped_lock lm (_state_mutex); return _subtitle_stream; } @@ -252,47 +281,27 @@ public: return _subtitle_scale; } - std::string audio_language () const { - boost::mutex::scoped_lock lm (_state_mutex); - return _audio_language; - } - - std::string subtitle_language () const { - boost::mutex::scoped_lock lm (_state_mutex); - return _subtitle_language; - } - - std::string territory () const { - boost::mutex::scoped_lock lm (_state_mutex); - return _territory; - } - - std::string rating () const { - boost::mutex::scoped_lock lm (_state_mutex); - return _rating; - } - - std::string studio () const { + int colour_lut () const { boost::mutex::scoped_lock lm (_state_mutex); - return _studio; + return _colour_lut; } - - std::string facility () const { + + int j2k_bandwidth () const { boost::mutex::scoped_lock lm (_state_mutex); - return _facility; + return _j2k_bandwidth; } - - std::string package_type () const { + + DCIMetadata dci_metadata () const { boost::mutex::scoped_lock lm (_state_mutex); - return _package_type; + return _dci_metadata; } - std::vector thumbs () const { + int dcp_frame_rate () const { boost::mutex::scoped_lock lm (_state_mutex); - return _thumbs; + return _dcp_frame_rate; } - Size size () const { + libdcp::Size size () const { boost::mutex::scoped_lock lm (_state_mutex); return _size; } @@ -307,28 +316,35 @@ public: return _content_digest; } - std::vector audio_streams () const { + std::vector > content_audio_streams () const { boost::mutex::scoped_lock lm (_state_mutex); - return _audio_streams; + return _content_audio_streams; } - std::vector subtitle_streams () const { + std::vector > subtitle_streams () const { boost::mutex::scoped_lock lm (_state_mutex); return _subtitle_streams; } - float frames_per_second () const { + float source_frame_rate () const { boost::mutex::scoped_lock lm (_state_mutex); - return _frames_per_second; + if (content_type() == STILL) { + return 24; + } + + return _source_frame_rate; } - + boost::shared_ptr audio_stream () const; + bool has_audio () const; + /* SET */ void set_directory (std::string); void set_name (std::string); void set_use_dci_name (bool); - virtual void set_content (std::string); + void set_content (std::string); + void set_trust_content_header (bool); void set_dcp_content_type (DCPContentType const *); void set_format (Format const *); void set_crop (Crop); @@ -338,53 +354,55 @@ public: void set_bottom_crop (int); void set_filters (std::vector); void set_scaler (Scaler const *); - void set_dcp_trim_start (int); - void set_dcp_trim_end (int); + void set_trim_start (int); + void set_trim_end (int); + void set_trim_type (TrimType); void set_dcp_ab (bool); - void set_use_source_audio (bool); - void set_audio_stream (boost::optional); + void set_content_audio_stream (boost::shared_ptr); void set_external_audio (std::vector); + void set_use_content_audio (bool); void set_audio_gain (float); void set_audio_delay (int); void set_still_duration (int); - void set_subtitle_stream (boost::optional); + void set_subtitle_stream (boost::shared_ptr); void set_with_subtitles (bool); void set_subtitle_offset (int); void set_subtitle_scale (float); - void set_audio_language (std::string); - void set_subtitle_language (std::string); - void set_territory (std::string); - void set_rating (std::string); - void set_studio (std::string); - void set_facility (std::string); - void set_package_type (std::string); - void set_thumbs (std::vector); - void set_size (Size); + void set_colour_lut (int); + void set_j2k_bandwidth (int); + void set_dci_metadata (DCIMetadata); + void set_dcp_frame_rate (int); + void set_size (libdcp::Size); void set_length (SourceFrame); void unset_length (); void set_content_digest (std::string); - void set_audio_streams (std::vector); - void set_subtitle_streams (std::vector); - void set_frames_per_second (float); + void set_content_audio_streams (std::vector >); + void set_subtitle_streams (std::vector >); + void set_source_frame_rate (float); /** Emitted when some property has changed */ mutable boost::signals2::signal Changed; - + + boost::signals2::signal AudioAnalysisSucceeded; + + /** Current version number of the state file */ + static int const state_version; + private: /** Log to write to */ - Log* _log; + boost::shared_ptr _log; /** Any running ExamineContentJob, or 0 */ boost::shared_ptr _examine_content_job; + /** Any running AnalyseAudioJob, or 0 */ + boost::shared_ptr _analyse_audio_job; - /** The date that we should use in a DCI name */ - boost::gregorian::date _dci_date; - - std::string thumb_file_for_frame (SourceFrame) const; - std::string thumb_base_for_frame (SourceFrame) const; void signal_changed (Property); void examine_content_finished (); + void analyse_audio_finished (); + std::string video_state_identifier () const; + std::string filename_safe_name () const; /** Complete path to directory containing the film metadata; * must not be relative. @@ -401,6 +419,11 @@ private: * or an absolute path. */ std::string _content; + /** If this is true, we will believe the length specified by the content + * file's header; if false, we will run through the whole content file + * the first time we see it in order to obtain the length. + */ + bool _trust_content_header; /** The type of content that this Film represents (feature, trailer etc.) */ DCPContentType const * _dcp_content_type; /** The format to present this Film in (flat, scope, etc.) */ @@ -411,25 +434,31 @@ private: std::vector _filters; /** Scaler algorithm to use */ Scaler const * _scaler; - /** Frames to trim off the start of the source */ - SourceFrame _dcp_trim_start; - /** Frames to trim off the end of the source */ - SourceFrame _dcp_trim_end; + /** Frames to trim off the start of the DCP */ + int _trim_start; + /** Frames to trim off the end of the DCP */ + int _trim_end; + TrimType _trim_type; /** 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 _dcp_ab; - bool _use_source_audio; - boost::optional _audio_stream; + /** The audio stream to use from our content */ + boost::shared_ptr _content_audio_stream; + /** List of filenames of external audio files, in channel order + (L, R, C, Lfe, Ls, Rs) + */ std::vector _external_audio; + /** true to use audio from our content file; false to use external audio */ + bool _use_content_audio; /** Gain to apply to audio in dB */ float _audio_gain; /** Delay to apply to audio (positive moves audio later) in milliseconds */ int _audio_delay; /** Duration to make still-sourced films (in seconds) */ int _still_duration; - boost::optional _subtitle_stream; + boost::shared_ptr _subtitle_stream; /** True if subtitles should be shown for this film */ bool _with_subtitles; /** y offset for placing subtitles, in source pixels; +ve is further down @@ -438,39 +467,46 @@ private: 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; + /** bandwidth for J2K files in bits per second */ + int _j2k_bandwidth; - /* DCI naming stuff */ - std::string _audio_language; - std::string _subtitle_language; - std::string _territory; - std::string _rating; - std::string _studio; - std::string _facility; - std::string _package_type; + /** DCI naming stuff */ + DCIMetadata _dci_metadata; + /** The date that we should use in a DCI name */ + boost::gregorian::date _dci_date; + /** Frames per second to run our DCP at */ + int _dcp_frame_rate; /* Data which are cached to speed things up */ - /** Vector of frame indices for each of our `thumbnails' */ - std::vector _thumbs; /** Size, in pixels, of the source (ignoring cropping) */ - Size _size; - /** Actual length of the source (in video frames) from examining it */ + libdcp::Size _size; + /** The length of the source, in video frames (as far as we know) */ boost::optional _length; /** MD5 digest of our content file */ std::string _content_digest; - /** the audio streams that the source has */ - std::vector _audio_streams; - /** the subtitle streams that the source has */ - std::vector _subtitle_streams; + /** The audio streams in our content */ + std::vector > _content_audio_streams; + /** A stream to represent possible external audio (will always exist) */ + boost::shared_ptr _sndfile_stream; + /** the subtitle streams that we can use */ + std::vector > _subtitle_streams; /** Frames per second of the source */ - float _frames_per_second; + float _source_frame_rate; + /** 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; }; #endif