src/lib/audio_content.cc

   1 /*
   2     Copyright (C) 2013-2015 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
  31 #include "i18n.h"
  32
  33 using std::string;
  34 using std::cout;
  35 using std::vector;
  36 using std::stringstream;
  37 using std::fixed;
  38 using std::setprecision;
  39 using boost::shared_ptr;
  40 using boost::dynamic_pointer_cast;
  41 using boost::optional;
  42
  43 /** Something stream-related has changed */
  44 int const AudioContentProperty::AUDIO_STREAMS = 200;
  45 int const AudioContentProperty::AUDIO_GAIN = 201;
  46 int const AudioContentProperty::AUDIO_DELAY = 202;
  47
  48 AudioContent::AudioContent (shared_ptr<const Film> film)
  49         : Content (film)
  50         , _audio_gain (0)
  51         , _audio_delay (Config::instance()->default_audio_delay ())
  52 {
  53
  54 }
  55
  56 AudioContent::AudioContent (shared_ptr<const Film> film, DCPTime s)
  57         : Content (film, s)
  58         , _audio_gain (0)
  59         , _audio_delay (Config::instance()->default_audio_delay ())
  60 {
  61
  62 }
  63
  64 AudioContent::AudioContent (shared_ptr<const Film> film, boost::filesystem::path p)
  65         : Content (film, p)
  66         , _audio_gain (0)
  67         , _audio_delay (Config::instance()->default_audio_delay ())
  68 {
  69
  70 }
  71
  72 AudioContent::AudioContent (shared_ptr<const Film> film, cxml::ConstNodePtr node)
  73         : Content (film, node)
  74 {
  75         _audio_gain = node->number_child<float> ("AudioGain");
  76         _audio_delay = node->number_child<int> ("AudioDelay");
  77 }
  78
  79 AudioContent::AudioContent (shared_ptr<const Film> film, vector<shared_ptr<Content> > c)
  80         : Content (film, c)
  81 {
  82         shared_ptr<AudioContent> ref = dynamic_pointer_cast<AudioContent> (c[0]);
  83         DCPOMATIC_ASSERT (ref);
  84
  85         for (size_t i = 0; i < c.size(); ++i) {
  86                 shared_ptr<AudioContent> ac = dynamic_pointer_cast<AudioContent> (c[i]);
  87
  88                 if (ac->audio_gain() != ref->audio_gain()) {
  89                         throw JoinError (_("Content to be joined must have the same audio gain."));
  90                 }
  91
  92                 if (ac->audio_delay() != ref->audio_delay()) {
  93                         throw JoinError (_("Content to be joined must have the same audio delay."));
  94                 }
  95         }
  96
  97         _audio_gain = ref->audio_gain ();
  98         _audio_delay = ref->audio_delay ();
  99 }
 100
 101 void
 102 AudioContent::as_xml (xmlpp::Node* node) const
 103 {
 104         boost::mutex::scoped_lock lm (_mutex);
 105         node->add_child("AudioGain")->add_child_text (raw_convert<string> (_audio_gain));
 106         node->add_child("AudioDelay")->add_child_text (raw_convert<string> (_audio_delay));
 107 }
 108
 109
 110 void
 111 AudioContent::set_audio_gain (double g)
 112 {
 113         {
 114                 boost::mutex::scoped_lock lm (_mutex);
 115                 _audio_gain = g;
 116         }
 117
 118         signal_changed (AudioContentProperty::AUDIO_GAIN);
 119 }
 120
 121 void
 122 AudioContent::set_audio_delay (int d)
 123 {
 124         {
 125                 boost::mutex::scoped_lock lm (_mutex);
 126                 _audio_delay = d;
 127         }
 128
 129         signal_changed (AudioContentProperty::AUDIO_DELAY);
 130 }
 131
 132 string
 133 AudioContent::technical_summary () const
 134 {
 135         string s = "audio :";
 136         BOOST_FOREACH (AudioStreamPtr i, audio_streams ()) {
 137                 s += String::compose ("stream channels %1 rate %2", i->channels(), i->frame_rate());
 138         }
 139
 140         return s;
 141 }
 142
 143 void
 144 AudioContent::set_audio_mapping (AudioMapping mapping)
 145 {
 146         int c = 0;
 147         BOOST_FOREACH (AudioStreamPtr i, audio_streams ()) {
 148                 AudioMapping stream_mapping (i->channels (), MAX_DCP_AUDIO_CHANNELS);
 149                 for (int j = 0; j < i->channels(); ++j) {
 150                         for (int k = 0; k < MAX_DCP_AUDIO_CHANNELS; ++k) {
 151                                 stream_mapping.set (j, k, mapping.get (c, k));
 152                         }
 153                         ++c;
 154                 }
 155                 i->set_mapping (stream_mapping);
 156         }
 157
 158         signal_changed (AudioContentProperty::AUDIO_STREAMS);
 159 }
 160
 161 AudioMapping
 162 AudioContent::audio_mapping () const
 163 {
 164         int channels = 0;
 165         BOOST_FOREACH (AudioStreamPtr i, audio_streams ()) {
 166                 channels += i->channels ();
 167         }
 168
 169         AudioMapping merged (channels, MAX_DCP_AUDIO_CHANNELS);
 170
 171         int c = 0;
 172         int s = 0;
 173         BOOST_FOREACH (AudioStreamPtr i, audio_streams ()) {
 174                 AudioMapping mapping = i->mapping ();
 175                 for (int j = 0; j < mapping.input_channels(); ++j) {
 176                         for (int k = 0; k < MAX_DCP_AUDIO_CHANNELS; ++k) {
 177                                 merged.set (c, k, mapping.get (j, k));
 178                         }
 179                         ++c;
 180                 }
 181                 ++s;
 182         }
 183
 184         return merged;
 185 }
 186
 187 /** @return the frame rate that this content should be resampled to in order
 188  *  that it is in sync with the active video content at its start time.
 189  */
 190 int
 191 AudioContent::resampled_audio_frame_rate () const
 192 {
 193         shared_ptr<const Film> film = _film.lock ();
 194         DCPOMATIC_ASSERT (film);
 195
 196         /* Resample to a DCI-approved sample rate */
 197         double t = has_rate_above_48k() ? 96000 : 48000;
 198
 199         FrameRateChange frc = film->active_frame_rate_change (position ());
 200
 201         /* Compensate if the DCP is being run at a different frame rate
 202            to the source; that is, if the video is run such that it will
 203            look different in the DCP compared to the source (slower or faster).
 204         */
 205
 206         if (frc.change_speed) {
 207                 t /= frc.speed_up;
 208         }
 209
 210         return lrint (t);
 211 }
 212
 213 string
 214 AudioContent::processing_description () const
 215 {
 216         vector<AudioStreamPtr> streams = audio_streams ();
 217         if (streams.empty ()) {
 218                 return "";
 219         }
 220
 221         /* Possible answers are:
 222            1. all audio will be resampled from x to y.
 223            2. all audio will be resampled to y (from a variety of rates)
 224            3. some audio will be resampled to y (from a variety of rates)
 225            4. nothing will be resampled.
 226         */
 227
 228         bool not_resampled = false;
 229         bool resampled = false;
 230         bool same = true;
 231
 232         optional<int> common_frame_rate;
 233         BOOST_FOREACH (AudioStreamPtr i, streams) {
 234                 if (i->frame_rate() != resampled_audio_frame_rate()) {
 235                         resampled = true;
 236                 } else {
 237                         not_resampled = true;
 238                 }
 239
 240                 if (common_frame_rate && common_frame_rate != i->frame_rate ()) {
 241                         same = false;
 242                 }
 243                 common_frame_rate = i->frame_rate ();
 244         }
 245
 246         if (not_resampled && !resampled) {
 247                 return _("Audio will not be resampled");
 248         }
 249
 250         if (not_resampled && resampled) {
 251                 return String::compose (_("Some audio will be resampled to %1kHz"), resampled_audio_frame_rate ());
 252         }
 253
 254         if (!not_resampled && resampled) {
 255                 if (same) {
 256                         return String::compose (_("Audio will be resampled from %1kHz to %2kHz"), common_frame_rate.get(), resampled_audio_frame_rate ());
 257                 } else {
 258                         return String::compose (_("Audio will be resampled to %1kHz"), resampled_audio_frame_rate ());
 259                 }
 260         }
 261
 262         return "";
 263 }
 264
 265 /** @return true if any stream in this content has a sampling rate of more than 48kHz */
 266 bool
 267 AudioContent::has_rate_above_48k () const
 268 {
 269         BOOST_FOREACH (AudioStreamPtr i, audio_streams ()) {
 270                 if (i->frame_rate() > 48000) {
 271                         return true;
 272                 }
 273         }
 274
 275         return false;
 276 }
 277
 278 /** @return User-visible names of each of our audio channels */
 279 vector<string>
 280 AudioContent::audio_channel_names () const
 281 {
 282         vector<string> n;
 283
 284         int t = 1;
 285         BOOST_FOREACH (AudioStreamPtr i, audio_streams ()) {
 286                 for (int j = 0; j < i->channels(); ++j) {
 287                         n.push_back (String::compose ("%1:%2", t, j + 1));
 288                 }
 289                 ++t;
 290         }
 291
 292         return n;
 293 }