X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Flib%2Ffilm.h;h=84f0b0233ac6247634a9499b94b2c0cc30f8a934;hb=996b0c06e23bcb6b300d7b8799df94993692e07d;hp=07764dac89da6be57bbe009d49af6c02378cee05;hpb=cd21997cc5d7e6bc16c6c6e767e61cddfc7f6add;p=dcpomatic.git diff --git a/src/lib/film.h b/src/lib/film.h index 07764dac8..84f0b0233 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,48 +32,52 @@ #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 "playlist.h" -class Format; +class DCPContentType; +class Container; class Job; class Filter; class Log; class ExamineContentJob; +class AnalyseAudioJob; class ExternalAudioStream; +class Content; +class Player; /** @class Film - * @brief A representation of a video, maybe with sound. - * - * 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. + * @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 (std::string d); Film (Film const &); - ~Film (); - std::string hash_dir () const; + std::string info_dir () const; std::string j2c_path (int f, bool t) const; - std::string hash_path (int f) const; - std::string video_mxf_dir () const; - std::string video_mxf_filename () 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 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; } @@ -82,30 +86,39 @@ public: std::string file (std::string f) const; std::string dir (std::string d) const; - std::string content_path () const; - ContentType content_type () const; - - int target_audio_sample_rate () const; - - void write_metadata () const; void read_metadata (); + void write_metadata () const; - libdcp::Size cropped_size (libdcp::Size) const; - std::string dci_name () const; - std::string dcp_name () const; - - boost::optional dcp_intrinsic_duration () const { - return _dcp_intrinsic_duration; - } + 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; } - int audio_channels () const; + bool have_dcp () const; - void set_dci_date_today (); + boost::shared_ptr player () const; + boost::shared_ptr playlist () const; + + OutputAudioFrame dcp_audio_frame_rate () 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; + + /* Proxies for some Playlist methods */ + + Playlist::ContentList content () const; + + Time length () const; + bool has_subtitles () const; + OutputVideoFrame best_dcp_video_frame_rate () const; + + void set_loop (int); + int loop () const; /** Identifiers for the parts of our state; used for signalling changes. @@ -114,35 +127,20 @@ public: NONE, NAME, USE_DCI_NAME, + /** The playlist's content list has changed (i.e. content has been added, moved around or removed) */ CONTENT, - TRUST_CONTENT_HEADER, + LOOP, DCP_CONTENT_TYPE, - FORMAT, - CROP, - FILTERS, + CONTAINER, SCALER, - TRIM_START, - TRIM_END, - DCP_AB, - CONTENT_AUDIO_STREAM, - EXTERNAL_AUDIO, - USE_CONTENT_AUDIO, - AUDIO_GAIN, - AUDIO_DELAY, - STILL_DURATION, - SUBTITLE_STREAM, + AB, WITH_SUBTITLES, SUBTITLE_OFFSET, SUBTITLE_SCALE, COLOUR_LUT, J2K_BANDWIDTH, DCI_METADATA, - SIZE, - LENGTH, - DCP_INTRINSIC_DURATION, - CONTENT_AUDIO_STREAMS, - SUBTITLE_STREAMS, - FRAMES_PER_SECOND, + DCP_VIDEO_FRAME_RATE, }; @@ -163,34 +161,14 @@ public: return _use_dci_name; } - std::string content () const { - boost::mutex::scoped_lock lm (_state_mutex); - 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; } - Format const * format () const { - boost::mutex::scoped_lock lm (_state_mutex); - return _format; - } - - Crop crop () const { - boost::mutex::scoped_lock lm (_state_mutex); - return _crop; - } - - std::vector filters () const { + Container const * container () const { boost::mutex::scoped_lock lm (_state_mutex); - return _filters; + return _container; } Scaler const * scaler () const { @@ -198,56 +176,9 @@ public: return _scaler; } - int trim_start () const { + bool ab () const { boost::mutex::scoped_lock lm (_state_mutex); - return _trim_start; - } - - int trim_end () const { - boost::mutex::scoped_lock lm (_state_mutex); - return _trim_end; - } - - bool dcp_ab () const { - boost::mutex::scoped_lock lm (_state_mutex); - return _dcp_ab; - } - - boost::shared_ptr content_audio_stream () const { - boost::mutex::scoped_lock lm (_state_mutex); - 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); - return _audio_gain; - } - - int audio_delay () const { - boost::mutex::scoped_lock lm (_state_mutex); - return _audio_delay; - } - - int still_duration () const { - boost::mutex::scoped_lock lm (_state_mutex); - return _still_duration; - } - - int still_duration_in_frames () const; - - boost::shared_ptr subtitle_stream () const { - boost::mutex::scoped_lock lm (_state_mutex); - return _subtitle_stream; + return _ab; } bool with_subtitles () const { @@ -275,145 +206,67 @@ public: return _j2k_bandwidth; } - 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 { - 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; - } - - libdcp::Size size () const { + DCIMetadata dci_metadata () const { boost::mutex::scoped_lock lm (_state_mutex); - return _size; + return _dci_metadata; } - boost::optional length () const { - boost::mutex::scoped_lock lm (_state_mutex); - return _length; - } - - std::string content_digest () const { + /* XXX: -> "video_frame_rate" */ + int dcp_video_frame_rate () const { boost::mutex::scoped_lock lm (_state_mutex); - return _content_digest; - } - - std::vector > content_audio_streams () const { - boost::mutex::scoped_lock lm (_state_mutex); - return _content_audio_streams; + return _dcp_video_frame_rate; } - std::vector > subtitle_streams () const { + int dcp_audio_channels () const { boost::mutex::scoped_lock lm (_state_mutex); - return _subtitle_streams; + return _dcp_audio_channels; } - - float frames_per_second () const { - boost::mutex::scoped_lock lm (_state_mutex); - if (content_type() == STILL) { - return 24; - } - - return _frames_per_second; - } - - boost::shared_ptr audio_stream () const; - /* SET */ void set_directory (std::string); void set_name (std::string); void set_use_dci_name (bool); - void set_content (std::string); - void set_trust_content_header (bool); + void add_content (boost::shared_ptr); + void remove_content (boost::shared_ptr); void set_dcp_content_type (DCPContentType const *); - void set_format (Format const *); - void set_crop (Crop); - void set_left_crop (int); - void set_right_crop (int); - void set_top_crop (int); - void set_bottom_crop (int); - void set_filters (std::vector); + void set_container (Container const *); void set_scaler (Scaler const *); - void set_trim_start (int); - void set_trim_end (int); - void set_dcp_ab (bool); - 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::shared_ptr); + 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_j2k_bandwidth (int); - 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_size (libdcp::Size); - void set_length (SourceFrame); - void unset_length (); - void set_dcp_intrinsic_duration (int); - void set_content_digest (std::string); - void set_content_audio_streams (std::vector >); - void set_subtitle_streams (std::vector >); - void set_frames_per_second (float); - - /** Emitted when some property has changed */ + void set_dci_metadata (DCIMetadata); + void set_dcp_video_frame_rate (int); + void set_dci_date_today (); + + /** Emitted when some property has of the Film has changed */ mutable boost::signals2::signal Changed; + /** 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; private: - /** Log to write to */ - Log* _log; - - /** Any running ExamineContentJob, or 0 */ - boost::shared_ptr _examine_content_job; - - /** The date that we should use in a DCI name */ - boost::gregorian::date _dci_date; - void signal_changed (Property); - void examine_content_finished (); + void analyse_audio_finished (); std::string video_state_identifier () const; + void playlist_changed (); + void playlist_content_changed (boost::weak_ptr, int); + 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. @@ -422,53 +275,21 @@ 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; - /** 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.) */ - Format const * _format; - /** The crop to apply to the source */ - Crop _crop; - /** Video filters that should be used when generating DCPs */ - std::vector _filters; + /** The container to put this Film in (flat, scope, etc.) */ + Container const * _container; /** Scaler algorithm to use */ Scaler const * _scaler; - /** Frames to trim off the start of the DCP */ - int _trim_start; - /** Frames to trim off the end of the DCP */ - int _trim_end; /** 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; - /** 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::shared_ptr _subtitle_stream; + 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 @@ -484,33 +305,13 @@ private: 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; - - /* Data which are cached to speed things up */ - - /** Size, in pixels, of the source (ignoring cropping) */ - libdcp::Size _size; - /** The length of the source, in video frames (as far as we know) */ - boost::optional _length; - boost::optional _dcp_intrinsic_duration; - /** MD5 digest of our content file */ - std::string _content_digest; - /** The audio streams in our content */ - std::vector > _content_audio_streams; - /** A stream to represent possible external audio (will always exist) */ - boost::shared_ptr _external_audio_stream; - /** the subtitle streams that we can use */ - std::vector > _subtitle_streams; - /** Frames per second of the source */ - float _frames_per_second; + /** DCI naming stuff */ + DCIMetadata _dci_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 _dcp_audio_channels; /** true if our state has changed since we last saved it */ mutable bool _dirty; @@ -519,6 +320,7 @@ private: mutable boost::mutex _state_mutex; friend class paths_test; + friend class film_metadata_test; }; #endif