2 Copyright (C) 2012-2018 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/thread.hpp>
40 #include <boost/filesystem.hpp>
41 #include <boost/thread/mutex.hpp>
62 struct isdcf_name_test;
73 boost::filesystem::path file () const {
80 InfoFileHandle (boost::mutex& mutex, boost::filesystem::path file, bool read);
82 boost::mutex::scoped_lock _lock;
84 boost::filesystem::path _file;
89 * @brief A representation of some audio and video content, and details of
90 * how they should be presented in a DCP.
92 * The content of a Film is held in a Playlist (created and managed by the Film).
94 class Film : public boost::enable_shared_from_this<Film>, public Signaller, public boost::noncopyable
97 explicit Film (boost::optional<boost::filesystem::path> dir);
100 boost::shared_ptr<InfoFileHandle> info_file_handle (DCPTimePeriod period, bool read) const;
101 boost::filesystem::path j2c_path (int, Frame, Eyes, bool) const;
102 boost::filesystem::path internal_video_asset_dir () const;
103 boost::filesystem::path internal_video_asset_filename (DCPTimePeriod p) const;
105 boost::filesystem::path audio_analysis_path (boost::shared_ptr<const Playlist>) const;
107 void send_dcp_to_tms ();
111 * It is safe to call this from any thread.
113 boost::shared_ptr<Log> log () const {
117 boost::filesystem::path file (boost::filesystem::path f) const;
118 boost::filesystem::path dir (boost::filesystem::path d, bool create = true) const;
120 void use_template (std::string name);
121 std::list<std::string> read_metadata (boost::optional<boost::filesystem::path> path = boost::optional<boost::filesystem::path> ());
122 void write_metadata () const;
123 void write_metadata (boost::filesystem::path path) const;
124 void write_template (boost::filesystem::path path) const;
125 boost::shared_ptr<xmlpp::Document> metadata (bool with_content_paths = true) const;
127 void copy_from (boost::shared_ptr<const Film> film);
129 std::string isdcf_name (bool if_created_now) const;
130 std::string dcp_name (bool if_created_now = false) const;
132 /** @return true if our state has changed since we last saved it */
133 bool dirty () const {
137 dcp::Size full_frame () const;
138 dcp::Size frame_size () const;
140 std::vector<CPLSummary> cpls () const;
142 int audio_frame_rate () const;
144 std::list<DCPTextTrack> closed_caption_tracks () const;
146 uint64_t required_disk_space () const;
147 bool should_be_enough_disk_space (double& required, double& available, bool& can_hard_link) const;
149 /* Proxies for some Playlist methods */
151 ContentList content () const;
152 DCPTime length () const;
153 int best_video_frame_rate () const;
154 FrameRateChange active_frame_rate_change (DCPTime) const;
155 std::pair<double, double> speed_up_range (int dcp_frame_rate) const;
157 dcp::EncryptedKDM make_kdm (
158 dcp::Certificate recipient,
159 std::vector<std::string> trusted_devices,
160 boost::filesystem::path cpl_file,
162 dcp::LocalTime until,
163 dcp::Formulation formulation,
164 bool disable_forensic_marking_picture,
165 boost::optional<int> disable_forensic_marking_audio
168 std::list<ScreenKDM> make_kdms (
169 std::list<boost::shared_ptr<Screen> > screens,
170 boost::filesystem::path cpl_file,
171 boost::posix_time::ptime from,
172 boost::posix_time::ptime until,
173 dcp::Formulation formulation,
174 bool disable_forensic_marking_picture,
175 boost::optional<int> disable_forensic_marking_audio
178 int state_version () const {
179 return _state_version;
182 std::string subtitle_language () const;
184 std::vector<std::string> audio_output_names () const;
186 void repeat_content (ContentList, int);
188 boost::shared_ptr<const Playlist> playlist () const {
192 std::list<DCPTimePeriod> reels () const;
193 std::list<int> mapped_audio_channels () const;
195 std::string content_summary (DCPTimePeriod period) const;
197 bool references_dcp_video () const;
198 bool references_dcp_audio () const;
200 /** Identifiers for the parts of our state;
201 used for signalling changes.
207 /** The playlist's content list has changed (i.e. content has been added or removed) */
209 /** The order of content in the playlist has changed */
221 /** The setting of _three_d has changed */
228 UPLOAD_AFTER_MAKE_DCP,
235 boost::optional<boost::filesystem::path> directory () const {
239 std::string name () const {
243 bool use_isdcf_name () const {
244 return _use_isdcf_name;
247 DCPContentType const * dcp_content_type () const {
248 return _dcp_content_type;
251 Ratio const * container () const {
255 Resolution resolution () const {
259 /* signed is a reserved word */
260 bool is_signed () const {
264 bool encrypted () const {
268 dcp::Key key () const {
272 int j2k_bandwidth () const {
273 return _j2k_bandwidth;
276 ISDCFMetadata isdcf_metadata () const {
277 return _isdcf_metadata;
280 /** @return The frame rate of the DCP */
281 int video_frame_rate () const {
282 return _video_frame_rate;
285 int audio_channels () const {
286 return _audio_channels;
289 bool three_d () const {
293 bool sequence () const {
297 bool interop () const {
301 AudioProcessor const * audio_processor () const {
302 return _audio_processor;
305 ReelType reel_type () const {
309 int64_t reel_length () const {
313 bool upload_after_make_dcp () const {
314 return _upload_after_make_dcp;
317 std::string context_id () const {
321 bool reencode_j2k () const {
322 return _reencode_j2k;
328 void set_directory (boost::filesystem::path);
329 void set_name (std::string);
330 void set_use_isdcf_name (bool);
331 void examine_and_add_content (boost::shared_ptr<Content> content, bool disable_audio_analysis = false);
332 void add_content (boost::shared_ptr<Content>);
333 void remove_content (boost::shared_ptr<Content>);
334 void remove_content (ContentList);
335 void move_content_earlier (boost::shared_ptr<Content>);
336 void move_content_later (boost::shared_ptr<Content>);
337 void set_dcp_content_type (DCPContentType const *);
338 void set_container (Ratio const *);
339 void set_resolution (Resolution);
340 void set_signed (bool);
341 void set_encrypted (bool);
342 void set_key (dcp::Key key);
343 void set_j2k_bandwidth (int);
344 void set_isdcf_metadata (ISDCFMetadata);
345 void set_video_frame_rate (int rate, bool user_explicit = false);
346 void set_audio_channels (int);
347 void set_three_d (bool);
348 void set_isdcf_date_today ();
349 void set_sequence (bool);
350 void set_interop (bool);
351 void set_audio_processor (AudioProcessor const * processor);
352 void set_reel_type (ReelType);
353 void set_reel_length (int64_t);
354 void set_upload_after_make_dcp (bool);
355 void set_reencode_j2k (bool);
357 /** Emitted when some property has of the Film is about to change or has changed */
358 mutable boost::signals2::signal<void (ChangeType, Property)> Change;
360 /** Emitted when some property of our content has changed */
361 mutable boost::signals2::signal<void (ChangeType, boost::weak_ptr<Content>, int, bool)> ContentChange;
363 /** Emitted when we have something important to tell the user */
364 boost::signals2::signal<void (std::string)> Message;
366 /** Current version number of the state file */
367 static int const current_state_version;
371 friend struct ::isdcf_name_test;
372 template <typename> friend class ChangeSignaller;
374 boost::filesystem::path info_file (DCPTimePeriod p) const;
376 void signal_change (ChangeType, Property);
377 void signal_change (ChangeType, int);
378 std::string video_identifier () const;
379 void playlist_change (ChangeType);
380 void playlist_order_changed ();
381 void playlist_content_change (ChangeType type, boost::weak_ptr<Content>, int, bool frequent);
382 void maybe_add_content (boost::weak_ptr<Job>, boost::weak_ptr<Content>, bool disable_audio_analysis);
383 void audio_analysis_finished ();
385 static std::string const metadata_file;
387 /** Log to write to */
388 boost::shared_ptr<Log> _log;
389 boost::shared_ptr<Playlist> _playlist;
391 /** Complete path to directory containing the film metadata;
392 * must not be relative.
394 boost::optional<boost::filesystem::path> _directory;
396 /** Name for DCP-o-matic */
398 /** True if a auto-generated ISDCF-compliant name should be used for our DCP */
399 bool _use_isdcf_name;
400 /** The type of content that this Film represents (feature, trailer etc.) */
401 DCPContentType const * _dcp_content_type;
402 /** The container to put this Film in (flat, scope, etc.) */
403 Ratio const * _container;
404 /** DCP resolution (2K or 4K) */
405 Resolution _resolution;
409 /** context ID used when encrypting picture assets; we keep it so that we can
410 * re-start picture MXF encodes.
412 std::string _context_id;
413 /** bandwidth for J2K files in bits per second */
415 /** ISDCF naming stuff */
416 ISDCFMetadata _isdcf_metadata;
417 /** Frames per second to run our DCP at */
418 int _video_frame_rate;
419 /** The date that we should use in a ISDCF name */
420 boost::gregorian::date _isdcf_date;
421 /** Number of audio channels requested for the DCP */
423 /** If true, the DCP will be written in 3D mode; otherwise in 2D.
424 This will be regardless of what content is on the playlist.
429 AudioProcessor const * _audio_processor;
431 /** Desired reel length in bytes, if _reel_type == REELTYPE_BY_LENGTH */
432 int64_t _reel_length;
433 bool _upload_after_make_dcp;
435 /** true if the user has ever explicitly set the video frame rate of this film */
436 bool _user_explicit_video_frame_rate;
440 /** true if our state has changed since we last saved it */
442 /** film being used as a template, or 0 */
443 boost::shared_ptr<Film> _template_film;
446 mutable boost::mutex _info_file_mutex;
448 boost::signals2::scoped_connection _playlist_change_connection;
449 boost::signals2::scoped_connection _playlist_order_changed_connection;
450 boost::signals2::scoped_connection _playlist_content_change_connection;
451 std::list<boost::signals2::connection> _job_connections;
452 std::list<boost::signals2::connection> _audio_analysis_connections;
454 friend struct paths_test;
455 friend struct film_metadata_test;