git.sesse.net Git - casparcg/blob - core/mixer/audio/audio_mixer.cpp

   1 /*
   2 * Copyright (c) 2011 Sveriges Television AB <info@casparcg.com>
   3 *
   4 * This file is part of CasparCG (www.casparcg.com).
   5 *
   6 * CasparCG 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 3 of the License, or
   9 * (at your option) any later version.
  10 *
  11 * CasparCG 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 CasparCG. If not, see <http://www.gnu.org/licenses/>.
  18 *
  19 * Author: Robert Nagy, ronag89@gmail.com
  20 */
  21
  22 #include "../../StdAfx.h"
  23
  24 #include "audio_mixer.h"
  25
  26 #include <core/frame/frame.h>
  27 #include <core/frame/frame_transform.h>
  28 #include <core/frame/audio_channel_layout.h>
  29 #include <core/monitor/monitor.h>
  30
  31 #include <common/diagnostics/graph.h>
  32 #include <common/linq.h>
  33
  34 #include <boost/range/adaptors.hpp>
  35 #include <boost/range/distance.hpp>
  36 #include <boost/lexical_cast.hpp>
  37
  38 #include <map>
  39 #include <stack>
  40 #include <vector>
  41
  42 namespace caspar { namespace core {
  43
  44 struct audio_item
  45 {
  46         const void*                             tag                             = nullptr;
  47         audio_transform                 transform;
  48         audio_buffer                    audio_data;
  49         audio_channel_layout    channel_layout  = audio_channel_layout::invalid();
  50
  51         audio_item()
  52         {
  53         }
  54
  55         audio_item(audio_item&& other)
  56                 : tag(std::move(other.tag))
  57                 , transform(std::move(other.transform))
  58                 , audio_data(std::move(other.audio_data))
  59                 , channel_layout(std::move(other.channel_layout))
  60         {
  61         }
  62 };
  63
  64 typedef cache_aligned_vector<double> audio_buffer_ps;
  65
  66 struct audio_stream
  67 {
  68         audio_transform                                                 prev_transform;
  69         audio_buffer_ps                                                 audio_data;
  70         std::unique_ptr<audio_channel_remapper> channel_remapper;
  71         bool                                                                    remapping_failed        = false;
  72         bool                                                                    is_still                        = false;
  73 };
  74
  75 struct audio_mixer::impl : boost::noncopyable
  76 {
  77         monitor::subject                                        monitor_subject_                { "/audio" };
  78         std::stack<core::audio_transform>       transform_stack_;
  79         std::map<const void*, audio_stream>     audio_streams_;
  80         std::vector<audio_item>                         items_;
  81         std::vector<int>                                        audio_cadence_;
  82         video_format_desc                                       format_desc_;
  83         audio_channel_layout                            channel_layout_                 = audio_channel_layout::invalid();
  84         float                                                           master_volume_                  = 1.0f;
  85         float                                                           previous_master_volume_ = master_volume_;
  86         spl::shared_ptr<diagnostics::graph>     graph_;
  87 public:
  88         impl(spl::shared_ptr<diagnostics::graph> graph)
  89                 : graph_(std::move(graph))
  90         {
  91                 graph_->set_color("volume", diagnostics::color(1.0f, 0.8f, 0.1f));
  92                 graph_->set_color("audio-clipping", diagnostics::color(0.3f, 0.6f, 0.3f));
  93                 transform_stack_.push(core::audio_transform());
  94         }
  95
  96         void push(const frame_transform& transform)
  97         {
  98                 transform_stack_.push(transform_stack_.top()*transform.audio_transform);
  99         }
 100
 101         void visit(const const_frame& frame)
 102         {
 103                 if(transform_stack_.top().volume < 0.002 || frame.audio_data().empty())
 104                         return;
 105
 106                 audio_item item;
 107                 item.tag                        = frame.stream_tag();
 108                 item.transform          = transform_stack_.top();
 109                 item.audio_data         = frame.audio_data();
 110                 item.channel_layout = frame.audio_channel_layout();
 111
 112                 if(item.transform.is_still)
 113                         item.transform.volume = 0.0;
 114
 115                 items_.push_back(std::move(item));
 116         }
 117
 118         void begin(const core::audio_transform& transform)
 119         {
 120                 transform_stack_.push(transform_stack_.top()*transform);
 121         }
 122
 123         void pop()
 124         {
 125                 transform_stack_.pop();
 126         }
 127
 128         void set_master_volume(float volume)
 129         {
 130                 master_volume_ = volume;
 131         }
 132
 133         float get_master_volume()
 134         {
 135                 return master_volume_;
 136         }
 137
 138         audio_buffer mix(const video_format_desc& format_desc, const audio_channel_layout& channel_layout)
 139         {
 140                 if(format_desc_ != format_desc || channel_layout_ != channel_layout)
 141                 {
 142                         audio_streams_.clear();
 143                         audio_cadence_ = format_desc.audio_cadence;
 144                         format_desc_ = format_desc;
 145                         channel_layout_ = channel_layout;
 146                 }
 147
 148                 std::map<const void*, audio_stream>     next_audio_streams;
 149
 150                 for (auto& item : items_)
 151                 {
 152                         audio_buffer_ps next_audio;
 153                         std::unique_ptr<audio_channel_remapper> channel_remapper;
 154                         bool remapping_failed = false;
 155
 156                         auto next_transform = item.transform;
 157                         auto prev_transform = next_transform;
 158
 159                         auto tag = item.tag;
 160
 161                         auto it = next_audio_streams.find(tag);
 162                         bool found = it != next_audio_streams.end();
 163
 164                         if (!found)
 165                         {
 166                                 it = audio_streams_.find(tag);
 167                                 found = it != audio_streams_.end();
 168                         }
 169
 170                         if (found)
 171                         {
 172                                 prev_transform = it->second.prev_transform;
 173                                 next_audio = std::move(it->second.audio_data);
 174                                 channel_remapper = std::move(it->second.channel_remapper);
 175                                 remapping_failed = it->second.remapping_failed;
 176                         }
 177
 178                         if (remapping_failed)
 179                         {
 180                                 CASPAR_LOG(trace) << "[audio_mixer] audio channel remapping already failed for stream.";
 181                                 next_audio_streams[tag].remapping_failed = true;
 182                                 continue;
 183                         }
 184
 185                         // Skip it if there is no existing audio stream and item has no audio-data.
 186                         if(!found && item.audio_data.empty())
 187                                 continue;
 188
 189                         if (item.channel_layout == audio_channel_layout::invalid())
 190                         {
 191                                 CASPAR_LOG(warning) << "[audio_mixer] invalid audio channel layout for item";
 192                                 next_audio_streams[tag].remapping_failed = true;
 193                                 continue;
 194                         }
 195
 196                         if (!channel_remapper)
 197                         {
 198                                 try
 199                                 {
 200                                         channel_remapper.reset(new audio_channel_remapper(item.channel_layout, channel_layout_));
 201                                 }
 202                                 catch (...)
 203                                 {
 204                                         CASPAR_LOG_CURRENT_EXCEPTION();
 205                                         CASPAR_LOG(error) << "[audio_mixer] audio channel remapping failed for stream.";
 206                                         next_audio_streams[tag].remapping_failed = true;
 207                                         continue;
 208                                 }
 209                         }
 210
 211                         item.audio_data = channel_remapper->mix_and_rearrange(item.audio_data);
 212
 213                         const double prev_volume = prev_transform.volume * previous_master_volume_;
 214                         const double next_volume = next_transform.volume * master_volume_;
 215
 216                         // TODO: Move volume mixing into code below, in order to support audio sample counts not corresponding to frame audio samples.
 217                         auto alpha = (next_volume-prev_volume)/static_cast<double>(item.audio_data.size()/channel_layout_.num_channels);
 218
 219                         for(size_t n = 0; n < item.audio_data.size(); ++n)
 220                         {
 221                                 auto sample_multiplier = (prev_volume + (n / channel_layout_.num_channels) * alpha);
 222                                 next_audio.push_back(item.audio_data.data()[n] * sample_multiplier);
 223                         }
 224
 225                         next_audio_streams[tag].prev_transform          = std::move(next_transform); // Store all active tags, inactive tags will be removed at the end.
 226                         next_audio_streams[tag].audio_data                      = std::move(next_audio);
 227                         next_audio_streams[tag].channel_remapper        = std::move(channel_remapper);
 228                         next_audio_streams[tag].remapping_failed        = remapping_failed;
 229                         next_audio_streams[tag].is_still                        = item.transform.is_still;
 230                 }
 231
 232                 previous_master_volume_ = master_volume_;
 233                 items_.clear();
 234
 235                 audio_streams_ = std::move(next_audio_streams);
 236
 237                 if(audio_streams_.empty())
 238                         audio_streams_[nullptr].audio_data = audio_buffer_ps(audio_size(audio_cadence_.front()), 0.0);
 239
 240                 { // sanity check
 241
 242                         auto nb_invalid_streams = cpplinq::from(audio_streams_)
 243                                 .select(values())
 244                                 .where([&](const audio_stream& x)
 245                                 {
 246                                         return !x.remapping_failed && x.audio_data.size() < audio_size(audio_cadence_.front());
 247                                 })
 248                                 .count();
 249
 250                         if(nb_invalid_streams > 0)
 251                                 CASPAR_LOG(trace) << "[audio_mixer] Incorrect frame audio cadence detected.";
 252                 }
 253
 254                 audio_buffer_ps result_ps(audio_size(audio_cadence_.front()), 0.0);
 255                 for (auto& stream : audio_streams_ | boost::adaptors::map_values)
 256                 {
 257                         if (stream.audio_data.size() < result_ps.size())
 258                         {
 259                                 auto samples = (result_ps.size() - stream.audio_data.size()) / channel_layout_.num_channels;
 260                                 CASPAR_LOG(trace) << L"[audio_mixer] Appended " << samples << L" zero samples";
 261                                 CASPAR_LOG(trace) << L"[audio_mixer] Actual number of samples " << stream.audio_data.size() / channel_layout_.num_channels;
 262                                 CASPAR_LOG(trace) << L"[audio_mixer] Wanted number of samples " << result_ps.size() / channel_layout_.num_channels;
 263                                 stream.audio_data.resize(result_ps.size(), 0.0);
 264                         }
 265
 266                         auto out = boost::range::transform(result_ps, stream.audio_data, std::begin(result_ps), std::plus<double>());
 267                         stream.audio_data.erase(std::begin(stream.audio_data), std::begin(stream.audio_data) + std::distance(std::begin(result_ps), out));
 268                 }
 269
 270                 boost::range::rotate(audio_cadence_, std::begin(audio_cadence_)+1);
 271
 272                 auto result_owner = spl::make_shared<mutable_audio_buffer>();
 273                 auto& result = *result_owner;
 274                 result.reserve(result_ps.size());
 275                 const int32_t min_amplitude = std::numeric_limits<int32_t>::min();
 276                 const int32_t max_amplitude = std::numeric_limits<int32_t>::max();
 277                 bool clipping = false;
 278                 boost::range::transform(result_ps, std::back_inserter(result), [&](double sample)
 279                 {
 280                         if (sample > max_amplitude)
 281                         {
 282                                 clipping = true;
 283                                 return max_amplitude;
 284                         }
 285                         else if (sample < min_amplitude)
 286                         {
 287                                 clipping = true;
 288                                 return min_amplitude;
 289                         }
 290                         else
 291                                 return static_cast<int32_t>(sample);
 292                 });
 293
 294                 if (clipping)
 295                         graph_->set_tag(diagnostics::tag_severity::WARNING, "audio-clipping");
 296
 297                 const int num_channels = channel_layout_.num_channels;
 298                 monitor_subject_ << monitor::message("/nb_channels") % num_channels;
 299
 300                 auto max = std::vector<int32_t>(num_channels, std::numeric_limits<int32_t>::min());
 301
 302                 for (size_t n = 0; n < result.size(); n += num_channels)
 303                         for (int ch = 0; ch < num_channels; ++ch)
 304                                 max[ch] = std::max(max[ch], std::abs(result[n + ch]));
 305
 306                 // Makes the dBFS of silence => -dynamic range of 32bit LPCM => about -192 dBFS
 307                 // Otherwise it would be -infinity
 308                 static const auto MIN_PFS = 0.5f / static_cast<float>(std::numeric_limits<int32_t>::max());
 309
 310                 for (int i = 0; i < num_channels; ++i)
 311                 {
 312                         const auto pFS = max[i] / static_cast<float>(std::numeric_limits<int32_t>::max());
 313                         const auto dBFS = 20.0f * std::log10(std::max(MIN_PFS, pFS));
 314
 315                         auto chan_str = boost::lexical_cast<std::string>(i + 1);
 316
 317                         monitor_subject_ << monitor::message("/" + chan_str + "/pFS") % pFS;
 318                         monitor_subject_ << monitor::message("/" + chan_str + "/dBFS") % dBFS;
 319                 }
 320
 321                 graph_->set_value("volume", static_cast<double>(*boost::max_element(max)) / std::numeric_limits<int32_t>::max());
 322
 323                 return caspar::array<int32_t>(result.data(), result.size(), true, std::move(result_owner));
 324         }
 325
 326         size_t audio_size(size_t num_samples) const
 327         {
 328                 return num_samples * channel_layout_.num_channels;
 329         }
 330 };
 331
 332 audio_mixer::audio_mixer(spl::shared_ptr<diagnostics::graph> graph) : impl_(new impl(std::move(graph))){}
 333 void audio_mixer::push(const frame_transform& transform){impl_->push(transform);}
 334 void audio_mixer::visit(const const_frame& frame){impl_->visit(frame);}
 335 void audio_mixer::pop(){impl_->pop();}
 336 void audio_mixer::set_master_volume(float volume) { impl_->set_master_volume(volume); }
 337 float audio_mixer::get_master_volume() { return impl_->get_master_volume(); }
 338 audio_buffer audio_mixer::operator()(const video_format_desc& format_desc, const audio_channel_layout& channel_layout){ return impl_->mix(format_desc, channel_layout); }
 339 monitor::subject& audio_mixer::monitor_output(){ return impl_->monitor_subject_; }
 340
 341 }}