git.sesse.net Git - casparcg/blob - modules/oal/consumer/oal_consumer.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 "oal_consumer.h"
  23
  24 #include <common/except.h>
  25 #include <common/executor.h>
  26 #include <common/diagnostics/graph.h>
  27 #include <common/log.h>
  28 #include <common/utf.h>
  29 #include <common/env.h>
  30 #include <common/future.h>
  31
  32 #include <core/consumer/frame_consumer.h>
  33 #include <core/frame/frame.h>
  34 #include <core/mixer/audio/audio_util.h>
  35 #include <core/mixer/audio/audio_mixer.h>
  36 #include <core/video_format.h>
  37
  38 #include <boost/circular_buffer.hpp>
  39 #include <boost/lexical_cast.hpp>
  40 #include <boost/property_tree/ptree.hpp>
  41 #include <boost/timer.hpp>
  42 #include <boost/thread/once.hpp>
  43 #include <boost/algorithm/string.hpp>
  44
  45 #include <tbb/concurrent_queue.h>
  46
  47 #include <AL/alc.h>
  48 #include <AL/al.h>
  49
  50 #include <array>
  51
  52 namespace caspar { namespace oal {
  53
  54 typedef cache_aligned_vector<int16_t> audio_buffer_16;
  55
  56 class device
  57 {
  58         ALCdevice*              device_         = nullptr;
  59         ALCcontext*             context_        = nullptr;
  60
  61 public:
  62         device()
  63         {
  64                 device_ = alcOpenDevice(nullptr);
  65
  66                 if(!device_)
  67                         CASPAR_THROW_EXCEPTION(invalid_operation() << msg_info("Failed to initialize audio device."));
  68
  69                 context_ = alcCreateContext(device_, nullptr);
  70
  71                 if(!context_)
  72                         CASPAR_THROW_EXCEPTION(invalid_operation() << msg_info("Failed to create audio context."));
  73
  74                 if(alcMakeContextCurrent(context_) == ALC_FALSE)
  75                         CASPAR_THROW_EXCEPTION(invalid_operation() << msg_info("Failed to activate audio context."));
  76         }
  77
  78         ~device()
  79         {
  80                 alcMakeContextCurrent(nullptr);
  81
  82                 if(context_)
  83                         alcDestroyContext(context_);
  84
  85                 if(device_)
  86                         alcCloseDevice(device_);
  87         }
  88
  89         ALCdevice* get()
  90         {
  91                 return device_;
  92         }
  93 };
  94
  95 void init_device()
  96 {
  97         static std::unique_ptr<device> instance;
  98         static boost::once_flag f = BOOST_ONCE_INIT;
  99
 100         boost::call_once(f, []{instance.reset(new device());});
 101 }
 102
 103 struct oal_consumer : public core::frame_consumer
 104 {
 105         core::monitor::subject                          monitor_subject_;
 106
 107         spl::shared_ptr<diagnostics::graph>     graph_;
 108         boost::timer                                            perf_timer_;
 109         int                                                                     channel_index_          = -1;
 110
 111         core::video_format_desc                         format_desc_;
 112
 113         ALuint                                                          source_                         = 0;
 114         std::array<ALuint, 3>                           buffers_;
 115
 116         executor                                                        executor_                       { L"oal_consumer" };
 117
 118 public:
 119         oal_consumer()
 120         {
 121                 buffers_.fill(0);
 122
 123                 init_device();
 124
 125                 graph_->set_color("tick-time", diagnostics::color(0.0f, 0.6f, 0.9f));
 126                 graph_->set_color("dropped-frame", diagnostics::color(0.3f, 0.6f, 0.3f));
 127                 graph_->set_color("late-frame", diagnostics::color(0.6f, 0.3f, 0.3f));
 128                 diagnostics::register_graph(graph_);
 129         }
 130
 131         ~oal_consumer()
 132         {
 133                 executor_.begin_invoke([=]
 134                 {
 135                         if(source_)
 136                         {
 137                                 alSourceStop(source_);
 138                                 alDeleteSources(1, &source_);
 139                         }
 140
 141                         for (auto& buffer : buffers_)
 142                         {
 143                                 if(buffer)
 144                                         alDeleteBuffers(1, &buffer);
 145                         };
 146                 });
 147         }
 148
 149         // frame consumer
 150
 151         void initialize(const core::video_format_desc& format_desc, int channel_index) override
 152         {
 153                 format_desc_    = format_desc;
 154                 channel_index_  = channel_index;
 155                 graph_->set_text(print());
 156
 157                 executor_.begin_invoke([=]
 158                 {
 159                         alGenBuffers(static_cast<ALsizei>(buffers_.size()), buffers_.data());
 160                         alGenSources(1, &source_);
 161
 162                         for(std::size_t n = 0; n < buffers_.size(); ++n)
 163                         {
 164                                 std::vector<int16_t> audio(format_desc_.audio_cadence[n % format_desc_.audio_cadence.size()]*format_desc_.audio_channels, 0);
 165                                 alBufferData(buffers_[n], AL_FORMAT_STEREO16, audio.data(), static_cast<ALsizei>(audio.size()*sizeof(int16_t)), format_desc_.audio_sample_rate);
 166                                 alSourceQueueBuffers(source_, 1, &buffers_[n]);
 167                         }
 168
 169                         alSourcei(source_, AL_LOOPING, AL_FALSE);
 170
 171                         alSourcePlay(source_);
 172                 });
 173         }
 174
 175         std::future<bool> send(core::const_frame frame) override
 176         {
 177                 // Will only block if the default executor queue capacity of 512 is
 178                 // exhausted, which should not happen
 179                 executor_.begin_invoke([=]
 180                 {
 181                         ALenum state;
 182                         alGetSourcei(source_, AL_SOURCE_STATE,&state);
 183                         if(state != AL_PLAYING)
 184                         {
 185                                 for(int n = 0; n < buffers_.size()-1; ++n)
 186                                 {
 187                                         ALuint buffer = 0;
 188                                         alSourceUnqueueBuffers(source_, 1, &buffer);
 189                                         if(buffer)
 190                                         {
 191                                                 std::vector<int16_t> audio(format_desc_.audio_cadence[n % format_desc_.audio_cadence.size()] * format_desc_.audio_channels, 0);
 192                                                 alBufferData(buffer, AL_FORMAT_STEREO16, audio.data(), static_cast<ALsizei>(audio.size()*sizeof(int16_t)), format_desc_.audio_sample_rate);
 193                                                 alSourceQueueBuffers(source_, 1, &buffer);
 194                                         }
 195                                 }
 196                                 alSourcePlay(source_);
 197                                 graph_->set_tag("late-frame");
 198                         }
 199
 200                         auto audio = core::audio_32_to_16(frame.audio_data());
 201
 202                         ALuint buffer = 0;
 203                         alSourceUnqueueBuffers(source_, 1, &buffer);
 204                         if(buffer)
 205                         {
 206                                 alBufferData(buffer, AL_FORMAT_STEREO16, audio.data(), static_cast<ALsizei>(audio.size()*sizeof(int16_t)), format_desc_.audio_sample_rate);
 207                                 alSourceQueueBuffers(source_, 1, &buffer);
 208                         }
 209                         else
 210                                 graph_->set_tag("dropped-frame");
 211
 212                         graph_->set_value("tick-time", perf_timer_.elapsed()*format_desc_.fps*0.5);
 213                         perf_timer_.restart();
 214                 });
 215
 216                 return make_ready_future(true);
 217         }
 218
 219         std::wstring print() const override
 220         {
 221                 return L"oal[" + boost::lexical_cast<std::wstring>(channel_index_) + L"|" + format_desc_.name + L"]";
 222         }
 223
 224         std::wstring name() const override
 225         {
 226                 return L"system-audio";
 227         }
 228
 229         boost::property_tree::wptree info() const override
 230         {
 231                 boost::property_tree::wptree info;
 232                 info.add(L"type", L"system-audio");
 233                 return info;
 234         }
 235
 236         bool has_synchronization_clock() const override
 237         {
 238                 return false;
 239         }
 240
 241         int delay_millis() const
 242         {
 243                 return 60;
 244         }
 245
 246         int buffer_depth() const override
 247         {
 248                 int delay_in_frames = static_cast<int>(delay_millis() / (1000.0 / format_desc_.fps));
 249
 250                 return delay_in_frames;
 251         }
 252
 253         int index() const override
 254         {
 255                 return 500;
 256         }
 257
 258         core::monitor::subject& monitor_output()
 259         {
 260                 return monitor_subject_;
 261         }
 262 };
 263
 264 spl::shared_ptr<core::frame_consumer> create_consumer(const std::vector<std::wstring>& params, core::interaction_sink*)
 265 {
 266         if(params.size() < 1 || !boost::iequals(params.at(0), L"AUDIO"))
 267                 return core::frame_consumer::empty();
 268
 269         return spl::make_shared<oal_consumer>();
 270 }
 271
 272 spl::shared_ptr<core::frame_consumer> create_preconfigured_consumer(const boost::property_tree::wptree&, core::interaction_sink*)
 273 {
 274         return spl::make_shared<oal_consumer>();
 275 }
 276
 277 }}