2 Copyright (C) 2013-2016 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 "user_property.h"
32 #include <libcxml/cxml.h>
33 #include <boost/filesystem.hpp>
34 #include <boost/signals2.hpp>
35 #include <boost/thread/mutex.hpp>
36 #include <boost/enable_shared_from_this.hpp>
52 static int const PATH;
53 static int const POSITION;
54 static int const LENGTH;
55 static int const TRIM_START;
56 static int const TRIM_END;
57 static int const VIDEO_FRAME_RATE;
61 * @brief A piece of content represented by one or more files on disk.
63 class Content : public boost::enable_shared_from_this<Content>, public Signaller, public boost::noncopyable
66 Content (boost::shared_ptr<const Film>);
67 Content (boost::shared_ptr<const Film>, DCPTime);
68 Content (boost::shared_ptr<const Film>, boost::filesystem::path);
69 Content (boost::shared_ptr<const Film>, cxml::ConstNodePtr);
70 Content (boost::shared_ptr<const Film>, std::vector<boost::shared_ptr<Content> >);
71 virtual ~Content () {}
73 /** Examine the content to establish digest, frame rates and any other
75 * @param job Job to use to report progress, or 0.
77 virtual void examine (boost::shared_ptr<Job> job);
79 virtual void use_template (boost::shared_ptr<const Content> c);
81 /** @return Quick one-line summary of the content, as will be presented in the
84 virtual std::string summary () const = 0;
86 /** @return Technical details of this content; these are written to logs to
87 * help with debugging.
89 virtual std::string technical_summary () const;
91 virtual void as_xml (xmlpp::Node *, bool with_paths) const;
92 virtual DCPTime full_length () const = 0;
93 virtual std::string identifier () const;
94 /** @return points at which to split this content when
95 * REELTYPE_BY_VIDEO_CONTENT is in use.
97 virtual std::list<DCPTime> reel_split_points () const;
99 boost::shared_ptr<Content> clone () const;
101 void set_path (boost::filesystem::path);
102 void set_paths (std::vector<boost::filesystem::path> paths);
104 std::string path_summary () const;
106 std::vector<boost::filesystem::path> paths () const {
107 boost::mutex::scoped_lock lm (_mutex);
111 size_t number_of_paths () const {
112 boost::mutex::scoped_lock lm (_mutex);
113 return _paths.size ();
116 boost::filesystem::path path (size_t i) const {
117 boost::mutex::scoped_lock lm (_mutex);
121 bool paths_valid () const;
123 /** @return Digest of the content's file(s). Note: this is
124 * not a complete MD5-or-whatever hash, but a sort of poor
125 * man's version (see comments in examine()).
127 std::string digest () const {
128 boost::mutex::scoped_lock lm (_mutex);
132 void set_position (DCPTime);
134 /** DCPTime that this content starts; i.e. the time that the first
135 * bit of the content (trimmed or not) will happen.
137 DCPTime position () const {
138 boost::mutex::scoped_lock lm (_mutex);
142 void set_trim_start (ContentTime);
144 ContentTime trim_start () const {
145 boost::mutex::scoped_lock lm (_mutex);
149 void set_trim_end (ContentTime);
151 ContentTime trim_end () const {
152 boost::mutex::scoped_lock lm (_mutex);
156 /** @return Time immediately after the last thing in this content */
157 DCPTime end () const {
158 return position() + length_after_trim();
161 DCPTime length_after_trim () const;
163 boost::optional<double> video_frame_rate () const {
164 boost::mutex::scoped_lock lm (_mutex);
165 return _video_frame_rate;
168 void set_video_frame_rate (double r);
170 double active_video_frame_rate () const;
172 void set_change_signals_frequent (bool f) {
173 _change_signals_frequent = f;
176 boost::shared_ptr<const Film> film () const;
178 std::list<UserProperty> user_properties () const;
180 boost::signals2::signal<void (boost::weak_ptr<Content>, int, bool)> Changed;
182 boost::shared_ptr<VideoContent> video;
183 boost::shared_ptr<AudioContent> audio;
184 boost::shared_ptr<SubtitleContent> subtitle;
186 void signal_changed (int);
190 virtual void add_properties (std::list<UserProperty> &) const;
192 boost::weak_ptr<const Film> _film;
194 /** _mutex which should be used to protect accesses, as examine
195 * jobs can update content state in threads other than the main one.
197 mutable boost::mutex _mutex;
199 /** Paths of our data files */
200 std::vector<boost::filesystem::path> _paths;
203 friend struct ffmpeg_pts_offset_test;
204 friend struct best_dcp_frame_rate_test_single;
205 friend struct best_dcp_frame_rate_test_double;
206 friend struct audio_sampling_rate_test;
210 ContentTime _trim_start;
211 ContentTime _trim_end;
212 /** The video frame rate that this content is or was prepared to be used with,
213 * or empty if the effective rate of this content should be dictated by something
214 * else (either some video happening at the same time, or the rate of the DCP).
216 boost::optional<double> _video_frame_rate;
217 bool _change_signals_frequent;