X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Flib%2Ffilm.h;h=5aff6f0be31ef1c00176c1e67d7b2aa6de93953b;hb=9b240c6d5d4e2189401498a99f98f41d1b15ed31;hp=06ebba3ce7545a6cac8939e8b547dd0c2b9bd69c;hpb=b7466a9653345bc51db4cb1d7e960bfc4c12721f;p=dcpomatic.git

diff --git a/src/lib/film.h b/src/lib/film.h
index 06ebba3ce..5aff6f0be 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 <string>
 #include <vector>
@@ -32,46 +32,45 @@
 #include <boost/thread.hpp>
 #include <boost/signals2.hpp>
 #include <boost/enable_shared_from_this.hpp>
-extern "C" {
-#include <libavcodec/avcodec.h>
-}
-#include "dcp_content_type.h"
 #include "util.h"
-#include "stream.h"
+#include "types.h"
+#include "playlist.h"
+#include "dci_metadata.h"
 
-class Format;
-class Job;
-class Filter;
+class DCPContentType;
 class Log;
-class ExamineContentJob;
+class Content;
+class Player;
 
 /** @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.
+ *
+ *  The content of a Film is held in a Playlist (created and managed by the Film).
  */
-class Film : public boost::enable_shared_from_this<Film>
+class Film : public boost::enable_shared_from_this<Film>, public boost::noncopyable
 {
 public:
-	Film (std::string d, bool must_exist = true);
-	Film (Film const &);
-	~Film ();
+	Film (std::string d);
 
-	std::string j2k_dir () const;
-	std::vector<std::string> audio_files () const;
-	std::pair<Position, std::string> thumb_subtitle (int) const;
+	std::string info_dir () const;
+	std::string j2c_path (int, Eyes, bool) const;
+	std::string info_path (int, Eyes) const;
+	std::string internal_video_mxf_dir () const;
+	std::string internal_video_mxf_filename () const;
+	boost::filesystem::path audio_analysis_path (boost::shared_ptr<const AudioContent>) const;
 
-	void examine_content ();
-	void send_dcp_to_tms ();
-	void copy_from_dvd ();
+	std::string dcp_video_mxf_filename () const;
+	std::string dcp_audio_mxf_filename () const;
 
-	void make_dcp (bool);
+	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> log () const {
 		return _log;
 	}
 
@@ -80,63 +79,60 @@ 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 ();
+	void write_metadata () const;
 
-	Size cropped_size (Size) const;
-	boost::optional<SourceFrame> dcp_length () const;
-	std::string dci_name () const;
-	std::string dcp_name () 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;
 	}
 
-	int audio_channels () const;
+	libdcp::Size full_frame () const;
 
-	void set_dci_date_today ();
+	bool have_dcp () const;
+
+	boost::shared_ptr<Player> make_player () const;
+	boost::shared_ptr<Playlist> 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 */
 
+	ContentList content () const;
+
+	Time length () const;
+	bool has_subtitles () const;
+	OutputVideoFrame best_dcp_video_frame_rate () const;
+
+	/** Identifiers for the parts of our state;
+	    used for signalling changes.
+	*/
 	enum Property {
 		NONE,
 		NAME,
 		USE_DCI_NAME,
+		/** The playlist's content list has changed (i.e. content has been added, moved around or removed) */
 		CONTENT,
 		DCP_CONTENT_TYPE,
-		FORMAT,
-		CROP,
-		FILTERS,
+		CONTAINER,
+		RESOLUTION,
 		SCALER,
-		DCP_TRIM_START,
-		DCP_TRIM_END,
-		DCP_AB,
-		AUDIO_STREAM,
-		AUDIO_GAIN,
-		AUDIO_DELAY,
-		STILL_DURATION,
-		SUBTITLE_STREAM,
 		WITH_SUBTITLES,
-		SUBTITLE_OFFSET,
-		SUBTITLE_SCALE,
+		J2K_BANDWIDTH,
 		DCI_METADATA,
-		THUMBS,
-		SIZE,
-		LENGTH,
-		AUDIO_SAMPLE_RATE,
-		HAS_SUBTITLES,
-		AUDIO_STREAMS,
-		SUBTITLE_STREAMS,
-		FRAMES_PER_SECOND,
+		DCP_VIDEO_FRAME_RATE,
+		DCP_AUDIO_CHANNELS,
+		/** The setting of _dcp_3d has been changed */
+		DCP_3D,
+		SEQUENCE_VIDEO,
 	};
 
 
@@ -157,29 +153,19 @@ public:
 		return _use_dci_name;
 	}
 
-	std::string content () const {
-		boost::mutex::scoped_lock lm (_state_mutex);
-		return _content;
-	}
-
 	DCPContentType const * dcp_content_type () const {
 		boost::mutex::scoped_lock lm (_state_mutex);
 		return _dcp_content_type;
 	}
 
-	Format const * format () const {
+	Ratio const * container () const {
 		boost::mutex::scoped_lock lm (_state_mutex);
-		return _format;
+		return _container;
 	}
 
-	Crop crop () const {
+	Resolution resolution () const {
 		boost::mutex::scoped_lock lm (_state_mutex);
-		return _crop;
-	}
-
-	std::vector<Filter const *> filters () const {
-		boost::mutex::scoped_lock lm (_state_mutex);
-		return _filters;
+		return _resolution;
 	}
 
 	Scaler const * scaler () const {
@@ -187,216 +173,86 @@ public:
 		return _scaler;
 	}
 
-	SourceFrame dcp_trim_start () const {
-		boost::mutex::scoped_lock lm (_state_mutex);
-		return _dcp_trim_start;
-	}
-
-	SourceFrame dcp_trim_end () const {
-		boost::mutex::scoped_lock lm (_state_mutex);
-		return _dcp_trim_end;
-	}
-	
-	bool dcp_ab () const {
-		boost::mutex::scoped_lock lm (_state_mutex);
-		return _dcp_ab;
-	}
-
-	int audio_stream_index () const {
-		boost::mutex::scoped_lock lm (_state_mutex);
-		return _audio_stream;
-	}
-
-	AudioStream audio_stream () const {
-		boost::mutex::scoped_lock lm (_state_mutex);
-		assert (_audio_stream < int (_audio_streams.size()));
-		return _audio_streams[_audio_stream];
-	}
-	
-	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 subtitle_stream_index () const {
-		boost::mutex::scoped_lock lm (_state_mutex);
-		return _subtitle_stream;
-	}
-
-	SubtitleStream subtitle_stream () const {
-		boost::mutex::scoped_lock lm (_state_mutex);
-		assert (_subtitle_stream < int (_subtitle_streams.size()));
-		return _subtitle_streams[_subtitle_stream];
-	}
-
 	bool with_subtitles () const {
 		boost::mutex::scoped_lock lm (_state_mutex);
 		return _with_subtitles;
 	}
 
-	int subtitle_offset () const {
+	int j2k_bandwidth () const {
 		boost::mutex::scoped_lock lm (_state_mutex);
-		return _subtitle_offset;
+		return _j2k_bandwidth;
 	}
 
-	float subtitle_scale () const {
+	DCIMetadata dci_metadata () const {
 		boost::mutex::scoped_lock lm (_state_mutex);
-		return _subtitle_scale;
+		return _dci_metadata;
 	}
 
-	std::string audio_language () const {
+	/* XXX: -> "video_frame_rate" */
+	int dcp_video_frame_rate () 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 _dcp_video_frame_rate;
 	}
 
-	std::vector<SourceFrame> thumbs () const {
-		boost::mutex::scoped_lock lm (_state_mutex);
-		return _thumbs;
-	}
-	
-	Size size () const {
-		boost::mutex::scoped_lock lm (_state_mutex);
-		return _size;
-	}
-
-	boost::optional<SourceFrame> length () const {
-		boost::mutex::scoped_lock lm (_state_mutex);
-		return _length;
-	}
-	
-	int audio_sample_rate () const {
-		boost::mutex::scoped_lock lm (_state_mutex);
-		return _audio_sample_rate;
-	}
-	
-	std::string content_digest () const {
-		boost::mutex::scoped_lock lm (_state_mutex);
-		return _content_digest;
-	}
-	
-	bool has_subtitles () const {
+	int dcp_audio_channels () const {
 		boost::mutex::scoped_lock lm (_state_mutex);
-		return _has_subtitles;
+		return _dcp_audio_channels;
 	}
 
-	std::vector<AudioStream> audio_streams () const {
+	bool dcp_3d () const {
 		boost::mutex::scoped_lock lm (_state_mutex);
-		return _audio_streams;
+		return _dcp_3d;
 	}
 
-	std::vector<SubtitleStream> subtitle_streams () const {
+	bool sequence_video () const {
 		boost::mutex::scoped_lock lm (_state_mutex);
-		return _subtitle_streams;
+		return _sequence_video;
 	}
 	
-	float frames_per_second () const {
-		boost::mutex::scoped_lock lm (_state_mutex);
-		return _frames_per_second;
-	}
-
 
 	/* SET */
 
 	void set_directory (std::string);
 	void set_name (std::string);
 	void set_use_dci_name (bool);
-	virtual void set_content (std::string);
+	void examine_and_add_content (boost::shared_ptr<Content>);
+	void add_content (boost::shared_ptr<Content>);
+	void remove_content (boost::shared_ptr<Content>);
 	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<Filter const *>);
+	void set_container (Ratio const *);
+	void set_resolution (Resolution);
 	void set_scaler (Scaler const *);
-	void set_dcp_trim_start (int);
-	void set_dcp_trim_end (int);
-	void set_dcp_ab (bool);
-	void set_audio_stream (int);
-	void set_audio_gain (float);
-	void set_audio_delay (int);
-	void set_still_duration (int);
-	void set_subtitle_stream (int);
 	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<SourceFrame>);
-	void set_size (Size);
-	void set_length (SourceFrame);
-	void unset_length ();
-	void set_audio_sample_rate (int);
-	void set_content_digest (std::string);
-	void set_has_subtitles (bool);
-	void set_audio_streams (std::vector<AudioStream>);
-	void set_subtitle_streams (std::vector<SubtitleStream>);
-	void set_frames_per_second (float);
-
-	/** Emitted when some property has changed */
+	void set_j2k_bandwidth (int);
+	void set_dci_metadata (DCIMetadata);
+	void set_dcp_video_frame_rate (int);
+	void set_dcp_audio_channels (int);
+	void set_dcp_3d (bool);
+	void set_dci_date_today ();
+	void set_sequence_video (bool);
+
+	/** Emitted when some property has of the Film has changed */
 	mutable boost::signals2::signal<void (Property)> Changed;
-	
-private:
-	
-	/** Log to write to */
-	Log* _log;
 
-	/** Any running ExamineContentJob, or 0 */
-	boost::shared_ptr<ExamineContentJob> _examine_content_job;
+	/** Emitted when some property of our content has changed */
+	mutable boost::signals2::signal<void (boost::weak_ptr<Content>, int)> ContentChanged;
 
-	boost::gregorian::date _dci_date;
+	/** Current version number of the state file */
+	static int const state_version;
+
+private:
 
-	std::string thumb_file_for_frame (SourceFrame) const;
-	std::string thumb_base_for_frame (SourceFrame) const;
 	void signal_changed (Property);
-	void examine_content_finished ();
-	
+	std::string video_identifier () const;
+	void playlist_changed ();
+	void playlist_content_changed (boost::weak_ptr<Content>, int);
+	std::string filename_safe_name () const;
+	void maybe_add_content (boost::weak_ptr<Job>, boost::weak_ptr<Content>);
+
+	/** Log to write to */
+	boost::shared_ptr<Log> _log;
+	boost::shared_ptr<Playlist> _playlist;
+
 	/** Complete path to directory containing the film metadata;
 	 *  must not be relative.
 	 */
@@ -404,86 +260,43 @@ 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;
 	/** 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<Filter const *> _filters;
+	/** The container to put this Film in (flat, scope, etc.) */
+	Ratio const * _container;
+	/** DCP resolution (2K or 4K) */
+	Resolution _resolution;
 	/** Scaler algorithm to use */
 	Scaler const * _scaler;
-	SourceFrame _dcp_trim_start;
-	SourceFrame _dcp_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;
-	/** An index into our _audio_streams vector for the stream to use for audio, or -1 if there is none */
-	int _audio_stream;
-	/** 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;
-	/** An index into our _subtitle_streams vector for the stream to use for subtitles, or -1 if there is none */
-	int _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
-	    the frame, -ve is further up.
+	/** 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_video_frame_rate;
+	/** The date that we should use in a DCI name */
+	boost::gregorian::date _dci_date;
+	int _dcp_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.
 	*/
-	int _subtitle_offset;
-	/** scale factor to apply to subtitles */
-	float _subtitle_scale;
-
-	/* 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<SourceFrame> _thumbs;
-	/** Size, in pixels, of the source (ignoring cropping) */
-	Size _size;
-	/** Actual length of the source (in video frames) from examining it */
-	boost::optional<SourceFrame> _length;
-	/** Sample rate of the source audio, in Hz */
-	int _audio_sample_rate;
-	/** MD5 digest of our content file */
-	std::string _content_digest;
-	/** true if the source has subtitles */
-	bool _has_subtitles;
-	/** the audio streams that the source has */
-	std::vector<AudioStream> _audio_streams;
-	/** the subtitle streams that the source has */
-	std::vector<SubtitleStream> _subtitle_streams;
-	/** Frames per second of the source */
-	float _frames_per_second;
+	bool _dcp_3d;
+	bool _sequence_video;
 
+	/** 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