2 Copyright (C) 2012 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.
21 * @brief A representation of some audio and video content, and details of
22 * how they should be presented in a DCP.
25 #ifndef DCPOMATIC_FILM_H
26 #define DCPOMATIC_FILM_H
31 #include <boost/thread/mutex.hpp>
32 #include <boost/thread.hpp>
33 #include <boost/signals2.hpp>
34 #include <boost/enable_shared_from_this.hpp>
38 #include "dci_metadata.h"
47 * @brief A representation of some audio and video content, and details of
48 * how they should be presented in a DCP.
50 * The content of a Film is held in a Playlist (created and managed by the Film).
52 class Film : public boost::enable_shared_from_this<Film>, public boost::noncopyable
57 std::string info_dir () const;
58 std::string j2c_path (int, Eyes, bool) const;
59 std::string info_path (int, Eyes) const;
60 std::string internal_video_mxf_dir () const;
61 std::string internal_video_mxf_filename () const;
62 boost::filesystem::path audio_analysis_path (boost::shared_ptr<const AudioContent>) const;
64 std::string video_mxf_filename () const;
65 std::string audio_mxf_filename () const;
67 void send_dcp_to_tms ();
71 * It is safe to call this from any thread.
73 boost::shared_ptr<Log> log () const {
77 int encoded_frames () const;
79 std::string file (std::string f) const;
80 std::string dir (std::string d) const;
82 void read_metadata ();
83 void write_metadata () const;
85 std::string dci_name (bool if_created_now) const;
86 std::string dcp_name (bool if_created_now = false) const;
88 /** @return true if our state has changed since we last saved it */
93 libdcp::Size full_frame () const;
95 bool have_dcp () const;
97 boost::shared_ptr<Player> make_player () const;
98 boost::shared_ptr<Playlist> playlist () const;
100 OutputAudioFrame audio_frame_rate () const;
102 OutputAudioFrame time_to_audio_frames (Time) const;
103 OutputVideoFrame time_to_video_frames (Time) const;
104 Time video_frames_to_time (OutputVideoFrame) const;
105 Time audio_frames_to_time (OutputAudioFrame) const;
107 /* Proxies for some Playlist methods */
109 ContentList content () const;
111 Time length () const;
112 bool has_subtitles () const;
113 OutputVideoFrame best_video_frame_rate () const;
115 /** Identifiers for the parts of our state;
116 used for signalling changes.
122 /** The playlist's content list has changed (i.e. content has been added, moved around or removed) */
133 /** The setting of _three_d has been changed */
141 std::string directory () const {
142 boost::mutex::scoped_lock lm (_directory_mutex);
146 std::string name () const {
147 boost::mutex::scoped_lock lm (_state_mutex);
151 bool use_dci_name () const {
152 boost::mutex::scoped_lock lm (_state_mutex);
153 return _use_dci_name;
156 DCPContentType const * dcp_content_type () const {
157 boost::mutex::scoped_lock lm (_state_mutex);
158 return _dcp_content_type;
161 Ratio const * container () const {
162 boost::mutex::scoped_lock lm (_state_mutex);
166 Resolution resolution () const {
167 boost::mutex::scoped_lock lm (_state_mutex);
171 Scaler const * scaler () const {
172 boost::mutex::scoped_lock lm (_state_mutex);
176 bool with_subtitles () const {
177 boost::mutex::scoped_lock lm (_state_mutex);
178 return _with_subtitles;
181 int j2k_bandwidth () const {
182 boost::mutex::scoped_lock lm (_state_mutex);
183 return _j2k_bandwidth;
186 DCIMetadata dci_metadata () const {
187 boost::mutex::scoped_lock lm (_state_mutex);
188 return _dci_metadata;
191 /** @return The frame rate of the DCP */
192 int video_frame_rate () const {
193 boost::mutex::scoped_lock lm (_state_mutex);
194 return _video_frame_rate;
197 int audio_channels () const {
198 boost::mutex::scoped_lock lm (_state_mutex);
199 return _audio_channels;
202 bool three_d () const {
203 boost::mutex::scoped_lock lm (_state_mutex);
207 bool sequence_video () const {
208 boost::mutex::scoped_lock lm (_state_mutex);
209 return _sequence_video;
215 void set_directory (std::string);
216 void set_name (std::string);
217 void set_use_dci_name (bool);
218 void examine_and_add_content (boost::shared_ptr<Content>);
219 void add_content (boost::shared_ptr<Content>);
220 void remove_content (boost::shared_ptr<Content>);
221 void set_dcp_content_type (DCPContentType const *);
222 void set_container (Ratio const *);
223 void set_resolution (Resolution);
224 void set_scaler (Scaler const *);
225 void set_with_subtitles (bool);
226 void set_j2k_bandwidth (int);
227 void set_dci_metadata (DCIMetadata);
228 void set_video_frame_rate (int);
229 void set_audio_channels (int);
230 void set_three_d (bool);
231 void set_dci_date_today ();
232 void set_sequence_video (bool);
234 /** Emitted when some property has of the Film has changed */
235 mutable boost::signals2::signal<void (Property)> Changed;
237 /** Emitted when some property of our content has changed */
238 mutable boost::signals2::signal<void (boost::weak_ptr<Content>, int)> ContentChanged;
240 /** Current version number of the state file */
241 static int const state_version;
245 void signal_changed (Property);
246 std::string video_identifier () const;
247 void playlist_changed ();
248 void playlist_content_changed (boost::weak_ptr<Content>, int);
249 std::string filename_safe_name () const;
250 void maybe_add_content (boost::weak_ptr<Job>, boost::weak_ptr<Content>);
252 /** Log to write to */
253 boost::shared_ptr<Log> _log;
254 boost::shared_ptr<Playlist> _playlist;
256 /** Complete path to directory containing the film metadata;
257 * must not be relative.
259 std::string _directory;
260 /** Mutex for _directory */
261 mutable boost::mutex _directory_mutex;
263 /** Name for DCP-o-matic */
265 /** True if a auto-generated DCI-compliant name should be used for our DCP */
267 /** The type of content that this Film represents (feature, trailer etc.) */
268 DCPContentType const * _dcp_content_type;
269 /** The container to put this Film in (flat, scope, etc.) */
270 Ratio const * _container;
271 /** DCP resolution (2K or 4K) */
272 Resolution _resolution;
273 /** Scaler algorithm to use */
274 Scaler const * _scaler;
275 /** True if subtitles should be shown for this film */
276 bool _with_subtitles;
277 /** bandwidth for J2K files in bits per second */
279 /** DCI naming stuff */
280 DCIMetadata _dci_metadata;
281 /** Frames per second to run our DCP at */
282 int _video_frame_rate;
283 /** The date that we should use in a DCI name */
284 boost::gregorian::date _dci_date;
285 /** Number of audio channels to put in the DCP */
287 /** If true, the DCP will be written in 3D mode; otherwise in 2D.
288 This will be regardless of what content is on the playlist.
291 bool _sequence_video;
293 /** true if our state has changed since we last saved it */
296 /** Mutex for all state except _directory */
297 mutable boost::mutex _state_mutex;
299 friend class paths_test;
300 friend class film_metadata_test;