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/thread/mutex.hpp>
32 #include <boost/thread.hpp>
33 #include <boost/signals2.hpp>
34 #include <boost/enable_shared_from_this.hpp>
36 #include "dci_metadata.h"
38 #include "ffmpeg_content.h"
45 class ExamineContentJob;
46 class AnalyseAudioJob;
47 class ExternalAudioStream;
52 * @brief A representation of some audio and video content, and details of
53 * how they should be presented in a DCP.
55 class Film : public boost::enable_shared_from_this<Film>
61 std::string info_dir () const;
62 std::string j2c_path (int f, bool t) const;
63 std::string info_path (int f) const;
64 std::string internal_video_mxf_dir () const;
65 std::string internal_video_mxf_filename () const;
66 boost::filesystem::path audio_analysis_path (boost::shared_ptr<const AudioContent>) const;
68 std::string dcp_video_mxf_filename () const;
69 std::string dcp_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 std::string file (std::string f) const;
84 std::string dir (std::string 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 bool have_dcp () const;
101 boost::shared_ptr<Player> player () const;
102 boost::shared_ptr<Playlist> playlist () const;
104 OutputAudioFrame dcp_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 Playlist::ContentList content () const;
115 Time length () const;
116 bool has_subtitles () const;
117 OutputVideoFrame best_dcp_video_frame_rate () const;
122 void set_sequence_video (bool);
124 /** Identifiers for the parts of our state;
125 used for signalling changes.
131 /** The playlist's content list has changed (i.e. content has been added, moved around or removed) */
143 DCP_VIDEO_FRAME_RATE,
149 std::string directory () const {
150 boost::mutex::scoped_lock lm (_directory_mutex);
154 std::string name () const {
155 boost::mutex::scoped_lock lm (_state_mutex);
159 bool use_dci_name () const {
160 boost::mutex::scoped_lock lm (_state_mutex);
161 return _use_dci_name;
164 DCPContentType const * dcp_content_type () const {
165 boost::mutex::scoped_lock lm (_state_mutex);
166 return _dcp_content_type;
169 Ratio const * container () const {
170 boost::mutex::scoped_lock lm (_state_mutex);
174 Scaler const * scaler () const {
175 boost::mutex::scoped_lock lm (_state_mutex);
179 bool with_subtitles () const {
180 boost::mutex::scoped_lock lm (_state_mutex);
181 return _with_subtitles;
184 int subtitle_offset () const {
185 boost::mutex::scoped_lock lm (_state_mutex);
186 return _subtitle_offset;
189 float subtitle_scale () const {
190 boost::mutex::scoped_lock lm (_state_mutex);
191 return _subtitle_scale;
194 int colour_lut () const {
195 boost::mutex::scoped_lock lm (_state_mutex);
199 int j2k_bandwidth () const {
200 boost::mutex::scoped_lock lm (_state_mutex);
201 return _j2k_bandwidth;
204 DCIMetadata dci_metadata () const {
205 boost::mutex::scoped_lock lm (_state_mutex);
206 return _dci_metadata;
209 /* XXX: -> "video_frame_rate" */
210 int dcp_video_frame_rate () const {
211 boost::mutex::scoped_lock lm (_state_mutex);
212 return _dcp_video_frame_rate;
215 int dcp_audio_channels () const {
216 boost::mutex::scoped_lock lm (_state_mutex);
217 return _dcp_audio_channels;
222 void set_directory (std::string);
223 void set_name (std::string);
224 void set_use_dci_name (bool);
225 void examine_and_add_content (boost::shared_ptr<Content>);
226 void add_content (boost::shared_ptr<Content>);
227 void remove_content (boost::shared_ptr<Content>);
228 void set_dcp_content_type (DCPContentType const *);
229 void set_container (Ratio const *);
230 void set_scaler (Scaler const *);
231 void set_with_subtitles (bool);
232 void set_subtitle_offset (int);
233 void set_subtitle_scale (float);
234 void set_colour_lut (int);
235 void set_j2k_bandwidth (int);
236 void set_dci_metadata (DCIMetadata);
237 void set_dcp_video_frame_rate (int);
238 void set_dci_date_today ();
240 /** Emitted when some property has of the Film has changed */
241 mutable boost::signals2::signal<void (Property)> Changed;
243 /** Emitted when some property of our content has changed */
244 mutable boost::signals2::signal<void (boost::weak_ptr<Content>, int)> ContentChanged;
246 /** Current version number of the state file */
247 static int const state_version;
251 void signal_changed (Property);
252 std::string video_state_identifier () const;
253 void playlist_changed ();
254 void playlist_content_changed (boost::weak_ptr<Content>, int);
255 std::string filename_safe_name () const;
256 void add_content_weak (boost::weak_ptr<Content>);
258 /** Log to write to */
259 boost::shared_ptr<Log> _log;
260 boost::shared_ptr<Playlist> _playlist;
262 /** Complete path to directory containing the film metadata;
263 * must not be relative.
265 std::string _directory;
266 /** Mutex for _directory */
267 mutable boost::mutex _directory_mutex;
269 /** Name for DCP-o-matic */
271 /** True if a auto-generated DCI-compliant name should be used for our DCP */
273 /** The type of content that this Film represents (feature, trailer etc.) */
274 DCPContentType const * _dcp_content_type;
275 /** The container to put this Film in (flat, scope, etc.) */
276 Ratio const * _container;
277 /** Scaler algorithm to use */
278 Scaler const * _scaler;
279 /** True if subtitles should be shown for this film */
280 bool _with_subtitles;
281 /** y offset for placing subtitles, in source pixels; +ve is further down
282 the frame, -ve is further up.
284 int _subtitle_offset;
285 /** scale factor to apply to subtitles */
286 float _subtitle_scale;
287 /** index of colour LUT to use when converting RGB to XYZ.
292 /** bandwidth for J2K files in bits per second */
294 /** DCI naming stuff */
295 DCIMetadata _dci_metadata;
296 /** Frames per second to run our DCP at */
297 int _dcp_video_frame_rate;
298 /** The date that we should use in a DCI name */
299 boost::gregorian::date _dci_date;
300 int _dcp_audio_channels;
302 /** true if our state has changed since we last saved it */
305 /** Mutex for all state except _directory */
306 mutable boost::mutex _state_mutex;
308 friend class paths_test;
309 friend class film_metadata_test;