2 Copyright (C) 2012-2015 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
30 #include "isdcf_metadata.h"
31 #include "frame_rate_change.h"
32 #include "signaller.h"
35 #include <dcp/encrypted_kdm.h>
36 #include <boost/signals2.hpp>
37 #include <boost/enable_shared_from_this.hpp>
38 #include <boost/filesystem.hpp>
52 struct isdcf_name_test;
56 * @brief A representation of some audio and video content, and details of
57 * how they should be presented in a DCP.
59 * The content of a Film is held in a Playlist (created and managed by the Film).
61 class Film : public boost::enable_shared_from_this<Film>, public Signaller, public boost::noncopyable
64 Film (boost::filesystem::path, bool log = true);
67 boost::filesystem::path info_file () const;
68 boost::filesystem::path j2c_path (int, Eyes, bool) const;
69 boost::filesystem::path internal_video_asset_dir () const;
70 boost::filesystem::path internal_video_asset_filename () const;
72 boost::filesystem::path audio_analysis_path (boost::shared_ptr<const Playlist>) 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 boost::filesystem::path file (boost::filesystem::path f) const;
85 boost::filesystem::path dir (boost::filesystem::path d) const;
87 std::list<std::string> read_metadata ();
88 void write_metadata () const;
89 boost::shared_ptr<xmlpp::Document> metadata () const;
91 std::string isdcf_name (bool if_created_now) const;
92 std::string dcp_name (bool if_created_now = false) const;
94 /** @return true if our state has changed since we last saved it */
99 dcp::Size full_frame () const;
100 dcp::Size frame_size () const;
102 std::vector<CPLSummary> cpls () const;
104 boost::shared_ptr<Player> make_player () const;
105 boost::shared_ptr<Playlist> playlist () const;
107 int audio_frame_rate () const;
109 uint64_t required_disk_space () const;
110 bool should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const;
112 /* Proxies for some Playlist methods */
114 ContentList content () const;
115 DCPTime length () const;
116 int best_video_frame_rate () const;
117 FrameRateChange active_frame_rate_change (DCPTime) const;
121 dcp::Certificate target,
122 boost::filesystem::path cpl_file,
124 dcp::LocalTime until,
125 dcp::Formulation formulation
128 std::list<dcp::EncryptedKDM> make_kdms (
129 std::list<boost::shared_ptr<Screen> >,
130 boost::filesystem::path cpl_file,
132 dcp::LocalTime until,
133 dcp::Formulation formulation
136 int state_version () const {
137 return _state_version;
140 std::string subtitle_language () const;
142 void make_audio_mapping_default (AudioMapping & mapping) const;
143 std::vector<std::string> audio_output_names () const;
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 or removed) */
164 /** The setting of _three_d has changed */
168 /** The setting of _burn_subtitles has changed */
176 boost::filesystem::path directory () const {
180 std::string name () const {
184 bool use_isdcf_name () const {
185 return _use_isdcf_name;
188 DCPContentType const * dcp_content_type () const {
189 return _dcp_content_type;
192 Ratio const * container () const {
196 Resolution resolution () const {
200 /* signed is a reserved word */
201 bool is_signed () const {
205 bool encrypted () const {
209 dcp::Key key () const {
213 int j2k_bandwidth () const {
214 return _j2k_bandwidth;
217 ISDCFMetadata isdcf_metadata () const {
218 return _isdcf_metadata;
221 /** @return The frame rate of the DCP */
222 int video_frame_rate () const {
223 return _video_frame_rate;
226 int audio_channels () const {
227 return _audio_channels;
230 bool three_d () const {
234 bool sequence_video () const {
235 return _sequence_video;
238 bool interop () const {
242 bool burn_subtitles () const {
243 return _burn_subtitles;
246 AudioProcessor const * audio_processor () const {
247 return _audio_processor;
253 void set_directory (boost::filesystem::path);
254 void set_name (std::string);
255 void set_use_isdcf_name (bool);
256 void examine_content (boost::shared_ptr<Content>);
257 void examine_and_add_content (boost::shared_ptr<Content>);
258 void add_content (boost::shared_ptr<Content>);
259 void remove_content (boost::shared_ptr<Content>);
260 void move_content_earlier (boost::shared_ptr<Content>);
261 void move_content_later (boost::shared_ptr<Content>);
262 void set_dcp_content_type (DCPContentType const *);
263 void set_container (Ratio const *);
264 void set_resolution (Resolution);
265 void set_signed (bool);
266 void set_encrypted (bool);
267 void set_key (dcp::Key key);
268 void set_j2k_bandwidth (int);
269 void set_isdcf_metadata (ISDCFMetadata);
270 void set_video_frame_rate (int);
271 void set_audio_channels (int);
272 void set_three_d (bool);
273 void set_isdcf_date_today ();
274 void set_sequence_video (bool);
275 void set_interop (bool);
276 void set_burn_subtitles (bool);
277 void set_audio_processor (AudioProcessor const * processor);
279 /** Emitted when some property has of the Film has changed */
280 mutable boost::signals2::signal<void (Property)> Changed;
282 /** Emitted when some property of our content has changed */
283 mutable boost::signals2::signal<void (boost::weak_ptr<Content>, int, bool)> ContentChanged;
285 /** Current version number of the state file */
286 static int const current_state_version;
290 friend struct ::isdcf_name_test;
292 void signal_changed (Property);
293 std::string video_identifier () const;
294 void playlist_changed ();
295 void playlist_content_changed (boost::weak_ptr<Content>, int, bool frequent);
296 std::string filename_safe_name () const;
297 void maybe_add_content (boost::weak_ptr<Job>, boost::weak_ptr<Content>);
299 /** Log to write to */
300 boost::shared_ptr<Log> _log;
301 boost::shared_ptr<Playlist> _playlist;
303 /** Complete path to directory containing the film metadata;
304 * must not be relative.
306 boost::filesystem::path _directory;
308 /** Name for DCP-o-matic */
310 /** True if a auto-generated ISDCF-compliant name should be used for our DCP */
311 bool _use_isdcf_name;
312 /** The type of content that this Film represents (feature, trailer etc.) */
313 DCPContentType const * _dcp_content_type;
314 /** The container to put this Film in (flat, scope, etc.) */
315 Ratio const * _container;
316 /** DCP resolution (2K or 4K) */
317 Resolution _resolution;
321 /** bandwidth for J2K files in bits per second */
323 /** ISDCF naming stuff */
324 ISDCFMetadata _isdcf_metadata;
325 /** Frames per second to run our DCP at */
326 int _video_frame_rate;
327 /** The date that we should use in a ISDCF name */
328 boost::gregorian::date _isdcf_date;
329 /** Number of audio channels requested for the DCP */
331 /** If true, the DCP will be written in 3D mode; otherwise in 2D.
332 This will be regardless of what content is on the playlist.
335 bool _sequence_video;
337 bool _burn_subtitles;
338 AudioProcessor const * _audio_processor;
342 /** true if our state has changed since we last saved it */
345 boost::signals2::scoped_connection _playlist_changed_connection;
346 boost::signals2::scoped_connection _playlist_content_changed_connection;
347 std::list<boost::signals2::connection> _job_connections;
349 friend struct paths_test;
350 friend struct film_metadata_test;