2 Copyright (C) 2012-2016 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, Frame, 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 recipient,
125 std::vector<dcp::Certificate> trusted_devices,
126 boost::filesystem::path cpl_file,
128 dcp::LocalTime until,
129 dcp::Formulation formulation
132 std::list<ScreenKDM> make_kdms (
133 std::list<boost::shared_ptr<Screen> >,
134 boost::filesystem::path cpl_file,
135 boost::posix_time::ptime from,
136 boost::posix_time::ptime until,
137 dcp::Formulation formulation
140 int state_version () const {
141 return _state_version;
144 std::string subtitle_language () const;
146 void make_audio_mapping_default (AudioMapping & mapping) const;
147 std::vector<std::string> audio_output_names () const;
149 void repeat_content (ContentList, int);
151 boost::shared_ptr<const Playlist> playlist () const {
155 std::list<DCPTimePeriod> reels () const;
157 /** Identifiers for the parts of our state;
158 used for signalling changes.
164 /** The playlist's content list has changed (i.e. content has been added or removed) */
166 /** The order of content in the playlist has changed */
178 /** The setting of _three_d has changed */
185 UPLOAD_AFTER_MAKE_DCP
191 boost::filesystem::path directory () const {
195 std::string name () const {
199 bool use_isdcf_name () const {
200 return _use_isdcf_name;
203 DCPContentType const * dcp_content_type () const {
204 return _dcp_content_type;
207 Ratio const * container () const {
211 Resolution resolution () const {
215 /* signed is a reserved word */
216 bool is_signed () const {
220 bool encrypted () const {
224 dcp::Key key () const {
228 int j2k_bandwidth () const {
229 return _j2k_bandwidth;
232 ISDCFMetadata isdcf_metadata () const {
233 return _isdcf_metadata;
236 /** @return The frame rate of the DCP */
237 int video_frame_rate () const {
238 return _video_frame_rate;
241 int audio_channels () const {
242 return _audio_channels;
245 bool three_d () const {
249 bool sequence () const {
253 bool interop () const {
257 AudioProcessor const * audio_processor () const {
258 return _audio_processor;
261 ReelType reel_type () const {
265 int64_t reel_length () const {
269 bool upload_after_make_dcp () const {
270 return _upload_after_make_dcp;
275 void set_directory (boost::filesystem::path);
276 void set_name (std::string);
277 void set_use_isdcf_name (bool);
278 void examine_content (boost::shared_ptr<Content>);
279 void examine_and_add_content (boost::shared_ptr<Content>);
280 void add_content (boost::shared_ptr<Content>);
281 void remove_content (boost::shared_ptr<Content>);
282 void remove_content (ContentList);
283 void move_content_earlier (boost::shared_ptr<Content>);
284 void move_content_later (boost::shared_ptr<Content>);
285 void set_dcp_content_type (DCPContentType const *);
286 void set_container (Ratio const *);
287 void set_resolution (Resolution);
288 void set_signed (bool);
289 void set_encrypted (bool);
290 void set_key (dcp::Key key);
291 void set_j2k_bandwidth (int);
292 void set_isdcf_metadata (ISDCFMetadata);
293 void set_video_frame_rate (int);
294 void set_audio_channels (int);
295 void set_three_d (bool);
296 void set_isdcf_date_today ();
297 void set_sequence (bool);
298 void set_interop (bool);
299 void set_audio_processor (AudioProcessor const * processor);
300 void set_reel_type (ReelType);
301 void set_reel_length (int64_t);
302 void set_upload_after_make_dcp (bool);
304 /** Emitted when some property has of the Film has changed */
305 mutable boost::signals2::signal<void (Property)> Changed;
307 /** Emitted when some property of our content has changed */
308 mutable boost::signals2::signal<void (boost::weak_ptr<Content>, int, bool)> ContentChanged;
310 /** Current version number of the state file */
311 static int const current_state_version;
315 friend struct ::isdcf_name_test;
317 void signal_changed (Property);
318 std::string video_identifier () const;
319 void playlist_changed ();
320 void playlist_order_changed ();
321 void playlist_content_changed (boost::weak_ptr<Content>, int, bool frequent);
322 void maybe_add_content (boost::weak_ptr<Job>, boost::weak_ptr<Content>);
323 void audio_analysis_finished ();
325 /** Log to write to */
326 boost::shared_ptr<Log> _log;
327 boost::shared_ptr<Playlist> _playlist;
329 /** Complete path to directory containing the film metadata;
330 * must not be relative.
332 boost::filesystem::path _directory;
334 /** Name for DCP-o-matic */
336 /** True if a auto-generated ISDCF-compliant name should be used for our DCP */
337 bool _use_isdcf_name;
338 /** The type of content that this Film represents (feature, trailer etc.) */
339 DCPContentType const * _dcp_content_type;
340 /** The container to put this Film in (flat, scope, etc.) */
341 Ratio const * _container;
342 /** DCP resolution (2K or 4K) */
343 Resolution _resolution;
347 /** bandwidth for J2K files in bits per second */
349 /** ISDCF naming stuff */
350 ISDCFMetadata _isdcf_metadata;
351 /** Frames per second to run our DCP at */
352 int _video_frame_rate;
353 /** The date that we should use in a ISDCF name */
354 boost::gregorian::date _isdcf_date;
355 /** Number of audio channels requested for the DCP */
357 /** If true, the DCP will be written in 3D mode; otherwise in 2D.
358 This will be regardless of what content is on the playlist.
363 AudioProcessor const * _audio_processor;
365 /** Desired reel length in bytes, if _reel_type == REELTYPE_BY_LENGTH */
366 int64_t _reel_length;
367 bool _upload_after_make_dcp;
371 /** true if our state has changed since we last saved it */
374 boost::signals2::scoped_connection _playlist_changed_connection;
375 boost::signals2::scoped_connection _playlist_order_changed_connection;
376 boost::signals2::scoped_connection _playlist_content_changed_connection;
377 std::list<boost::signals2::connection> _job_connections;
378 std::list<boost::signals2::connection> _audio_analysis_connections;
380 friend struct paths_test;
381 friend struct film_metadata_test;