2 Copyright (C) 2013-2015 Carl Hetherington <cth@carlh.net>
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 /** @file src/lib/content.h
21 * @brief Content class.
24 #ifndef DCPOMATIC_CONTENT_H
25 #define DCPOMATIC_CONTENT_H
28 #include "signaller.h"
29 #include "dcpomatic_time.h"
30 #include "raw_convert.h"
31 #include <libcxml/cxml.h>
32 #include <boost/filesystem.hpp>
33 #include <boost/signals2.hpp>
34 #include <boost/thread/mutex.hpp>
35 #include <boost/enable_shared_from_this.hpp>
51 static int const PATH;
52 static int const POSITION;
53 static int const LENGTH;
54 static int const TRIM_START;
55 static int const TRIM_END;
59 * @brief A piece of content represented by one or more files on disk.
61 class Content : public boost::enable_shared_from_this<Content>, public Signaller, public boost::noncopyable
64 Content (boost::shared_ptr<const Film>);
65 Content (boost::shared_ptr<const Film>, DCPTime);
66 Content (boost::shared_ptr<const Film>, boost::filesystem::path);
67 Content (boost::shared_ptr<const Film>, cxml::ConstNodePtr);
68 Content (boost::shared_ptr<const Film>, std::vector<boost::shared_ptr<Content> >);
69 virtual ~Content () {}
71 /** Examine the content to establish digest, frame rates and any other
73 * @param job Job to use to report progress, or 0.
75 virtual void examine (boost::shared_ptr<Job> job);
77 /** @return Quick one-line summary of the content, as will be presented in the
80 virtual std::string summary () const = 0;
82 /** @return Technical details of this content; these are written to logs to
83 * help with debugging.
85 virtual std::string technical_summary () const;
87 virtual void as_xml (xmlpp::Node *) const;
88 virtual DCPTime full_length () const = 0;
89 virtual std::string identifier () const;
90 /** @return points at which to split this content when
91 * REELTYPE_BY_VIDEO_CONTENT is in use.
93 virtual std::list<DCPTime> reel_split_points () const;
95 boost::shared_ptr<Content> clone () const;
97 void set_path (boost::filesystem::path);
99 std::string path_summary () const;
101 std::vector<boost::filesystem::path> paths () const {
102 boost::mutex::scoped_lock lm (_mutex);
106 size_t number_of_paths () const {
107 boost::mutex::scoped_lock lm (_mutex);
108 return _paths.size ();
111 boost::filesystem::path path (size_t i) const {
112 boost::mutex::scoped_lock lm (_mutex);
116 bool paths_valid () const;
118 /** @return Digest of the content's file(s). Note: this is
119 * not a complete MD5-or-whatever hash, but a sort of poor
120 * man's version (see comments in ::examine).
122 std::string digest () const {
123 boost::mutex::scoped_lock lm (_mutex);
127 void set_position (DCPTime);
129 /** DCPTime that this content starts; i.e. the time that the first
130 * bit of the content (trimmed or not) will happen.
132 DCPTime position () const {
133 boost::mutex::scoped_lock lm (_mutex);
137 void set_trim_start (ContentTime);
139 ContentTime trim_start () const {
140 boost::mutex::scoped_lock lm (_mutex);
144 void set_trim_end (ContentTime);
146 ContentTime trim_end () const {
147 boost::mutex::scoped_lock lm (_mutex);
151 /** @return Time immediately after the last thing in this content */
152 DCPTime end () const {
153 return position() + length_after_trim();
156 DCPTime length_after_trim () const;
158 void set_change_signals_frequent (bool f) {
159 _change_signals_frequent = f;
162 boost::shared_ptr<const Film> film () const;
168 UserProperty (std::string category_, std::string key_, T value_, std::string unit_ = "")
169 : category (category_)
171 , value (raw_convert<std::string> (value_))
175 std::string category;
181 std::list<UserProperty> user_properties () const;
183 boost::signals2::signal<void (boost::weak_ptr<Content>, int, bool)> Changed;
186 void signal_changed (int);
188 virtual void add_properties (std::list<UserProperty> &) const {}
190 boost::weak_ptr<const Film> _film;
192 /** _mutex which should be used to protect accesses, as examine
193 * jobs can update content state in threads other than the main one.
195 mutable boost::mutex _mutex;
197 /** Paths of our data files */
198 std::vector<boost::filesystem::path> _paths;
203 ContentTime _trim_start;
204 ContentTime _trim_end;
205 bool _change_signals_frequent;