X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Flib%2Ffilm.h;h=071f474aca6f645a097dee2360e88e0a05cc6141;hb=147cca5876dfbdf56e21289c3a36bec4b4850191;hp=af1f49e2ef56534dc847123f7183ea3eb1694e3a;hpb=60990830b23f295d218b6ae549654e5c67a7bdff;p=dcpomatic.git diff --git a/src/lib/film.h b/src/lib/film.h index af1f49e2e..071f474ac 100644 --- a/src/lib/film.h +++ b/src/lib/film.h @@ -18,12 +18,12 @@ */ /** @file src/film.h - * @brief A representation of a piece of video (with sound), including naming, - * the source content file, and how it should be presented in a DCP. + * @brief A representation of some audio and video content, and details of + * how they should be presented in a DCP. */ -#ifndef DVDOMATIC_FILM_H -#define DVDOMATIC_FILM_H +#ifndef DCPOMATIC_FILM_H +#define DCPOMATIC_FILM_H #include #include @@ -32,46 +32,53 @@ #include #include #include -extern "C" { -#include -} -#include "dcp_content_type.h" #include "util.h" -#include "stream.h" +#include "dci_metadata.h" +#include "types.h" +#include "ffmpeg_content.h" +#include "audio_mapping.h" +class DCPContentType; class Format; class Job; class Filter; class Log; class ExamineContentJob; +class AnalyseAudioJob; +class ExternalAudioStream; +class Content; +class Player; +class Playlist; /** @class Film - * @brief A representation of a video with sound. - * - * A representation of a piece of video (with sound), including naming, - * the source content file, and how it should be presented in a DCP. + * @brief A representation of some audio and video content, and details of + * how they should be presented in a DCP. */ class Film : public boost::enable_shared_from_this { public: Film (std::string d, bool must_exist = true); 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; - void examine_content (); - void send_dcp_to_tms (); - void copy_from_dvd (); + void examine_content (boost::shared_ptr); + std::string dcp_video_mxf_filename () const; + std::string dcp_audio_mxf_filename () const; - void make_dcp (bool); + void analyse_audio (); + void send_dcp_to_tms (); + void make_dcp (); /** @return Logger. * It is safe to call this from any thread. */ - Log* log () const { + boost::shared_ptr log () const { return _log; } @@ -80,63 +87,76 @@ public: std::string file (std::string f) const; std::string dir (std::string d) const; - 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; } + bool have_dcp () const; + + boost::shared_ptr player () const; + + /* Proxies for some Playlist methods */ + + ContentAudioFrame audio_length () const; int audio_channels () const; + int audio_frame_rate () const; + bool has_audio () const; + + float video_frame_rate () const; + libdcp::Size video_size () const; + ContentVideoFrame video_length () const; - void set_dci_date_today (); + std::vector ffmpeg_subtitle_streams () const; + boost::optional ffmpeg_subtitle_stream () const; + std::vector ffmpeg_audio_streams () const; + boost::optional ffmpeg_audio_stream () const; + + void set_ffmpeg_subtitle_stream (FFmpegSubtitleStream); + void set_ffmpeg_audio_stream (FFmpegAudioStream); + enum TrimType { + CPL, + ENCODE + }; + + /** Identifiers for the parts of our state; + used for signalling changes. + */ enum Property { NONE, NAME, USE_DCI_NAME, + TRUST_CONTENT_HEADERS, + /** The content list has changed (i.e. content has been added, moved around or removed) */ CONTENT, DCP_CONTENT_TYPE, FORMAT, CROP, FILTERS, SCALER, - DCP_TRIM_START, - DCP_TRIM_END, - DCP_AB, - USE_SOURCE_AUDIO, - AUDIO_STREAM, - EXTERNAL_AUDIO, + TRIM_START, + TRIM_END, + AB, + TRIM_TYPE, AUDIO_GAIN, AUDIO_DELAY, - STILL_DURATION, - SUBTITLE_STREAM, WITH_SUBTITLES, SUBTITLE_OFFSET, SUBTITLE_SCALE, + COLOUR_LUT, + J2K_BANDWIDTH, DCI_METADATA, - THUMBS, - SIZE, - LENGTH, - AUDIO_STREAMS, - SUBTITLE_STREAMS, - FRAMES_PER_SECOND, + DCP_FRAME_RATE, + AUDIO_MAPPING }; @@ -157,7 +177,12 @@ public: return _use_dci_name; } - std::string content () const { + bool trust_content_headers () const { + boost::mutex::scoped_lock lm (_state_mutex); + return _trust_content_headers; + } + + ContentList content () const { boost::mutex::scoped_lock lm (_state_mutex); return _content; } @@ -187,36 +212,26 @@ 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 { - boost::mutex::scoped_lock lm (_state_mutex); - return _dcp_trim_end; - } - - bool dcp_ab () const { + int trim_end () const { boost::mutex::scoped_lock lm (_state_mutex); - return _dcp_ab; + return _trim_end; } - bool use_source_audio () const { + TrimType trim_type () const { boost::mutex::scoped_lock lm (_state_mutex); - return _use_source_audio; + return _trim_type; } - boost::optional audio_stream () const { + bool ab () const { boost::mutex::scoped_lock lm (_state_mutex); - return _audio_stream; + return _ab; } - std::vector external_audio () const { - boost::mutex::scoped_lock lm (_state_mutex); - return _external_audio; - } - float audio_gain () const { boost::mutex::scoped_lock lm (_state_mutex); return _audio_gain; @@ -227,16 +242,6 @@ public: return _audio_delay; } - int still_duration () const { - boost::mutex::scoped_lock lm (_state_mutex); - return _still_duration; - } - - boost::optional subtitle_stream () const { - boost::mutex::scoped_lock lm (_state_mutex); - return _subtitle_stream; - } - bool with_subtitles () const { boost::mutex::scoped_lock lm (_state_mutex); return _with_subtitles; @@ -252,83 +257,41 @@ public: return _subtitle_scale; } - std::string audio_language () const { + int colour_lut () 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 { - boost::mutex::scoped_lock lm (_state_mutex); - return _studio; - } - - std::string facility () const { - boost::mutex::scoped_lock lm (_state_mutex); - return _facility; - } - - std::string package_type () const { - boost::mutex::scoped_lock lm (_state_mutex); - return _package_type; + return _colour_lut; } - std::vector thumbs () const { - boost::mutex::scoped_lock lm (_state_mutex); - return _thumbs; - } - - Size size () const { + int j2k_bandwidth () const { boost::mutex::scoped_lock lm (_state_mutex); - return _size; + return _j2k_bandwidth; } - boost::optional length () const { - boost::mutex::scoped_lock lm (_state_mutex); - return _length; - } - - std::string content_digest () const { - boost::mutex::scoped_lock lm (_state_mutex); - return _content_digest; - } - - std::vector audio_streams () const { + DCIMetadata dci_metadata () const { boost::mutex::scoped_lock lm (_state_mutex); - return _audio_streams; + return _dci_metadata; } - std::vector subtitle_streams () const { + int dcp_frame_rate () const { boost::mutex::scoped_lock lm (_state_mutex); - return _subtitle_streams; + return _dcp_frame_rate; } - - float frames_per_second () const { + + AudioMapping audio_mapping () const { boost::mutex::scoped_lock lm (_state_mutex); - return _frames_per_second; + return _audio_mapping; } - /* 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_trust_content_headers (bool); + 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_format (Format const *); void set_crop (Crop); @@ -338,53 +301,49 @@ 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_dcp_ab (bool); - void set_use_source_audio (bool); - void set_audio_stream (boost::optional); - void set_external_audio (std::vector); + void set_trim_start (int); + void set_trim_end (int); + void set_ab (bool); + void set_trim_type (TrimType); void set_audio_gain (float); void set_audio_delay (int); - void set_still_duration (int); - void set_subtitle_stream (boost::optional); 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_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); - - /** Emitted when some property has changed */ + void set_colour_lut (int); + void set_j2k_bandwidth (int); + void set_dci_metadata (DCIMetadata); + void set_dcp_frame_rate (int); + void set_dci_date_today (); + void set_audio_mapping (AudioMapping); + + /** Emitted when some property has of the Film has changed */ mutable boost::signals2::signal Changed; - -private: - - /** Log to write to */ - Log* _log; - /** Any running ExamineContentJob, or 0 */ - boost::shared_ptr _examine_content_job; + /** Emitted when some property of our content has changed */ + mutable boost::signals2::signal, int)> ContentChanged; - /** The date that we should use in a DCI name */ - boost::gregorian::date _dci_date; + boost::signals2::signal AudioAnalysisSucceeded; - std::string thumb_file_for_frame (SourceFrame) const; - std::string thumb_base_for_frame (SourceFrame) const; + /** Current version number of the state file */ + static int const state_version; + +private: + void signal_changed (Property); - void examine_content_finished (); + void analyse_audio_finished (); + std::string video_state_identifier () const; + void read_metadata (); + void content_changed (boost::weak_ptr, int); + boost::shared_ptr ffmpeg () const; + void setup_default_audio_mapping (); + std::string filename_safe_name () const; + + /** 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. @@ -393,14 +352,12 @@ private: /** Mutex for _directory */ mutable boost::mutex _directory_mutex; - /** Name for DVD-o-matic */ + /** 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; - /** File or directory containing content; may be relative to our directory - * or an absolute path. - */ - std::string _content; + bool _trust_content_headers; + ContentList _content; /** 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 +368,20 @@ 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; - std::vector _external_audio; + bool _ab; /** 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; /** 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 +390,29 @@ 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 */ + DCIMetadata _dci_metadata; + /** Frames per second to run our DCP at */ + int _dcp_frame_rate; + /** The date that we should use in a DCI name */ + boost::gregorian::date _dci_date; + AudioMapping _audio_mapping; - /* 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; - - /* 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 */ - 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; - /** Frames per second of the source */ - float _frames_per_second; - + /** 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