Use plain git hash for VERSION when there is no exact tag.
[dcpomatic.git] / src / lib / film.h
index 55bbb406959a65167626c894515ec99833f0b5d9..43a41ad45d5a43fbeaf92accdea2595e9155e6db 100644 (file)
 
 */
 
+
 /** @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 "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 "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/thread.hpp>
@@ -45,6 +55,7 @@
 #include <string>
 #include <vector>
 
+
 namespace xmlpp {
        class Document;
 }
@@ -53,30 +64,29 @@ 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
 {
 public:
        InfoFileHandle (boost::mutex& mutex, boost::filesystem::path file, bool read);
-       ~InfoFileHandle ();
-
-       FILE* get () const {
-               return _handle;
-       }
 
-       boost::filesystem::path file () const {
+       dcp::File& get () {
                return _file;
        }
 
@@ -84,10 +94,10 @@ private:
        friend class Film;
 
        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,
@@ -113,7 +123,6 @@ public:
        boost::filesystem::path subtitle_analysis_path (std::shared_ptr<const Content>) const;
 
        void send_dcp_to_tms ();
-       void make_dcp (TranscodeJob::ChangedBehaviour behaviour);
 
        /** @return Logger.
         *  It is safe to call this from any thread.
@@ -127,7 +136,7 @@ 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;
        std::shared_ptr<xmlpp::Document> metadata (bool with_content_paths = true) const;
@@ -148,8 +157,6 @@ public:
 
        std::vector<CPLSummary> cpls () const;
 
-       int audio_frame_rate () const;
-
        std::list<DCPTextTrack> closed_caption_tracks () const;
 
        uint64_t required_disk_space () const;
@@ -165,16 +172,7 @@ 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;
@@ -195,8 +193,12 @@ public:
                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;
 
        std::string content_summary (dcpomatic::DCPTimePeriod period) const;
 
@@ -212,52 +214,7 @@ public:
                return _tolerant;
        }
 
-       /** Identifiers for the parts of our state;
-           used for signalling changes.
-       */
-       enum class 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,
-               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_VERSIONS,
-               NAME_LANGUAGE,
-               AUDIO_LANGUAGE,
-               RELEASE_TERRITORY,
-               SIGN_LANGUAGE_VIDEO_LANGUAGE,
-               VERSION_NUMBER,
-               STATUS,
-               CHAIN,
-               DISTRIBUTOR,
-               FACILITY,
-               STUDIO,
-               TEMP_VERSION,
-               PRE_RELEASE,
-               RED_BAND,
-               TWO_D_VERSION_OF_THREE_D,
-               LUMINANCE,
-       };
-
+       bool last_written_by_earlier_than(int major, int minor, int micro) const;
 
        /* GET */
 
@@ -318,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;
        }
@@ -357,6 +318,10 @@ public:
                return _name_language;
        }
 
+       TerritoryType territory_type() const {
+               return _territory_type;
+       }
+
        boost::optional<dcp::LanguageTag::RegionSubtag> release_territory () const {
                return _release_territory;
        }
@@ -413,6 +378,9 @@ public:
                return _isdcf_date;
        }
 
+       int audio_frame_rate () const {
+               return _audio_frame_rate;
+       }
 
        /* SET */
 
@@ -436,6 +404,7 @@ public:
        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);
@@ -446,6 +415,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);
@@ -460,11 +430,12 @@ public:
        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, std::weak_ptr<Content>, int, bool)> ContentChange;
@@ -474,6 +445,8 @@ public:
        */
        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;
 
@@ -483,13 +456,16 @@ 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;
        friend struct ::atmos_encrypted_passthrough_test;
-       template <class, class> friend class ChangeSignaller;
+       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);
@@ -500,6 +476,7 @@ private:
        void audio_analysis_finished ();
        void check_settings_consistency ();
        void maybe_set_container_and_resolution ();
+       void set_dirty (bool dirty);
 
        /** Log to write to */
        std::shared_ptr<Log> _log;
@@ -510,6 +487,8 @@ private:
         */
        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 */
@@ -540,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 */
@@ -553,6 +533,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;
@@ -567,6 +548,7 @@ private:
        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;
 
@@ -594,7 +576,7 @@ private:
 };
 
 
-typedef ChangeSignaller<Film, Film::Property> FilmChangeSignaller;
+typedef ChangeSignaller<Film, FilmProperty> FilmChangeSignaller;
 
 
 #endif