src/lib/audio_content.cc

   1 /*
   2     Copyright (C) 2013-2016 Carl Hetherington <cth@carlh.net>
   3
   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.
   8
   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.
  13
  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.
  17
  18 */
  19
  20 #include "audio_content.h"
  21 #include "film.h"
  22 #include "exceptions.h"
  23 #include "config.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>
  30 #include <iostream>
  31
  32 #include "i18n.h"
  33
  34 using std::string;
  35 using std::cout;
  36 using std::vector;
  37 using std::stringstream;
  38 using std::fixed;
  39 using std::list;
  40 using std::pair;
  41 using std::setprecision;
  42 using boost::shared_ptr;
  43 using boost::dynamic_pointer_cast;
  44 using boost::optional;
  45
  46 /** Something stream-related has changed */
  47 int const AudioContentProperty::STREAMS = 200;
  48 int const AudioContentProperty::GAIN = 201;
  49 int const AudioContentProperty::DELAY = 202;
  50
  51 AudioContent::AudioContent (Content* parent)
  52         : ContentPart (parent)
  53         , _gain (0)
  54         , _delay (Config::instance()->default_audio_delay ())
  55 {
  56
  57 }
  58
  59 shared_ptr<AudioContent>
  60 AudioContent::from_xml (Content* parent, cxml::ConstNodePtr node)
  61 {
  62         if (!node->optional_number_child<double> ("AudioGain")) {
  63                 return shared_ptr<AudioContent> ();
  64         }
  65
  66         return shared_ptr<AudioContent> (new AudioContent (parent, node));
  67 }
  68
  69 AudioContent::AudioContent (Content* parent, cxml::ConstNodePtr node)
  70         : ContentPart (parent)
  71 {
  72         _gain = node->number_child<double> ("AudioGain");
  73         _delay = node->number_child<int> ("AudioDelay");
  74
  75         /* Backwards compatibility */
  76         optional<double> r = node->optional_number_child<double> ("AudioVideoFrameRate");
  77         if (r) {
  78                 _parent->set_video_frame_rate (r.get ());
  79         }
  80 }
  81
  82 AudioContent::AudioContent (Content* parent, vector<shared_ptr<Content> > c)
  83         : ContentPart (parent)
  84 {
  85         shared_ptr<AudioContent> ref = c[0]->audio;
  86         DCPOMATIC_ASSERT (ref);
  87
  88         for (size_t i = 1; i < c.size(); ++i) {
  89                 if (c[i]->audio->gain() != ref->gain()) {
  90                         throw JoinError (_("Content to be joined must have the same audio gain."));
  91                 }
  92
  93                 if (c[i]->audio->delay() != ref->delay()) {
  94                         throw JoinError (_("Content to be joined must have the same audio delay."));
  95                 }
  96         }
  97
  98         _gain = ref->gain ();
  99         _delay = ref->delay ();
 100         _streams = ref->streams ();
 101 }
 102
 103 void
 104 AudioContent::as_xml (xmlpp::Node* node) const
 105 {
 106         boost::mutex::scoped_lock lm (_mutex);
 107         node->add_child("AudioGain")->add_child_text (raw_convert<string> (_gain));
 108         node->add_child("AudioDelay")->add_child_text (raw_convert<string> (_delay));
 109 }
 110
 111 void
 112 AudioContent::set_gain (double g)
 113 {
 114         maybe_set (_gain, g, AudioContentProperty::GAIN);
 115 }
 116
 117 void
 118 AudioContent::set_delay (int d)
 119 {
 120         maybe_set (_delay, d, AudioContentProperty::DELAY);
 121 }
 122
 123 string
 124 AudioContent::technical_summary () const
 125 {
 126         string s = "audio :";
 127         BOOST_FOREACH (AudioStreamPtr i, streams ()) {
 128                 s += String::compose ("stream channels %1 rate %2", i->channels(), i->frame_rate());
 129         }
 130
 131         return s;
 132 }
 133
 134 void
 135 AudioContent::set_mapping (AudioMapping mapping)
 136 {
 137         int c = 0;
 138         BOOST_FOREACH (AudioStreamPtr i, streams ()) {
 139                 AudioMapping stream_mapping (i->channels (), MAX_DCP_AUDIO_CHANNELS);
 140                 for (int j = 0; j < i->channels(); ++j) {
 141                         for (int k = 0; k < MAX_DCP_AUDIO_CHANNELS; ++k) {
 142                                 stream_mapping.set (j, k, mapping.get (c, k));
 143                         }
 144                         ++c;
 145                 }
 146                 i->set_mapping (stream_mapping);
 147         }
 148
 149         _parent->signal_changed (AudioContentProperty::STREAMS);
 150 }
 151
 152 AudioMapping
 153 AudioContent::mapping () const
 154 {
 155         int channels = 0;
 156         BOOST_FOREACH (AudioStreamPtr i, streams ()) {
 157                 channels += i->channels ();
 158         }
 159
 160         AudioMapping merged (channels, MAX_DCP_AUDIO_CHANNELS);
 161         merged.make_zero ();
 162
 163         int c = 0;
 164         int s = 0;
 165         BOOST_FOREACH (AudioStreamPtr i, streams ()) {
 166                 AudioMapping mapping = i->mapping ();
 167                 for (int j = 0; j < mapping.input_channels(); ++j) {
 168                         for (int k = 0; k < MAX_DCP_AUDIO_CHANNELS; ++k) {
 169                                 if (k < mapping.output_channels()) {
 170                                         merged.set (c, k, mapping.get (j, k));
 171                                 }
 172                         }
 173                         ++c;
 174                 }
 175                 ++s;
 176         }
 177
 178         return merged;
 179 }
 180
 181 /** @return the frame rate that this content should be resampled to in order
 182  *  that it is in sync with the active video content at its start time.
 183  */
 184 int
 185 AudioContent::resampled_frame_rate () const
 186 {
 187         /* Resample to a DCI-approved sample rate */
 188         double t = has_rate_above_48k() ? 96000 : 48000;
 189
 190         FrameRateChange frc (_parent->active_video_frame_rate(), _parent->film()->video_frame_rate());
 191
 192         /* Compensate if the DCP is being run at a different frame rate
 193            to the source; that is, if the video is run such that it will
 194            look different in the DCP compared to the source (slower or faster).
 195         */
 196
 197         if (frc.change_speed) {
 198                 t /= frc.speed_up;
 199         }
 200
 201         return lrint (t);
 202 }
 203
 204 string
 205 AudioContent::processing_description () const
 206 {
 207         if (streams().empty ()) {
 208                 return "";
 209         }
 210
 211         /* Possible answers are:
 212            1. all audio will be resampled from x to y.
 213            2. all audio will be resampled to y (from a variety of rates)
 214            3. some audio will be resampled to y (from a variety of rates)
 215            4. nothing will be resampled.
 216         */
 217
 218         bool not_resampled = false;
 219         bool resampled = false;
 220         bool same = true;
 221
 222         optional<int> common_frame_rate;
 223         BOOST_FOREACH (AudioStreamPtr i, streams()) {
 224                 if (i->frame_rate() != resampled_frame_rate()) {
 225                         resampled = true;
 226                 } else {
 227                         not_resampled = true;
 228                 }
 229
 230                 if (common_frame_rate && common_frame_rate != i->frame_rate ()) {
 231                         same = false;
 232                 }
 233                 common_frame_rate = i->frame_rate ();
 234         }
 235
 236         if (not_resampled && !resampled) {
 237                 return _("Audio will not be resampled");
 238         }
 239
 240         if (not_resampled && resampled) {
 241                 return String::compose (_("Some audio will be resampled to %1kHz"), resampled_frame_rate ());
 242         }
 243
 244         if (!not_resampled && resampled) {
 245                 if (same) {
 246                         return String::compose (_("Audio will be resampled from %1kHz to %2kHz"), common_frame_rate.get(), resampled_frame_rate ());
 247                 } else {
 248                         return String::compose (_("Audio will be resampled to %1kHz"), resampled_frame_rate ());
 249                 }
 250         }
 251
 252         return "";
 253 }
 254
 255 /** @return true if any stream in this content has a sampling rate of more than 48kHz */
 256 bool
 257 AudioContent::has_rate_above_48k () const
 258 {
 259         BOOST_FOREACH (AudioStreamPtr i, streams ()) {
 260                 if (i->frame_rate() > 48000) {
 261                         return true;
 262                 }
 263         }
 264
 265         return false;
 266 }
 267
 268 /** @return User-visible names of each of our audio channels */
 269 vector<string>
 270 AudioContent::channel_names () const
 271 {
 272         vector<string> n;
 273
 274         int t = 1;
 275         BOOST_FOREACH (AudioStreamPtr i, streams ()) {
 276                 for (int j = 0; j < i->channels(); ++j) {
 277                         n.push_back (String::compose ("%1:%2", t, j + 1));
 278                 }
 279                 ++t;
 280         }
 281
 282         return n;
 283 }
 284
 285 void
 286 AudioContent::add_properties (list<UserProperty>& p) const
 287 {
 288         shared_ptr<const AudioStream> stream;
 289         if (streams().size() == 1) {
 290                 stream = streams().front ();
 291         }
 292
 293         if (stream) {
 294                 p.push_back (UserProperty (_("Audio"), _("Channels"), stream->channels ()));
 295                 p.push_back (UserProperty (_("Audio"), _("Content audio sample rate"), stream->frame_rate(), _("Hz")));
 296         }
 297
 298         FrameRateChange const frc (_parent->active_video_frame_rate(), _parent->film()->video_frame_rate());
 299         ContentTime const c (_parent->full_length(), frc);
 300
 301         p.push_back (
 302                 UserProperty (_("Length"), _("Full length in video frames at content rate"), c.frames_round(frc.source))
 303                 );
 304
 305         if (stream) {
 306                 p.push_back (
 307                         UserProperty (
 308                                 _("Length"),
 309                                 _("Full length in audio samples at content rate"),
 310                                 c.frames_round (stream->frame_rate ())
 311                                 )
 312                         );
 313         }
 314
 315         p.push_back (UserProperty (_("Audio"), _("DCP frame rate"), resampled_frame_rate (), _("Hz")));
 316         p.push_back (UserProperty (_("Length"), _("Full length in video frames at DCP rate"), c.frames_round (frc.dcp)));
 317
 318         if (stream) {
 319                 p.push_back (
 320                         UserProperty (
 321                                 _("Length"),
 322                                 _("Full length in audio samples at DCP rate"),
 323                                 c.frames_round (resampled_frame_rate ())
 324                                 )
 325                         );
 326         }
 327 }
 328
 329 void
 330 AudioContent::set_streams (vector<AudioStreamPtr> streams)
 331 {
 332         {
 333                 boost::mutex::scoped_lock lm (_mutex);
 334                 _streams = streams;
 335         }
 336
 337         _parent->signal_changed (AudioContentProperty::STREAMS);
 338 }
 339
 340 AudioStreamPtr
 341 AudioContent::stream () const
 342 {
 343         boost::mutex::scoped_lock lm (_mutex);
 344         DCPOMATIC_ASSERT (_streams.size() == 1);
 345         return _streams.front ();
 346 }
 347
 348 void
 349 AudioContent::add_stream (AudioStreamPtr stream)
 350 {
 351         {
 352                 boost::mutex::scoped_lock lm (_mutex);
 353                 _streams.push_back (stream);
 354         }
 355
 356         _parent->signal_changed (AudioContentProperty::STREAMS);
 357 }
 358
 359 void
 360 AudioContent::set_stream (AudioStreamPtr stream)
 361 {
 362         {
 363                 boost::mutex::scoped_lock lm (_mutex);
 364                 _streams.clear ();
 365                 _streams.push_back (stream);
 366         }
 367
 368         _parent->signal_changed (AudioContentProperty::STREAMS);
 369 }