X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Flib%2Fcontent.h;h=6b647790f2d635b9a038b5038513f40fce96dd8e;hb=422be0eece2bf6ee80db1d3c21553cd82efff789;hp=d39fc9e1ac99d3ca1de4ebd2ad4ab6b475567f5a;hpb=28dbf4fd074d2046a3c8ddebac9a537a80fd457a;p=dcpomatic.git diff --git a/src/lib/content.h b/src/lib/content.h index d39fc9e1a..6b647790f 100644 --- a/src/lib/content.h +++ b/src/lib/content.h @@ -1,30 +1,44 @@ /* - Copyright (C) 2013 Carl Hetherington + Copyright (C) 2013-2016 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 "types.h" +#include "signaller.h" +#include "dcpomatic_time.h" +#include "raw_convert.h" +#include "user_property.h" +#include #include #include #include #include -#include + +namespace xmlpp { + class Node; +} namespace cxml { class Node; @@ -33,39 +47,172 @@ namespace cxml { class Job; class Film; -class Content : public boost::enable_shared_from_this +class ContentProperty { public: - Content (boost::filesystem::path); - Content (boost::shared_ptr); - Content (Content const &); - - virtual void examine (boost::shared_ptr, boost::shared_ptr, bool); + static int const PATH; + static int const POSITION; + 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 Signaller, public boost::noncopyable +{ +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 >); + virtual ~Content () {} + + /** 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); + + /** @return Quick one-line summary of the content, as will be presented in the + * film editor. + */ virtual std::string summary () const = 0; - virtual std::string information () const = 0; + + /** @return Technical details of this content; these are written to logs to + * help with debugging. + */ + virtual std::string technical_summary () const; + virtual void as_xml (xmlpp::Node *) const; - virtual boost::shared_ptr clone () const = 0; - - boost::filesystem::path file () const { + virtual DCPTime full_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 () const; + + boost::shared_ptr clone () const; + + void set_path (boost::filesystem::path); + + std::string path_summary () const; + + std::vector paths () const { + boost::mutex::scoped_lock lm (_mutex); + return _paths; + } + + size_t number_of_paths () const { + boost::mutex::scoped_lock lm (_mutex); + return _paths.size (); + } + + boost::filesystem::path path (size_t i) const { boost::mutex::scoped_lock lm (_mutex); - return _file; + return _paths[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). + */ std::string digest () const { boost::mutex::scoped_lock lm (_mutex); return _digest; } - boost::signals2::signal, int)> Changed; + void set_position (DCPTime); + + /** DCPTime that this content starts; i.e. the time that the first + * bit of the content (trimmed or not) will happen. + */ + DCPTime position () const { + boost::mutex::scoped_lock lm (_mutex); + return _position; + } + + void set_trim_start (ContentTime); + + ContentTime trim_start () const { + boost::mutex::scoped_lock lm (_mutex); + return _trim_start; + } + + void set_trim_end (ContentTime); + + 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(); + } + + DCPTime length_after_trim () const; + + boost::optional video_frame_rate () const { + boost::mutex::scoped_lock lm (_mutex); + return _video_frame_rate; + } + + void set_video_frame_rate (double r); + + double active_video_frame_rate () const; + + void set_change_signals_frequent (bool f) { + _change_signals_frequent = f; + } + + boost::shared_ptr film () const; + + std::list user_properties () const; + + boost::signals2::signal, int, bool)> Changed; + + boost::shared_ptr video; + boost::shared_ptr audio; + boost::shared_ptr subtitle; -protected: void signal_changed (int); - + +protected: + + virtual void add_properties (std::list &) const; + + boost::weak_ptr _film; + + /** _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 _paths; + private: - boost::filesystem::path _file; + 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; + std::string _digest; + DCPTime _position; + ContentTime _trim_start; + 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; }; #endif