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"
34 #include <dcp/encrypted_kdm.h>
35 #include <boost/signals2.hpp>
36 #include <boost/enable_shared_from_this.hpp>
37 #include <boost/filesystem.hpp>
58 struct isdcf_name_test;
62 * @brief A representation of some audio and video content, and details of
63 * how they should be presented in a DCP.
65 * The content of a Film is held in a Playlist (created and managed by the Film).
67 class Film : public boost::enable_shared_from_this<Film>, public Signaller, public boost::noncopyable
70 Film (boost::filesystem::path, bool log = true);
73 boost::filesystem::path info_file (DCPTimePeriod p) const;
74 boost::filesystem::path j2c_path (int, Eyes, bool) const;
75 boost::filesystem::path internal_video_asset_dir () const;
76 boost::filesystem::path internal_video_asset_filename (DCPTimePeriod p) const;
78 boost::filesystem::path audio_analysis_path (boost::shared_ptr<const Playlist>) const;
80 void send_dcp_to_tms ();
84 * It is safe to call this from any thread.
86 boost::shared_ptr<Log> log () const {
90 boost::filesystem::path file (boost::filesystem::path f) const;
91 boost::filesystem::path dir (boost::filesystem::path d) const;
93 std::list<std::string> read_metadata ();
94 void write_metadata () const;
95 boost::shared_ptr<xmlpp::Document> metadata () const;
97 std::string isdcf_name (bool if_created_now) const;
98 std::string dcp_name (bool if_created_now = false) const;
100 /** @return true if our state has changed since we last saved it */
101 bool dirty () const {
105 dcp::Size full_frame () const;
106 dcp::Size frame_size () const;
108 std::vector<CPLSummary> cpls () const;
110 int audio_frame_rate () const;
112 uint64_t required_disk_space () const;
113 bool should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const;
115 /* Proxies for some Playlist methods */
117 ContentList content () const;
118 DCPTime length () const;
119 int best_video_frame_rate () const;
120 FrameRateChange active_frame_rate_change (DCPTime) const;
124 dcp::Certificate target,
125 boost::filesystem::path cpl_file,
127 dcp::LocalTime until,
128 dcp::Formulation formulation
131 std::list<ScreenKDM> make_kdms (
132 std::list<boost::shared_ptr<Screen> >,
133 boost::filesystem::path cpl_file,
135 dcp::LocalTime until,
136 dcp::Formulation formulation
139 int state_version () const {
140 return _state_version;
143 std::string subtitle_language () const;
145 void make_audio_mapping_default (AudioMapping & mapping) const;
146 std::vector<std::string> audio_output_names () const;
148 void repeat_content (ContentList, int);
150 boost::shared_ptr<const Playlist> playlist () const {
154 std::list<DCPTimePeriod> reels () const;
156 /** Identifiers for the parts of our state;
157 used for signalling changes.
163 /** The playlist's content list has changed (i.e. content has been added or removed) */
175 /** The setting of _three_d has changed */
185 boost::filesystem::path directory () const {
189 std::string name () const {
193 bool use_isdcf_name () const {
194 return _use_isdcf_name;
197 DCPContentType const * dcp_content_type () const {
198 return _dcp_content_type;
201 Ratio const * container () const {
205 Resolution resolution () const {
209 /* signed is a reserved word */
210 bool is_signed () const {
214 bool encrypted () const {
218 dcp::Key key () const {
222 int j2k_bandwidth () const {
223 return _j2k_bandwidth;
226 ISDCFMetadata isdcf_metadata () const {
227 return _isdcf_metadata;
230 /** @return The frame rate of the DCP */
231 int video_frame_rate () const {
232 return _video_frame_rate;
235 int audio_channels () const {
236 return _audio_channels;
239 bool three_d () const {
243 bool sequence_video () const {
244 return _sequence_video;
247 bool interop () const {
251 AudioProcessor const * audio_processor () const {
252 return _audio_processor;
258 void set_directory (boost::filesystem::path);
259 void set_name (std::string);
260 void set_use_isdcf_name (bool);
261 void examine_content (boost::shared_ptr<Content>);
262 void examine_and_add_content (boost::shared_ptr<Content>);
263 void add_content (boost::shared_ptr<Content>);
264 void remove_content (boost::shared_ptr<Content>);
265 void remove_content (ContentList);
266 void move_content_earlier (boost::shared_ptr<Content>);
267 void move_content_later (boost::shared_ptr<Content>);
268 void set_dcp_content_type (DCPContentType const *);
269 void set_container (Ratio const *);
270 void set_resolution (Resolution);
271 void set_signed (bool);
272 void set_encrypted (bool);
273 void set_key (dcp::Key key);
274 void set_j2k_bandwidth (int);
275 void set_isdcf_metadata (ISDCFMetadata);
276 void set_video_frame_rate (int);
277 void set_audio_channels (int);
278 void set_three_d (bool);
279 void set_isdcf_date_today ();
280 void set_sequence_video (bool);
281 void set_interop (bool);
282 void set_audio_processor (AudioProcessor const * processor);
284 /** Emitted when some property has of the Film has changed */
285 mutable boost::signals2::signal<void (Property)> Changed;
287 /** Emitted when some property of our content has changed */
288 mutable boost::signals2::signal<void (boost::weak_ptr<Content>, int, bool)> ContentChanged;
290 /** Current version number of the state file */
291 static int const current_state_version;
295 friend struct ::isdcf_name_test;
297 void signal_changed (Property);
298 std::string video_identifier () const;
299 void playlist_changed ();
300 void playlist_content_changed (boost::weak_ptr<Content>, int, bool frequent);
301 void maybe_add_content (boost::weak_ptr<Job>, boost::weak_ptr<Content>);
302 void audio_analysis_finished ();
304 /** Log to write to */
305 boost::shared_ptr<Log> _log;
306 boost::shared_ptr<Playlist> _playlist;
308 /** Complete path to directory containing the film metadata;
309 * must not be relative.
311 boost::filesystem::path _directory;
313 /** Name for DCP-o-matic */
315 /** True if a auto-generated ISDCF-compliant name should be used for our DCP */
316 bool _use_isdcf_name;
317 /** The type of content that this Film represents (feature, trailer etc.) */
318 DCPContentType const * _dcp_content_type;
319 /** The container to put this Film in (flat, scope, etc.) */
320 Ratio const * _container;
321 /** DCP resolution (2K or 4K) */
322 Resolution _resolution;
326 /** bandwidth for J2K files in bits per second */
328 /** ISDCF naming stuff */
329 ISDCFMetadata _isdcf_metadata;
330 /** Frames per second to run our DCP at */
331 int _video_frame_rate;
332 /** The date that we should use in a ISDCF name */
333 boost::gregorian::date _isdcf_date;
334 /** Number of audio channels requested for the DCP */
336 /** If true, the DCP will be written in 3D mode; otherwise in 2D.
337 This will be regardless of what content is on the playlist.
340 bool _sequence_video;
342 AudioProcessor const * _audio_processor;
346 /** true if our state has changed since we last saved it */
349 boost::signals2::scoped_connection _playlist_changed_connection;
350 boost::signals2::scoped_connection _playlist_content_changed_connection;
351 std::list<boost::signals2::connection> _job_connections;
352 std::list<boost::signals2::connection> _audio_analysis_connections;
354 friend struct paths_test;
355 friend struct film_metadata_test;