2 Copyright (C) 2012-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.
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/signals2.hpp>
32 #include <boost/enable_shared_from_this.hpp>
33 #include <boost/filesystem.hpp>
35 #include <dcp/decrypted_kdm.h>
36 #include <dcp/encrypted_kdm.h>
39 #include "isdcf_metadata.h"
40 #include "frame_rate_change.h"
50 class isdcf_name_test;
54 * @brief A representation of some audio and video content, and details of
55 * how they should be presented in a DCP.
57 * The content of a Film is held in a Playlist (created and managed by the Film).
59 class Film : public boost::enable_shared_from_this<Film>, public boost::noncopyable
62 Film (boost::filesystem::path, bool log = true);
64 boost::filesystem::path info_dir () const;
65 boost::filesystem::path j2c_path (int, Eyes, bool) const;
66 boost::filesystem::path info_path (int, Eyes) const;
67 boost::filesystem::path internal_video_mxf_dir () const;
68 boost::filesystem::path internal_video_mxf_filename () const;
69 boost::filesystem::path audio_analysis_dir () const;
71 boost::filesystem::path video_mxf_filename () const;
72 boost::filesystem::path audio_mxf_filename () const;
74 void send_dcp_to_tms ();
78 * It is safe to call this from any thread.
80 boost::shared_ptr<Log> log () const {
84 int encoded_frames () const;
86 boost::filesystem::path file (boost::filesystem::path f) const;
87 boost::filesystem::path dir (boost::filesystem::path d) const;
89 std::list<std::string> read_metadata ();
90 void write_metadata () const;
91 boost::shared_ptr<xmlpp::Document> metadata () const;
93 std::string isdcf_name (bool if_created_now) const;
94 std::string dcp_name (bool if_created_now = false) const;
96 /** @return true if our state has changed since we last saved it */
101 dcp::Size full_frame () const;
102 dcp::Size frame_size () const;
104 std::vector<CPLSummary> cpls () const;
106 boost::shared_ptr<Player> make_player () const;
107 boost::shared_ptr<Playlist> playlist () const;
109 int audio_frame_rate () const;
111 uint64_t required_disk_space () const;
112 bool should_be_enough_disk_space (double &, double &) const;
114 /* Proxies for some Playlist methods */
116 ContentList content () const;
117 DCPTime length () const;
118 bool has_subtitles () const;
119 int best_video_frame_rate () const;
120 FrameRateChange active_frame_rate_change (DCPTime) const;
124 boost::shared_ptr<dcp::Certificate> target,
125 boost::filesystem::path cpl_file,
130 std::list<dcp::EncryptedKDM> make_kdms (
131 std::list<boost::shared_ptr<Screen> >,
132 boost::filesystem::path cpl_file,
137 dcp::Key key () const {
141 int state_version () const {
142 return _state_version;
145 /** Identifiers for the parts of our state;
146 used for signalling changes.
152 /** The playlist's content list has changed (i.e. content has been added, moved around or removed) */
165 /** The setting of _three_d has been changed */
174 boost::filesystem::path directory () const {
178 std::string name () const {
182 bool use_isdcf_name () const {
183 return _use_isdcf_name;
186 DCPContentType const * dcp_content_type () const {
187 return _dcp_content_type;
190 Ratio const * container () const {
194 Resolution resolution () const {
198 Scaler const * scaler () const {
202 bool with_subtitles () const {
203 return _with_subtitles;
206 /* signed is a reserved word */
207 bool is_signed () const {
211 bool encrypted () const {
215 int j2k_bandwidth () const {
216 return _j2k_bandwidth;
219 ISDCFMetadata isdcf_metadata () const {
220 return _isdcf_metadata;
223 /** @return The frame rate of the DCP */
224 int video_frame_rate () const {
225 return _video_frame_rate;
228 int audio_channels () const {
229 return _audio_channels;
232 bool three_d () const {
236 bool sequence_video () const {
237 return _sequence_video;
240 bool interop () const {
247 void set_directory (boost::filesystem::path);
248 void set_name (std::string);
249 void set_use_isdcf_name (bool);
250 void examine_and_add_content (boost::shared_ptr<Content>);
251 void add_content (boost::shared_ptr<Content>);
252 void remove_content (boost::shared_ptr<Content>);
253 void move_content_earlier (boost::shared_ptr<Content>);
254 void move_content_later (boost::shared_ptr<Content>);
255 void set_dcp_content_type (DCPContentType const *);
256 void set_container (Ratio const *);
257 void set_resolution (Resolution);
258 void set_scaler (Scaler const *);
259 void set_with_subtitles (bool);
260 void set_signed (bool);
261 void set_encrypted (bool);
262 void set_j2k_bandwidth (int);
263 void set_isdcf_metadata (ISDCFMetadata);
264 void set_video_frame_rate (int);
265 void set_audio_channels (int);
266 void set_three_d (bool);
267 void set_isdcf_date_today ();
268 void set_sequence_video (bool);
269 void set_interop (bool);
271 /** Emitted when some property has of the Film has changed */
272 mutable boost::signals2::signal<void (Property)> Changed;
274 /** Emitted when some property of our content has changed */
275 mutable boost::signals2::signal<void (boost::weak_ptr<Content>, int)> ContentChanged;
277 /** Current version number of the state file */
278 static int const current_state_version;
282 friend class ::isdcf_name_test;
284 void signal_changed (Property);
285 std::string video_identifier () const;
286 void playlist_changed ();
287 void playlist_content_changed (boost::weak_ptr<Content>, int);
288 std::string filename_safe_name () const;
289 void maybe_add_content (boost::weak_ptr<Job>, boost::weak_ptr<Content>);
291 /** Log to write to */
292 boost::shared_ptr<Log> _log;
293 boost::shared_ptr<Playlist> _playlist;
295 /** Complete path to directory containing the film metadata;
296 * must not be relative.
298 boost::filesystem::path _directory;
300 /** Name for DCP-o-matic */
302 /** True if a auto-generated ISDCF-compliant name should be used for our DCP */
303 bool _use_isdcf_name;
304 /** The type of content that this Film represents (feature, trailer etc.) */
305 DCPContentType const * _dcp_content_type;
306 /** The container to put this Film in (flat, scope, etc.) */
307 Ratio const * _container;
308 /** DCP resolution (2K or 4K) */
309 Resolution _resolution;
310 /** Scaler algorithm to use */
311 Scaler const * _scaler;
312 /** True if subtitles should be shown for this film */
313 bool _with_subtitles;
316 /** bandwidth for J2K files in bits per second */
318 /** ISDCF naming stuff */
319 ISDCFMetadata _isdcf_metadata;
320 /** Frames per second to run our DCP at */
321 int _video_frame_rate;
322 /** The date that we should use in a ISDCF name */
323 boost::gregorian::date _isdcf_date;
324 /** Number of audio channels to put in the DCP */
326 /** If true, the DCP will be written in 3D mode; otherwise in 2D.
327 This will be regardless of what content is on the playlist.
330 bool _sequence_video;
336 /** true if our state has changed since we last saved it */
339 friend class paths_test;
340 friend class film_metadata_test;