src/lib/audio_content.cc

   1 /*
   2     Copyright (C) 2013-2021 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   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.
  10
  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.
  15
  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/>.
  18
  19 */
  20
  21
  22 #include "audio_content.h"
  23 #include "compose.hpp"
  24 #include "config.h"
  25 #include "exceptions.h"
  26 #include "film.h"
  27 #include "frame_rate_change.h"
  28 #include <dcp/raw_convert.h>
  29 #include <libcxml/cxml.h>
  30 #include <libxml++/libxml++.h>
  31 #include <iostream>
  32
  33 #include "i18n.h"
  34
  35
  36 using std::cout;
  37 using std::dynamic_pointer_cast;
  38 using std::fixed;
  39 using std::list;
  40 using std::make_shared;
  41 using std::pair;
  42 using std::setprecision;
  43 using std::shared_ptr;
  44 using std::string;
  45 using std::vector;
  46 using boost::optional;
  47 using dcp::raw_convert;
  48 using namespace dcpomatic;
  49
  50
  51 /** Something stream-related has changed */
  52 int const AudioContentProperty::STREAMS = 200;
  53 int const AudioContentProperty::GAIN = 201;
  54 int const AudioContentProperty::DELAY = 202;
  55 int const AudioContentProperty::LANGUAGE = 203;
  56
  57
  58 AudioContent::AudioContent (Content* parent)
  59         : ContentPart (parent)
  60         , _delay (Config::instance()->default_audio_delay())
  61 {
  62
  63 }
  64
  65
  66 shared_ptr<AudioContent>
  67 AudioContent::from_xml (Content* parent, cxml::ConstNodePtr node, int version)
  68 {
  69         if (version < 34) {
  70                 /* With old metadata FFmpeg content has the audio-related tags even with no
  71                    audio streams, so check for that.
  72                 */
  73                 if (node->string_child("Type") == "FFmpeg" && node->node_children("AudioStream").empty()) {
  74                         return {};
  75                 }
  76
  77                 /* Otherwise we can drop through to the newer logic */
  78         }
  79
  80         if (!node->optional_number_child<double> ("AudioGain")) {
  81                 return {};
  82         }
  83
  84         return make_shared<AudioContent>(parent, node);
  85 }
  86
  87
  88 AudioContent::AudioContent (Content* parent, cxml::ConstNodePtr node)
  89         : ContentPart (parent)
  90 {
  91         _gain = node->number_child<double> ("AudioGain");
  92         _delay = node->number_child<int> ("AudioDelay");
  93         auto lang = node->optional_node_child ("Language");
  94         if (lang) {
  95                 _language = dcp::LanguageTag (lang->content());
  96         }
  97
  98         /* Backwards compatibility */
  99         auto r = node->optional_number_child<double>("AudioVideoFrameRate");
 100         if (r) {
 101                 _parent->set_video_frame_rate (r.get());
 102         }
 103 }
 104
 105
 106 AudioContent::AudioContent (Content* parent, vector<shared_ptr<Content> > c)
 107         : ContentPart (parent)
 108 {
 109         auto ref = c[0]->audio;
 110         DCPOMATIC_ASSERT (ref);
 111
 112         for (size_t i = 1; i < c.size(); ++i) {
 113                 if (c[i]->audio->gain() != ref->gain()) {
 114                         throw JoinError (_("Content to be joined must have the same audio gain."));
 115                 }
 116
 117                 if (c[i]->audio->delay() != ref->delay()) {
 118                         throw JoinError (_("Content to be joined must have the same audio delay."));
 119                 }
 120
 121                 if (c[i]->audio->language() != ref->language()) {
 122                         throw JoinError (_("Content to be joined must have the same audio language."));
 123                 }
 124         }
 125
 126         _gain = ref->gain ();
 127         _delay = ref->delay ();
 128         _streams = ref->streams ();
 129         _language = ref->language ();
 130 }
 131
 132
 133 void
 134 AudioContent::as_xml (xmlpp::Node* node) const
 135 {
 136         boost::mutex::scoped_lock lm (_mutex);
 137         node->add_child("AudioGain")->add_child_text(raw_convert<string>(_gain));
 138         node->add_child("AudioDelay")->add_child_text(raw_convert<string>(_delay));
 139         if (_language) {
 140                 node->add_child("Language")->add_child_text(_language->to_string());
 141         }
 142 }
 143
 144
 145 void
 146 AudioContent::set_gain (double g)
 147 {
 148         maybe_set (_gain, g, AudioContentProperty::GAIN);
 149 }
 150
 151
 152 void
 153 AudioContent::set_delay (int d)
 154 {
 155         maybe_set (_delay, d, AudioContentProperty::DELAY);
 156 }
 157
 158
 159 void
 160 AudioContent::set_language (optional<dcp::LanguageTag> language)
 161 {
 162         maybe_set (_language, language, AudioContentProperty::LANGUAGE);
 163 }
 164
 165
 166 string
 167 AudioContent::technical_summary () const
 168 {
 169         string s = "audio: ";
 170         for (auto i: streams()) {
 171                 s += String::compose ("stream channels %1 rate %2 ", i->channels(), i->frame_rate());
 172         }
 173
 174         return s;
 175 }
 176
 177
 178 void
 179 AudioContent::set_mapping (AudioMapping mapping)
 180 {
 181         ContentChangeSignaller cc (_parent, AudioContentProperty::STREAMS);
 182
 183         int c = 0;
 184         for (auto i: streams()) {
 185                 AudioMapping stream_mapping (i->channels(), MAX_DCP_AUDIO_CHANNELS);
 186                 for (int j = 0; j < i->channels(); ++j) {
 187                         for (int k = 0; k < MAX_DCP_AUDIO_CHANNELS; ++k) {
 188                                 stream_mapping.set (j, k, mapping.get(c, k));
 189                         }
 190                         ++c;
 191                 }
 192                 i->set_mapping (stream_mapping);
 193         }
 194 }
 195
 196
 197 AudioMapping
 198 AudioContent::mapping () const
 199 {
 200         int channels = 0;
 201         for (auto i: streams()) {
 202                 channels += i->channels ();
 203         }
 204
 205         AudioMapping merged (channels, MAX_DCP_AUDIO_CHANNELS);
 206         merged.make_zero ();
 207
 208         int c = 0;
 209         int s = 0;
 210         for (auto i: streams()) {
 211                 auto mapping = i->mapping ();
 212                 for (int j = 0; j < mapping.input_channels(); ++j) {
 213                         for (int k = 0; k < MAX_DCP_AUDIO_CHANNELS; ++k) {
 214                                 if (k < mapping.output_channels()) {
 215                                         merged.set (c, k, mapping.get(j, k));
 216                                 }
 217                         }
 218                         ++c;
 219                 }
 220                 ++s;
 221         }
 222
 223         return merged;
 224 }
 225
 226
 227 /** @return the frame rate that this content should be resampled to in order
 228  *  that it is in sync with the active video content at its start time.
 229  */
 230 int
 231 AudioContent::resampled_frame_rate (shared_ptr<const Film> film) const
 232 {
 233         double t = film->audio_frame_rate ();
 234
 235         FrameRateChange frc (film, _parent);
 236
 237         /* Compensate if the DCP is being run at a different frame rate
 238            to the source; that is, if the video is run such that it will
 239            look different in the DCP compared to the source (slower or faster).
 240         */
 241
 242         if (frc.change_speed) {
 243                 t /= frc.speed_up;
 244         }
 245
 246         return lrint (t);
 247 }
 248
 249 string
 250 AudioContent::processing_description (shared_ptr<const Film> film) const
 251 {
 252         if (streams().empty()) {
 253                 return "";
 254         }
 255
 256         /* Possible answers are:
 257            1. all audio will be resampled from x to y.
 258            2. all audio will be resampled to y (from a variety of rates)
 259            3. some audio will be resampled to y (from a variety of rates)
 260            4. nothing will be resampled.
 261         */
 262
 263         bool not_resampled = false;
 264         bool resampled = false;
 265         bool same = true;
 266
 267         optional<int> common_frame_rate;
 268         for (auto i: streams()) {
 269                 if (i->frame_rate() != resampled_frame_rate(film)) {
 270                         resampled = true;
 271                 } else {
 272                         not_resampled = true;
 273                 }
 274
 275                 if (common_frame_rate && common_frame_rate != i->frame_rate ()) {
 276                         same = false;
 277                 }
 278                 common_frame_rate = i->frame_rate ();
 279         }
 280
 281         if (not_resampled && !resampled) {
 282                 return _("Audio will not be resampled");
 283         }
 284
 285         if (not_resampled && resampled) {
 286                 return String::compose (_("Some audio will be resampled to %1Hz"), resampled_frame_rate(film));
 287         }
 288
 289         if (!not_resampled && resampled) {
 290                 if (same) {
 291                         return String::compose (_("Audio will be resampled from %1Hz to %2Hz"), common_frame_rate.get(), resampled_frame_rate(film));
 292                 } else {
 293                         return String::compose (_("Audio will be resampled to %1Hz"), resampled_frame_rate(film));
 294                 }
 295         }
 296
 297         return "";
 298 }
 299
 300
 301 /** @return User-visible names of each of our audio channels */
 302 vector<NamedChannel>
 303 AudioContent::channel_names () const
 304 {
 305         vector<NamedChannel> n;
 306
 307         int index = 0;
 308         int stream = 1;
 309         for (auto i: streams()) {
 310                 for (int j = 0; j < i->channels(); ++j) {
 311                         n.push_back (NamedChannel(String::compose ("%1:%2", stream, j + 1), index++));
 312                 }
 313                 ++stream;
 314         }
 315
 316         return n;
 317 }
 318
 319
 320 void
 321 AudioContent::add_properties (shared_ptr<const Film> film, list<UserProperty>& p) const
 322 {
 323         shared_ptr<const AudioStream> stream;
 324         if (streams().size() == 1) {
 325                 stream = streams().front();
 326         }
 327
 328         if (stream) {
 329                 p.push_back (UserProperty(UserProperty::AUDIO, _("Channels"), stream->channels()));
 330                 p.push_back (UserProperty(UserProperty::AUDIO, _("Content audio sample rate"), stream->frame_rate(), _("Hz")));
 331         }
 332
 333         FrameRateChange const frc (_parent->active_video_frame_rate(film), film->video_frame_rate());
 334         ContentTime const c (_parent->full_length(film), frc);
 335
 336         p.push_back (
 337                 UserProperty (UserProperty::LENGTH, _("Full length in video frames at content rate"), c.frames_round(frc.source))
 338                 );
 339
 340         if (stream) {
 341                 p.push_back (
 342                         UserProperty (
 343                                 UserProperty::LENGTH,
 344                                 _("Full length in audio samples at content rate"),
 345                                 c.frames_round (stream->frame_rate ())
 346                                 )
 347                         );
 348         }
 349
 350         p.push_back (UserProperty(UserProperty::AUDIO, _("DCP sample rate"), resampled_frame_rate(film), _("Hz")));
 351         p.push_back (UserProperty(UserProperty::LENGTH, _("Full length in video frames at DCP rate"), c.frames_round (frc.dcp)));
 352
 353         if (stream) {
 354                 p.push_back (
 355                         UserProperty (
 356                                 UserProperty::LENGTH,
 357                                 _("Full length in audio samples at DCP rate"),
 358                                 c.frames_round(resampled_frame_rate(film))
 359                                 )
 360                         );
 361         }
 362 }
 363
 364
 365 void
 366 AudioContent::set_streams (vector<AudioStreamPtr> streams)
 367 {
 368         ContentChangeSignaller cc (_parent, AudioContentProperty::STREAMS);
 369
 370         {
 371                 boost::mutex::scoped_lock lm (_mutex);
 372                 _streams = streams;
 373         }
 374 }
 375
 376
 377 AudioStreamPtr
 378 AudioContent::stream () const
 379 {
 380         boost::mutex::scoped_lock lm (_mutex);
 381         DCPOMATIC_ASSERT (_streams.size() == 1);
 382         return _streams.front ();
 383 }
 384
 385
 386 void
 387 AudioContent::add_stream (AudioStreamPtr stream)
 388 {
 389         ContentChangeSignaller cc (_parent, AudioContentProperty::STREAMS);
 390
 391         {
 392                 boost::mutex::scoped_lock lm (_mutex);
 393                 _streams.push_back (stream);
 394         }
 395 }
 396
 397
 398 void
 399 AudioContent::set_stream (AudioStreamPtr stream)
 400 {
 401         ContentChangeSignaller cc (_parent, AudioContentProperty::STREAMS);
 402
 403         {
 404                 boost::mutex::scoped_lock lm (_mutex);
 405                 _streams.clear ();
 406                 _streams.push_back (stream);
 407         }
 408 }
 409
 410
 411 void
 412 AudioContent::take_settings_from (shared_ptr<const AudioContent> c)
 413 {
 414         set_gain (c->_gain);
 415         set_delay (c->_delay);
 416
 417         size_t i = 0;
 418         size_t j = 0;
 419
 420         while (i < _streams.size() && j < c->_streams.size()) {
 421                 _streams[i]->set_mapping (c->_streams[j]->mapping());
 422                 ++i;
 423                 ++j;
 424         }
 425 }
 426
 427
 428 void
 429 AudioContent::modify_position (shared_ptr<const Film> film, DCPTime& pos) const
 430 {
 431         pos = pos.round (film->audio_frame_rate());
 432 }
 433
 434
 435 void
 436 AudioContent::modify_trim_start (ContentTime& trim) const
 437 {
 438         DCPOMATIC_ASSERT (!_streams.empty());
 439         /* XXX: we're in trouble if streams have different rates */
 440         trim = trim.round (_streams.front()->frame_rate());
 441 }