summaryrefslogtreecommitdiff
path: root/src/lib/content.h
blob: 965b33b22b98d0ebf9a81d5166aa4623e8fdb763 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
/*
    Copyright (C) 2013 Carl Hetherington <cth@carlh.net>

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/

#ifndef DCPOMATIC_CONTENT_H
#define DCPOMATIC_CONTENT_H

#include <set>
#include <boost/filesystem.hpp>
#include <boost/signals2.hpp>
#include <boost/thread/mutex.hpp>
#include <boost/enable_shared_from_this.hpp>
#include <libxml++/libxml++.h>
#include "types.h"

namespace cxml {
	class Node;
}

class Job;
class Film;

class ContentProperty
{
public:
	static int const PATH;
	static int const POSITION;
	static int const LENGTH;
	static int const TRIM_START;
	static int const TRIM_END;
};

class Content : public boost::enable_shared_from_this<Content>, public boost::noncopyable
{
public:
	Content (boost::shared_ptr<const Film>);
	Content (boost::shared_ptr<const Film>, DCPTime);
	Content (boost::shared_ptr<const Film>, boost::filesystem::path);
	Content (boost::shared_ptr<const Film>, boost::shared_ptr<const cxml::Node>);
	Content (boost::shared_ptr<const Film>, std::vector<boost::shared_ptr<Content> >);
	virtual ~Content () {}
	
	virtual void examine (boost::shared_ptr<Job>);
	virtual std::string summary () const = 0;
	virtual std::string technical_summary () const;
	virtual std::string information () const = 0;
	virtual void as_xml (xmlpp::Node *) const;
	virtual DCPTime full_length () const = 0;
	virtual std::string identifier () const;

	boost::shared_ptr<Content> clone () const;

	void set_path (boost::filesystem::path);

	std::string path_summary () const;

	std::vector<boost::filesystem::path> paths () const {
		boost::mutex::scoped_lock lm (_mutex);
		return _paths;
	}

	size_t number_of_paths () const {
		boost::mutex::scoped_lock lm (_mutex);
		return _paths.size ();
	}

	boost::filesystem::path path (size_t i) const {
		boost::mutex::scoped_lock lm (_mutex);
		return _paths[i];
	}
	
	bool paths_valid () const;

	/** @return MD5 digest of the content's file(s) */
	std::string digest () const {
		boost::mutex::scoped_lock lm (_mutex);
		return _digest;
	}

	void set_position (DCPTime);

	/** DCPTime that this content starts; i.e. the time that the first
	 *  bit of the content (trimmed or not) will happen.
	 */
	DCPTime position () const {
		boost::mutex::scoped_lock lm (_mutex);
		return _position;
	}

	void set_trim_start (DCPTime);

	DCPTime trim_start () const {
		boost::mutex::scoped_lock lm (_mutex);
		return _trim_start;
	}

	void set_trim_end (DCPTime);
	
	DCPTime trim_end () const {
		boost::mutex::scoped_lock lm (_mutex);
		return _trim_end;
	}
	
	DCPTime end () const {
		return position() + length_after_trim() - 1;
	}

	DCPTime length_after_trim () const;
	
	void set_change_signals_frequent (bool f) {
		_change_signals_frequent = f;
	}

	bool trimmed (DCPTime) const;

	boost::signals2::signal<void (boost::weak_ptr<Content>, int, bool)> Changed;

protected:
	void signal_changed (int);

	boost::weak_ptr<const Film> _film;

	/** _mutex which should be used to protect accesses, as examine
	    jobs can update content state in threads other than the main one.
	*/
	mutable boost::mutex _mutex;

	/** Paths of our data files */
	std::vector<boost::filesystem::path> _paths;
	
private:
	std::string _digest;
	DCPTime _position;
	DCPTime _trim_start;
	DCPTime _trim_end;
	bool _change_signals_frequent;
};

#endif