2 Copyright (C) 2013 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 #ifndef DCPOMATIC_CONTENT_H
21 #define DCPOMATIC_CONTENT_H
24 #include <boost/filesystem.hpp>
25 #include <boost/signals2.hpp>
26 #include <boost/thread/mutex.hpp>
27 #include <boost/enable_shared_from_this.hpp>
28 #include <libxml++/libxml++.h>
41 static int const PATH;
42 static int const POSITION;
43 static int const LENGTH;
44 static int const TRIM_START;
45 static int const TRIM_END;
48 class Content : public boost::enable_shared_from_this<Content>, public boost::noncopyable
51 Content (boost::shared_ptr<const Film>, Time);
52 Content (boost::shared_ptr<const Film>, boost::filesystem::path);
53 Content (boost::shared_ptr<const Film>, boost::shared_ptr<const cxml::Node>);
54 virtual ~Content () {}
56 virtual void examine (boost::shared_ptr<Job>);
57 virtual std::string summary () const = 0;
58 virtual std::string technical_summary () const;
59 virtual std::string information () const = 0;
60 virtual void as_xml (xmlpp::Node *) const;
61 virtual Time full_length () const = 0;
62 virtual std::string identifier () const;
64 boost::shared_ptr<Content> clone () const;
66 void set_path (boost::filesystem::path);
68 boost::filesystem::path path () const {
69 boost::mutex::scoped_lock lm (_mutex);
73 bool path_valid () const;
75 /** @return MD5 digest of the content's file(s) */
76 std::string digest () const {
77 boost::mutex::scoped_lock lm (_mutex);
81 void set_position (Time);
83 /** Time that this content starts; i.e. the time that the first
84 * bit of the content (trimmed or not) will happen.
86 Time position () const {
87 boost::mutex::scoped_lock lm (_mutex);
91 void set_trim_start (Time);
93 Time trim_start () const {
94 boost::mutex::scoped_lock lm (_mutex);
98 void set_trim_end (Time);
100 Time trim_end () const {
101 boost::mutex::scoped_lock lm (_mutex);
106 return position() + length_after_trim();
109 Time length_after_trim () const;
111 void set_change_signals_frequent (bool f) {
112 _change_signals_frequent = f;
115 bool trimmed (Time) const;
117 boost::signals2::signal<void (boost::weak_ptr<Content>, int, bool)> Changed;
120 void signal_changed (int);
122 boost::weak_ptr<const Film> _film;
124 /** _mutex which should be used to protect accesses, as examine
125 jobs can update content state in threads other than the main one.
127 mutable boost::mutex _mutex;
130 /** Path of a file or a directory containing files */
131 boost::filesystem::path _path;
136 bool _change_signals_frequent;