Fix isdcf name ATMOS test.
[dcpomatic.git] / src / lib / film.h
index 6b50bba5e9759a2ffd39e83dce4f988863bb3451..babc14a295c2d75cba261cf56c1dd2120ccdb03a 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 "frame_rate_change.h"
-#include "isdcf_metadata.h"
+#include "named_channel.h"
+#include "resolution.h"
 #include "signaller.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 <boost/filesystem.hpp>
 #include <boost/signals2.hpp>
 #include <boost/thread.hpp>
@@ -44,6 +52,7 @@
 #include <string>
 #include <vector>
 
+
 namespace xmlpp {
        class Document;
 }
@@ -62,20 +71,17 @@ class Ratio;
 class Job;
 class Film;
 struct isdcf_name_test;
+struct isdcf_name_with_atmos;
 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;
        }
 
@@ -83,10 +89,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,
@@ -94,12 +100,15 @@ private:
  *
  *  The content of a Film is held in a Playlist (created and managed by the Film).
  */
-class Film : public std::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 ();
 
+       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;
@@ -109,7 +118,6 @@ public:
        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.
@@ -123,7 +131,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;
@@ -144,13 +152,13 @@ public:
 
        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;
@@ -184,7 +192,12 @@ public:
 
        std::list<dcpomatic::DCPTimePeriod> reels () const;
        std::list<int> mapped_audio_channels () const;
-       std::vector<dcp::LanguageTag> audio_languages () 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;
 
        std::string content_summary (dcpomatic::DCPTimePeriod period) const;
@@ -201,6 +214,8 @@ public:
                return _tolerant;
        }
 
+       bool last_written_by_earlier_than(int major, int minor, int micro) const;
+
        /** Identifiers for the parts of our state;
            used for signalling changes.
        */
@@ -217,8 +232,8 @@ public:
                RESOLUTION,
                ENCRYPTED,
                J2K_BANDWIDTH,
-               ISDCF_METADATA,
                VIDEO_FRAME_RATE,
+               AUDIO_FRAME_RATE,
                AUDIO_CHANNELS,
                /** The setting of _three_d has changed */
                THREE_D,
@@ -234,11 +249,17 @@ public:
                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,
        };
 
@@ -281,10 +302,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;
@@ -345,14 +362,14 @@ public:
                return _name_language;
        }
 
-       dcp::LanguageTag audio_language () const {
-               return _audio_language;
-       }
-
        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;
        }
@@ -373,10 +390,38 @@ public:
                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 */
 
        void set_directory (boost::filesystem::path);
@@ -393,7 +438,6 @@ public:
        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);
@@ -410,14 +454,21 @@ 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_audio_language (dcp::LanguageTag lang);
        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;
 
@@ -432,6 +483,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;
 
@@ -441,6 +494,7 @@ public:
 private:
 
        friend struct ::isdcf_name_test;
+       friend struct ::isdcf_name_with_atmos;
        friend struct ::recover_test_2d_encrypted;
        friend struct ::atmos_encrypted_passthrough_test;
        template <class, class> friend class ChangeSignaller;
@@ -458,8 +512,7 @@ private:
        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 */
        std::shared_ptr<Log> _log;
@@ -470,6 +523,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 */
@@ -488,8 +543,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 */
@@ -515,14 +568,21 @@ private:
        std::vector<dcp::Rating> _ratings;
        std::vector<std::string> _content_versions;
        dcp::LanguageTag _name_language;
-       dcp::LanguageTag _audio_language;
        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;