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::optional<boost::filesystem::path> dir);
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 void use_template (std::string name);
95 std::list<std::string> read_metadata (boost::optional<boost::filesystem::path> path = boost::optional<boost::filesystem::path> ());
96 void write_metadata () const;
97 void write_template (boost::filesystem::path path) const;
98 boost::shared_ptr<xmlpp::Document> metadata (bool with_content_paths = true) const;
100 std::string isdcf_name (bool if_created_now) const;
101 std::string dcp_name (bool if_created_now = false) const;
103 /** @return true if our state has changed since we last saved it */
104 bool dirty () const {
108 dcp::Size full_frame () const;
109 dcp::Size frame_size () const;
111 std::vector<CPLSummary> cpls () const;
113 int audio_frame_rate () const;
115 uint64_t required_disk_space () const;
116 bool should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const;
118 /* Proxies for some Playlist methods */
120 ContentList content () const;
121 DCPTime length () const;
122 int best_video_frame_rate () const;
123 FrameRateChange active_frame_rate_change (DCPTime) const;
125 dcp::EncryptedKDM make_kdm (
126 dcp::Certificate recipient,
127 std::vector<dcp::Certificate> trusted_devices,
128 boost::filesystem::path cpl_file,
130 dcp::LocalTime until,
131 dcp::Formulation formulation
134 std::list<ScreenKDM> make_kdms (
135 std::list<boost::shared_ptr<Screen> >,
136 boost::filesystem::path cpl_file,
137 boost::posix_time::ptime from,
138 boost::posix_time::ptime until,
139 dcp::Formulation formulation
142 int state_version () const {
143 return _state_version;
146 std::string subtitle_language () const;
148 void make_audio_mapping_default (
149 AudioMapping & mapping,
150 boost::optional<boost::filesystem::path> filename = boost::optional<boost::filesystem::path> ()
153 std::vector<std::string> audio_output_names () const;
155 void repeat_content (ContentList, int);
157 boost::shared_ptr<const Playlist> playlist () const {
161 std::list<DCPTimePeriod> reels () const;
162 std::list<int> mapped_audio_channels () const;
164 /** @param A period within the DCP
165 * @return Name of the content which most contributes to the given period.
167 std::string content_summary (DCPTimePeriod period) const;
169 std::list<std::string> fix_conflicting_settings ();
171 /** Identifiers for the parts of our state;
172 used for signalling changes.
178 /** The playlist's content list has changed (i.e. content has been added or removed) */
180 /** The order of content in the playlist has changed */
192 /** The setting of _three_d has changed */
199 UPLOAD_AFTER_MAKE_DCP
205 boost::optional<boost::filesystem::path> directory () const {
209 std::string name () const {
213 bool use_isdcf_name () const {
214 return _use_isdcf_name;
217 DCPContentType const * dcp_content_type () const {
218 return _dcp_content_type;
221 Ratio const * container () const {
225 Resolution resolution () const {
229 /* signed is a reserved word */
230 bool is_signed () const {
234 bool encrypted () const {
238 dcp::Key key () const {
242 int j2k_bandwidth () const {
243 return _j2k_bandwidth;
246 ISDCFMetadata isdcf_metadata () const {
247 return _isdcf_metadata;
250 /** @return The frame rate of the DCP */
251 int video_frame_rate () const {
252 return _video_frame_rate;
255 int audio_channels () const {
256 return _audio_channels;
259 bool three_d () const {
263 bool sequence () const {
267 bool interop () const {
271 AudioProcessor const * audio_processor () const {
272 return _audio_processor;
275 ReelType reel_type () const {
279 int64_t reel_length () const {
283 bool upload_after_make_dcp () const {
284 return _upload_after_make_dcp;
287 std::string context_id () const {
294 void set_directory (boost::filesystem::path);
295 void set_name (std::string);
296 void set_use_isdcf_name (bool);
297 void examine_and_add_content (boost::shared_ptr<Content>);
298 void add_content (boost::shared_ptr<Content>);
299 void remove_content (boost::shared_ptr<Content>);
300 void remove_content (ContentList);
301 void move_content_earlier (boost::shared_ptr<Content>);
302 void move_content_later (boost::shared_ptr<Content>);
303 void set_dcp_content_type (DCPContentType const *);
304 void set_container (Ratio const *);
305 void set_resolution (Resolution);
306 void set_signed (bool);
307 void set_encrypted (bool);
308 void set_key (dcp::Key key);
309 void set_j2k_bandwidth (int);
310 void set_isdcf_metadata (ISDCFMetadata);
311 void set_video_frame_rate (int);
312 void set_audio_channels (int);
313 void set_three_d (bool);
314 void set_isdcf_date_today ();
315 void set_sequence (bool);
316 void set_interop (bool);
317 void set_audio_processor (AudioProcessor const * processor);
318 void set_reel_type (ReelType);
319 void set_reel_length (int64_t);
320 void set_upload_after_make_dcp (bool);
322 /** Emitted when some property has of the Film has changed */
323 mutable boost::signals2::signal<void (Property)> Changed;
325 /** Emitted when some property of our content has changed */
326 mutable boost::signals2::signal<void (boost::weak_ptr<Content>, int, bool)> ContentChanged;
328 /** Current version number of the state file */
329 static int const current_state_version;
333 friend struct ::isdcf_name_test;
335 void signal_changed (Property);
336 std::string video_identifier () const;
337 void playlist_changed ();
338 void playlist_order_changed ();
339 void playlist_content_changed (boost::weak_ptr<Content>, int, bool frequent);
340 void maybe_add_content (boost::weak_ptr<Job>, boost::weak_ptr<Content>);
341 void audio_analysis_finished ();
343 /** Log to write to */
344 boost::shared_ptr<Log> _log;
345 boost::shared_ptr<Playlist> _playlist;
347 /** Complete path to directory containing the film metadata;
348 * must not be relative.
350 boost::optional<boost::filesystem::path> _directory;
352 /** Name for DCP-o-matic */
354 /** True if a auto-generated ISDCF-compliant name should be used for our DCP */
355 bool _use_isdcf_name;
356 /** The type of content that this Film represents (feature, trailer etc.) */
357 DCPContentType const * _dcp_content_type;
358 /** The container to put this Film in (flat, scope, etc.) */
359 Ratio const * _container;
360 /** DCP resolution (2K or 4K) */
361 Resolution _resolution;
365 /** context ID used when encrypting picture assets; we keep it so that we can
366 * re-start picture MXF encodes.
368 std::string _context_id;
369 /** bandwidth for J2K files in bits per second */
371 /** ISDCF naming stuff */
372 ISDCFMetadata _isdcf_metadata;
373 /** Frames per second to run our DCP at */
374 int _video_frame_rate;
375 /** The date that we should use in a ISDCF name */
376 boost::gregorian::date _isdcf_date;
377 /** Number of audio channels requested for the DCP */
379 /** If true, the DCP will be written in 3D mode; otherwise in 2D.
380 This will be regardless of what content is on the playlist.
385 AudioProcessor const * _audio_processor;
387 /** Desired reel length in bytes, if _reel_type == REELTYPE_BY_LENGTH */
388 int64_t _reel_length;
389 bool _upload_after_make_dcp;
393 /** true if our state has changed since we last saved it */
395 /** film being used as a template, or 0 */
396 boost::shared_ptr<Film> _template_film;
398 boost::signals2::scoped_connection _playlist_changed_connection;
399 boost::signals2::scoped_connection _playlist_order_changed_connection;
400 boost::signals2::scoped_connection _playlist_content_changed_connection;
401 std::list<boost::signals2::connection> _job_connections;
402 std::list<boost::signals2::connection> _audio_analysis_connections;
404 friend struct paths_test;
405 friend struct film_metadata_test;