2 Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 DCP-o-matic is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
22 * @brief A representation of some audio and video content, and details of
23 * how they should be presented in a DCP.
26 #ifndef DCPOMATIC_FILM_H
27 #define DCPOMATIC_FILM_H
31 #include "isdcf_metadata.h"
32 #include "frame_rate_change.h"
33 #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>
59 struct isdcf_name_test;
63 * @brief A representation of some audio and video content, and details of
64 * how they should be presented in a DCP.
66 * The content of a Film is held in a Playlist (created and managed by the Film).
68 class Film : public boost::enable_shared_from_this<Film>, public Signaller, public boost::noncopyable
71 Film (boost::filesystem::path, bool log = true);
74 boost::filesystem::path info_file (DCPTimePeriod p) const;
75 boost::filesystem::path j2c_path (int, Frame, Eyes, bool) const;
76 boost::filesystem::path internal_video_asset_dir () const;
77 boost::filesystem::path internal_video_asset_filename (DCPTimePeriod p) const;
79 boost::filesystem::path audio_analysis_path (boost::shared_ptr<const Playlist>) const;
81 void send_dcp_to_tms ();
85 * It is safe to call this from any thread.
87 boost::shared_ptr<Log> log () const {
91 boost::filesystem::path file (boost::filesystem::path f) const;
92 boost::filesystem::path dir (boost::filesystem::path d) const;
94 std::list<std::string> read_metadata ();
95 void write_metadata () const;
96 boost::shared_ptr<xmlpp::Document> metadata (bool with_content_paths = true) const;
98 std::string isdcf_name (bool if_created_now) const;
99 std::string dcp_name (bool if_created_now = false) const;
101 /** @return true if our state has changed since we last saved it */
102 bool dirty () const {
106 dcp::Size full_frame () const;
107 dcp::Size frame_size () const;
109 std::vector<CPLSummary> cpls () const;
111 int audio_frame_rate () const;
113 uint64_t required_disk_space () const;
114 bool should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const;
116 /* Proxies for some Playlist methods */
118 ContentList content () const;
119 DCPTime length () const;
120 int best_video_frame_rate () const;
121 FrameRateChange active_frame_rate_change (DCPTime) const;
123 dcp::EncryptedKDM make_kdm (
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 (
147 AudioMapping & mapping,
148 boost::optional<boost::filesystem::path> filename = boost::optional<boost::filesystem::path> ()
151 std::vector<std::string> audio_output_names () const;
153 void repeat_content (ContentList, int);
155 boost::shared_ptr<const Playlist> playlist () const {
159 std::list<DCPTimePeriod> reels () const;
160 std::list<int> mapped_audio_channels () const;
162 /** @param A period within the DCP
163 * @return Name of the content which most contributes to the given period.
165 std::string content_summary (DCPTimePeriod period) const;
167 std::list<std::string> fix_conflicting_settings ();
169 /** Identifiers for the parts of our state;
170 used for signalling changes.
176 /** The playlist's content list has changed (i.e. content has been added or removed) */
178 /** The order of content in the playlist has changed */
190 /** The setting of _three_d has changed */
197 UPLOAD_AFTER_MAKE_DCP
203 boost::filesystem::path directory () const {
207 std::string name () const {
211 bool use_isdcf_name () const {
212 return _use_isdcf_name;
215 DCPContentType const * dcp_content_type () const {
216 return _dcp_content_type;
219 Ratio const * container () const {
223 Resolution resolution () const {
227 /* signed is a reserved word */
228 bool is_signed () const {
232 bool encrypted () const {
236 dcp::Key key () const {
240 int j2k_bandwidth () const {
241 return _j2k_bandwidth;
244 ISDCFMetadata isdcf_metadata () const {
245 return _isdcf_metadata;
248 /** @return The frame rate of the DCP */
249 int video_frame_rate () const {
250 return _video_frame_rate;
253 int audio_channels () const {
254 return _audio_channels;
257 bool three_d () const {
261 bool sequence () const {
265 bool interop () const {
269 AudioProcessor const * audio_processor () const {
270 return _audio_processor;
273 ReelType reel_type () const {
277 int64_t reel_length () const {
281 bool upload_after_make_dcp () const {
282 return _upload_after_make_dcp;
287 void set_directory (boost::filesystem::path);
288 void set_name (std::string);
289 void set_use_isdcf_name (bool);
290 void examine_content (boost::shared_ptr<Content>);
291 void examine_and_add_content (boost::shared_ptr<Content>);
292 void add_content (boost::shared_ptr<Content>);
293 void remove_content (boost::shared_ptr<Content>);
294 void remove_content (ContentList);
295 void move_content_earlier (boost::shared_ptr<Content>);
296 void move_content_later (boost::shared_ptr<Content>);
297 void set_dcp_content_type (DCPContentType const *);
298 void set_container (Ratio const *);
299 void set_resolution (Resolution);
300 void set_signed (bool);
301 void set_encrypted (bool);
302 void set_key (dcp::Key key);
303 void set_j2k_bandwidth (int);
304 void set_isdcf_metadata (ISDCFMetadata);
305 void set_video_frame_rate (int);
306 void set_audio_channels (int);
307 void set_three_d (bool);
308 void set_isdcf_date_today ();
309 void set_sequence (bool);
310 void set_interop (bool);
311 void set_audio_processor (AudioProcessor const * processor);
312 void set_reel_type (ReelType);
313 void set_reel_length (int64_t);
314 void set_upload_after_make_dcp (bool);
316 /** Emitted when some property has of the Film has changed */
317 mutable boost::signals2::signal<void (Property)> Changed;
319 /** Emitted when some property of our content has changed */
320 mutable boost::signals2::signal<void (boost::weak_ptr<Content>, int, bool)> ContentChanged;
322 /** Current version number of the state file */
323 static int const current_state_version;
327 friend struct ::isdcf_name_test;
329 void signal_changed (Property);
330 std::string video_identifier () const;
331 void playlist_changed ();
332 void playlist_order_changed ();
333 void playlist_content_changed (boost::weak_ptr<Content>, int, bool frequent);
334 void maybe_add_content (boost::weak_ptr<Job>, boost::weak_ptr<Content>);
335 void audio_analysis_finished ();
337 /** Log to write to */
338 boost::shared_ptr<Log> _log;
339 boost::shared_ptr<Playlist> _playlist;
341 /** Complete path to directory containing the film metadata;
342 * must not be relative.
344 boost::filesystem::path _directory;
346 /** Name for DCP-o-matic */
348 /** True if a auto-generated ISDCF-compliant name should be used for our DCP */
349 bool _use_isdcf_name;
350 /** The type of content that this Film represents (feature, trailer etc.) */
351 DCPContentType const * _dcp_content_type;
352 /** The container to put this Film in (flat, scope, etc.) */
353 Ratio const * _container;
354 /** DCP resolution (2K or 4K) */
355 Resolution _resolution;
359 /** bandwidth for J2K files in bits per second */
361 /** ISDCF naming stuff */
362 ISDCFMetadata _isdcf_metadata;
363 /** Frames per second to run our DCP at */
364 int _video_frame_rate;
365 /** The date that we should use in a ISDCF name */
366 boost::gregorian::date _isdcf_date;
367 /** Number of audio channels requested for the DCP */
369 /** If true, the DCP will be written in 3D mode; otherwise in 2D.
370 This will be regardless of what content is on the playlist.
375 AudioProcessor const * _audio_processor;
377 /** Desired reel length in bytes, if _reel_type == REELTYPE_BY_LENGTH */
378 int64_t _reel_length;
379 bool _upload_after_make_dcp;
383 /** true if our state has changed since we last saved it */
386 boost::signals2::scoped_connection _playlist_changed_connection;
387 boost::signals2::scoped_connection _playlist_order_changed_connection;
388 boost::signals2::scoped_connection _playlist_content_changed_connection;
389 std::list<boost::signals2::connection> _job_connections;
390 std::list<boost::signals2::connection> _audio_analysis_connections;
392 friend struct paths_test;
393 friend struct film_metadata_test;