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 std::string audio_analysis_path () const;
68 std::string dcp_video_mxf_filename () const;
69 std::string dcp_audio_mxf_filename () const;
71 void analyse_audio ();
72 void send_dcp_to_tms ();
76 * It is safe to call this from any thread.
78 boost::shared_ptr<Log> log () const {
82 int encoded_frames () const;
84 std::string file (std::string f) const;
85 std::string dir (std::string d) const;
87 void read_metadata ();
88 void write_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;
100 bool have_dcp () const;
102 boost::shared_ptr<Player> player () const;
103 boost::shared_ptr<Playlist> playlist () const;
105 OutputAudioFrame dcp_audio_frame_rate () const;
107 OutputAudioFrame time_to_audio_frames (Time) const;
108 OutputVideoFrame time_to_video_frames (Time) const;
109 Time video_frames_to_time (OutputVideoFrame) const;
110 Time audio_frames_to_time (OutputAudioFrame) const;
112 /* Proxies for some Playlist methods */
114 Playlist::ContentList content () const;
116 Time length () const;
117 bool has_subtitles () const;
118 OutputVideoFrame best_dcp_video_frame_rate () const;
123 void set_sequence_video (bool);
125 /** Identifiers for the parts of our state;
126 used for signalling changes.
132 /** The playlist's content list has changed (i.e. content has been added, moved around or removed) */
145 DCP_VIDEO_FRAME_RATE,
151 std::string directory () const {
152 boost::mutex::scoped_lock lm (_directory_mutex);
156 std::string name () const {
157 boost::mutex::scoped_lock lm (_state_mutex);
161 bool use_dci_name () const {
162 boost::mutex::scoped_lock lm (_state_mutex);
163 return _use_dci_name;
166 DCPContentType const * dcp_content_type () const {
167 boost::mutex::scoped_lock lm (_state_mutex);
168 return _dcp_content_type;
171 Ratio const * container () const {
172 boost::mutex::scoped_lock lm (_state_mutex);
176 Scaler const * scaler () const {
177 boost::mutex::scoped_lock lm (_state_mutex);
182 boost::mutex::scoped_lock lm (_state_mutex);
186 bool with_subtitles () const {
187 boost::mutex::scoped_lock lm (_state_mutex);
188 return _with_subtitles;
191 int subtitle_offset () const {
192 boost::mutex::scoped_lock lm (_state_mutex);
193 return _subtitle_offset;
196 float subtitle_scale () const {
197 boost::mutex::scoped_lock lm (_state_mutex);
198 return _subtitle_scale;
201 int colour_lut () const {
202 boost::mutex::scoped_lock lm (_state_mutex);
206 int j2k_bandwidth () const {
207 boost::mutex::scoped_lock lm (_state_mutex);
208 return _j2k_bandwidth;
211 DCIMetadata dci_metadata () const {
212 boost::mutex::scoped_lock lm (_state_mutex);
213 return _dci_metadata;
216 /* XXX: -> "video_frame_rate" */
217 int dcp_video_frame_rate () const {
218 boost::mutex::scoped_lock lm (_state_mutex);
219 return _dcp_video_frame_rate;
222 int dcp_audio_channels () const {
223 boost::mutex::scoped_lock lm (_state_mutex);
224 return _dcp_audio_channels;
229 void set_directory (std::string);
230 void set_name (std::string);
231 void set_use_dci_name (bool);
232 void examine_and_add_content (boost::shared_ptr<Content>);
233 void add_content (boost::shared_ptr<Content>);
234 void remove_content (boost::shared_ptr<Content>);
235 void set_dcp_content_type (DCPContentType const *);
236 void set_container (Ratio const *);
237 void set_scaler (Scaler const *);
239 void set_with_subtitles (bool);
240 void set_subtitle_offset (int);
241 void set_subtitle_scale (float);
242 void set_colour_lut (int);
243 void set_j2k_bandwidth (int);
244 void set_dci_metadata (DCIMetadata);
245 void set_dcp_video_frame_rate (int);
246 void set_dci_date_today ();
248 /** Emitted when some property has of the Film has changed */
249 mutable boost::signals2::signal<void (Property)> Changed;
251 /** Emitted when some property of our content has changed */
252 mutable boost::signals2::signal<void (boost::weak_ptr<Content>, int)> ContentChanged;
254 boost::signals2::signal<void ()> AudioAnalysisSucceeded;
256 /** Current version number of the state file */
257 static int const state_version;
261 void signal_changed (Property);
262 void analyse_audio_finished ();
263 std::string video_state_identifier () const;
264 void playlist_changed ();
265 void playlist_content_changed (boost::weak_ptr<Content>, int);
266 std::string filename_safe_name () const;
268 /** Log to write to */
269 boost::shared_ptr<Log> _log;
270 /** Any running AnalyseAudioJob, or 0 */
271 boost::shared_ptr<AnalyseAudioJob> _analyse_audio_job;
272 boost::shared_ptr<Playlist> _playlist;
274 /** Complete path to directory containing the film metadata;
275 * must not be relative.
277 std::string _directory;
278 /** Mutex for _directory */
279 mutable boost::mutex _directory_mutex;
281 /** Name for DCP-o-matic */
283 /** True if a auto-generated DCI-compliant name should be used for our DCP */
285 /** The type of content that this Film represents (feature, trailer etc.) */
286 DCPContentType const * _dcp_content_type;
287 /** The container to put this Film in (flat, scope, etc.) */
288 Ratio const * _container;
289 /** Scaler algorithm to use */
290 Scaler const * _scaler;
291 /** true to create an A/B comparison DCP, where the left half of the image
292 is the video without any filters or post-processing, and the right half
293 has the specified filters and post-processing.
296 /** True if subtitles should be shown for this film */
297 bool _with_subtitles;
298 /** y offset for placing subtitles, in source pixels; +ve is further down
299 the frame, -ve is further up.
301 int _subtitle_offset;
302 /** scale factor to apply to subtitles */
303 float _subtitle_scale;
304 /** index of colour LUT to use when converting RGB to XYZ.
309 /** bandwidth for J2K files in bits per second */
311 /** DCI naming stuff */
312 DCIMetadata _dci_metadata;
313 /** Frames per second to run our DCP at */
314 int _dcp_video_frame_rate;
315 /** The date that we should use in a DCI name */
316 boost::gregorian::date _dci_date;
317 int _dcp_audio_channels;
319 /** true if our state has changed since we last saved it */
322 /** Mutex for all state except _directory */
323 mutable boost::mutex _state_mutex;
325 friend class paths_test;
326 friend class film_metadata_test;