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>
37 #include "dci_metadata.h"
50 * @brief A representation of some audio and video content, and details of
51 * how they should be presented in a DCP.
53 * The content of a Film is held in a Playlist (created and managed by the Film).
55 class Film : public boost::enable_shared_from_this<Film>, public boost::noncopyable
58 Film (boost::filesystem::path);
60 std::string info_dir () const;
61 std::string j2c_path (int, Eyes, bool) const;
62 std::string info_path (int, Eyes) const;
63 std::string internal_video_mxf_dir () const;
64 std::string internal_video_mxf_filename () const;
65 boost::filesystem::path audio_analysis_path (boost::shared_ptr<const AudioContent>) const;
67 std::string video_mxf_filename () const;
68 std::string audio_mxf_filename () const;
70 void send_dcp_to_tms ();
74 * It is safe to call this from any thread.
76 boost::shared_ptr<Log> log () const {
80 int encoded_frames () const;
82 std::string file (std::string f) const;
83 std::string dir (std::string d) const;
85 void read_metadata ();
86 void write_metadata () const;
88 std::string dci_name (bool if_created_now) const;
89 std::string dcp_name (bool if_created_now = false) const;
91 /** @return true if our state has changed since we last saved it */
96 libdcp::Size full_frame () const;
98 bool have_dcp () const;
100 boost::shared_ptr<Player> make_player () const;
101 boost::shared_ptr<Playlist> playlist () const;
103 OutputAudioFrame audio_frame_rate () const;
105 OutputAudioFrame time_to_audio_frames (Time) const;
106 OutputVideoFrame time_to_video_frames (Time) const;
107 Time video_frames_to_time (OutputVideoFrame) const;
108 Time audio_frames_to_time (OutputAudioFrame) const;
110 /* Proxies for some Playlist methods */
112 ContentList content () const;
114 Time length () const;
115 bool has_subtitles () const;
116 OutputVideoFrame best_video_frame_rate () const;
119 std::list<boost::shared_ptr<Screen> >,
120 boost::posix_time::ptime from,
121 boost::posix_time::ptime until,
122 std::string directory
125 libdcp::Key key () const {
129 /** Identifiers for the parts of our state;
130 used for signalling changes.
136 /** The playlist's content list has changed (i.e. content has been added, moved around or removed) */
148 /** The setting of _three_d has been changed */
157 std::string directory () const {
161 std::string name () const {
165 bool use_dci_name () const {
166 return _use_dci_name;
169 DCPContentType const * dcp_content_type () const {
170 return _dcp_content_type;
173 Ratio const * container () const {
177 Resolution resolution () const {
181 Scaler const * scaler () const {
185 bool with_subtitles () const {
186 return _with_subtitles;
189 bool encrypted () const {
193 int j2k_bandwidth () const {
194 return _j2k_bandwidth;
197 DCIMetadata dci_metadata () const {
198 return _dci_metadata;
201 /** @return The frame rate of the DCP */
202 int video_frame_rate () const {
203 return _video_frame_rate;
206 int audio_channels () const {
207 return _audio_channels;
210 bool three_d () const {
214 bool sequence_video () const {
215 return _sequence_video;
218 bool interop () const {
225 void set_directory (std::string);
226 void set_name (std::string);
227 void set_use_dci_name (bool);
228 void examine_and_add_content (boost::shared_ptr<Content>);
229 void add_content (boost::shared_ptr<Content>);
230 void remove_content (boost::shared_ptr<Content>);
231 void set_dcp_content_type (DCPContentType const *);
232 void set_container (Ratio const *);
233 void set_resolution (Resolution);
234 void set_scaler (Scaler const *);
235 void set_with_subtitles (bool);
236 void set_encrypted (bool);
237 void set_j2k_bandwidth (int);
238 void set_dci_metadata (DCIMetadata);
239 void set_video_frame_rate (int);
240 void set_audio_channels (int);
241 void set_three_d (bool);
242 void set_dci_date_today ();
243 void set_sequence_video (bool);
244 void set_interop (bool);
246 /** Emitted when some property has of the Film has changed */
247 mutable boost::signals2::signal<void (Property)> Changed;
249 /** Emitted when some property of our content has changed */
250 mutable boost::signals2::signal<void (boost::weak_ptr<Content>, int)> ContentChanged;
252 /** Current version number of the state file */
253 static int const state_version;
257 void signal_changed (Property);
258 std::string video_identifier () const;
259 void playlist_changed ();
260 void playlist_content_changed (boost::weak_ptr<Content>, int);
261 std::string filename_safe_name () const;
262 void maybe_add_content (boost::weak_ptr<Job>, boost::weak_ptr<Content>);
264 /** Log to write to */
265 boost::shared_ptr<Log> _log;
266 boost::shared_ptr<Playlist> _playlist;
268 /** Complete path to directory containing the film metadata;
269 * must not be relative.
271 std::string _directory;
273 /** Name for DCP-o-matic */
275 /** True if a auto-generated DCI-compliant name should be used for our DCP */
277 /** The type of content that this Film represents (feature, trailer etc.) */
278 DCPContentType const * _dcp_content_type;
279 /** The container to put this Film in (flat, scope, etc.) */
280 Ratio const * _container;
281 /** DCP resolution (2K or 4K) */
282 Resolution _resolution;
283 /** Scaler algorithm to use */
284 Scaler const * _scaler;
285 /** True if subtitles should be shown for this film */
286 bool _with_subtitles;
288 /** bandwidth for J2K files in bits per second */
290 /** DCI naming stuff */
291 DCIMetadata _dci_metadata;
292 /** Frames per second to run our DCP at */
293 int _video_frame_rate;
294 /** The date that we should use in a DCI name */
295 boost::gregorian::date _dci_date;
296 /** Number of audio channels to put in the DCP */
298 /** If true, the DCP will be written in 3D mode; otherwise in 2D.
299 This will be regardless of what content is on the playlist.
302 bool _sequence_video;
306 /** true if our state has changed since we last saved it */
309 friend class paths_test;
310 friend class film_metadata_test;