X-Git-Url: https://main.carlh.net/gitweb/?p=dcpomatic.git;a=blobdiff_plain;f=src%2Flib%2Ffilm.h;h=e1260f26aae5083a6378830083f579a458e8162f;hp=64bb159c7ba7a2892c5d07d07b34cdc6e31c81f7;hb=HEAD;hpb=d1957e43ef4a3966e35b9f28b8faf96e925d2310

diff --git a/src/lib/film.h b/src/lib/film.h
index 64bb159c7..43a41ad45 100644
--- a/src/lib/film.h
+++ b/src/lib/film.h
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2020 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
@@ -18,30 +18,43 @@
 
 */
 
+
 /** @file  src/film.h
  *  @brief A representation of some audio and video content, and details of
  *  how they should be presented in a DCP.
  */
 
+
 #ifndef DCPOMATIC_FILM_H
 #define DCPOMATIC_FILM_H
 
-#include "util.h"
-#include "types.h"
-#include "isdcf_metadata.h"
+
+#include "change_signaller.h"
+#include "dcp_text_track.h"
+#include "dcpomatic_time.h"
+#include "film_property.h"
 #include "frame_rate_change.h"
+#include "named_channel.h"
+#include "resolution.h"
 #include "signaller.h"
-#include "dcp_text_track.h"
-#include <dcp/key.h>
+#include "territory_type.h"
+#include "transcode_job.h"
+#include "types.h"
+#include "util.h"
 #include <dcp/encrypted_kdm.h>
+#include <dcp/file.h>
+#include <dcp/key.h>
+#include <dcp/language_tag.h>
+#include <dcp/rating.h>
+#include <dcp/types.h>
+#include <boost/filesystem.hpp>
 #include <boost/signals2.hpp>
-#include <boost/enable_shared_from_this.hpp>
 #include <boost/thread.hpp>
-#include <boost/filesystem.hpp>
 #include <boost/thread/mutex.hpp>
+#include <inttypes.h>
 #include <string>
 #include <vector>
-#include <inttypes.h>
+
 
 namespace xmlpp {
 	class Document;
@@ -51,41 +64,40 @@ namespace dcpomatic {
 	class Screen;
 }
 
+class AudioContent;
+class AudioProcessor;
+class Content;
 class DCPContentType;
+class Film;
+class Job;
 class Log;
-class Content;
 class Playlist;
-class AudioContent;
-class AudioProcessor;
 class Ratio;
-class Job;
-class Film;
+struct atmos_encrypted_passthrough_test;
 struct isdcf_name_test;
+struct isdcf_name_with_atmos;
+struct isdcf_name_with_ccap;
+struct ov_subs_in_vf_name;
 struct recover_test_2d_encrypted;
 
+
 class InfoFileHandle
 {
 public:
-	~InfoFileHandle ();
-
-	FILE* get () const {
-		return _handle;
-	}
+	InfoFileHandle (boost::mutex& mutex, boost::filesystem::path file, bool read);
 
-	boost::filesystem::path file () const {
+	dcp::File& get () {
 		return _file;
 	}
 
 private:
 	friend class Film;
 
-	InfoFileHandle (boost::mutex& mutex, boost::filesystem::path file, bool read);
-
 	boost::mutex::scoped_lock _lock;
-	FILE* _handle;
-	boost::filesystem::path _file;
+	dcp::File _file;
 };
 
+
 /** @class Film
  *
  *  @brief A representation of some audio, video, subtitle and closed-caption content,
@@ -93,27 +105,29 @@ private:
  *
  *  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>, public Signaller, public boost::noncopyable
+class Film : public std::enable_shared_from_this<Film>, public Signaller
 {
 public:
 	explicit Film (boost::optional<boost::filesystem::path> dir);
 	~Film ();
 
-	boost::shared_ptr<InfoFileHandle> info_file_handle (dcpomatic::DCPTimePeriod period, bool read) const;
+	Film (Film const&) = delete;
+	Film& operator= (Film const&) = delete;
+
+	std::shared_ptr<InfoFileHandle> info_file_handle (dcpomatic::DCPTimePeriod period, bool read) const;
 	boost::filesystem::path j2c_path (int, Frame, Eyes, bool) const;
 	boost::filesystem::path internal_video_asset_dir () const;
 	boost::filesystem::path internal_video_asset_filename (dcpomatic::DCPTimePeriod p) const;
 
-	boost::filesystem::path audio_analysis_path (boost::shared_ptr<const Playlist>) const;
-	boost::filesystem::path subtitle_analysis_path (boost::shared_ptr<const Content>) const;
+	boost::filesystem::path audio_analysis_path (std::shared_ptr<const Playlist>) const;
+	boost::filesystem::path subtitle_analysis_path (std::shared_ptr<const Content>) const;
 
 	void send_dcp_to_tms ();
-	void make_dcp (bool gui = false, bool check = true);
 
 	/** @return Logger.
 	 *  It is safe to call this from any thread.
 	 */
-	boost::shared_ptr<Log> log () const {
+	std::shared_ptr<Log> log () const {
 		return _log;
 	}
 
@@ -122,12 +136,12 @@ public:
 
 	void use_template (std::string name);
 	std::list<std::string> read_metadata (boost::optional<boost::filesystem::path> path = boost::optional<boost::filesystem::path> ());
-	void write_metadata () const;
+	void write_metadata ();
 	void write_metadata (boost::filesystem::path path) const;
 	void write_template (boost::filesystem::path path) const;
-	boost::shared_ptr<xmlpp::Document> metadata (bool with_content_paths = true) const;
+	std::shared_ptr<xmlpp::Document> metadata (bool with_content_paths = true) const;
 
-	void copy_from (boost::shared_ptr<const Film> film);
+	void copy_from (std::shared_ptr<const Film> film);
 
 	std::string isdcf_name (bool if_created_now) const;
 	std::string dcp_name (bool if_created_now = false) const;
@@ -139,16 +153,17 @@ public:
 
 	dcp::Size full_frame () const;
 	dcp::Size frame_size () const;
+	dcp::Size active_area () const;
 
 	std::vector<CPLSummary> cpls () const;
 
-	int audio_frame_rate () const;
-
 	std::list<DCPTextTrack> closed_caption_tracks () const;
 
 	uint64_t required_disk_space () const;
 	bool should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const;
 
+	bool has_sign_language_video_channel () const;
+
 	/* Proxies for some Playlist methods */
 
 	ContentList content () const;
@@ -157,38 +172,39 @@ public:
 	FrameRateChange active_frame_rate_change (dcpomatic::DCPTime) const;
 	std::pair<double, double> speed_up_range (int dcp_frame_rate) const;
 
-	dcp::EncryptedKDM make_kdm (
-		dcp::Certificate recipient,
-		std::vector<std::string> trusted_devices,
-		boost::filesystem::path cpl_file,
-		dcp::LocalTime from,
-		dcp::LocalTime until,
-		dcp::Formulation formulation,
-		bool disable_forensic_marking_picture,
-		boost::optional<int> disable_forensic_marking_audio
-		) const;
+	dcp::DecryptedKDM make_kdm(boost::filesystem::path cpl_file, dcp::LocalTime from, dcp::LocalTime until) const;
 
 	int state_version () const {
 		return _state_version;
 	}
 
-	std::string subtitle_language () const;
-
-	std::vector<std::string> audio_output_names () const;
+	std::vector<NamedChannel> audio_output_names () const;
 
 	void repeat_content (ContentList, int);
 
-	boost::shared_ptr<const Playlist> playlist () const {
+	std::shared_ptr<const Playlist> playlist () const {
 		return _playlist;
 	}
 
 	std::list<dcpomatic::DCPTimePeriod> reels () const;
 	std::list<int> mapped_audio_channels () const;
 
+	boost::optional<dcp::LanguageTag> audio_language () const {
+		return _audio_language;
+	}
+
+	/** @param burnt_in If non-null, filled with true if all subtitles are burnt in, otherwise false.
+	 *  @return pair containing the main subtitle language, and additional languages
+	 */
+	std::pair<boost::optional<dcp::LanguageTag>, std::vector<dcp::LanguageTag>> subtitle_languages(bool* burnt_in = nullptr) const;
+	/** @return all closed caption languages in the film */
+	std::vector<dcp::LanguageTag> closed_caption_languages() const;
+
 	std::string content_summary (dcpomatic::DCPTimePeriod period) const;
 
 	bool references_dcp_video () const;
 	bool references_dcp_audio () const;
+	bool contains_atmos_content () const;
 
 	void set_tolerant (bool t) {
 		_tolerant = t;
@@ -198,38 +214,7 @@ public:
 		return _tolerant;
 	}
 
-	/** Identifiers for the parts of our state;
-	    used for signalling changes.
-	*/
-	enum Property {
-		NONE,
-		NAME,
-		USE_ISDCF_NAME,
-		/** The playlist's content list has changed (i.e. content has been added or removed) */
-		CONTENT,
-		/** The order of content in the playlist has changed */
-		CONTENT_ORDER,
-		DCP_CONTENT_TYPE,
-		CONTAINER,
-		RESOLUTION,
-		ENCRYPTED,
-		J2K_BANDWIDTH,
-		ISDCF_METADATA,
-		VIDEO_FRAME_RATE,
-		AUDIO_CHANNELS,
-		/** The setting of _three_d has changed */
-		THREE_D,
-		SEQUENCE,
-		INTEROP,
-		AUDIO_PROCESSOR,
-		REEL_TYPE,
-		REEL_LENGTH,
-		REENCODE_J2K,
-		MARKERS,
-		RATINGS,
-		CONTENT_VERSION
-	};
-
+	bool last_written_by_earlier_than(int major, int minor, int micro) const;
 
 	/* GET */
 
@@ -269,10 +254,6 @@ public:
 		return _j2k_bandwidth;
 	}
 
-	ISDCFMetadata isdcf_metadata () const {
-		return _isdcf_metadata;
-	}
-
 	/** @return The frame rate of the DCP */
 	int video_frame_rate () const {
 		return _video_frame_rate;
@@ -294,6 +275,10 @@ public:
 		return _interop;
 	}
 
+	bool limit_to_smpte_bv20() const {
+		return _limit_to_smpte_bv20;
+	}
+
 	AudioProcessor const * audio_processor () const {
 		return _audio_processor;
 	}
@@ -314,8 +299,10 @@ public:
 		return _reencode_j2k;
 	}
 
+	typedef std::map<dcp::Marker, dcpomatic::DCPTime> Markers;
+
 	boost::optional<dcpomatic::DCPTime> marker (dcp::Marker type) const;
-	std::map<dcp::Marker, dcpomatic::DCPTime> markers () const {
+	Markers markers () const {
 		return _markers;
 	}
 
@@ -323,8 +310,76 @@ public:
 		return _ratings;
 	}
 
-	std::string content_version () const {
-		return _content_version;
+	std::vector<std::string> content_versions () const {
+		return _content_versions;
+	}
+
+	dcp::LanguageTag name_language () const {
+		return _name_language;
+	}
+
+	TerritoryType territory_type() const {
+		return _territory_type;
+	}
+
+	boost::optional<dcp::LanguageTag::RegionSubtag> release_territory () const {
+		return _release_territory;
+	}
+
+	boost::optional<dcp::LanguageTag> sign_language_video_language () const {
+		return _sign_language_video_language;
+	}
+
+	int version_number () const {
+		return _version_number;
+	}
+
+	dcp::Status status () const {
+		return _status;
+	}
+
+	boost::optional<std::string> chain () const {
+		return _chain;
+	}
+
+	boost::optional<std::string> distributor () const {
+		return _distributor;
+	}
+
+	boost::optional<std::string> facility () const {
+		return _facility;
+	}
+
+	boost::optional<std::string> studio () const {
+		return _studio;
+	}
+
+	bool temp_version () const {
+		return _temp_version;
+	}
+
+	bool pre_release () const {
+		return _pre_release;
+	}
+
+	bool red_band () const {
+		return _red_band;
+	}
+
+	bool two_d_version_of_three_d () const {
+		return _two_d_version_of_three_d;
+	}
+
+	boost::optional<dcp::Luminance> luminance () const {
+		return _luminance;
+	}
+
+	boost::gregorian::date isdcf_date () const {
+		return _isdcf_date;
+	}
+
+	int audio_frame_rate () const {
+		return _audio_frame_rate;
 	}
 
 	/* SET */
@@ -332,24 +387,24 @@ public:
 	void set_directory (boost::filesystem::path);
 	void set_name (std::string);
 	void set_use_isdcf_name (bool);
-	void examine_and_add_content (boost::shared_ptr<Content> content, bool disable_audio_analysis = false);
-	void add_content (boost::shared_ptr<Content>);
-	void remove_content (boost::shared_ptr<Content>);
+	void examine_and_add_content (std::shared_ptr<Content> content, bool disable_audio_analysis = false);
+	void add_content (std::shared_ptr<Content>);
+	void remove_content (std::shared_ptr<Content>);
 	void remove_content (ContentList);
-	void move_content_earlier (boost::shared_ptr<Content>);
-	void move_content_later (boost::shared_ptr<Content>);
+	void move_content_earlier (std::shared_ptr<Content>);
+	void move_content_later (std::shared_ptr<Content>);
 	void set_dcp_content_type (DCPContentType const *);
 	void set_container (Ratio const *, bool user_explicit = true);
 	void set_resolution (Resolution, bool user_explicit = true);
 	void set_encrypted (bool);
 	void set_j2k_bandwidth (int);
-	void set_isdcf_metadata (ISDCFMetadata);
 	void set_video_frame_rate (int rate, bool user_explicit = false);
 	void set_audio_channels (int);
 	void set_three_d (bool);
 	void set_isdcf_date_today ();
 	void set_sequence (bool);
 	void set_interop (bool);
+	void set_limit_to_smpte_bv20(bool);
 	void set_audio_processor (AudioProcessor const * processor);
 	void set_reel_type (ReelType);
 	void set_reel_length (int64_t);
@@ -358,19 +413,40 @@ public:
 	void unset_marker (dcp::Marker type);
 	void clear_markers ();
 	void set_ratings (std::vector<dcp::Rating> r);
-	void set_content_version (std::string v);
+	void set_content_versions (std::vector<std::string> v);
+	void set_name_language (dcp::LanguageTag lang);
+	void set_territory_type(TerritoryType type);
+	void set_release_territory (boost::optional<dcp::LanguageTag::RegionSubtag> region = boost::none);
+	void set_sign_language_video_language (boost::optional<dcp::LanguageTag> tag);
+	void set_version_number (int v);
+	void set_status (dcp::Status s);
+	void set_chain (boost::optional<std::string> c = boost::none);
+	void set_facility (boost::optional<std::string> f = boost::none);
+	void set_studio (boost::optional<std::string> s = boost::none);
+	void set_temp_version (bool t);
+	void set_pre_release (bool p);
+	void set_red_band (bool r);
+	void set_two_d_version_of_three_d (bool t);
+	void set_distributor (boost::optional<std::string> d = boost::none);
+	void set_luminance (boost::optional<dcp::Luminance> l = boost::none);
+	void set_audio_language (boost::optional<dcp::LanguageTag> language);
+	void set_audio_frame_rate (int rate);
+
+	void add_ffoc_lfoc (Markers& markers) const;
 
 	/** Emitted when some property has of the Film is about to change or has changed */
-	mutable boost::signals2::signal<void (ChangeType, Property)> Change;
+	mutable boost::signals2::signal<void (ChangeType, FilmProperty)> Change;
 
 	/** Emitted when some property of our content has changed */
-	mutable boost::signals2::signal<void (ChangeType, boost::weak_ptr<Content>, int, bool)> ContentChange;
+	mutable boost::signals2::signal<void (ChangeType, std::weak_ptr<Content>, int, bool)> ContentChange;
 
 	/** Emitted when the film's length might have changed; this is not like a normal
 	    property as its value is derived from the playlist, so it has its own signal.
 	*/
 	mutable boost::signals2::signal<void ()> LengthChange;
 
+	boost::signals2::signal<void (bool)> DirtyChange;
+
 	/** Emitted when we have something important to tell the user */
 	boost::signals2::signal<void (std::string)> Message;
 
@@ -380,34 +456,39 @@ public:
 private:
 
 	friend struct ::isdcf_name_test;
+	friend struct ::isdcf_name_with_atmos;
+	friend struct ::isdcf_name_with_ccap;
 	friend struct ::recover_test_2d_encrypted;
-	template <typename> friend class ChangeSignaller;
+	friend struct ::atmos_encrypted_passthrough_test;
+	friend struct ::ov_subs_in_vf_name;
+	template <class, class> friend class ChangeSignalDespatcher;
 
 	boost::filesystem::path info_file (dcpomatic::DCPTimePeriod p) const;
 
-	void signal_change (ChangeType, Property);
+	void signal_change (ChangeType, FilmProperty);
 	void signal_change (ChangeType, int);
 	std::string video_identifier () const;
 	void playlist_change (ChangeType);
 	void playlist_order_changed ();
-	void playlist_content_change (ChangeType type, boost::weak_ptr<Content>, int, bool frequent);
+	void playlist_content_change (ChangeType type, std::weak_ptr<Content>, int, bool frequent);
 	void playlist_length_change ();
-	void maybe_add_content (boost::weak_ptr<Job>, boost::weak_ptr<Content>, bool disable_audio_analysis);
+	void maybe_add_content (std::weak_ptr<Job>, std::weak_ptr<Content>, bool disable_audio_analysis);
 	void audio_analysis_finished ();
 	void check_settings_consistency ();
 	void maybe_set_container_and_resolution ();
-
-	static std::string const metadata_file;
+	void set_dirty (bool dirty);
 
 	/** Log to write to */
-	boost::shared_ptr<Log> _log;
-	boost::shared_ptr<Playlist> _playlist;
+	std::shared_ptr<Log> _log;
+	std::shared_ptr<Playlist> _playlist;
 
 	/** Complete path to directory containing the film metadata;
 	 *  must not be relative.
 	 */
 	boost::optional<boost::filesystem::path> _directory;
 
+	boost::optional<std::string> _last_written_by;
+
 	/** Name for DCP-o-matic */
 	std::string _name;
 	/** True if a auto-generated ISDCF-compliant name should be used for our DCP */
@@ -426,8 +507,6 @@ private:
 	std::string _context_id;
 	/** bandwidth for J2K files in bits per second */
 	int _j2k_bandwidth;
-	/** ISDCF naming stuff */
-	ISDCFMetadata _isdcf_metadata;
 	/** Frames per second to run our DCP at */
 	int _video_frame_rate;
 	/** The date that we should use in a ISDCF name */
@@ -440,6 +519,7 @@ private:
 	bool _three_d;
 	bool _sequence;
 	bool _interop;
+	bool _limit_to_smpte_bv20;
 	AudioProcessor const * _audio_processor;
 	ReelType _reel_type;
 	/** Desired reel length in bytes, if _reel_type == REELTYPE_BY_LENGTH */
@@ -451,14 +531,31 @@ private:
 	bool _user_explicit_resolution;
 	std::map<dcp::Marker, dcpomatic::DCPTime> _markers;
 	std::vector<dcp::Rating> _ratings;
-	std::string _content_version;
+	std::vector<std::string> _content_versions;
+	dcp::LanguageTag _name_language;
+	TerritoryType _territory_type = TerritoryType::SPECIFIC;
+	boost::optional<dcp::LanguageTag::RegionSubtag> _release_territory;
+	boost::optional<dcp::LanguageTag> _sign_language_video_language;
+	int _version_number;
+	dcp::Status _status;
+	boost::optional<std::string> _chain;
+	boost::optional<std::string> _distributor;
+	boost::optional<std::string> _facility;
+	boost::optional<std::string> _studio;
+	bool _temp_version = false;
+	bool _pre_release = false;
+	bool _red_band = false;
+	bool _two_d_version_of_three_d = false;
+	boost::optional<dcp::Luminance> _luminance;
+	boost::optional<dcp::LanguageTag> _audio_language;
+	int _audio_frame_rate = 48000;
 
 	int _state_version;
 
 	/** true if our state has changed since we last saved it */
 	mutable bool _dirty;
 	/** film being used as a template, or 0 */
-	boost::shared_ptr<Film> _template_film;
+	std::shared_ptr<Film> _template_film;
 
 	/** Be tolerant of errors in content (currently applies to DCP only).
 	    Not saved as state.
@@ -478,4 +575,8 @@ private:
 	friend struct film_metadata_test;
 };
 
+
+typedef ChangeSignaller<Film, FilmProperty> FilmChangeSignaller;
+
+
 #endif