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>
30 #include "dcpomatic_time.h"
42 static int const PATH;
43 static int const POSITION;
44 static int const LENGTH;
45 static int const TRIM_START;
46 static int const TRIM_END;
49 class Content : public boost::enable_shared_from_this<Content>, public boost::noncopyable
52 Content (boost::shared_ptr<const Film>);
53 Content (boost::shared_ptr<const Film>, DCPTime);
54 Content (boost::shared_ptr<const Film>, boost::filesystem::path);
55 Content (boost::shared_ptr<const Film>, boost::shared_ptr<const cxml::Node>);
56 Content (boost::shared_ptr<const Film>, std::vector<boost::shared_ptr<Content> >);
57 virtual ~Content () {}
59 virtual void examine (boost::shared_ptr<Job>);
60 virtual std::string summary () const = 0;
61 /** @return Technical details of this content; these are written to logs to
62 * help with debugging.
64 virtual std::string technical_summary () const;
65 virtual std::string information () const = 0;
66 virtual void as_xml (xmlpp::Node *) const;
67 virtual DCPTime full_length () const = 0;
68 virtual std::string identifier () const;
70 boost::shared_ptr<Content> clone () const;
72 void set_path (boost::filesystem::path);
74 std::string path_summary () const;
76 std::vector<boost::filesystem::path> paths () const {
77 boost::mutex::scoped_lock lm (_mutex);
81 size_t number_of_paths () const {
82 boost::mutex::scoped_lock lm (_mutex);
83 return _paths.size ();
86 boost::filesystem::path path (size_t i) const {
87 boost::mutex::scoped_lock lm (_mutex);
91 bool paths_valid () const;
93 /** @return MD5 digest of the content's file(s) */
94 std::string digest () const {
95 boost::mutex::scoped_lock lm (_mutex);
99 void set_position (DCPTime);
101 /** DCPTime that this content starts; i.e. the time that the first
102 * bit of the content (trimmed or not) will happen.
104 DCPTime position () const {
105 boost::mutex::scoped_lock lm (_mutex);
109 void set_trim_start (DCPTime);
111 DCPTime trim_start () const {
112 boost::mutex::scoped_lock lm (_mutex);
116 void set_trim_end (DCPTime);
118 DCPTime trim_end () const {
119 boost::mutex::scoped_lock lm (_mutex);
123 DCPTime end () const {
124 return position() + length_after_trim();
127 DCPTime length_after_trim () const;
129 void set_change_signals_frequent (bool f) {
130 _change_signals_frequent = f;
133 boost::signals2::signal<void (boost::weak_ptr<Content>, int, bool)> Changed;
136 void signal_changed (int);
138 boost::weak_ptr<const Film> _film;
140 /** _mutex which should be used to protect accesses, as examine
141 jobs can update content state in threads other than the main one.
143 mutable boost::mutex _mutex;
145 /** Paths of our data files */
146 std::vector<boost::filesystem::path> _paths;
153 bool _change_signals_frequent;