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>
36 #include "dci_metadata.h"
48 * @brief A representation of some audio and video content, and details of
49 * how they should be presented in a DCP.
51 * The content of a Film is held in a Playlist (created and managed by the Film).
53 class Film : public boost::enable_shared_from_this<Film>, public boost::noncopyable
56 Film (boost::filesystem::path);
58 std::string info_dir () const;
59 std::string j2c_path (int, Eyes, bool) const;
60 std::string info_path (int, Eyes) const;
61 std::string internal_video_mxf_dir () const;
62 std::string internal_video_mxf_filename () const;
63 boost::filesystem::path audio_analysis_path (boost::shared_ptr<const AudioContent>) const;
65 std::string video_mxf_filename () const;
66 std::string audio_mxf_filename () const;
68 void send_dcp_to_tms ();
72 * It is safe to call this from any thread.
74 boost::shared_ptr<Log> log () const {
78 int encoded_frames () const;
80 std::string file (std::string f) const;
81 std::string dir (std::string d) const;
83 void read_metadata ();
84 void write_metadata () const;
86 std::string dci_name (bool if_created_now) const;
87 std::string dcp_name (bool if_created_now = false) const;
89 /** @return true if our state has changed since we last saved it */
94 libdcp::Size full_frame () const;
96 bool have_dcp () const;
98 boost::shared_ptr<Player> make_player () const;
99 boost::shared_ptr<Playlist> playlist () const;
101 OutputAudioFrame audio_frame_rate () const;
103 OutputAudioFrame time_to_audio_frames (Time) const;
104 OutputVideoFrame time_to_video_frames (Time) const;
105 Time video_frames_to_time (OutputVideoFrame) const;
106 Time audio_frames_to_time (OutputAudioFrame) const;
108 /* Proxies for some Playlist methods */
110 ContentList content () const;
112 Time length () const;
113 bool has_subtitles () const;
114 OutputVideoFrame best_video_frame_rate () const;
116 /** Identifiers for the parts of our state;
117 used for signalling changes.
123 /** The playlist's content list has changed (i.e. content has been added, moved around or removed) */
134 /** The setting of _three_d has been changed */
143 std::string directory () const {
147 std::string name () const {
151 bool use_dci_name () const {
152 return _use_dci_name;
155 DCPContentType const * dcp_content_type () const {
156 return _dcp_content_type;
159 Ratio const * container () const {
163 Resolution resolution () const {
167 Scaler const * scaler () const {
171 bool with_subtitles () const {
172 return _with_subtitles;
175 int j2k_bandwidth () const {
176 return _j2k_bandwidth;
179 DCIMetadata dci_metadata () const {
180 return _dci_metadata;
183 /** @return The frame rate of the DCP */
184 int video_frame_rate () const {
185 return _video_frame_rate;
188 int audio_channels () const {
189 return _audio_channels;
192 bool three_d () const {
196 bool sequence_video () const {
197 return _sequence_video;
200 bool interop () const {
207 void set_directory (std::string);
208 void set_name (std::string);
209 void set_use_dci_name (bool);
210 void examine_and_add_content (boost::shared_ptr<Content>);
211 void add_content (boost::shared_ptr<Content>);
212 void remove_content (boost::shared_ptr<Content>);
213 void set_dcp_content_type (DCPContentType const *);
214 void set_container (Ratio const *);
215 void set_resolution (Resolution);
216 void set_scaler (Scaler const *);
217 void set_with_subtitles (bool);
218 void set_j2k_bandwidth (int);
219 void set_dci_metadata (DCIMetadata);
220 void set_video_frame_rate (int);
221 void set_audio_channels (int);
222 void set_three_d (bool);
223 void set_dci_date_today ();
224 void set_sequence_video (bool);
225 void set_interop (bool);
227 /** Emitted when some property has of the Film has changed */
228 mutable boost::signals2::signal<void (Property)> Changed;
230 /** Emitted when some property of our content has changed */
231 mutable boost::signals2::signal<void (boost::weak_ptr<Content>, int)> ContentChanged;
233 /** Current version number of the state file */
234 static int const state_version;
238 void signal_changed (Property);
239 std::string video_identifier () const;
240 void playlist_changed ();
241 void playlist_content_changed (boost::weak_ptr<Content>, int);
242 std::string filename_safe_name () const;
243 void maybe_add_content (boost::weak_ptr<Job>, boost::weak_ptr<Content>);
245 /** Log to write to */
246 boost::shared_ptr<Log> _log;
247 boost::shared_ptr<Playlist> _playlist;
249 /** Complete path to directory containing the film metadata;
250 * must not be relative.
252 std::string _directory;
254 /** Name for DCP-o-matic */
256 /** True if a auto-generated DCI-compliant name should be used for our DCP */
258 /** The type of content that this Film represents (feature, trailer etc.) */
259 DCPContentType const * _dcp_content_type;
260 /** The container to put this Film in (flat, scope, etc.) */
261 Ratio const * _container;
262 /** DCP resolution (2K or 4K) */
263 Resolution _resolution;
264 /** Scaler algorithm to use */
265 Scaler const * _scaler;
266 /** True if subtitles should be shown for this film */
267 bool _with_subtitles;
268 /** bandwidth for J2K files in bits per second */
270 /** DCI naming stuff */
271 DCIMetadata _dci_metadata;
272 /** Frames per second to run our DCP at */
273 int _video_frame_rate;
274 /** The date that we should use in a DCI name */
275 boost::gregorian::date _dci_date;
276 /** Number of audio channels to put in the DCP */
278 /** If true, the DCP will be written in 3D mode; otherwise in 2D.
279 This will be regardless of what content is on the playlist.
282 bool _sequence_video;
285 /** true if our state has changed since we last saved it */
288 friend class paths_test;
289 friend class film_metadata_test;