2 Copyright (C) 2013-2014 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.
20 #include "audio_content.h"
21 #include "analyse_audio_job.h"
22 #include "job_manager.h"
24 #include "exceptions.h"
26 #include "frame_rate_change.h"
27 #include "audio_processor.h"
28 #include "raw_convert.h"
29 #include <libcxml/cxml.h>
36 using std::stringstream;
38 using std::setprecision;
39 using boost::shared_ptr;
40 using boost::dynamic_pointer_cast;
42 int const AudioContentProperty::AUDIO_CHANNELS = 200;
43 int const AudioContentProperty::AUDIO_LENGTH = 201;
44 int const AudioContentProperty::AUDIO_FRAME_RATE = 202;
45 int const AudioContentProperty::AUDIO_GAIN = 203;
46 int const AudioContentProperty::AUDIO_DELAY = 204;
47 int const AudioContentProperty::AUDIO_MAPPING = 205;
48 int const AudioContentProperty::AUDIO_PROCESSOR = 206;
50 AudioContent::AudioContent (shared_ptr<const Film> f)
53 , _audio_delay (Config::instance()->default_audio_delay ())
54 , _audio_processor (0)
59 AudioContent::AudioContent (shared_ptr<const Film> f, DCPTime s)
62 , _audio_delay (Config::instance()->default_audio_delay ())
63 , _audio_processor (0)
68 AudioContent::AudioContent (shared_ptr<const Film> f, boost::filesystem::path p)
71 , _audio_delay (Config::instance()->default_audio_delay ())
72 , _audio_processor (0)
77 AudioContent::AudioContent (shared_ptr<const Film> f, cxml::ConstNodePtr node)
79 , _audio_processor (0)
81 _audio_gain = node->number_child<float> ("AudioGain");
82 _audio_delay = node->number_child<int> ("AudioDelay");
83 if (node->optional_string_child ("AudioProcessor")) {
84 _audio_processor = AudioProcessor::from_id (node->string_child ("AudioProcessor"));
88 AudioContent::AudioContent (shared_ptr<const Film> f, vector<shared_ptr<Content> > c)
91 shared_ptr<AudioContent> ref = dynamic_pointer_cast<AudioContent> (c[0]);
92 DCPOMATIC_ASSERT (ref);
94 for (size_t i = 0; i < c.size(); ++i) {
95 shared_ptr<AudioContent> ac = dynamic_pointer_cast<AudioContent> (c[i]);
97 if (ac->audio_gain() != ref->audio_gain()) {
98 throw JoinError (_("Content to be joined must have the same audio gain."));
101 if (ac->audio_delay() != ref->audio_delay()) {
102 throw JoinError (_("Content to be joined must have the same audio delay."));
106 _audio_gain = ref->audio_gain ();
107 _audio_delay = ref->audio_delay ();
108 _audio_processor = ref->audio_processor ();
112 AudioContent::as_xml (xmlpp::Node* node) const
114 boost::mutex::scoped_lock lm (_mutex);
115 node->add_child("AudioGain")->add_child_text (raw_convert<string> (_audio_gain));
116 node->add_child("AudioDelay")->add_child_text (raw_convert<string> (_audio_delay));
117 if (_audio_processor) {
118 node->add_child("AudioProcessor")->add_child_text (_audio_processor->id ());
124 AudioContent::set_audio_gain (double g)
127 boost::mutex::scoped_lock lm (_mutex);
131 signal_changed (AudioContentProperty::AUDIO_GAIN);
135 AudioContent::set_audio_delay (int d)
138 boost::mutex::scoped_lock lm (_mutex);
142 signal_changed (AudioContentProperty::AUDIO_DELAY);
146 AudioContent::set_audio_processor (AudioProcessor const * p)
149 boost::mutex::scoped_lock lm (_mutex);
150 _audio_processor = p;
153 /* The channel count might have changed, so reset the mapping */
154 AudioMapping m (processed_audio_channels ());
156 set_audio_mapping (m);
158 signal_changed (AudioContentProperty::AUDIO_PROCESSOR);
161 boost::signals2::connection
162 AudioContent::analyse_audio (boost::function<void()> finished)
164 shared_ptr<const Film> film = _film.lock ();
165 DCPOMATIC_ASSERT (film);
167 shared_ptr<AnalyseAudioJob> job (new AnalyseAudioJob (film, dynamic_pointer_cast<AudioContent> (shared_from_this())));
168 boost::signals2::connection c = job->Finished.connect (finished);
169 JobManager::instance()->add (job);
174 boost::filesystem::path
175 AudioContent::audio_analysis_path () const
177 shared_ptr<const Film> film = _film.lock ();
179 return boost::filesystem::path ();
182 boost::filesystem::path p = film->audio_analysis_dir ();
183 p /= digest() + "_" + audio_mapping().digest();
188 AudioContent::technical_summary () const
190 return String::compose (
191 "audio: channels %1, length %2, content rate %3, resampled rate %4",
193 audio_length().seconds(),
195 resampled_audio_frame_rate()
200 AudioContent::set_audio_mapping (AudioMapping)
202 signal_changed (AudioContentProperty::AUDIO_MAPPING);
205 /** @return the frame rate that this content should be resampled to in order
206 * that it is in sync with the active video content at its start time.
209 AudioContent::resampled_audio_frame_rate () const
211 shared_ptr<const Film> film = _film.lock ();
212 DCPOMATIC_ASSERT (film);
214 /* Resample to a DCI-approved sample rate */
215 double t = dcp_audio_frame_rate (audio_frame_rate ());
217 FrameRateChange frc = film->active_frame_rate_change (position ());
219 /* Compensate if the DCP is being run at a different frame rate
220 to the source; that is, if the video is run such that it will
221 look different in the DCP compared to the source (slower or faster).
224 if (frc.change_speed) {
232 AudioContent::processed_audio_channels () const
234 if (!audio_processor ()) {
235 return audio_channels ();
238 return audio_processor()->out_channels (audio_channels ());
242 AudioContent::processing_description () const
246 if (audio_frame_rate() != resampled_audio_frame_rate ()) {
248 from << fixed << setprecision(3) << (audio_frame_rate() / 1000.0);
250 to << fixed << setprecision(3) << (resampled_audio_frame_rate() / 1000.0);
252 d << String::compose (_("Audio will be resampled from %1kHz to %2kHz."), from.str(), to.str());
254 d << _("Audio will not be resampled.");