2 Copyright (C) 2013-2016 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 DCP-o-matic is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
21 #include "audio_content.h"
23 #include "exceptions.h"
25 #include "frame_rate_change.h"
26 #include "raw_convert.h"
27 #include "compose.hpp"
28 #include <libcxml/cxml.h>
29 #include <libxml++/libxml++.h>
30 #include <boost/foreach.hpp>
38 using std::stringstream;
42 using std::setprecision;
43 using boost::shared_ptr;
44 using boost::dynamic_pointer_cast;
45 using boost::optional;
47 /** Something stream-related has changed */
48 int const AudioContentProperty::STREAMS = 200;
49 int const AudioContentProperty::GAIN = 201;
50 int const AudioContentProperty::DELAY = 202;
52 AudioContent::AudioContent (Content* parent)
53 : ContentPart (parent)
55 , _delay (Config::instance()->default_audio_delay ())
60 shared_ptr<AudioContent>
61 AudioContent::from_xml (Content* parent, cxml::ConstNodePtr node)
63 if (!node->optional_number_child<double> ("AudioGain")) {
64 return shared_ptr<AudioContent> ();
67 return shared_ptr<AudioContent> (new AudioContent (parent, node));
70 AudioContent::AudioContent (Content* parent, cxml::ConstNodePtr node)
71 : ContentPart (parent)
73 _gain = node->number_child<double> ("AudioGain");
74 _delay = node->number_child<int> ("AudioDelay");
76 /* Backwards compatibility */
77 optional<double> r = node->optional_number_child<double> ("AudioVideoFrameRate");
79 _parent->set_video_frame_rate (r.get ());
83 AudioContent::AudioContent (Content* parent, vector<shared_ptr<Content> > c)
84 : ContentPart (parent)
86 shared_ptr<AudioContent> ref = c[0]->audio;
87 DCPOMATIC_ASSERT (ref);
89 for (size_t i = 1; i < c.size(); ++i) {
90 if (c[i]->audio->gain() != ref->gain()) {
91 throw JoinError (_("Content to be joined must have the same audio gain."));
94 if (c[i]->audio->delay() != ref->delay()) {
95 throw JoinError (_("Content to be joined must have the same audio delay."));
100 _delay = ref->delay ();
101 _streams = ref->streams ();
105 AudioContent::as_xml (xmlpp::Node* node) const
107 boost::mutex::scoped_lock lm (_mutex);
108 node->add_child("AudioGain")->add_child_text (raw_convert<string> (_gain));
109 node->add_child("AudioDelay")->add_child_text (raw_convert<string> (_delay));
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 FrameRateChange frc (_parent->active_video_frame_rate(), _parent->film()->video_frame_rate());
193 /* Compensate if the DCP is being run at a different frame rate
194 to the source; that is, if the video is run such that it will
195 look different in the DCP compared to the source (slower or faster).
198 if (frc.change_speed) {
206 AudioContent::processing_description () const
208 if (streams().empty ()) {
212 /* Possible answers are:
213 1. all audio will be resampled from x to y.
214 2. all audio will be resampled to y (from a variety of rates)
215 3. some audio will be resampled to y (from a variety of rates)
216 4. nothing will be resampled.
219 bool not_resampled = false;
220 bool resampled = false;
223 optional<int> common_frame_rate;
224 BOOST_FOREACH (AudioStreamPtr i, streams()) {
225 if (i->frame_rate() != resampled_frame_rate()) {
228 not_resampled = true;
231 if (common_frame_rate && common_frame_rate != i->frame_rate ()) {
234 common_frame_rate = i->frame_rate ();
237 if (not_resampled && !resampled) {
238 return _("Audio will not be resampled");
241 if (not_resampled && resampled) {
242 return String::compose (_("Some audio will be resampled to %1kHz"), resampled_frame_rate ());
245 if (!not_resampled && resampled) {
247 return String::compose (_("Audio will be resampled from %1kHz to %2kHz"), common_frame_rate.get(), resampled_frame_rate ());
249 return String::compose (_("Audio will be resampled to %1kHz"), resampled_frame_rate ());
256 /** @return true if any stream in this content has a sampling rate of more than 48kHz */
258 AudioContent::has_rate_above_48k () const
260 BOOST_FOREACH (AudioStreamPtr i, streams ()) {
261 if (i->frame_rate() > 48000) {
269 /** @return User-visible names of each of our audio channels */
271 AudioContent::channel_names () const
276 BOOST_FOREACH (AudioStreamPtr i, streams ()) {
277 for (int j = 0; j < i->channels(); ++j) {
278 n.push_back (String::compose ("%1:%2", t, j + 1));
287 AudioContent::add_properties (list<UserProperty>& p) const
289 shared_ptr<const AudioStream> stream;
290 if (streams().size() == 1) {
291 stream = streams().front ();
295 p.push_back (UserProperty (_("Audio"), _("Channels"), stream->channels ()));
296 p.push_back (UserProperty (_("Audio"), _("Content audio sample rate"), stream->frame_rate(), _("Hz")));
299 FrameRateChange const frc (_parent->active_video_frame_rate(), _parent->film()->video_frame_rate());
300 ContentTime const c (_parent->full_length(), frc);
303 UserProperty (_("Length"), _("Full length in video frames at content rate"), c.frames_round(frc.source))
310 _("Full length in audio samples at content rate"),
311 c.frames_round (stream->frame_rate ())
316 p.push_back (UserProperty (_("Audio"), _("DCP frame rate"), resampled_frame_rate (), _("Hz")));
317 p.push_back (UserProperty (_("Length"), _("Full length in video frames at DCP rate"), c.frames_round (frc.dcp)));
323 _("Full length in audio samples at DCP rate"),
324 c.frames_round (resampled_frame_rate ())
331 AudioContent::set_streams (vector<AudioStreamPtr> streams)
334 boost::mutex::scoped_lock lm (_mutex);
338 _parent->signal_changed (AudioContentProperty::STREAMS);
342 AudioContent::stream () const
344 boost::mutex::scoped_lock lm (_mutex);
345 DCPOMATIC_ASSERT (_streams.size() == 1);
346 return _streams.front ();
350 AudioContent::add_stream (AudioStreamPtr stream)
353 boost::mutex::scoped_lock lm (_mutex);
354 _streams.push_back (stream);
357 _parent->signal_changed (AudioContentProperty::STREAMS);
361 AudioContent::set_stream (AudioStreamPtr stream)
364 boost::mutex::scoped_lock lm (_mutex);
366 _streams.push_back (stream);
369 _parent->signal_changed (AudioContentProperty::STREAMS);