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);
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_path (boost::shared_ptr<const AudioContent>) 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 void read_metadata ();
87 void write_metadata () const;
89 std::string dci_name (bool if_created_now) const;
90 std::string dcp_name (bool if_created_now = false) const;
92 /** @return true if our state has changed since we last saved it */
97 libdcp::Size full_frame () const;
99 std::list<boost::filesystem::path> dcps () const;
101 boost::shared_ptr<Player> make_player () const;
102 boost::shared_ptr<Playlist> playlist () const;
104 OutputAudioFrame audio_frame_rate () const;
106 OutputAudioFrame time_to_audio_frames (Time) const;
107 OutputVideoFrame time_to_video_frames (Time) const;
108 Time video_frames_to_time (OutputVideoFrame) const;
109 Time audio_frames_to_time (OutputAudioFrame) const;
111 /* Proxies for some Playlist methods */
113 ContentList content () const;
114 Time length () const;
115 bool has_subtitles () const;
116 OutputVideoFrame best_video_frame_rate () const;
120 boost::shared_ptr<libdcp::Certificate> target,
121 boost::filesystem::path dcp,
122 boost::posix_time::ptime from,
123 boost::posix_time::ptime until
126 std::list<libdcp::KDM> make_kdms (
127 std::list<boost::shared_ptr<Screen> >,
128 boost::filesystem::path dcp,
129 boost::posix_time::ptime from,
130 boost::posix_time::ptime until
133 libdcp::Key key () const {
137 /** Identifiers for the parts of our state;
138 used for signalling changes.
144 /** The playlist's content list has changed (i.e. content has been added, moved around or removed) */
157 /** The setting of _three_d has been changed */
166 boost::filesystem::path directory () const {
170 std::string name () const {
174 bool use_dci_name () const {
175 return _use_dci_name;
178 DCPContentType const * dcp_content_type () const {
179 return _dcp_content_type;
182 Ratio const * container () const {
186 Resolution resolution () const {
190 Scaler const * scaler () const {
194 bool with_subtitles () const {
195 return _with_subtitles;
198 /* signed is a reserved word */
199 bool is_signed () const {
203 bool encrypted () const {
207 int j2k_bandwidth () const {
208 return _j2k_bandwidth;
211 DCIMetadata dci_metadata () const {
212 return _dci_metadata;
215 /** @return The frame rate of the DCP */
216 int video_frame_rate () const {
217 return _video_frame_rate;
220 int audio_channels () const {
221 return _audio_channels;
224 bool three_d () const {
228 bool sequence_video () const {
229 return _sequence_video;
232 bool interop () const {
239 void set_directory (boost::filesystem::path);
240 void set_name (std::string);
241 void set_use_dci_name (bool);
242 void examine_and_add_content (boost::shared_ptr<Content>);
243 void add_content (boost::shared_ptr<Content>);
244 void remove_content (boost::shared_ptr<Content>);
245 void move_content_earlier (boost::shared_ptr<Content>);
246 void move_content_later (boost::shared_ptr<Content>);
247 void set_dcp_content_type (DCPContentType const *);
248 void set_container (Ratio const *);
249 void set_resolution (Resolution);
250 void set_scaler (Scaler const *);
251 void set_with_subtitles (bool);
252 void set_signed (bool);
253 void set_encrypted (bool);
254 void set_j2k_bandwidth (int);
255 void set_dci_metadata (DCIMetadata);
256 void set_video_frame_rate (int);
257 void set_audio_channels (int);
258 void set_three_d (bool);
259 void set_dci_date_today ();
260 void set_sequence_video (bool);
261 void set_interop (bool);
263 /** Emitted when some property has of the Film has changed */
264 mutable boost::signals2::signal<void (Property)> Changed;
266 /** Emitted when some property of our content has changed */
267 mutable boost::signals2::signal<void (boost::weak_ptr<Content>, int)> ContentChanged;
269 /** Current version number of the state file */
270 static int const state_version;
274 void signal_changed (Property);
275 std::string video_identifier () const;
276 void playlist_changed ();
277 void playlist_content_changed (boost::weak_ptr<Content>, int);
278 std::string filename_safe_name () const;
279 void maybe_add_content (boost::weak_ptr<Job>, boost::weak_ptr<Content>);
281 /** Log to write to */
282 boost::shared_ptr<Log> _log;
283 boost::shared_ptr<Playlist> _playlist;
285 /** Complete path to directory containing the film metadata;
286 * must not be relative.
288 boost::filesystem::path _directory;
290 /** Name for DCP-o-matic */
292 /** True if a auto-generated DCI-compliant name should be used for our DCP */
294 /** The type of content that this Film represents (feature, trailer etc.) */
295 DCPContentType const * _dcp_content_type;
296 /** The container to put this Film in (flat, scope, etc.) */
297 Ratio const * _container;
298 /** DCP resolution (2K or 4K) */
299 Resolution _resolution;
300 /** Scaler algorithm to use */
301 Scaler const * _scaler;
302 /** True if subtitles should be shown for this film */
303 bool _with_subtitles;
306 /** bandwidth for J2K files in bits per second */
308 /** DCI naming stuff */
309 DCIMetadata _dci_metadata;
310 /** Frames per second to run our DCP at */
311 int _video_frame_rate;
312 /** The date that we should use in a DCI name */
313 boost::gregorian::date _dci_date;
314 /** Number of audio channels to put in the DCP */
316 /** If true, the DCP will be written in 3D mode; otherwise in 2D.
317 This will be regardless of what content is on the playlist.
320 bool _sequence_video;
324 /** true if our state has changed since we last saved it */
327 friend class paths_test;
328 friend class film_metadata_test;