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 DVDOMATIC_FILM_H
26 #define DVDOMATIC_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;
53 * @brief A representation of some audio and video content, and details of
54 * how they should be presented in a DCP.
56 class Film : public boost::enable_shared_from_this<Film>
59 Film (std::string d, bool must_exist = true);
62 std::string info_dir () const;
63 std::string j2c_path (int f, bool t) const;
64 std::string info_path (int f) const;
65 std::string video_mxf_dir () const;
66 std::string video_mxf_filename () const;
67 std::string audio_analysis_path () const;
69 void examine_content (boost::shared_ptr<Content>);
70 void analyse_audio ();
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 int target_audio_sample_rate () const;
88 void write_metadata () const;
90 libdcp::Size cropped_size (libdcp::Size) const;
91 std::string dci_name (bool if_created_now) const;
92 std::string dcp_name (bool if_created_now = false) const;
94 /** @return true if our state has changed since we last saved it */
99 bool have_dcp () const;
101 boost::shared_ptr<Player> player () const;
103 /* Proxies for some Playlist methods */
105 ContentAudioFrame audio_length () const;
106 int audio_channels () const;
107 int audio_frame_rate () const;
108 int64_t audio_channel_layout () const;
109 bool has_audio () const;
111 float video_frame_rate () const;
112 libdcp::Size video_size () const;
113 ContentVideoFrame video_length () const;
115 std::vector<FFmpegSubtitleStream> ffmpeg_subtitle_streams () const;
116 boost::optional<FFmpegSubtitleStream> ffmpeg_subtitle_stream () const;
117 std::vector<FFmpegAudioStream> ffmpeg_audio_streams () const;
118 boost::optional<FFmpegAudioStream> ffmpeg_audio_stream () const;
120 void set_ffmpeg_subtitle_stream (FFmpegSubtitleStream);
121 void set_ffmpeg_audio_stream (FFmpegAudioStream);
123 /** Identifiers for the parts of our state;
124 used for signalling changes.
130 TRUST_CONTENT_HEADERS,
131 /** The content list has changed (i.e. content has been added, moved around or removed) */
155 std::string directory () const {
156 boost::mutex::scoped_lock lm (_directory_mutex);
160 std::string name () const {
161 boost::mutex::scoped_lock lm (_state_mutex);
165 bool use_dci_name () const {
166 boost::mutex::scoped_lock lm (_state_mutex);
167 return _use_dci_name;
170 bool trust_content_headers () const {
171 boost::mutex::scoped_lock lm (_state_mutex);
172 return _trust_content_headers;
175 ContentList content () const {
176 boost::mutex::scoped_lock lm (_state_mutex);
180 DCPContentType const * dcp_content_type () const {
181 boost::mutex::scoped_lock lm (_state_mutex);
182 return _dcp_content_type;
185 Format const * format () const {
186 boost::mutex::scoped_lock lm (_state_mutex);
191 boost::mutex::scoped_lock lm (_state_mutex);
195 std::vector<Filter const *> filters () const {
196 boost::mutex::scoped_lock lm (_state_mutex);
200 Scaler const * scaler () const {
201 boost::mutex::scoped_lock lm (_state_mutex);
205 int trim_start () const {
206 boost::mutex::scoped_lock lm (_state_mutex);
210 int trim_end () const {
211 boost::mutex::scoped_lock lm (_state_mutex);
216 boost::mutex::scoped_lock lm (_state_mutex);
220 float audio_gain () const {
221 boost::mutex::scoped_lock lm (_state_mutex);
225 int audio_delay () const {
226 boost::mutex::scoped_lock lm (_state_mutex);
230 bool with_subtitles () const {
231 boost::mutex::scoped_lock lm (_state_mutex);
232 return _with_subtitles;
235 int subtitle_offset () const {
236 boost::mutex::scoped_lock lm (_state_mutex);
237 return _subtitle_offset;
240 float subtitle_scale () const {
241 boost::mutex::scoped_lock lm (_state_mutex);
242 return _subtitle_scale;
245 int colour_lut () const {
246 boost::mutex::scoped_lock lm (_state_mutex);
250 int j2k_bandwidth () const {
251 boost::mutex::scoped_lock lm (_state_mutex);
252 return _j2k_bandwidth;
255 DCIMetadata dci_metadata () const {
256 boost::mutex::scoped_lock lm (_state_mutex);
257 return _dci_metadata;
260 int dcp_frame_rate () const {
261 boost::mutex::scoped_lock lm (_state_mutex);
262 return _dcp_frame_rate;
267 void set_directory (std::string);
268 void set_name (std::string);
269 void set_use_dci_name (bool);
270 void set_trust_content_headers (bool);
271 void add_content (boost::shared_ptr<Content>);
272 void remove_content (boost::shared_ptr<Content>);
273 void move_content_earlier (boost::shared_ptr<Content>);
274 void move_content_later (boost::shared_ptr<Content>);
275 void set_dcp_content_type (DCPContentType const *);
276 void set_format (Format const *);
277 void set_crop (Crop);
278 void set_left_crop (int);
279 void set_right_crop (int);
280 void set_top_crop (int);
281 void set_bottom_crop (int);
282 void set_filters (std::vector<Filter const *>);
283 void set_scaler (Scaler const *);
284 void set_trim_start (int);
285 void set_trim_end (int);
287 void set_audio_gain (float);
288 void set_audio_delay (int);
289 void set_with_subtitles (bool);
290 void set_subtitle_offset (int);
291 void set_subtitle_scale (float);
292 void set_colour_lut (int);
293 void set_j2k_bandwidth (int);
294 void set_dci_metadata (DCIMetadata);
295 void set_dcp_frame_rate (int);
296 void set_dci_date_today ();
298 /** Emitted when some property has of the Film has changed */
299 mutable boost::signals2::signal<void (Property)> Changed;
301 /** Emitted when some property of our content has changed */
302 mutable boost::signals2::signal<void (int)> ContentChanged;
304 boost::signals2::signal<void ()> AudioAnalysisSucceeded;
306 /** Current version number of the state file */
307 static int const state_version;
311 void signal_changed (Property);
312 void analyse_audio_finished ();
313 std::string video_state_identifier () const;
314 void read_metadata ();
315 void content_changed (int);
316 boost::shared_ptr<FFmpegContent> ffmpeg () const;
318 /** Log to write to */
319 boost::shared_ptr<Log> _log;
320 /** Any running AnalyseAudioJob, or 0 */
321 boost::shared_ptr<AnalyseAudioJob> _analyse_audio_job;
322 boost::shared_ptr<Playlist> _playlist;
324 /** Complete path to directory containing the film metadata;
325 * must not be relative.
327 std::string _directory;
328 /** Mutex for _directory */
329 mutable boost::mutex _directory_mutex;
331 /** Name for DVD-o-matic */
333 /** True if a auto-generated DCI-compliant name should be used for our DCP */
335 bool _trust_content_headers;
336 ContentList _content;
337 std::list<boost::signals2::connection> _content_connections;
338 /** The type of content that this Film represents (feature, trailer etc.) */
339 DCPContentType const * _dcp_content_type;
340 /** The format to present this Film in (flat, scope, etc.) */
341 Format const * _format;
342 /** The crop to apply to the source */
344 /** Video filters that should be used when generating DCPs */
345 std::vector<Filter const *> _filters;
346 /** Scaler algorithm to use */
347 Scaler const * _scaler;
348 /** Frames to trim off the start of the DCP */
350 /** Frames to trim off the end of the DCP */
352 /** true to create an A/B comparison DCP, where the left half of the image
353 is the video without any filters or post-processing, and the right half
354 has the specified filters and post-processing.
357 /** Gain to apply to audio in dB */
359 /** Delay to apply to audio (positive moves audio later) in milliseconds */
361 /** True if subtitles should be shown for this film */
362 bool _with_subtitles;
363 /** y offset for placing subtitles, in source pixels; +ve is further down
364 the frame, -ve is further up.
366 int _subtitle_offset;
367 /** scale factor to apply to subtitles */
368 float _subtitle_scale;
369 /** index of colour LUT to use when converting RGB to XYZ.
374 /** bandwidth for J2K files in bits per second */
376 /** DCI naming stuff */
377 DCIMetadata _dci_metadata;
378 /** Frames per second to run our DCP at */
380 /** The date that we should use in a DCI name */
381 boost::gregorian::date _dci_date;
383 /** true if our state has changed since we last saved it */
386 /** Mutex for all state except _directory */
387 mutable boost::mutex _state_mutex;
389 friend class paths_test;
390 friend class film_metadata_test;