2 Copyright (C) 2013-2016 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"
22 #include "exceptions.h"
24 #include "frame_rate_change.h"
25 #include "raw_convert.h"
26 #include "compose.hpp"
27 #include <libcxml/cxml.h>
28 #include <libxml++/libxml++.h>
29 #include <boost/foreach.hpp>
37 using std::stringstream;
41 using std::setprecision;
42 using boost::shared_ptr;
43 using boost::dynamic_pointer_cast;
44 using boost::optional;
46 /** Something stream-related has changed */
47 <<<<<<< 17dbd967c18aff2f3007eb86b5eee5b43f23bc4b
48 int const AudioContentProperty::AUDIO_STREAMS = 200;
49 int const AudioContentProperty::AUDIO_GAIN = 201;
50 int const AudioContentProperty::AUDIO_DELAY = 202;
51 int const AudioContentProperty::AUDIO_VIDEO_FRAME_RATE = 203;
53 int const AudioContentProperty::STREAMS = 200;
54 int const AudioContentProperty::GAIN = 201;
55 int const AudioContentProperty::DELAY = 202;
56 >>>>>>> Rename video/audio/subtitle part methods.
58 AudioContent::AudioContent (Content* parent, shared_ptr<const Film> film)
59 : ContentPart (parent, film)
61 , _delay (Config::instance()->default_audio_delay ())
66 AudioContent::AudioContent (Content* parent, shared_ptr<const Film> film, cxml::ConstNodePtr node)
67 : ContentPart (parent, film)
69 _gain = node->number_child<double> ("AudioGain");
70 _delay = node->number_child<int> ("AudioDelay");
71 _video_frame_rate = node->optional_number_child<double> ("AudioVideoFrameRate");
74 AudioContent::AudioContent (Content* parent, shared_ptr<const Film> film, vector<shared_ptr<Content> > c)
75 : ContentPart (parent, film)
77 shared_ptr<AudioContent> ref = c[0]->audio;
78 DCPOMATIC_ASSERT (ref);
80 for (size_t i = 1; i < c.size(); ++i) {
81 if (c[i]->audio->gain() != ref->gain()) {
82 throw JoinError (_("Content to be joined must have the same audio gain."));
85 if (c[i]->audio->delay() != ref->delay()) {
86 throw JoinError (_("Content to be joined must have the same audio delay."));
89 if (ac->audio_video_frame_rate() != ref->audio_video_frame_rate()) {
90 throw JoinError (_("Content to be joined must have the same video frame rate."));
94 _gain = ref->audio_gain ();
95 _delay = ref->audio_delay ();
96 /* Preserve the optional<> part of this */
97 _video_frame_rate = ref->_audio_video_frame_rate;
98 _streams = ref->streams ();
102 AudioContent::as_xml (xmlpp::Node* node) const
104 boost::mutex::scoped_lock lm (_mutex);
105 node->add_child("AudioGain")->add_child_text (raw_convert<string> (_gain));
106 node->add_child("AudioDelay")->add_child_text (raw_convert<string> (_delay));
107 if (_audio_video_frame_rate) {
108 node->add_child("AudioVideoFrameRate")->add_child_text (raw_convert<string> (_audio_video_frame_rate.get()));
113 AudioContent::set_gain (double g)
115 maybe_set (_gain, g, AudioContentProperty::GAIN);
119 AudioContent::set_delay (int d)
121 maybe_set (_delay, d, AudioContentProperty::DELAY);
125 AudioContent::technical_summary () const
127 string s = "audio :";
128 BOOST_FOREACH (AudioStreamPtr i, streams ()) {
129 s += String::compose ("stream channels %1 rate %2", i->channels(), i->frame_rate());
136 AudioContent::set_mapping (AudioMapping mapping)
139 BOOST_FOREACH (AudioStreamPtr i, streams ()) {
140 AudioMapping stream_mapping (i->channels (), MAX_DCP_AUDIO_CHANNELS);
141 for (int j = 0; j < i->channels(); ++j) {
142 for (int k = 0; k < MAX_DCP_AUDIO_CHANNELS; ++k) {
143 stream_mapping.set (j, k, mapping.get (c, k));
147 i->set_mapping (stream_mapping);
150 _parent->signal_changed (AudioContentProperty::STREAMS);
154 AudioContent::mapping () const
157 BOOST_FOREACH (AudioStreamPtr i, streams ()) {
158 channels += i->channels ();
161 AudioMapping merged (channels, MAX_DCP_AUDIO_CHANNELS);
166 BOOST_FOREACH (AudioStreamPtr i, streams ()) {
167 AudioMapping mapping = i->mapping ();
168 for (int j = 0; j < mapping.input_channels(); ++j) {
169 for (int k = 0; k < MAX_DCP_AUDIO_CHANNELS; ++k) {
170 if (k < mapping.output_channels()) {
171 merged.set (c, k, mapping.get (j, k));
182 /** @return the frame rate that this content should be resampled to in order
183 * that it is in sync with the active video content at its start time.
186 AudioContent::resampled_frame_rate () const
188 /* Resample to a DCI-approved sample rate */
189 double t = has_rate_above_48k() ? 96000 : 48000;
191 shared_ptr<const Film> film = _film.lock ();
192 DCPOMATIC_ASSERT (film);
193 FrameRateChange frc (audio_video_frame_rate(), film->video_frame_rate());
195 /* Compensate if the DCP is being run at a different frame rate
196 to the source; that is, if the video is run such that it will
197 look different in the DCP compared to the source (slower or faster).
200 if (frc.change_speed) {
208 AudioContent::processing_description () const
210 if (streams().empty ()) {
214 /* Possible answers are:
215 1. all audio will be resampled from x to y.
216 2. all audio will be resampled to y (from a variety of rates)
217 3. some audio will be resampled to y (from a variety of rates)
218 4. nothing will be resampled.
221 bool not_resampled = false;
222 bool resampled = false;
225 optional<int> common_frame_rate;
226 BOOST_FOREACH (AudioStreamPtr i, streams()) {
227 if (i->frame_rate() != resampled_frame_rate()) {
230 not_resampled = true;
233 if (common_frame_rate && common_frame_rate != i->frame_rate ()) {
236 common_frame_rate = i->frame_rate ();
239 if (not_resampled && !resampled) {
240 return _("Audio will not be resampled");
243 if (not_resampled && resampled) {
244 return String::compose (_("Some audio will be resampled to %1kHz"), resampled_frame_rate ());
247 if (!not_resampled && resampled) {
249 return String::compose (_("Audio will be resampled from %1kHz to %2kHz"), common_frame_rate.get(), resampled_frame_rate ());
251 return String::compose (_("Audio will be resampled to %1kHz"), resampled_frame_rate ());
258 /** @return true if any stream in this content has a sampling rate of more than 48kHz */
260 AudioContent::has_rate_above_48k () const
262 BOOST_FOREACH (AudioStreamPtr i, streams ()) {
263 if (i->frame_rate() > 48000) {
271 /** @return User-visible names of each of our audio channels */
273 AudioContent::channel_names () const
278 BOOST_FOREACH (AudioStreamPtr i, streams ()) {
279 for (int j = 0; j < i->channels(); ++j) {
280 n.push_back (String::compose ("%1:%2", t, j + 1));
289 AudioContent::add_properties (list<UserProperty>& p) const
291 shared_ptr<const AudioStream> stream;
292 if (streams().size() == 1) {
293 stream = streams().front ();
297 p.push_back (UserProperty (_("Audio"), _("Channels"), stream->channels ()));
298 p.push_back (UserProperty (_("Audio"), _("Content audio frame rate"), stream->frame_rate(), _("Hz")));
301 shared_ptr<const Film> film = _film.lock ();
302 DCPOMATIC_ASSERT (film);
304 FrameRateChange const frc (audio_video_frame_rate(), film->video_frame_rate());
305 ContentTime const c (_parent->full_length(), frc);
308 UserProperty (_("Length"), _("Full length in video frames at content rate"), c.frames_round(frc.source))
315 _("Full length in audio frames at content rate"),
316 c.frames_round (stream->frame_rate ())
321 p.push_back (UserProperty (_("Audio"), _("DCP frame rate"), resampled_frame_rate (), _("Hz")));
322 p.push_back (UserProperty (_("Length"), _("Full length in video frames at DCP rate"), c.frames_round (frc.dcp)));
328 _("Full length in audio frames at DCP rate"),
329 c.frames_round (resampled_frame_rate ())
336 AudioContent::set_audio_video_frame_rate (double r)
339 boost::mutex::scoped_lock lm (_mutex);
340 _audio_video_frame_rate = r;
343 signal_changed (AudioContentProperty::AUDIO_VIDEO_FRAME_RATE);
347 AudioContent::audio_video_frame_rate () const
350 boost::mutex::scoped_lock lm (_mutex);
351 if (_audio_video_frame_rate) {
352 return _audio_video_frame_rate.get ();
356 /* No frame rate specified, so assume this content has been
357 prepared for any concurrent video content.
359 return film()->active_frame_rate_change(position()).source;
362 AudioContent::set_streams (vector<AudioStreamPtr> streams)
365 boost::mutex::scoped_lock lm (_mutex);
369 _parent->signal_changed (AudioContentProperty::STREAMS);
373 AudioContent::stream () const
375 boost::mutex::scoped_lock lm (_mutex);
376 DCPOMATIC_ASSERT (_streams.size() == 1);
377 return _streams.front ();
381 AudioContent::add_stream (AudioStreamPtr stream)
384 boost::mutex::scoped_lock lm (_mutex);
385 _streams.push_back (stream);
388 _parent->signal_changed (AudioContentProperty::STREAMS);
392 AudioContent::set_stream (AudioStreamPtr stream)
395 boost::mutex::scoped_lock lm (_mutex);
397 _streams.push_back (stream);
400 _parent->signal_changed (AudioContentProperty::STREAMS);