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"
39 #include "audio_mapping.h"
46 class ExamineContentJob;
47 class AnalyseAudioJob;
48 class ExternalAudioStream;
54 * @brief A representation of some audio and video content, and details of
55 * how they should be presented in a DCP.
57 class Film : public boost::enable_shared_from_this<Film>
60 Film (std::string d, bool must_exist = true);
63 std::string info_dir () const;
64 std::string j2c_path (int f, bool t) const;
65 std::string info_path (int f) const;
66 std::string internal_video_mxf_dir () const;
67 std::string internal_video_mxf_filename () const;
68 std::string audio_analysis_path () const;
70 void examine_content (boost::shared_ptr<Content>);
71 std::string dcp_video_mxf_filename () const;
72 std::string dcp_audio_mxf_filename () const;
74 void analyse_audio ();
75 void send_dcp_to_tms ();
79 * It is safe to call this from any thread.
81 boost::shared_ptr<Log> log () const {
85 int encoded_frames () const;
87 std::string file (std::string f) const;
88 std::string dir (std::string d) const;
90 int target_audio_sample_rate () const;
92 void write_metadata () const;
94 libdcp::Size cropped_size (libdcp::Size) const;
95 std::string dci_name (bool if_created_now) const;
96 std::string dcp_name (bool if_created_now = false) const;
98 /** @return true if our state has changed since we last saved it */
103 bool have_dcp () const;
105 boost::shared_ptr<Player> player () const;
107 /* Proxies for some Playlist methods */
109 ContentList content () const;
111 ContentAudioFrame audio_length () const;
112 int audio_channels () const;
113 int audio_frame_rate () const;
114 bool has_audio () const;
116 float video_frame_rate () const;
117 libdcp::Size video_size () const;
118 ContentVideoFrame video_length () const;
120 ContentVideoFrame content_length () const;
122 std::vector<FFmpegSubtitleStream> ffmpeg_subtitle_streams () const;
123 boost::optional<FFmpegSubtitleStream> ffmpeg_subtitle_stream () const;
124 std::vector<FFmpegAudioStream> ffmpeg_audio_streams () const;
125 boost::optional<FFmpegAudioStream> ffmpeg_audio_stream () const;
127 void set_ffmpeg_subtitle_stream (FFmpegSubtitleStream);
128 void set_ffmpeg_audio_stream (FFmpegAudioStream);
138 /** Identifiers for the parts of our state;
139 used for signalling changes.
145 TRUST_CONTENT_HEADERS,
146 /** The playlist's content list has changed (i.e. content has been added, moved around or removed) */
173 std::string directory () const {
174 boost::mutex::scoped_lock lm (_directory_mutex);
178 std::string name () const {
179 boost::mutex::scoped_lock lm (_state_mutex);
183 bool use_dci_name () const {
184 boost::mutex::scoped_lock lm (_state_mutex);
185 return _use_dci_name;
188 bool trust_content_headers () const {
189 boost::mutex::scoped_lock lm (_state_mutex);
190 return _trust_content_headers;
193 DCPContentType const * dcp_content_type () const {
194 boost::mutex::scoped_lock lm (_state_mutex);
195 return _dcp_content_type;
198 Format const * format () const {
199 boost::mutex::scoped_lock lm (_state_mutex);
204 boost::mutex::scoped_lock lm (_state_mutex);
208 std::vector<Filter const *> filters () const {
209 boost::mutex::scoped_lock lm (_state_mutex);
213 Scaler const * scaler () const {
214 boost::mutex::scoped_lock lm (_state_mutex);
218 int trim_start () const {
219 boost::mutex::scoped_lock lm (_state_mutex);
223 int trim_end () const {
224 boost::mutex::scoped_lock lm (_state_mutex);
228 TrimType trim_type () const {
229 boost::mutex::scoped_lock lm (_state_mutex);
234 boost::mutex::scoped_lock lm (_state_mutex);
238 float audio_gain () const {
239 boost::mutex::scoped_lock lm (_state_mutex);
243 int audio_delay () const {
244 boost::mutex::scoped_lock lm (_state_mutex);
248 bool with_subtitles () const {
249 boost::mutex::scoped_lock lm (_state_mutex);
250 return _with_subtitles;
253 int subtitle_offset () const {
254 boost::mutex::scoped_lock lm (_state_mutex);
255 return _subtitle_offset;
258 float subtitle_scale () const {
259 boost::mutex::scoped_lock lm (_state_mutex);
260 return _subtitle_scale;
263 int colour_lut () const {
264 boost::mutex::scoped_lock lm (_state_mutex);
268 int j2k_bandwidth () const {
269 boost::mutex::scoped_lock lm (_state_mutex);
270 return _j2k_bandwidth;
273 DCIMetadata dci_metadata () const {
274 boost::mutex::scoped_lock lm (_state_mutex);
275 return _dci_metadata;
278 int dcp_frame_rate () const {
279 boost::mutex::scoped_lock lm (_state_mutex);
280 return _dcp_frame_rate;
283 AudioMapping audio_mapping () const {
284 boost::mutex::scoped_lock lm (_state_mutex);
285 return _audio_mapping;
290 void set_directory (std::string);
291 void set_name (std::string);
292 void set_use_dci_name (bool);
293 void set_trust_content_headers (bool);
294 void add_content (boost::shared_ptr<Content>);
295 void remove_content (boost::shared_ptr<Content>);
296 void move_content_earlier (boost::shared_ptr<Content>);
297 void move_content_later (boost::shared_ptr<Content>);
298 void set_dcp_content_type (DCPContentType const *);
299 void set_format (Format const *);
300 void set_crop (Crop);
301 void set_left_crop (int);
302 void set_right_crop (int);
303 void set_top_crop (int);
304 void set_bottom_crop (int);
305 void set_filters (std::vector<Filter const *>);
306 void set_scaler (Scaler const *);
307 void set_trim_start (int);
308 void set_trim_end (int);
310 void set_trim_type (TrimType);
311 void set_audio_gain (float);
312 void set_audio_delay (int);
313 void set_with_subtitles (bool);
314 void set_subtitle_offset (int);
315 void set_subtitle_scale (float);
316 void set_colour_lut (int);
317 void set_j2k_bandwidth (int);
318 void set_dci_metadata (DCIMetadata);
319 void set_dcp_frame_rate (int);
320 void set_dci_date_today ();
321 void set_audio_mapping (AudioMapping);
323 /** Emitted when some property has of the Film has changed */
324 mutable boost::signals2::signal<void (Property)> Changed;
326 /** Emitted when some property of our content has changed */
327 mutable boost::signals2::signal<void (boost::weak_ptr<Content>, int)> ContentChanged;
329 boost::signals2::signal<void ()> AudioAnalysisSucceeded;
331 /** Current version number of the state file */
332 static int const state_version;
336 void signal_changed (Property);
337 void analyse_audio_finished ();
338 std::string video_state_identifier () const;
339 void read_metadata ();
340 void playlist_changed ();
341 void playlist_content_changed (boost::weak_ptr<Content>, int);
342 void setup_default_audio_mapping ();
343 std::string filename_safe_name () const;
345 /** Log to write to */
346 boost::shared_ptr<Log> _log;
347 /** Any running AnalyseAudioJob, or 0 */
348 boost::shared_ptr<AnalyseAudioJob> _analyse_audio_job;
349 boost::shared_ptr<Playlist> _playlist;
351 /** Complete path to directory containing the film metadata;
352 * must not be relative.
354 std::string _directory;
355 /** Mutex for _directory */
356 mutable boost::mutex _directory_mutex;
358 /** Name for DCP-o-matic */
360 /** True if a auto-generated DCI-compliant name should be used for our DCP */
362 bool _trust_content_headers;
363 /** The type of content that this Film represents (feature, trailer etc.) */
364 DCPContentType const * _dcp_content_type;
365 /** The format to present this Film in (flat, scope, etc.) */
366 Format const * _format;
367 /** The crop to apply to the source */
369 /** Video filters that should be used when generating DCPs */
370 std::vector<Filter const *> _filters;
371 /** Scaler algorithm to use */
372 Scaler const * _scaler;
373 /** Frames to trim off the start of the DCP */
375 /** Frames to trim off the end of the DCP */
378 /** true to create an A/B comparison DCP, where the left half of the image
379 is the video without any filters or post-processing, and the right half
380 has the specified filters and post-processing.
383 /** Gain to apply to audio in dB */
385 /** Delay to apply to audio (positive moves audio later) in milliseconds */
387 /** True if subtitles should be shown for this film */
388 bool _with_subtitles;
389 /** y offset for placing subtitles, in source pixels; +ve is further down
390 the frame, -ve is further up.
392 int _subtitle_offset;
393 /** scale factor to apply to subtitles */
394 float _subtitle_scale;
395 /** index of colour LUT to use when converting RGB to XYZ.
400 /** bandwidth for J2K files in bits per second */
402 /** DCI naming stuff */
403 DCIMetadata _dci_metadata;
404 /** Frames per second to run our DCP at */
406 /** The date that we should use in a DCI name */
407 boost::gregorian::date _dci_date;
408 AudioMapping _audio_mapping;
410 /** true if our state has changed since we last saved it */
413 /** Mutex for all state except _directory */
414 mutable boost::mutex _state_mutex;
416 friend class paths_test;
417 friend class film_metadata_test;