2 Copyright (C) 2012 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
31 #include <boost/signals2.hpp>
32 #include <boost/enable_shared_from_this.hpp>
33 #include <boost/filesystem.hpp>
34 #include <libdcp/key.h>
35 #include <libdcp/kdm.h>
38 #include "dci_metadata.h"
51 * @brief A representation of some audio and video content, and details of
52 * how they should be presented in a DCP.
54 * The content of a Film is held in a Playlist (created and managed by the Film).
56 class Film : public boost::enable_shared_from_this<Film>, public boost::noncopyable
59 Film (boost::filesystem::path, bool log = true);
61 boost::filesystem::path info_dir () const;
62 boost::filesystem::path j2c_path (int, Eyes, bool) const;
63 boost::filesystem::path info_path (int, Eyes) const;
64 boost::filesystem::path internal_video_mxf_dir () const;
65 boost::filesystem::path internal_video_mxf_filename () const;
66 boost::filesystem::path audio_analysis_dir () const;
68 boost::filesystem::path video_mxf_filename () const;
69 boost::filesystem::path audio_mxf_filename () const;
71 void send_dcp_to_tms ();
75 * It is safe to call this from any thread.
77 boost::shared_ptr<Log> log () const {
81 int encoded_frames () const;
83 boost::filesystem::path file (boost::filesystem::path f) const;
84 boost::filesystem::path dir (boost::filesystem::path d) const;
86 std::list<std::string> read_metadata ();
87 void write_metadata () const;
88 boost::shared_ptr<xmlpp::Document> metadata () const;
90 std::string dci_name (bool if_created_now) const;
91 std::string dcp_name (bool if_created_now = false) const;
93 /** @return true if our state has changed since we last saved it */
98 libdcp::Size full_frame () const;
99 libdcp::Size frame_size () const;
101 std::list<boost::filesystem::path> dcps () const;
103 boost::shared_ptr<Player> make_player () const;
104 boost::shared_ptr<Playlist> playlist () const;
106 OutputAudioFrame audio_frame_rate () const;
108 OutputAudioFrame time_to_audio_frames (Time) const;
109 OutputVideoFrame time_to_video_frames (Time) const;
110 Time video_frames_to_time (OutputVideoFrame) const;
111 Time audio_frames_to_time (OutputAudioFrame) const;
113 uint64_t required_disk_space () const;
114 bool should_be_enough_disk_space (double &, double &) const;
116 /* Proxies for some Playlist methods */
118 ContentList content () const;
119 Time length () const;
120 bool has_subtitles () const;
121 OutputVideoFrame best_video_frame_rate () const;
125 boost::shared_ptr<libdcp::Certificate> target,
126 boost::filesystem::path dcp,
127 boost::posix_time::ptime from,
128 boost::posix_time::ptime until
131 std::list<libdcp::KDM> make_kdms (
132 std::list<boost::shared_ptr<Screen> >,
133 boost::filesystem::path dcp,
134 boost::posix_time::ptime from,
135 boost::posix_time::ptime until
138 libdcp::Key key () const {
142 int state_version () const {
143 return _state_version;
146 /** Identifiers for the parts of our state;
147 used for signalling changes.
153 /** The playlist's content list has changed (i.e. content has been added, moved around or removed) */
166 /** The setting of _three_d has been changed */
175 boost::filesystem::path directory () const {
179 std::string name () const {
183 bool use_dci_name () const {
184 return _use_dci_name;
187 DCPContentType const * dcp_content_type () const {
188 return _dcp_content_type;
191 Ratio const * container () const {
195 Resolution resolution () const {
199 Scaler const * scaler () const {
203 bool with_subtitles () const {
204 return _with_subtitles;
207 /* signed is a reserved word */
208 bool is_signed () const {
212 bool encrypted () const {
216 int j2k_bandwidth () const {
217 return _j2k_bandwidth;
220 DCIMetadata dci_metadata () const {
221 return _dci_metadata;
224 /** @return The frame rate of the DCP */
225 int video_frame_rate () const {
226 return _video_frame_rate;
229 int audio_channels () const {
230 return _audio_channels;
233 bool three_d () const {
237 bool sequence_video () const {
238 return _sequence_video;
241 bool interop () const {
248 void set_directory (boost::filesystem::path);
249 void set_name (std::string);
250 void set_use_dci_name (bool);
251 void examine_and_add_content (boost::shared_ptr<Content>);
252 void add_content (boost::shared_ptr<Content>);
253 void remove_content (boost::shared_ptr<Content>);
254 void move_content_earlier (boost::shared_ptr<Content>);
255 void move_content_later (boost::shared_ptr<Content>);
256 void set_dcp_content_type (DCPContentType const *);
257 void set_container (Ratio const *);
258 void set_resolution (Resolution);
259 void set_scaler (Scaler const *);
260 void set_with_subtitles (bool);
261 void set_signed (bool);
262 void set_encrypted (bool);
263 void set_j2k_bandwidth (int);
264 void set_dci_metadata (DCIMetadata);
265 void set_video_frame_rate (int);
266 void set_audio_channels (int);
267 void set_three_d (bool);
268 void set_dci_date_today ();
269 void set_sequence_video (bool);
270 void set_interop (bool);
272 /** Emitted when some property has of the Film has changed */
273 mutable boost::signals2::signal<void (Property)> Changed;
275 /** Emitted when some property of our content has changed */
276 mutable boost::signals2::signal<void (boost::weak_ptr<Content>, int)> ContentChanged;
278 /** Current version number of the state file */
279 static int const current_state_version;
283 void signal_changed (Property);
284 std::string video_identifier () const;
285 void playlist_changed ();
286 void playlist_content_changed (boost::weak_ptr<Content>, int);
287 std::string filename_safe_name () const;
288 void maybe_add_content (boost::weak_ptr<Job>, boost::weak_ptr<Content>);
290 /** Log to write to */
291 boost::shared_ptr<Log> _log;
292 boost::shared_ptr<Playlist> _playlist;
294 /** Complete path to directory containing the film metadata;
295 * must not be relative.
297 boost::filesystem::path _directory;
299 /** Name for DCP-o-matic */
301 /** True if a auto-generated DCI-compliant name should be used for our DCP */
303 /** The type of content that this Film represents (feature, trailer etc.) */
304 DCPContentType const * _dcp_content_type;
305 /** The container to put this Film in (flat, scope, etc.) */
306 Ratio const * _container;
307 /** DCP resolution (2K or 4K) */
308 Resolution _resolution;
309 /** Scaler algorithm to use */
310 Scaler const * _scaler;
311 /** True if subtitles should be shown for this film */
312 bool _with_subtitles;
315 /** bandwidth for J2K files in bits per second */
317 /** DCI naming stuff */
318 DCIMetadata _dci_metadata;
319 /** Frames per second to run our DCP at */
320 int _video_frame_rate;
321 /** The date that we should use in a DCI name */
322 boost::gregorian::date _dci_date;
323 /** Number of audio channels to put in the DCP */
325 /** If true, the DCP will be written in 3D mode; otherwise in 2D.
326 This will be regardless of what content is on the playlist.
329 bool _sequence_video;
335 /** true if our state has changed since we last saved it */
338 friend class paths_test;
339 friend class film_metadata_test;