2 Copyright (C) 2012-2019 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"
34 #include "dcp_text_track.h"
36 #include <dcp/encrypted_kdm.h>
37 #include <boost/signals2.hpp>
38 #include <boost/enable_shared_from_this.hpp>
39 #include <boost/filesystem.hpp>
62 struct isdcf_name_test;
66 * @brief A representation of some audio and video content, and details of
67 * how they should be presented in a DCP.
69 * The content of a Film is held in a Playlist (created and managed by the Film).
71 class Film : public boost::enable_shared_from_this<Film>, public Signaller, public boost::noncopyable
74 explicit Film (boost::optional<boost::filesystem::path> dir);
77 boost::filesystem::path info_file (dcpomatic::DCPTimePeriod p) const;
78 boost::filesystem::path j2c_path (int, Frame, Eyes, bool) const;
79 boost::filesystem::path internal_video_asset_dir () const;
80 boost::filesystem::path internal_video_asset_filename (dcpomatic::DCPTimePeriod p) const;
82 boost::filesystem::path audio_analysis_path (boost::shared_ptr<const Playlist>) const;
84 void send_dcp_to_tms ();
85 void make_dcp (bool gui = false);
88 * It is safe to call this from any thread.
90 boost::shared_ptr<Log> log () const {
94 boost::filesystem::path file (boost::filesystem::path f) const;
95 boost::filesystem::path dir (boost::filesystem::path d, bool create = true) const;
97 void use_template (std::string name);
98 std::list<std::string> read_metadata (boost::optional<boost::filesystem::path> path = boost::optional<boost::filesystem::path> ());
99 void write_metadata () const;
100 void write_metadata (boost::filesystem::path path) const;
101 void write_template (boost::filesystem::path path) const;
102 boost::shared_ptr<xmlpp::Document> metadata (bool with_content_paths = true) const;
104 void copy_from (boost::shared_ptr<const Film> film);
106 std::string isdcf_name (bool if_created_now) const;
107 std::string dcp_name (bool if_created_now = false) const;
109 /** @return true if our state has changed since we last saved it */
110 bool dirty () const {
114 dcp::Size full_frame () const;
115 dcp::Size frame_size () const;
117 std::vector<CPLSummary> cpls () const;
119 int audio_frame_rate () const;
121 std::list<DCPTextTrack> closed_caption_tracks () const;
123 uint64_t required_disk_space () const;
124 bool should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const;
126 /* Proxies for some Playlist methods */
128 ContentList content () const;
129 dcpomatic::DCPTime length () const;
130 int best_video_frame_rate () const;
131 FrameRateChange active_frame_rate_change (dcpomatic::DCPTime) const;
132 std::pair<double, double> speed_up_range (int dcp_frame_rate) const;
134 dcp::EncryptedKDM make_kdm (
135 dcp::Certificate recipient,
136 std::vector<std::string> trusted_devices,
137 boost::filesystem::path cpl_file,
139 dcp::LocalTime until,
140 dcp::Formulation formulation,
141 bool disable_forensic_marking_picture,
142 boost::optional<int> disable_forensic_marking_audio
145 std::list<boost::shared_ptr<ScreenKDM> > make_kdms (
146 std::list<boost::shared_ptr<dcpomatic::Screen> > screens,
147 boost::filesystem::path cpl_file,
148 boost::posix_time::ptime from,
149 boost::posix_time::ptime until,
150 dcp::Formulation formulation,
151 bool disable_forensic_marking_picture,
152 boost::optional<int> disable_forensic_marking_audio
155 int state_version () const {
156 return _state_version;
159 std::string subtitle_language () const;
161 std::vector<std::string> audio_output_names () const;
163 void repeat_content (ContentList, int);
165 boost::shared_ptr<const Playlist> playlist () const {
169 std::list<dcpomatic::DCPTimePeriod> reels () const;
170 std::list<int> mapped_audio_channels () const;
172 std::string content_summary (dcpomatic::DCPTimePeriod period) const;
174 bool references_dcp_video () const;
175 bool references_dcp_audio () const;
177 /** Identifiers for the parts of our state;
178 used for signalling changes.
184 /** The playlist's content list has changed (i.e. content has been added or removed) */
186 /** The order of content in the playlist has changed */
198 /** The setting of _three_d has changed */
205 UPLOAD_AFTER_MAKE_DCP,
214 boost::optional<boost::filesystem::path> directory () const {
218 std::string name () const {
222 bool use_isdcf_name () const {
223 return _use_isdcf_name;
226 DCPContentType const * dcp_content_type () const {
227 return _dcp_content_type;
230 Ratio const * container () const {
234 Resolution resolution () const {
238 /* signed is a reserved word */
239 bool is_signed () const {
243 bool encrypted () const {
247 dcp::Key key () const {
251 int j2k_bandwidth () const {
252 return _j2k_bandwidth;
255 ISDCFMetadata isdcf_metadata () const {
256 return _isdcf_metadata;
259 /** @return The frame rate of the DCP */
260 int video_frame_rate () const {
261 return _video_frame_rate;
264 int audio_channels () const {
265 return _audio_channels;
268 bool three_d () const {
272 bool sequence () const {
276 bool interop () const {
280 AudioProcessor const * audio_processor () const {
281 return _audio_processor;
284 ReelType reel_type () const {
288 int64_t reel_length () const {
292 bool upload_after_make_dcp () const {
293 return _upload_after_make_dcp;
296 std::string context_id () const {
300 bool reencode_j2k () const {
301 return _reencode_j2k;
304 boost::optional<dcpomatic::DCPTime> marker (dcp::Marker type) const;
305 std::map<dcp::Marker, dcpomatic::DCPTime> markers () const {
309 std::vector<dcp::Rating> ratings () const {
315 void set_directory (boost::filesystem::path);
316 void set_name (std::string);
317 void set_use_isdcf_name (bool);
318 void examine_and_add_content (boost::shared_ptr<Content> content, bool disable_audio_analysis = false);
319 void add_content (boost::shared_ptr<Content>);
320 void remove_content (boost::shared_ptr<Content>);
321 void remove_content (ContentList);
322 void move_content_earlier (boost::shared_ptr<Content>);
323 void move_content_later (boost::shared_ptr<Content>);
324 void set_dcp_content_type (DCPContentType const *);
325 void set_container (Ratio const *);
326 void set_resolution (Resolution);
327 void set_signed (bool);
328 void set_encrypted (bool);
329 void set_key (dcp::Key key);
330 void set_j2k_bandwidth (int);
331 void set_isdcf_metadata (ISDCFMetadata);
332 void set_video_frame_rate (int rate, bool user_explicit = false);
333 void set_audio_channels (int);
334 void set_three_d (bool);
335 void set_isdcf_date_today ();
336 void set_sequence (bool);
337 void set_interop (bool);
338 void set_audio_processor (AudioProcessor const * processor);
339 void set_reel_type (ReelType);
340 void set_reel_length (int64_t);
341 void set_upload_after_make_dcp (bool);
342 void set_reencode_j2k (bool);
343 void set_marker (dcp::Marker type, dcpomatic::DCPTime time);
344 void unset_marker (dcp::Marker type);
345 void set_ratings (std::vector<dcp::Rating> r);
347 /** Emitted when some property has of the Film is about to change or has changed */
348 mutable boost::signals2::signal<void (ChangeType, Property)> Change;
350 /** Emitted when some property of our content has changed */
351 mutable boost::signals2::signal<void (ChangeType, boost::weak_ptr<Content>, int, bool)> ContentChange;
353 /** Emitted when we have something important to tell the user */
354 boost::signals2::signal<void (std::string)> Message;
356 /** Current version number of the state file */
357 static int const current_state_version;
361 friend struct ::isdcf_name_test;
362 template <typename> friend class ChangeSignaller;
364 void signal_change (ChangeType, Property);
365 void signal_change (ChangeType, int);
366 std::string video_identifier () const;
367 void playlist_change (ChangeType);
368 void playlist_order_changed ();
369 void playlist_content_change (ChangeType type, boost::weak_ptr<Content>, int, bool frequent);
370 void maybe_add_content (boost::weak_ptr<Job>, boost::weak_ptr<Content>, bool disable_audio_analysis);
371 void audio_analysis_finished ();
373 static std::string const metadata_file;
375 /** Log to write to */
376 boost::shared_ptr<Log> _log;
377 boost::shared_ptr<Playlist> _playlist;
379 /** Complete path to directory containing the film metadata;
380 * must not be relative.
382 boost::optional<boost::filesystem::path> _directory;
384 /** Name for DCP-o-matic */
386 /** True if a auto-generated ISDCF-compliant name should be used for our DCP */
387 bool _use_isdcf_name;
388 /** The type of content that this Film represents (feature, trailer etc.) */
389 DCPContentType const * _dcp_content_type;
390 /** The container to put this Film in (flat, scope, etc.) */
391 Ratio const * _container;
392 /** DCP resolution (2K or 4K) */
393 Resolution _resolution;
397 /** context ID used when encrypting picture assets; we keep it so that we can
398 * re-start picture MXF encodes.
400 std::string _context_id;
401 /** bandwidth for J2K files in bits per second */
403 /** ISDCF naming stuff */
404 ISDCFMetadata _isdcf_metadata;
405 /** Frames per second to run our DCP at */
406 int _video_frame_rate;
407 /** The date that we should use in a ISDCF name */
408 boost::gregorian::date _isdcf_date;
409 /** Number of audio channels requested for the DCP */
411 /** If true, the DCP will be written in 3D mode; otherwise in 2D.
412 This will be regardless of what content is on the playlist.
417 AudioProcessor const * _audio_processor;
419 /** Desired reel length in bytes, if _reel_type == REELTYPE_BY_LENGTH */
420 int64_t _reel_length;
421 bool _upload_after_make_dcp;
423 /** true if the user has ever explicitly set the video frame rate of this film */
424 bool _user_explicit_video_frame_rate;
425 std::map<dcp::Marker, dcpomatic::DCPTime> _markers;
426 std::vector<dcp::Rating> _ratings;
430 /** true if our state has changed since we last saved it */
432 /** film being used as a template, or 0 */
433 boost::shared_ptr<Film> _template_film;
435 boost::signals2::scoped_connection _playlist_change_connection;
436 boost::signals2::scoped_connection _playlist_order_changed_connection;
437 boost::signals2::scoped_connection _playlist_content_change_connection;
438 std::list<boost::signals2::connection> _job_connections;
439 std::list<boost::signals2::connection> _audio_analysis_connections;
441 friend struct paths_test;
442 friend struct film_metadata_test;