2 Copyright (C) 2013-2018 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 DCP-o-matic is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
21 /** @file src/lib/content.h
22 * @brief Content class.
25 #ifndef DCPOMATIC_CONTENT_H
26 #define DCPOMATIC_CONTENT_H
29 #include "signaller.h"
30 #include "dcpomatic_time.h"
31 #include "change_signaller.h"
32 #include "user_property.h"
33 #include <libcxml/cxml.h>
34 #include <boost/filesystem.hpp>
35 #include <boost/signals2.hpp>
36 #include <boost/thread/mutex.hpp>
37 #include <boost/enable_shared_from_this.hpp>
53 static int const PATH;
54 static int const POSITION;
55 static int const LENGTH;
56 static int const TRIM_START;
57 static int const TRIM_END;
58 static int const VIDEO_FRAME_RATE;
62 * @brief A piece of content represented by one or more files on disk.
64 class Content : public boost::enable_shared_from_this<Content>, public Signaller, public boost::noncopyable
69 Content (boost::filesystem::path);
70 Content (cxml::ConstNodePtr);
71 Content (std::vector<boost::shared_ptr<Content> >);
72 virtual ~Content () {}
74 /** Examine the content to establish digest, frame rates and any other
76 * @param job Job to use to report progress, or 0.
78 virtual void examine (boost::shared_ptr<const Film> film, boost::shared_ptr<Job> job);
80 virtual void take_settings_from (boost::shared_ptr<const Content> c);
82 /** @return Quick one-line summary of the content, as will be presented in the
85 virtual std::string summary () const = 0;
87 /** @return Technical details of this content; these are written to logs to
88 * help with debugging.
90 virtual std::string technical_summary () const;
92 virtual void as_xml (xmlpp::Node *, bool with_paths) const;
93 virtual DCPTime full_length (boost::shared_ptr<const Film>) const = 0;
94 virtual DCPTime approximate_length () const = 0;
95 virtual std::string identifier () const;
96 /** @return points at which to split this content when
97 * REELTYPE_BY_VIDEO_CONTENT is in use.
99 virtual std::list<DCPTime> reel_split_points () const;
101 boost::shared_ptr<Content> clone () const;
103 void set_paths (std::vector<boost::filesystem::path> paths);
105 std::string path_summary () const;
107 std::vector<boost::filesystem::path> paths () const {
108 boost::mutex::scoped_lock lm (_mutex);
112 size_t number_of_paths () const {
113 boost::mutex::scoped_lock lm (_mutex);
114 return _paths.size ();
117 boost::filesystem::path path (size_t i) const {
118 boost::mutex::scoped_lock lm (_mutex);
122 std::time_t last_write_time (size_t i) const {
123 boost::mutex::scoped_lock lm (_mutex);
124 return _last_write_times[i];
127 bool paths_valid () const;
129 /** @return Digest of the content's file(s). Note: this is
130 * not a complete MD5-or-whatever hash, but a sort of poor
131 * man's version (see comments in examine()).
133 std::string digest () const {
134 boost::mutex::scoped_lock lm (_mutex);
138 void set_position (boost::shared_ptr<const Film> film, DCPTime);
140 /** DCPTime that this content starts; i.e. the time that the first
141 * bit of the content (trimmed or not) will happen.
143 DCPTime position () const {
144 boost::mutex::scoped_lock lm (_mutex);
148 void set_trim_start (ContentTime);
150 ContentTime trim_start () const {
151 boost::mutex::scoped_lock lm (_mutex);
155 void set_trim_end (ContentTime);
157 ContentTime trim_end () const {
158 boost::mutex::scoped_lock lm (_mutex);
162 /** @return Time immediately after the last thing in this content */
163 DCPTime end (boost::shared_ptr<const Film> film) const {
164 return position() + length_after_trim(film);
167 DCPTime length_after_trim (boost::shared_ptr<const Film> film) const;
169 boost::optional<double> video_frame_rate () const {
170 boost::mutex::scoped_lock lm (_mutex);
171 return _video_frame_rate;
174 void set_video_frame_rate (double r);
175 void unset_video_frame_rate ();
177 double active_video_frame_rate (boost::shared_ptr<const Film> film) const;
179 void set_change_signals_frequent (bool f) {
180 _change_signals_frequent = f;
183 std::list<UserProperty> user_properties () const;
185 std::string calculate_digest () const;
187 /* CHANGE_PENDING and CHANGE_CANCELLED may be emitted from any thread; CHANGE_DONE always from GUI thread */
188 boost::signals2::signal<void (ChangeType, boost::weak_ptr<Content>, int, bool)> Change;
190 boost::shared_ptr<VideoContent> video;
191 boost::shared_ptr<AudioContent> audio;
192 std::list<boost::shared_ptr<TextContent> > text;
194 boost::shared_ptr<TextContent> only_text () const;
195 boost::shared_ptr<TextContent> text_of_original_type (TextType type) const;
199 virtual void add_properties (std::list<UserProperty> &) const;
201 /** _mutex which should be used to protect accesses, as examine
202 * jobs can update content state in threads other than the main one.
204 mutable boost::mutex _mutex;
206 void add_path (boost::filesystem::path p);
209 friend struct ffmpeg_pts_offset_test;
210 friend struct best_dcp_frame_rate_test_single;
211 friend struct best_dcp_frame_rate_test_double;
212 friend struct audio_sampling_rate_test;
213 template<class> friend class ChangeSignaller;
215 void signal_change (ChangeType, int);
217 /** Paths of our data files */
218 std::vector<boost::filesystem::path> _paths;
219 std::vector<std::time_t> _last_write_times;
223 ContentTime _trim_start;
224 ContentTime _trim_end;
225 /** The video frame rate that this content is or was prepared to be used with,
226 * or empty if the effective rate of this content should be dictated by something
227 * else (either some video happening at the same time, or the rate of the DCP).
229 boost::optional<double> _video_frame_rate;
230 bool _change_signals_frequent;