2 Copyright (C) 2013-2014 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 "dcpomatic_time.h"
29 #include <libxml++/libxml++.h>
30 #include <libcxml/cxml.h>
31 #include <boost/filesystem.hpp>
32 #include <boost/signals2.hpp>
33 #include <boost/thread/mutex.hpp>
34 #include <boost/enable_shared_from_this.hpp>
46 static int const PATH;
47 static int const POSITION;
48 static int const LENGTH;
49 static int const TRIM_START;
50 static int const TRIM_END;
54 * @brief A piece of content represented by one or more files on disk.
56 class Content : public boost::enable_shared_from_this<Content>, public boost::noncopyable
59 Content (boost::shared_ptr<const Film>);
60 Content (boost::shared_ptr<const Film>, DCPTime);
61 Content (boost::shared_ptr<const Film>, boost::filesystem::path);
62 Content (boost::shared_ptr<const Film>, cxml::ConstNodePtr);
63 Content (boost::shared_ptr<const Film>, std::vector<boost::shared_ptr<Content> >);
64 virtual ~Content () {}
66 /** Examine the content to establish digest, frame rates and any other
68 * @param job Job to use to report progress, or 0.
69 * @param calculate_digest True to calculate a digest for the content's file(s).
71 virtual void examine (boost::shared_ptr<Job> job, bool calculate_digest);
73 /** @return Quick one-line summary of the content, as will be presented in the
76 virtual std::string summary () const = 0;
78 /** @return Technical details of this content; these are written to logs to
79 * help with debugging.
81 virtual std::string technical_summary () const;
83 virtual std::string information () const = 0;
84 virtual void as_xml (xmlpp::Node *) const;
85 virtual DCPTime full_length () const = 0;
86 virtual std::string identifier () const;
88 boost::shared_ptr<Content> clone () const;
90 void set_path (boost::filesystem::path);
92 std::string path_summary () const;
94 std::vector<boost::filesystem::path> paths () const {
95 boost::mutex::scoped_lock lm (_mutex);
99 size_t number_of_paths () const {
100 boost::mutex::scoped_lock lm (_mutex);
101 return _paths.size ();
104 boost::filesystem::path path (size_t i) const {
105 boost::mutex::scoped_lock lm (_mutex);
109 bool paths_valid () const;
111 /** @return MD5 digest of the content's file(s) */
112 boost::optional<std::string> digest () const {
113 boost::mutex::scoped_lock lm (_mutex);
117 void set_position (DCPTime);
119 /** DCPTime that this content starts; i.e. the time that the first
120 * bit of the content (trimmed or not) will happen.
122 DCPTime position () const {
123 boost::mutex::scoped_lock lm (_mutex);
127 void set_trim_start (DCPTime);
129 DCPTime trim_start () const {
130 boost::mutex::scoped_lock lm (_mutex);
134 void set_trim_end (DCPTime);
136 DCPTime trim_end () const {
137 boost::mutex::scoped_lock lm (_mutex);
141 DCPTime end () const {
142 return position() + length_after_trim();
145 DCPTime length_after_trim () const;
147 void set_change_signals_frequent (bool f) {
148 _change_signals_frequent = f;
151 boost::shared_ptr<const Film> film () const {
152 return _film.lock ();
155 boost::signals2::signal<void (boost::weak_ptr<Content>, int, bool)> Changed;
158 void signal_changed (int);
160 boost::weak_ptr<const Film> _film;
162 /** _mutex which should be used to protect accesses, as examine
163 * jobs can update content state in threads other than the main one.
165 mutable boost::mutex _mutex;
167 /** Paths of our data files */
168 std::vector<boost::filesystem::path> _paths;
171 boost::optional<std::string> _digest;
175 bool _change_signals_frequent;