Remove unused forward declaration.
[dcpomatic.git] / src / lib / film.h
index a28d81b6fafc411a418577cedfafa787003a4ba9..5bf6c55f7b12a7898dd6afe62f24e3b7b9886f97 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2019 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2020 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
@@ -36,7 +36,9 @@
 #include <dcp/encrypted_kdm.h>
 #include <boost/signals2.hpp>
 #include <boost/enable_shared_from_this.hpp>
+#include <boost/thread.hpp>
 #include <boost/filesystem.hpp>
+#include <boost/thread/mutex.hpp>
 #include <string>
 #include <vector>
 #include <inttypes.h>
@@ -55,16 +57,38 @@ class Content;
 class Playlist;
 class AudioContent;
 class AudioProcessor;
-class AudioMapping;
 class Ratio;
 class Job;
-class ScreenKDM;
+class Film;
 struct isdcf_name_test;
 
+class InfoFileHandle
+{
+public:
+       ~InfoFileHandle ();
+
+       FILE* get () const {
+               return _handle;
+       }
+
+       boost::filesystem::path file () const {
+               return _file;
+       }
+
+private:
+       friend class Film;
+
+       InfoFileHandle (boost::mutex& mutex, boost::filesystem::path file, bool read);
+
+       boost::mutex::scoped_lock _lock;
+       FILE* _handle;
+       boost::filesystem::path _file;
+};
+
 /** @class Film
  *
- *  @brief A representation of some audio and video content, and details of
- *  how they should be presented in a DCP.
+ *  @brief A representation of some audio, video, subtitle and closed-caption content,
+ *  and details of how they should be presented in a DCP.
  *
  *  The content of a Film is held in a Playlist (created and managed by the Film).
  */
@@ -74,12 +98,13 @@ public:
        explicit Film (boost::optional<boost::filesystem::path> dir);
        ~Film ();
 
-       boost::filesystem::path info_file (dcpomatic::DCPTimePeriod p) const;
+       boost::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;
        boost::filesystem::path internal_video_asset_filename (dcpomatic::DCPTimePeriod p) const;
 
        boost::filesystem::path audio_analysis_path (boost::shared_ptr<const Playlist>) const;
+       boost::filesystem::path subtitle_analysis_path (boost::shared_ptr<const Content>) const;
 
        void send_dcp_to_tms ();
        void make_dcp (bool gui = false, bool check = true);
@@ -142,16 +167,6 @@ public:
                boost::optional<int> disable_forensic_marking_audio
                ) const;
 
-       std::list<boost::shared_ptr<ScreenKDM> > make_kdms (
-               std::list<boost::shared_ptr<dcpomatic::Screen> > screens,
-               boost::filesystem::path cpl_file,
-               boost::posix_time::ptime from,
-               boost::posix_time::ptime until,
-               dcp::Formulation formulation,
-               bool disable_forensic_marking_picture,
-               boost::optional<int> disable_forensic_marking_audio
-               ) const;
-
        int state_version () const {
                return _state_version;
        }
@@ -174,6 +189,14 @@ public:
        bool references_dcp_video () const;
        bool references_dcp_audio () const;
 
+       void set_tolerant (bool t) {
+               _tolerant = t;
+       }
+
+       bool tolerant () const {
+               return _tolerant;
+       }
+
        /** Identifiers for the parts of our state;
            used for signalling changes.
        */
@@ -205,7 +228,8 @@ public:
                UPLOAD_AFTER_MAKE_DCP,
                REENCODE_J2K,
                MARKERS,
-               RATINGS
+               RATINGS,
+               CONTENT_VERSION
        };
 
 
@@ -310,6 +334,10 @@ public:
                return _ratings;
        }
 
+       std::string content_version () const {
+               return _content_version;
+       }
+
        /* SET */
 
        void set_directory (boost::filesystem::path);
@@ -322,8 +350,8 @@ public:
        void move_content_earlier (boost::shared_ptr<Content>);
        void move_content_later (boost::shared_ptr<Content>);
        void set_dcp_content_type (DCPContentType const *);
-       void set_container (Ratio const *);
-       void set_resolution (Resolution);
+       void set_container (Ratio const *, bool user_explicit = true);
+       void set_resolution (Resolution, bool user_explicit = true);
        void set_signed (bool);
        void set_encrypted (bool);
        void set_key (dcp::Key key);
@@ -342,7 +370,9 @@ public:
        void set_reencode_j2k (bool);
        void set_marker (dcp::Marker type, dcpomatic::DCPTime time);
        void unset_marker (dcp::Marker type);
+       void clear_markers ();
        void set_ratings (std::vector<dcp::Rating> r);
+       void set_content_version (std::string v);
 
        /** Emitted when some property has of the Film is about to change or has changed */
        mutable boost::signals2::signal<void (ChangeType, Property)> Change;
@@ -350,6 +380,11 @@ public:
        /** Emitted when some property of our content has changed */
        mutable boost::signals2::signal<void (ChangeType, boost::weak_ptr<Content>, int, bool)> ContentChange;
 
+       /** Emitted when the film's length might have changed; this is not like a normal
+           property as its value is derived from the playlist, so it has its own signal.
+       */
+       mutable boost::signals2::signal<void ()> LengthChange;
+
        /** Emitted when we have something important to tell the user */
        boost::signals2::signal<void (std::string)> Message;
 
@@ -361,14 +396,19 @@ private:
        friend struct ::isdcf_name_test;
        template <typename> friend class ChangeSignaller;
 
+       boost::filesystem::path info_file (dcpomatic::DCPTimePeriod p) const;
+
        void signal_change (ChangeType, Property);
        void signal_change (ChangeType, int);
        std::string video_identifier () const;
        void playlist_change (ChangeType);
        void playlist_order_changed ();
        void playlist_content_change (ChangeType type, boost::weak_ptr<Content>, int, bool frequent);
+       void playlist_length_change ();
        void maybe_add_content (boost::weak_ptr<Job>, boost::weak_ptr<Content>, bool disable_audio_analysis);
        void audio_analysis_finished ();
+       void check_settings_consistency ();
+       void maybe_set_container_and_resolution ();
 
        static std::string const metadata_file;
 
@@ -422,8 +462,11 @@ private:
        bool _reencode_j2k;
        /** true if the user has ever explicitly set the video frame rate of this film */
        bool _user_explicit_video_frame_rate;
+       bool _user_explicit_container;
+       bool _user_explicit_resolution;
        std::map<dcp::Marker, dcpomatic::DCPTime> _markers;
        std::vector<dcp::Rating> _ratings;
+       std::string _content_version;
 
        int _state_version;
 
@@ -432,9 +475,17 @@ private:
        /** film being used as a template, or 0 */
        boost::shared_ptr<Film> _template_film;
 
+       /** Be tolerant of errors in content (currently applies to DCP only).
+           Not saved as state.
+       */
+       bool _tolerant;
+
+       mutable boost::mutex _info_file_mutex;
+
        boost::signals2::scoped_connection _playlist_change_connection;
        boost::signals2::scoped_connection _playlist_order_changed_connection;
        boost::signals2::scoped_connection _playlist_content_change_connection;
+       boost::signals2::scoped_connection _playlist_length_change_connection;
        std::list<boost::signals2::connection> _job_connections;
        std::list<boost::signals2::connection> _audio_analysis_connections;