Extract part of the content change job to Content.
[dcpomatic.git] / src / lib / content.h
index ea2aaf8d40e7e43f9b413315a51d2aeb286214d7..d17b0d0e5a22f86360e8a678073add3a620f9084 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2013-2016 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2021 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
 
 */
 
+
 /** @file  src/lib/content.h
  *  @brief Content class.
  */
 
+
 #ifndef DCPOMATIC_CONTENT_H
 #define DCPOMATIC_CONTENT_H
 
 #include "types.h"
 #include "signaller.h"
 #include "dcpomatic_time.h"
-#include "raw_convert.h"
+#include "change_signaller.h"
 #include "user_property.h"
 #include <libcxml/cxml.h>
 #include <boost/filesystem.hpp>
 #include <boost/signals2.hpp>
 #include <boost/thread/mutex.hpp>
-#include <boost/enable_shared_from_this.hpp>
+
 
 namespace xmlpp {
        class Node;
@@ -46,6 +48,7 @@ namespace cxml {
 
 class Job;
 class Film;
+class AtmosContent;
 
 class ContentProperty
 {
@@ -58,24 +61,30 @@ public:
        static int const VIDEO_FRAME_RATE;
 };
 
+
 /** @class Content
  *  @brief A piece of content represented by one or more files on disk.
  */
-class Content : public boost::enable_shared_from_this<Content>, public Signaller, public boost::noncopyable
+class Content : public std::enable_shared_from_this<Content>, public Signaller
 {
 public:
-       Content (boost::shared_ptr<const Film>);
-       Content (boost::shared_ptr<const Film>, DCPTime);
-       Content (boost::shared_ptr<const Film>, boost::filesystem::path);
-       Content (boost::shared_ptr<const Film>, cxml::ConstNodePtr);
-       Content (boost::shared_ptr<const Film>, std::vector<boost::shared_ptr<Content> >);
+       explicit Content ();
+       Content (dcpomatic::DCPTime);
+       Content (boost::filesystem::path);
+       Content (cxml::ConstNodePtr);
+       Content (std::vector<std::shared_ptr<Content>>);
        virtual ~Content () {}
 
+       Content (Content const&) = delete;
+       Content& operator= (Content const&) = delete;
+
        /** Examine the content to establish digest, frame rates and any other
         *  useful metadata.
         *  @param job Job to use to report progress, or 0.
         */
-       virtual void examine (boost::shared_ptr<Job> job);
+       virtual void examine (std::shared_ptr<const Film> film, std::shared_ptr<Job> job);
+
+       virtual void take_settings_from (std::shared_ptr<const Content> c);
 
        /** @return Quick one-line summary of the content, as will be presented in the
         *  film editor.
@@ -87,17 +96,18 @@ public:
         */
        virtual std::string technical_summary () const;
 
-       virtual void as_xml (xmlpp::Node *) const;
-       virtual DCPTime full_length () const = 0;
+       virtual void as_xml (xmlpp::Node *, bool with_paths) const;
+       virtual dcpomatic::DCPTime full_length (std::shared_ptr<const Film>) const = 0;
+       virtual dcpomatic::DCPTime approximate_length () const = 0;
        virtual std::string identifier () const;
        /** @return points at which to split this content when
         *  REELTYPE_BY_VIDEO_CONTENT is in use.
         */
-       virtual std::list<DCPTime> reel_split_points () const;
+       virtual std::list<dcpomatic::DCPTime> reel_split_points (std::shared_ptr<const Film>) const;
 
-       boost::shared_ptr<Content> clone () const;
+       std::shared_ptr<Content> clone () const;
 
-       void set_path (boost::filesystem::path);
+       void set_paths (std::vector<boost::filesystem::path> paths);
 
        std::string path_summary () const;
 
@@ -116,47 +126,52 @@ public:
                return _paths[i];
        }
 
+       std::time_t last_write_time (size_t i) const {
+               boost::mutex::scoped_lock lm (_mutex);
+               return _last_write_times[i];
+       }
+
        bool paths_valid () const;
 
        /** @return Digest of the content's file(s).  Note: this is
         *  not a complete MD5-or-whatever hash, but a sort of poor
-        *  man's version (see comments in ::examine).
+        *  man's version (see comments in examine()).
         */
        std::string digest () const {
                boost::mutex::scoped_lock lm (_mutex);
                return _digest;
        }
 
-       void set_position (DCPTime);
+       void set_position (std::shared_ptr<const Film> film, dcpomatic::DCPTime, bool force_emit = false);
 
-       /** DCPTime that this content starts; i.e. the time that the first
+       /** dcpomatic::DCPTime that this content starts; i.e. the time that the first
         *  bit of the content (trimmed or not) will happen.
         */
-       DCPTime position () const {
+       dcpomatic::DCPTime position () const {
                boost::mutex::scoped_lock lm (_mutex);
                return _position;
        }
 
-       void set_trim_start (ContentTime);
+       void set_trim_start (dcpomatic::ContentTime);
 
-       ContentTime trim_start () const {
+       dcpomatic::ContentTime trim_start () const {
                boost::mutex::scoped_lock lm (_mutex);
                return _trim_start;
        }
 
-       void set_trim_end (ContentTime);
+       void set_trim_end (dcpomatic::ContentTime);
 
-       ContentTime trim_end () const {
+       dcpomatic::ContentTime trim_end () const {
                boost::mutex::scoped_lock lm (_mutex);
                return _trim_end;
        }
 
        /** @return Time immediately after the last thing in this content */
-       DCPTime end () const {
-               return position() + length_after_trim();
+       dcpomatic::DCPTime end (std::shared_ptr<const Film> film) const {
+               return position() + length_after_trim(film);
        }
 
-       DCPTime length_after_trim () const;
+       dcpomatic::DCPTime length_after_trim (std::shared_ptr<const Film> film) const;
 
        boost::optional<double> video_frame_rate () const {
                boost::mutex::scoped_lock lm (_mutex);
@@ -164,49 +179,60 @@ public:
        }
 
        void set_video_frame_rate (double r);
+       void unset_video_frame_rate ();
 
-       double active_video_frame_rate () const;
+       double active_video_frame_rate (std::shared_ptr<const Film> film) const;
 
        void set_change_signals_frequent (bool f) {
                _change_signals_frequent = f;
        }
 
-       boost::shared_ptr<const Film> film () const;
+       std::list<UserProperty> user_properties (std::shared_ptr<const Film> film) const;
 
-       std::list<UserProperty> user_properties () const;
+       std::string calculate_digest () const;
 
-       boost::signals2::signal<void (boost::weak_ptr<Content>, int, bool)> Changed;
+       /* ChangeType::PENDING and ChangeType::CANCELLED may be emitted from any thread; ChangeType::DONE always from GUI thread */
+       boost::signals2::signal<void (ChangeType, std::weak_ptr<Content>, int, bool)> Change;
 
-       boost::shared_ptr<VideoContent> video;
-       boost::shared_ptr<AudioContent> audio;
-       boost::shared_ptr<SubtitleContent> subtitle;
+       std::shared_ptr<VideoContent> video;
+       std::shared_ptr<AudioContent> audio;
+       std::list<std::shared_ptr<TextContent>> text;
+       std::shared_ptr<AtmosContent> atmos;
 
-       void signal_changed (int);
+       std::shared_ptr<TextContent> only_text () const;
+       std::shared_ptr<TextContent> text_of_original_type (TextType type) const;
 
-protected:
+       /** @return true if this content has changed since it was last examined */
+       bool changed () const;
 
-       virtual void add_properties (std::list<UserProperty> &) const {}
+protected:
 
-       boost::weak_ptr<const Film> _film;
+       virtual void add_properties (std::shared_ptr<const Film> film, std::list<UserProperty> &) const;
 
        /** _mutex which should be used to protect accesses, as examine
         *  jobs can update content state in threads other than the main one.
         */
        mutable boost::mutex _mutex;
 
-       /** Paths of our data files */
-       std::vector<boost::filesystem::path> _paths;
+       void add_path (boost::filesystem::path p);
 
 private:
        friend struct ffmpeg_pts_offset_test;
        friend struct best_dcp_frame_rate_test_single;
        friend struct best_dcp_frame_rate_test_double;
        friend struct audio_sampling_rate_test;
+       template<class, class> friend class ChangeSignaller;
+
+       void signal_change (ChangeType, int);
+
+       /** Paths of our data files */
+       std::vector<boost::filesystem::path> _paths;
+       std::vector<std::time_t> _last_write_times;
 
        std::string _digest;
-       DCPTime _position;
-       ContentTime _trim_start;
-       ContentTime _trim_end;
+       dcpomatic::DCPTime _position;
+       dcpomatic::ContentTime _trim_start;
+       dcpomatic::ContentTime _trim_end;
        /** The video frame rate that this content is or was prepared to be used with,
         *  or empty if the effective rate of this content should be dictated by something
         *  else (either some video happening at the same time, or the rate of the DCP).
@@ -215,4 +241,8 @@ private:
        bool _change_signals_frequent;
 };
 
+
+typedef ChangeSignaller<Content, int> ContentChangeSignaller;
+
+
 #endif