2 Copyright (C) 2013-2021 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/>.
22 #include "audio_content.h"
23 #include "compose.hpp"
25 #include "exceptions.h"
27 #include "frame_rate_change.h"
28 #include <dcp/raw_convert.h>
29 #include <libcxml/cxml.h>
30 #include <libxml++/libxml++.h>
37 using std::dynamic_pointer_cast;
40 using std::make_shared;
42 using std::setprecision;
43 using std::shared_ptr;
46 using boost::optional;
47 using dcp::raw_convert;
48 using namespace dcpomatic;
51 /** Something stream-related has changed */
52 int const AudioContentProperty::STREAMS = 200;
53 int const AudioContentProperty::GAIN = 201;
54 int const AudioContentProperty::DELAY = 202;
57 AudioContent::AudioContent (Content* parent)
58 : ContentPart (parent)
59 , _delay (Config::instance()->default_audio_delay())
65 shared_ptr<AudioContent>
66 AudioContent::from_xml (Content* parent, cxml::ConstNodePtr node, int version)
69 /* With old metadata FFmpeg content has the audio-related tags even with no
70 audio streams, so check for that.
72 if (node->string_child("Type") == "FFmpeg" && node->node_children("AudioStream").empty()) {
76 /* Otherwise we can drop through to the newer logic */
79 if (!node->optional_number_child<double> ("AudioGain")) {
83 return make_shared<AudioContent>(parent, node);
87 AudioContent::AudioContent (Content* parent, cxml::ConstNodePtr node)
88 : ContentPart (parent)
90 _gain = node->number_child<double> ("AudioGain");
91 _delay = node->number_child<int> ("AudioDelay");
93 /* Backwards compatibility */
94 auto r = node->optional_number_child<double>("AudioVideoFrameRate");
96 _parent->set_video_frame_rate (r.get());
101 AudioContent::AudioContent (Content* parent, vector<shared_ptr<Content>> c)
102 : ContentPart (parent)
104 auto ref = c[0]->audio;
105 DCPOMATIC_ASSERT (ref);
107 for (size_t i = 1; i < c.size(); ++i) {
108 if (c[i]->audio->gain() != ref->gain()) {
109 throw JoinError (_("Content to be joined must have the same audio gain."));
112 if (c[i]->audio->delay() != ref->delay()) {
113 throw JoinError (_("Content to be joined must have the same audio delay."));
117 _gain = ref->gain ();
118 _delay = ref->delay ();
119 _streams = ref->streams ();
124 AudioContent::as_xml (xmlpp::Node* node) const
126 boost::mutex::scoped_lock lm (_mutex);
127 node->add_child("AudioGain")->add_child_text(raw_convert<string>(_gain));
128 node->add_child("AudioDelay")->add_child_text(raw_convert<string>(_delay));
133 AudioContent::set_gain (double g)
135 maybe_set (_gain, g, AudioContentProperty::GAIN);
140 AudioContent::set_delay (int d)
142 maybe_set (_delay, d, AudioContentProperty::DELAY);
147 AudioContent::technical_summary () const
149 string s = "audio: ";
150 for (auto i: streams()) {
151 s += String::compose ("stream channels %1 rate %2 ", i->channels(), i->frame_rate());
159 AudioContent::set_mapping (AudioMapping mapping)
161 ContentChangeSignaller cc (_parent, AudioContentProperty::STREAMS);
164 for (auto i: streams()) {
165 AudioMapping stream_mapping (i->channels(), MAX_DCP_AUDIO_CHANNELS);
166 for (int j = 0; j < i->channels(); ++j) {
167 for (int k = 0; k < MAX_DCP_AUDIO_CHANNELS; ++k) {
168 stream_mapping.set (j, k, mapping.get(c, k));
172 i->set_mapping (stream_mapping);
178 AudioContent::mapping () const
181 for (auto i: streams()) {
182 channels += i->channels ();
185 AudioMapping merged (channels, MAX_DCP_AUDIO_CHANNELS);
190 for (auto i: streams()) {
191 auto mapping = i->mapping ();
192 for (int j = 0; j < mapping.input_channels(); ++j) {
193 for (int k = 0; k < MAX_DCP_AUDIO_CHANNELS; ++k) {
194 if (k < mapping.output_channels()) {
195 merged.set (c, k, mapping.get(j, k));
207 /** @return the frame rate that this content should be resampled to in order
208 * that it is in sync with the active video content at its start time.
211 AudioContent::resampled_frame_rate (shared_ptr<const Film> film) const
213 double t = film->audio_frame_rate ();
215 FrameRateChange frc (film, _parent);
217 /* Compensate if the DCP is being run at a different frame rate
218 to the source; that is, if the video is run such that it will
219 look different in the DCP compared to the source (slower or faster).
222 if (frc.change_speed) {
230 AudioContent::processing_description (shared_ptr<const Film> film) const
232 if (streams().empty()) {
236 /* Possible answers are:
237 1. all audio will be resampled from x to y.
238 2. all audio will be resampled to y (from a variety of rates)
239 3. some audio will be resampled to y (from a variety of rates)
240 4. nothing will be resampled.
243 bool not_resampled = false;
244 bool resampled = false;
247 optional<int> common_frame_rate;
248 for (auto i: streams()) {
249 if (i->frame_rate() != resampled_frame_rate(film)) {
252 not_resampled = true;
255 if (common_frame_rate && common_frame_rate != i->frame_rate ()) {
258 common_frame_rate = i->frame_rate ();
261 if (not_resampled && !resampled) {
262 return _("Audio will not be resampled");
265 if (not_resampled && resampled) {
266 return String::compose (_("Some audio will be resampled to %1Hz"), resampled_frame_rate(film));
269 if (!not_resampled && resampled) {
271 return String::compose (_("Audio will be resampled from %1Hz to %2Hz"), common_frame_rate.get(), resampled_frame_rate(film));
273 return String::compose (_("Audio will be resampled to %1Hz"), resampled_frame_rate(film));
281 /** @return User-visible names of each of our audio channels */
283 AudioContent::channel_names () const
285 vector<NamedChannel> n;
289 for (auto i: streams()) {
290 for (int j = 0; j < i->channels(); ++j) {
291 n.push_back (NamedChannel(String::compose ("%1:%2", stream, j + 1), index++));
301 AudioContent::add_properties (shared_ptr<const Film> film, list<UserProperty>& p) const
303 shared_ptr<const AudioStream> stream;
304 if (streams().size() == 1) {
305 stream = streams().front();
309 p.push_back (UserProperty(UserProperty::AUDIO, _("Channels"), stream->channels()));
310 p.push_back (UserProperty(UserProperty::AUDIO, _("Content audio sample rate"), stream->frame_rate(), _("Hz")));
313 FrameRateChange const frc (_parent->active_video_frame_rate(film), film->video_frame_rate());
314 ContentTime const c (_parent->full_length(film), frc);
317 UserProperty (UserProperty::LENGTH, _("Full length in video frames at content rate"), c.frames_round(frc.source))
323 UserProperty::LENGTH,
324 _("Full length in audio samples at content rate"),
325 c.frames_round (stream->frame_rate ())
330 p.push_back (UserProperty(UserProperty::AUDIO, _("DCP sample rate"), resampled_frame_rate(film), _("Hz")));
331 p.push_back (UserProperty(UserProperty::LENGTH, _("Full length in video frames at DCP rate"), c.frames_round (frc.dcp)));
336 UserProperty::LENGTH,
337 _("Full length in audio samples at DCP rate"),
338 c.frames_round(resampled_frame_rate(film))
346 AudioContent::set_streams (vector<AudioStreamPtr> streams)
348 ContentChangeSignaller cc (_parent, AudioContentProperty::STREAMS);
351 boost::mutex::scoped_lock lm (_mutex);
358 AudioContent::stream () const
360 boost::mutex::scoped_lock lm (_mutex);
361 DCPOMATIC_ASSERT (_streams.size() == 1);
362 return _streams.front ();
367 AudioContent::add_stream (AudioStreamPtr stream)
369 ContentChangeSignaller cc (_parent, AudioContentProperty::STREAMS);
372 boost::mutex::scoped_lock lm (_mutex);
373 _streams.push_back (stream);
379 AudioContent::set_stream (AudioStreamPtr stream)
381 ContentChangeSignaller cc (_parent, AudioContentProperty::STREAMS);
384 boost::mutex::scoped_lock lm (_mutex);
386 _streams.push_back (stream);
392 AudioContent::take_settings_from (shared_ptr<const AudioContent> c)
395 set_delay (c->_delay);
400 while (i < _streams.size() && j < c->_streams.size()) {
401 _streams[i]->set_mapping (c->_streams[j]->mapping());
409 AudioContent::modify_position (shared_ptr<const Film> film, DCPTime& pos) const
411 pos = pos.round (film->audio_frame_rate());
416 AudioContent::modify_trim_start (ContentTime& trim) const
418 DCPOMATIC_ASSERT (!_streams.empty());
419 /* XXX: we're in trouble if streams have different rates */
420 trim = trim.round (_streams.front()->frame_rate());