X-Git-Url: https://main.carlh.net/gitweb/?p=dcpomatic.git;a=blobdiff_plain;f=src%2Flib%2Fcontent.h;h=d17b0d0e5a22f86360e8a678073add3a620f9084;hp=f7e97feac9a3489d1083f96278a4eea3e491d367;hb=07b21bb92a8d54c6c03de9aadc63ab93b65d9bc5;hpb=cb1dfa9ec09af2abf6d10e4bf2764476db83841b diff --git a/src/lib/content.h b/src/lib/content.h index f7e97feac..d17b0d0e5 100644 --- a/src/lib/content.h +++ b/src/lib/content.h @@ -1,38 +1,46 @@ /* - Copyright (C) 2013-2014 Carl Hetherington + Copyright (C) 2013-2021 Carl Hetherington - This program is free software; you can redistribute it and/or modify + This file is part of DCP-o-matic. + + DCP-o-matic is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. - This program is distributed in the hope that it will be useful, + DCP-o-matic is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + along with DCP-o-matic. If not, see . */ + /** @file src/lib/content.h * @brief Content class. */ + #ifndef DCPOMATIC_CONTENT_H #define DCPOMATIC_CONTENT_H -#include +#include "types.h" +#include "signaller.h" +#include "dcpomatic_time.h" +#include "change_signaller.h" +#include "user_property.h" +#include #include #include #include -#include -#include -#include -#include "types.h" -#include "dcpomatic_time.h" + + +namespace xmlpp { + class Node; +} namespace cxml { class Node; @@ -40,6 +48,7 @@ namespace cxml { class Job; class Film; +class AtmosContent; class ContentProperty { @@ -49,45 +58,56 @@ public: static int const LENGTH; static int const TRIM_START; static int const TRIM_END; + 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, public boost::noncopyable +class Content : public std::enable_shared_from_this, public Signaller { public: - Content (boost::shared_ptr); - Content (boost::shared_ptr, DCPTime); - Content (boost::shared_ptr, boost::filesystem::path); - Content (boost::shared_ptr, cxml::ConstNodePtr); - Content (boost::shared_ptr, std::vector >); + explicit Content (); + Content (dcpomatic::DCPTime); + Content (boost::filesystem::path); + Content (cxml::ConstNodePtr); + Content (std::vector>); 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); - + virtual void examine (std::shared_ptr film, std::shared_ptr job); + + virtual void take_settings_from (std::shared_ptr c); + /** @return Quick one-line summary of the content, as will be presented in the * film editor. */ virtual std::string summary () const = 0; - + /** @return Technical details of this content; these are written to logs to * help with debugging. */ virtual std::string technical_summary () const; - - virtual std::string information () const = 0; - 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 = 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 reel_split_points (std::shared_ptr) const; - boost::shared_ptr clone () const; + std::shared_ptr clone () const; - void set_path (boost::filesystem::path); + void set_paths (std::vector paths); std::string path_summary () const; @@ -105,74 +125,124 @@ public: boost::mutex::scoped_lock lm (_mutex); 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 MD5 digest of the content's file(s) */ + /** @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()). + */ std::string digest () const { boost::mutex::scoped_lock lm (_mutex); return _digest; } - void set_position (DCPTime); + void set_position (std::shared_ptr 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 (DCPTime); + void set_trim_start (dcpomatic::ContentTime); - DCPTime trim_start () const { + dcpomatic::ContentTime trim_start () const { boost::mutex::scoped_lock lm (_mutex); return _trim_start; } - void set_trim_end (DCPTime); - - DCPTime trim_end () const { + void set_trim_end (dcpomatic::ContentTime); + + dcpomatic::ContentTime trim_end () const { boost::mutex::scoped_lock lm (_mutex); return _trim_end; } - - DCPTime end () const { - return position() + length_after_trim(); + + /** @return Time immediately after the last thing in this content */ + dcpomatic::DCPTime end (std::shared_ptr film) const { + return position() + length_after_trim(film); + } + + dcpomatic::DCPTime length_after_trim (std::shared_ptr film) const; + + boost::optional video_frame_rate () const { + boost::mutex::scoped_lock lm (_mutex); + return _video_frame_rate; } - DCPTime length_after_trim () const; - + void set_video_frame_rate (double r); + void unset_video_frame_rate (); + + double active_video_frame_rate (std::shared_ptr film) const; + void set_change_signals_frequent (bool f) { _change_signals_frequent = f; } - boost::shared_ptr film () const { - return _film.lock (); - } + std::list user_properties (std::shared_ptr film) const; + + std::string calculate_digest () const; + + /* ChangeType::PENDING and ChangeType::CANCELLED may be emitted from any thread; ChangeType::DONE always from GUI thread */ + boost::signals2::signal, int, bool)> Change; - boost::signals2::signal, int, bool)> Changed; + std::shared_ptr video; + std::shared_ptr audio; + std::list> text; + std::shared_ptr atmos; + + std::shared_ptr only_text () const; + std::shared_ptr text_of_original_type (TextType type) const; + + /** @return true if this content has changed since it was last examined */ + bool changed () const; protected: - void signal_changed (int); - boost::weak_ptr _film; + virtual void add_properties (std::shared_ptr film, std::list &) 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; + 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 friend class ChangeSignaller; + + void signal_change (ChangeType, int); + /** Paths of our data files */ std::vector _paths; - -private: + std::vector _last_write_times; + std::string _digest; - DCPTime _position; - DCPTime _trim_start; - DCPTime _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). + */ + boost::optional _video_frame_rate; bool _change_signals_frequent; }; + +typedef ChangeSignaller ContentChangeSignaller; + + #endif