Add custom reels option to Film.

[dcpomatic.git] / src / lib / film.h

diff --git a/src/lib/film.h b/src/lib/film.h
index 5c230614decc9fe657afd52bccc13d2b20ccb061..0a0c5a4e1dcadd716af7197d3335eeb185ca0821 100644 (file)
--- a/src/lib/film.h
+++ b/src/lib/film.h
@@ -37,6 +37,7 @@
 #include "named_channel.h"
 #include "resolution.h"
 #include "signaller.h"
+#include "territory_type.h"
 #include "transcode_job.h"
 #include "types.h"
 #include "util.h"
@@ -63,19 +64,21 @@ 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;
-struct atmos_encrypted_passthrough_test;
 
 
 class InfoFileHandle
@@ -183,15 +186,17 @@ public:
                return _playlist;
        }
 
-       std::list<dcpomatic::DCPTimePeriod> reels () const;
+       std::vector<dcpomatic::DCPTimePeriod> reels() const;
        std::list<int> mapped_audio_channels () const;
 
        boost::optional<dcp::LanguageTag> audio_language () const {
                return _audio_language;
        }
 
-       /** @return pair containing the main subtitle language, and additional languages */
-       std::pair<boost::optional<dcp::LanguageTag>, std::vector<dcp::LanguageTag>> subtitle_languages () const;
+       /** @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;
 
@@ -286,6 +291,10 @@ public:
                return _reel_length;
        }
 
+       std::vector<dcpomatic::DCPTime> custom_reel_boundaries() const {
+               return _custom_reel_boundaries;
+       }
+
        std::string context_id () const {
                return _context_id;
        }
@@ -313,6 +322,10 @@ public:
                return _name_language;
        }
 
+       TerritoryType territory_type() const {
+               return _territory_type;
+       }
+
        boost::optional<dcp::LanguageTag::RegionSubtag> release_territory () const {
                return _release_territory;
        }
@@ -399,6 +412,7 @@ public:
        void set_audio_processor (AudioProcessor const * processor);
        void set_reel_type (ReelType);
        void set_reel_length (int64_t);
+       void set_custom_reel_boundaries(std::vector<dcpomatic::DCPTime> boundaries);
        void set_reencode_j2k (bool);
        void set_marker (dcp::Marker type, dcpomatic::DCPTime time);
        void unset_marker (dcp::Marker type);
@@ -406,6 +420,7 @@ public:
        void set_ratings (std::vector<dcp::Rating> r);
        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);
@@ -424,6 +439,10 @@ public:
 
        void add_ffoc_lfoc (Markers& markers) const;
 
+       void set_ui_state(std::string key, std::string value);
+       boost::optional<std::string> ui_state(std::string key) const;
+       void read_ui_state();
+
        /** Emitted when some property has of the Film is about to change or has changed */
        mutable boost::signals2::signal<void (ChangeType, FilmProperty)> Change;
 
@@ -447,8 +466,10 @@ private:
 
        friend struct ::isdcf_name_test;
        friend struct ::isdcf_name_with_atmos;
+       friend struct ::isdcf_name_with_ccap;
        friend struct ::recover_test_2d_encrypted;
        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;
@@ -465,6 +486,7 @@ private:
        void check_settings_consistency ();
        void maybe_set_container_and_resolution ();
        void set_dirty (bool dirty);
+       void write_ui_state() const;
 
        /** Log to write to */
        std::shared_ptr<Log> _log;
@@ -510,8 +532,10 @@ private:
        bool _limit_to_smpte_bv20;
        AudioProcessor const * _audio_processor;
        ReelType _reel_type;
-       /** Desired reel length in bytes, if _reel_type == REELTYPE_BY_LENGTH */
+       /** Desired reel length in bytes, if _reel_type == BY_LENGTH */
        int64_t _reel_length;
+       /** Reel boundaries (excluding those at the start and end, sorted in ascending order) if _reel_type == CUSTOM */
+       std::vector<dcpomatic::DCPTime> _custom_reel_boundaries;
        bool _reencode_j2k;
        /** true if the user has ever explicitly set the video frame rate of this film */
        bool _user_explicit_video_frame_rate;
@@ -521,6 +545,7 @@ private:
        std::vector<dcp::Rating> _ratings;
        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;
@@ -549,6 +574,8 @@ private:
        */
        bool _tolerant;
 
+       std::map<std::string, std::string> _ui_state;
+
        mutable boost::mutex _info_file_mutex;
 
        boost::signals2::scoped_connection _playlist_change_connection;