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 "constants.h"
26 #include "exceptions.h"
28 #include "frame_rate_change.h"
29 #include "maths_util.h"
30 #include "video_content.h"
31 #include <dcp/raw_convert.h>
32 #include <libcxml/cxml.h>
33 #include <libxml++/libxml++.h>
40 using std::dynamic_pointer_cast;
43 using std::make_shared;
45 using std::setprecision;
46 using std::shared_ptr;
49 using boost::optional;
50 using dcp::raw_convert;
51 using namespace dcpomatic;
54 /** Something stream-related has changed */
55 int const AudioContentProperty::STREAMS = 200;
56 int const AudioContentProperty::GAIN = 201;
57 int const AudioContentProperty::DELAY = 202;
58 int const AudioContentProperty::FADE_IN = 203;
59 int const AudioContentProperty::FADE_OUT = 204;
60 int const AudioContentProperty::USE_SAME_FADES_AS_VIDEO = 205;
63 AudioContent::AudioContent (Content* parent)
64 : ContentPart (parent)
65 , _delay (Config::instance()->default_audio_delay())
71 shared_ptr<AudioContent>
72 AudioContent::from_xml (Content* parent, cxml::ConstNodePtr node, int version)
75 /* With old metadata FFmpeg content has the audio-related tags even with no
76 audio streams, so check for that.
78 if (node->string_child("Type") == "FFmpeg" && node->node_children("AudioStream").empty()) {
82 /* Otherwise we can drop through to the newer logic */
85 if (!node->optional_number_child<double> ("AudioGain")) {
89 return make_shared<AudioContent>(parent, node);
93 AudioContent::AudioContent (Content* parent, cxml::ConstNodePtr node)
94 : ContentPart (parent)
96 _gain = node->number_child<double> ("AudioGain");
97 _delay = node->number_child<int> ("AudioDelay");
98 _fade_in = ContentTime(node->optional_number_child<ContentTime::Type>("AudioFadeIn").get_value_or(0));
99 _fade_out = ContentTime(node->optional_number_child<ContentTime::Type>("AudioFadeOut").get_value_or(0));
100 _use_same_fades_as_video = node->optional_bool_child("AudioUseSameFadesAsVideo").get_value_or(false);
104 AudioContent::AudioContent (Content* parent, vector<shared_ptr<Content>> c)
105 : ContentPart (parent)
107 auto ref = c[0]->audio;
108 DCPOMATIC_ASSERT (ref);
110 for (size_t i = 1; i < c.size(); ++i) {
111 if (c[i]->audio->gain() != ref->gain()) {
112 throw JoinError (_("Content to be joined must have the same audio gain."));
115 if (c[i]->audio->delay() != ref->delay()) {
116 throw JoinError (_("Content to be joined must have the same audio delay."));
120 _gain = ref->gain ();
121 _delay = ref->delay ();
122 _streams = ref->streams ();
127 AudioContent::as_xml (xmlpp::Node* node) const
129 boost::mutex::scoped_lock lm (_mutex);
130 node->add_child("AudioGain")->add_child_text(raw_convert<string>(_gain));
131 node->add_child("AudioDelay")->add_child_text(raw_convert<string>(_delay));
132 node->add_child("AudioFadeIn")->add_child_text(raw_convert<string>(_fade_in.get()));
133 node->add_child("AudioFadeOut")->add_child_text(raw_convert<string>(_fade_out.get()));
134 node->add_child("AudioUseSameFadesAsVideo")->add_child_text(_use_same_fades_as_video ? "1" : "0");
139 AudioContent::set_gain (double g)
141 maybe_set (_gain, g, AudioContentProperty::GAIN);
146 AudioContent::set_delay (int d)
148 maybe_set (_delay, d, AudioContentProperty::DELAY);
153 AudioContent::technical_summary () const
155 string s = "audio: ";
156 for (auto i: streams()) {
157 s += String::compose ("stream channels %1 rate %2 ", i->channels(), i->frame_rate());
165 AudioContent::set_mapping (AudioMapping mapping)
167 ContentChangeSignaller cc (_parent, AudioContentProperty::STREAMS);
170 for (auto i: streams()) {
171 AudioMapping stream_mapping (i->channels(), MAX_DCP_AUDIO_CHANNELS);
172 for (int j = 0; j < i->channels(); ++j) {
173 for (int k = 0; k < MAX_DCP_AUDIO_CHANNELS; ++k) {
174 stream_mapping.set (j, k, mapping.get(c, k));
178 i->set_mapping (stream_mapping);
184 AudioContent::mapping () const
187 for (auto i: streams()) {
188 channels += i->channels ();
191 AudioMapping merged (channels, MAX_DCP_AUDIO_CHANNELS);
196 for (auto i: streams()) {
197 auto mapping = i->mapping ();
198 for (int j = 0; j < mapping.input_channels(); ++j) {
199 for (int k = 0; k < MAX_DCP_AUDIO_CHANNELS; ++k) {
200 if (k < mapping.output_channels()) {
201 merged.set (c, k, mapping.get(j, k));
213 /** @return the frame rate that this content should be resampled to in order
214 * that it is in sync with the active video content at its start time.
217 AudioContent::resampled_frame_rate (shared_ptr<const Film> film) const
219 double t = film->audio_frame_rate ();
221 FrameRateChange frc (film, _parent);
223 /* Compensate if the DCP is being run at a different frame rate
224 to the source; that is, if the video is run such that it will
225 look different in the DCP compared to the source (slower or faster).
228 if (frc.change_speed) {
236 AudioContent::processing_description (shared_ptr<const Film> film) const
238 if (streams().empty()) {
242 /* Possible answers are:
243 1. all audio will be resampled from x to y.
244 2. all audio will be resampled to y (from a variety of rates)
245 3. some audio will be resampled to y (from a variety of rates)
246 4. nothing will be resampled.
249 bool not_resampled = false;
250 bool resampled = false;
253 optional<int> common_frame_rate;
254 for (auto i: streams()) {
255 if (i->frame_rate() != resampled_frame_rate(film)) {
258 not_resampled = true;
261 if (common_frame_rate && common_frame_rate != i->frame_rate ()) {
264 common_frame_rate = i->frame_rate ();
267 if (not_resampled && !resampled) {
268 return _("Audio will not be resampled");
271 if (not_resampled && resampled) {
272 return String::compose (_("Some audio will be resampled to %1Hz"), resampled_frame_rate(film));
275 if (!not_resampled && resampled) {
277 return String::compose (_("Audio will be resampled from %1Hz to %2Hz"), common_frame_rate.get(), resampled_frame_rate(film));
279 return String::compose (_("Audio will be resampled to %1Hz"), resampled_frame_rate(film));
287 /** @return User-visible names of each of our audio channels */
289 AudioContent::channel_names () const
291 vector<NamedChannel> n;
295 for (auto i: streams()) {
296 for (int j = 0; j < i->channels(); ++j) {
297 n.push_back (NamedChannel(String::compose ("%1:%2", stream, j + 1), index++));
307 AudioContent::add_properties (shared_ptr<const Film> film, list<UserProperty>& p) const
309 shared_ptr<const AudioStream> stream;
310 if (streams().size() == 1) {
311 stream = streams().front();
315 p.push_back (UserProperty(UserProperty::AUDIO, _("Channels"), stream->channels()));
316 p.push_back (UserProperty(UserProperty::AUDIO, _("Content sample rate"), stream->frame_rate(), _("Hz")));
317 if (auto bits = stream->bit_depth()) {
318 p.push_back(UserProperty(UserProperty::AUDIO, _("Content bit depth"), *bits, _("bits")));
322 FrameRateChange const frc (_parent->active_video_frame_rate(film), film->video_frame_rate());
323 ContentTime const c (_parent->full_length(film), frc);
326 UserProperty (UserProperty::LENGTH, _("Full length in video frames at content rate"), c.frames_round(frc.source))
332 UserProperty::LENGTH,
333 _("Full length in audio samples at content rate"),
334 c.frames_round (stream->frame_rate ())
339 p.push_back (UserProperty(UserProperty::AUDIO, _("DCP sample rate"), resampled_frame_rate(film), _("Hz")));
340 p.push_back (UserProperty(UserProperty::LENGTH, _("Full length in video frames at DCP rate"), c.frames_round (frc.dcp)));
345 UserProperty::LENGTH,
346 _("Full length in audio samples at DCP rate"),
347 c.frames_round(resampled_frame_rate(film))
355 AudioContent::set_streams (vector<AudioStreamPtr> streams)
357 ContentChangeSignaller cc (_parent, AudioContentProperty::STREAMS);
360 boost::mutex::scoped_lock lm (_mutex);
367 AudioContent::stream () const
369 boost::mutex::scoped_lock lm (_mutex);
370 DCPOMATIC_ASSERT (_streams.size() == 1);
371 return _streams.front ();
376 AudioContent::add_stream (AudioStreamPtr stream)
378 ContentChangeSignaller cc (_parent, AudioContentProperty::STREAMS);
381 boost::mutex::scoped_lock lm (_mutex);
382 _streams.push_back (stream);
388 AudioContent::set_stream (AudioStreamPtr stream)
390 ContentChangeSignaller cc (_parent, AudioContentProperty::STREAMS);
393 boost::mutex::scoped_lock lm (_mutex);
395 _streams.push_back (stream);
401 AudioContent::take_settings_from (shared_ptr<const AudioContent> c)
404 set_delay (c->_delay);
405 set_fade_in (c->fade_in());
406 set_fade_out (c->fade_out());
408 auto const streams_to_take = std::min(_streams.size(), c->_streams.size());
410 for (auto i = 0U; i < streams_to_take; ++i) {
411 auto mapping = _streams[i]->mapping();
412 mapping.take_from(c->_streams[i]->mapping());
413 _streams[i]->set_mapping(mapping);
419 AudioContent::modify_position (shared_ptr<const Film> film, DCPTime& pos) const
421 pos = pos.round (film->audio_frame_rate());
426 AudioContent::modify_trim_start(shared_ptr<const Film> film, ContentTime& trim) const
428 /* When this trim is used it the audio will have been resampled, and using the
429 * DCP rate here reduces the chance of rounding errors causing audio glitches
430 * due to errors in placement of audio frames (#2373).
432 trim = trim.round(film ? film->audio_frame_rate() : 48000);
437 AudioContent::fade_in () const
439 boost::mutex::scoped_lock lm (_mutex);
440 if (_use_same_fades_as_video && _parent->video) {
441 return dcpomatic::ContentTime::from_frames(_parent->video->fade_in(), _parent->video_frame_rate().get_value_or(24));
449 AudioContent::fade_out () const
451 boost::mutex::scoped_lock lm (_mutex);
452 if (_use_same_fades_as_video && _parent->video) {
453 return dcpomatic::ContentTime::from_frames(_parent->video->fade_out(), _parent->video_frame_rate().get_value_or(24));
461 AudioContent::set_fade_in (ContentTime t)
463 maybe_set (_fade_in, t, AudioContentProperty::FADE_IN);
468 AudioContent::set_fade_out (ContentTime t)
470 maybe_set (_fade_out, t, AudioContentProperty::FADE_OUT);
475 AudioContent::set_use_same_fades_as_video (bool s)
477 maybe_set (_use_same_fades_as_video, s, AudioContentProperty::USE_SAME_FADES_AS_VIDEO);
482 AudioContent::fade (AudioStreamPtr stream, Frame frame, Frame length, int frame_rate) const
484 auto const in = fade_in().frames_round(frame_rate);
485 auto const out = fade_out().frames_round(frame_rate);
487 /* Where the start trim ends, at frame_rate */
488 auto const trim_start = _parent->trim_start().frames_round(frame_rate);
489 /* Where the end trim starts within the whole length of the content, at frame_rate */
490 auto const trim_end = ContentTime(ContentTime::from_frames(stream->length(), stream->frame_rate()) - _parent->trim_end()).frames_round(frame_rate);
493 (in == 0 || (frame >= (trim_start + in))) &&
494 (out == 0 || ((frame + length) < (trim_end - out)))
496 /* This section starts after the fade in and ends before the fade out */
500 /* Start position relative to the start of the fade in */
501 auto in_start = frame - trim_start;
502 /* Start position relative to the start of the fade out */
503 auto out_start = frame - (trim_end - out);
505 vector<float> coeffs(length);
506 for (auto coeff = 0; coeff < length; ++coeff) {
509 coeffs[coeff] *= logarithmic_fade_in_curve(static_cast<float>(in_start + coeff) / in);
512 coeffs[coeff] *= logarithmic_fade_out_curve(static_cast<float>(out_start + coeff) / out);