src/lib/audio_content.cc

   1 /*
   2     Copyright (C) 2013-2014 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 "analyse_audio_job.h"
  22 #include "job_manager.h"
  23 #include "film.h"
  24 #include "exceptions.h"
  25 #include "config.h"
  26 #include "frame_rate_change.h"
  27 #include "audio_processor.h"
  28 #include "raw_convert.h"
  29 #include <libcxml/cxml.h>
  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
  42 int const AudioContentProperty::AUDIO_CHANNELS = 200;
  43 int const AudioContentProperty::AUDIO_FRAME_RATE = 201;
  44 int const AudioContentProperty::AUDIO_GAIN = 202;
  45 int const AudioContentProperty::AUDIO_DELAY = 203;
  46 int const AudioContentProperty::AUDIO_MAPPING = 204;
  47 int const AudioContentProperty::AUDIO_PROCESSOR = 205;
  48
  49 AudioContent::AudioContent (shared_ptr<const Film> f)
  50         : Content (f)
  51         , _audio_gain (0)
  52         , _audio_delay (Config::instance()->default_audio_delay ())
  53         , _audio_processor (0)
  54 {
  55
  56 }
  57
  58 AudioContent::AudioContent (shared_ptr<const Film> f, DCPTime s)
  59         : Content (f, s)
  60         , _audio_gain (0)
  61         , _audio_delay (Config::instance()->default_audio_delay ())
  62         , _audio_processor (0)
  63 {
  64
  65 }
  66
  67 AudioContent::AudioContent (shared_ptr<const Film> f, boost::filesystem::path p)
  68         : Content (f, p)
  69         , _audio_gain (0)
  70         , _audio_delay (Config::instance()->default_audio_delay ())
  71         , _audio_processor (0)
  72 {
  73
  74 }
  75
  76 AudioContent::AudioContent (shared_ptr<const Film> f, cxml::ConstNodePtr node)
  77         : Content (f, node)
  78         , _audio_processor (0)
  79 {
  80         _audio_gain = node->number_child<float> ("AudioGain");
  81         _audio_delay = node->number_child<int> ("AudioDelay");
  82         if (node->optional_string_child ("AudioProcessor")) {
  83                 _audio_processor = AudioProcessor::from_id (node->string_child ("AudioProcessor"));
  84         }
  85 }
  86
  87 AudioContent::AudioContent (shared_ptr<const Film> f, vector<shared_ptr<Content> > c)
  88         : Content (f, c)
  89 {
  90         shared_ptr<AudioContent> ref = dynamic_pointer_cast<AudioContent> (c[0]);
  91         DCPOMATIC_ASSERT (ref);
  92
  93         for (size_t i = 0; i < c.size(); ++i) {
  94                 shared_ptr<AudioContent> ac = dynamic_pointer_cast<AudioContent> (c[i]);
  95
  96                 if (ac->audio_gain() != ref->audio_gain()) {
  97                         throw JoinError (_("Content to be joined must have the same audio gain."));
  98                 }
  99
 100                 if (ac->audio_delay() != ref->audio_delay()) {
 101                         throw JoinError (_("Content to be joined must have the same audio delay."));
 102                 }
 103         }
 104
 105         _audio_gain = ref->audio_gain ();
 106         _audio_delay = ref->audio_delay ();
 107         _audio_processor = ref->audio_processor ();
 108 }
 109
 110 void
 111 AudioContent::as_xml (xmlpp::Node* node) const
 112 {
 113         boost::mutex::scoped_lock lm (_mutex);
 114         node->add_child("AudioGain")->add_child_text (raw_convert<string> (_audio_gain));
 115         node->add_child("AudioDelay")->add_child_text (raw_convert<string> (_audio_delay));
 116         if (_audio_processor) {
 117                 node->add_child("AudioProcessor")->add_child_text (_audio_processor->id ());
 118         }
 119 }
 120
 121
 122 void
 123 AudioContent::set_audio_gain (double g)
 124 {
 125         {
 126                 boost::mutex::scoped_lock lm (_mutex);
 127                 _audio_gain = g;
 128         }
 129
 130         signal_changed (AudioContentProperty::AUDIO_GAIN);
 131 }
 132
 133 void
 134 AudioContent::set_audio_delay (int d)
 135 {
 136         {
 137                 boost::mutex::scoped_lock lm (_mutex);
 138                 _audio_delay = d;
 139         }
 140
 141         signal_changed (AudioContentProperty::AUDIO_DELAY);
 142 }
 143
 144 void
 145 AudioContent::set_audio_processor (AudioProcessor const * p)
 146 {
 147         {
 148                 boost::mutex::scoped_lock lm (_mutex);
 149                 _audio_processor = p;
 150         }
 151
 152         /* The channel count might have changed, so reset the mapping */
 153         AudioMapping m (processed_audio_channels ());
 154         m.make_default ();
 155         set_audio_mapping (m);
 156
 157         signal_changed (AudioContentProperty::AUDIO_PROCESSOR);
 158 }
 159
 160 boost::signals2::connection
 161 AudioContent::analyse_audio (boost::function<void()> finished)
 162 {
 163         shared_ptr<const Film> film = _film.lock ();
 164         DCPOMATIC_ASSERT (film);
 165
 166         shared_ptr<AnalyseAudioJob> job (new AnalyseAudioJob (film, dynamic_pointer_cast<AudioContent> (shared_from_this())));
 167         boost::signals2::connection c = job->Finished.connect (finished);
 168         JobManager::instance()->add (job);
 169
 170         return c;
 171 }
 172
 173 boost::filesystem::path
 174 AudioContent::audio_analysis_path () const
 175 {
 176         shared_ptr<const Film> film = _film.lock ();
 177         if (!film) {
 178                 return boost::filesystem::path ();
 179         }
 180
 181         boost::filesystem::path p = film->audio_analysis_dir ();
 182         p /= digest() + "_" + audio_mapping().digest();
 183         return p;
 184 }
 185
 186 string
 187 AudioContent::technical_summary () const
 188 {
 189         return String::compose (
 190                 "audio: channels %1, content rate %2, resampled rate %3",
 191                 audio_channels(),
 192                 audio_frame_rate(),
 193                 resampled_audio_frame_rate()
 194                 );
 195 }
 196
 197 void
 198 AudioContent::set_audio_mapping (AudioMapping)
 199 {
 200         signal_changed (AudioContentProperty::AUDIO_MAPPING);
 201 }
 202
 203 /** @return the frame rate that this content should be resampled to in order
 204  *  that it is in sync with the active video content at its start time.
 205  */
 206 int
 207 AudioContent::resampled_audio_frame_rate () const
 208 {
 209         shared_ptr<const Film> film = _film.lock ();
 210         DCPOMATIC_ASSERT (film);
 211
 212         /* Resample to a DCI-approved sample rate */
 213         double t = dcp_audio_frame_rate (audio_frame_rate ());
 214
 215         FrameRateChange frc = film->active_frame_rate_change (position ());
 216
 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).
 220         */
 221
 222         if (frc.change_speed) {
 223                 t /= frc.speed_up;
 224         }
 225
 226         return rint (t);
 227 }
 228
 229 int
 230 AudioContent::processed_audio_channels () const
 231 {
 232         if (!audio_processor ()) {
 233                 return audio_channels ();
 234         }
 235
 236         return audio_processor()->out_channels (audio_channels ());
 237 }
 238
 239 string
 240 AudioContent::processing_description () const
 241 {
 242         stringstream d;
 243
 244         if (audio_frame_rate() != resampled_audio_frame_rate ()) {
 245                 stringstream from;
 246                 from << fixed << setprecision(3) << (audio_frame_rate() / 1000.0);
 247                 stringstream to;
 248                 to << fixed << setprecision(3) << (resampled_audio_frame_rate() / 1000.0);
 249
 250                 d << String::compose (_("Audio will be resampled from %1kHz to %2kHz."), from.str(), to.str());
 251         } else {
 252                 d << _("Audio will not be resampled.");
 253         }
 254
 255         return d.str ();
 256 }
 257