Various Doxygen fixes.

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

diff --git a/src/lib/film.h b/src/lib/film.h
index ca0855b5c2e58d5670394fcf2ca513c9f82a4350..9f473d7110b914866e21e443b2b9918eb90b44d8 100644 (file)
--- a/src/lib/film.h
+++ b/src/lib/film.h
@@ -47,7 +47,6 @@ namespace xmlpp {
 class DCPContentType;
 class Log;
 class Content;
-class Player;
 class Playlist;
 class AudioContent;
 class Screen;
@@ -68,7 +67,7 @@ struct isdcf_name_test;
 class Film : public boost::enable_shared_from_this<Film>, public Signaller, public boost::noncopyable
 {
 public:
-       Film (boost::filesystem::path, bool log = true);
+       Film (boost::optional<boost::filesystem::path> dir);
        ~Film ();
 
        boost::filesystem::path info_file (DCPTimePeriod p) const;
@@ -89,11 +88,13 @@ public:
        }
 
        boost::filesystem::path file (boost::filesystem::path f) const;
-       boost::filesystem::path dir (boost::filesystem::path d) const;
+       boost::filesystem::path dir (boost::filesystem::path d, bool create = true) const;
 
-       std::list<std::string> read_metadata ();
+       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;
-       boost::shared_ptr<xmlpp::Document> metadata () const;
+       void write_template (boost::filesystem::path path) const;
+       boost::shared_ptr<xmlpp::Document> metadata (bool with_content_paths = true) const;
 
        std::string isdcf_name (bool if_created_now) const;
        std::string dcp_name (bool if_created_now = false) const;
@@ -120,8 +121,7 @@ public:
        int best_video_frame_rate () const;
        FrameRateChange active_frame_rate_change (DCPTime) const;
 
-       dcp::EncryptedKDM
-       make_kdm (
+       dcp::EncryptedKDM make_kdm (
                dcp::Certificate recipient,
                std::vector<dcp::Certificate> trusted_devices,
                boost::filesystem::path cpl_file,
@@ -131,7 +131,7 @@ public:
                ) const;
 
        std::list<ScreenKDM> make_kdms (
-               std::list<boost::shared_ptr<Screen> >,
+               std::list<boost::shared_ptr<Screen> > screens,
                boost::filesystem::path cpl_file,
                boost::posix_time::ptime from,
                boost::posix_time::ptime until,
@@ -158,9 +158,12 @@ public:
        }
 
        std::list<DCPTimePeriod> reels () const;
-
        std::list<int> mapped_audio_channels () const;
 
+       std::string content_summary (DCPTimePeriod period) const;
+
+       std::list<std::string> fix_conflicting_settings ();
+
        /** Identifiers for the parts of our state;
            used for signalling changes.
        */
@@ -195,7 +198,7 @@ public:
 
        /* GET */
 
-       boost::filesystem::path directory () const {
+       boost::optional<boost::filesystem::path> directory () const {
                return _directory;
        }
 
@@ -277,12 +280,16 @@ public:
                return _upload_after_make_dcp;
        }
 
+       std::string context_id () const {
+               return _context_id;
+       }
+
+
        /* SET */
 
        void set_directory (boost::filesystem::path);
        void set_name (std::string);
        void set_use_isdcf_name (bool);
-       void examine_content (boost::shared_ptr<Content>);
        void examine_and_add_content (boost::shared_ptr<Content>);
        void add_content (boost::shared_ptr<Content>);
        void remove_content (boost::shared_ptr<Content>);
@@ -336,7 +343,7 @@ private:
        /** Complete path to directory containing the film metadata;
         *  must not be relative.
         */
-       boost::filesystem::path _directory;
+       boost::optional<boost::filesystem::path> _directory;
 
        /** Name for DCP-o-matic */
        std::string _name;
@@ -351,6 +358,10 @@ private:
        bool _signed;
        bool _encrypted;
        dcp::Key _key;
+       /** context ID used when encrypting picture assets; we keep it so that we can
+        *  re-start picture MXF encodes.
+        */
+       std::string _context_id;
        /** bandwidth for J2K files in bits per second */
        int _j2k_bandwidth;
        /** ISDCF naming stuff */
@@ -377,6 +388,8 @@ private:
 
        /** 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;
 
        boost::signals2::scoped_connection _playlist_changed_connection;
        boost::signals2::scoped_connection _playlist_order_changed_connection;