Move luminance to Interop/SMPTE metadata and remove the ISDCF metadata dialogue.

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

diff --git a/src/lib/film.h b/src/lib/film.h
index 6828df21aa366cad9e7506cedad0b5925a9d2dff..5fc56acfb0613570bc29b1067181703cc03b5319 100644 (file)
--- 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.
 
@@ -26,22 +26,22 @@
 #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 "frame_rate_change.h"
 #include "signaller.h"
-#include "dcp_text_track.h"
-#include <dcp/language_tag.h>
-#include <dcp/key.h>
+#include "types.h"
+#include "util.h"
 #include <dcp/encrypted_kdm.h>
+#include <dcp/key.h>
+#include <dcp/language_tag.h>
+#include <boost/filesystem.hpp>
 #include <boost/signals2.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;
@@ -183,6 +183,8 @@ public:
 
        std::list<dcpomatic::DCPTimePeriod> reels () const;
        std::list<int> mapped_audio_channels () const;
+       std::vector<dcp::LanguageTag> audio_languages () const;
+       std::pair<boost::optional<dcp::LanguageTag>, std::vector<dcp::LanguageTag>> subtitle_languages () const;
 
        std::string content_summary (dcpomatic::DCPTimePeriod period) const;
 
@@ -201,7 +203,7 @@ public:
        /** Identifiers for the parts of our state;
            used for signalling changes.
        */
-       enum Property {
+       enum class Property {
                NONE,
                NAME,
                USE_ISDCF_NAME,
@@ -214,7 +216,6 @@ public:
                RESOLUTION,
                ENCRYPTED,
                J2K_BANDWIDTH,
-               ISDCF_METADATA,
                VIDEO_FRAME_RATE,
                AUDIO_CHANNELS,
                /** The setting of _three_d has changed */
@@ -236,8 +237,12 @@ public:
                CHAIN,
                DISTRIBUTOR,
                FACILITY,
+               STUDIO,
+               TEMP_VERSION,
+               PRE_RELEASE,
+               RED_BAND,
+               TWO_D_VERSION_OF_THREE_D,
                LUMINANCE,
-               SUBTITLE_LANGUAGES
        };
 
 
@@ -279,10 +284,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;
@@ -347,7 +348,7 @@ public:
                return _audio_language;
        }
 
-       dcp::LanguageTag::RegionSubtag release_territory () const {
+       boost::optional<dcp::LanguageTag::RegionSubtag> release_territory () const {
                return _release_territory;
        }
 
@@ -359,24 +360,40 @@ public:
                return _status;
        }
 
-       std::string chain () const {
+       boost::optional<std::string> chain () const {
                return _chain;
        }
 
-       std::string distributor () const {
+       boost::optional<std::string> distributor () const {
                return _distributor;
        }
 
-       std::string facility () const {
+       boost::optional<std::string> facility () const {
                return _facility;
        }
 
-       dcp::Luminance luminance () const {
-               return _luminance;
+       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;
        }
 
-       std::vector<dcp::LanguageTag> subtitle_languages () const {
-               return _subtitle_languages;
+       boost::optional<dcp::Luminance> luminance () const {
+               return _luminance;
        }
 
        /* SET */
@@ -395,7 +412,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);
@@ -413,16 +429,18 @@ public:
        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 (dcp::LanguageTag::RegionSubtag region);
+       void set_release_territory (boost::optional<dcp::LanguageTag::RegionSubtag> region = boost::none);
        void set_version_number (int v);
        void set_status (dcp::Status s);
-       void set_chain (std::string c);
-       void set_facility (std::string f);
-       void set_distributor (std::string d);
-       void set_luminance (dcp::Luminance l);
-       void set_subtitle_language (dcp::LanguageTag language);
-       void unset_subtitle_language ();
-       void set_subtitle_languages (std::vector<dcp::LanguageTag> languages);
+       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 add_ffoc_lfoc (Markers& markers) const;
 
@@ -448,7 +466,7 @@ private:
        friend struct ::isdcf_name_test;
        friend struct ::recover_test_2d_encrypted;
        friend struct ::atmos_encrypted_passthrough_test;
-       template <typename> friend class ChangeSignaller;
+       template <class, class> friend class ChangeSignaller;
 
        boost::filesystem::path info_file (dcpomatic::DCPTimePeriod p) const;
 
@@ -493,8 +511,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 */
@@ -521,14 +537,18 @@ private:
        std::vector<std::string> _content_versions;
        dcp::LanguageTag _name_language;
        dcp::LanguageTag _audio_language;
-       dcp::LanguageTag::RegionSubtag _release_territory;
+       boost::optional<dcp::LanguageTag::RegionSubtag> _release_territory;
        int _version_number;
        dcp::Status _status;
-       std::string _chain;
-       std::string _distributor;
-       std::string _facility;
-       dcp::Luminance _luminance;
-       std::vector<dcp::LanguageTag> _subtitle_languages;
+       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;
 
        int _state_version;
 
@@ -555,4 +575,8 @@ private:
        friend struct film_metadata_test;
 };
 
+
+typedef ChangeSignaller<Film, Film::Property> FilmChangeSignaller;
+
+
 #endif