2 * Copyright (c) 2011 Sveriges Television AB <info@casparcg.com>
4 * This file is part of CasparCG (www.casparcg.com).
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.
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.
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/>.
19 * Author: Robert Nagy, ronag89@gmail.com
22 #include "oal_consumer.h"
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>
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 #include <core/help/help_sink.h>
38 #include <core/help/help_repository.h>
40 #include <boost/circular_buffer.hpp>
41 #include <boost/lexical_cast.hpp>
42 #include <boost/property_tree/ptree.hpp>
43 #include <boost/timer.hpp>
44 #include <boost/thread/once.hpp>
45 #include <boost/algorithm/string.hpp>
47 #include <tbb/concurrent_queue.h>
54 namespace caspar { namespace oal {
56 typedef cache_aligned_vector<int16_t> audio_buffer_16;
60 ALCdevice* device_ = nullptr;
61 ALCcontext* context_ = nullptr;
66 device_ = alcOpenDevice(nullptr);
69 CASPAR_THROW_EXCEPTION(invalid_operation() << msg_info("Failed to initialize audio device."));
71 context_ = alcCreateContext(device_, nullptr);
74 CASPAR_THROW_EXCEPTION(invalid_operation() << msg_info("Failed to create audio context."));
76 if(alcMakeContextCurrent(context_) == ALC_FALSE)
77 CASPAR_THROW_EXCEPTION(invalid_operation() << msg_info("Failed to activate audio context."));
82 alcMakeContextCurrent(nullptr);
85 alcDestroyContext(context_);
88 alcCloseDevice(device_);
99 static std::unique_ptr<device> instance;
100 static boost::once_flag f = BOOST_ONCE_INIT;
102 boost::call_once(f, []{instance.reset(new device());});
105 struct oal_consumer : public core::frame_consumer
107 core::monitor::subject monitor_subject_;
109 spl::shared_ptr<diagnostics::graph> graph_;
110 boost::timer perf_timer_;
111 int channel_index_ = -1;
113 core::video_format_desc format_desc_;
116 std::array<ALuint, 3> buffers_;
118 executor executor_ { L"oal_consumer" };
127 graph_->set_color("tick-time", diagnostics::color(0.0f, 0.6f, 0.9f));
128 graph_->set_color("dropped-frame", diagnostics::color(0.3f, 0.6f, 0.3f));
129 graph_->set_color("late-frame", diagnostics::color(0.6f, 0.3f, 0.3f));
130 diagnostics::register_graph(graph_);
135 executor_.begin_invoke([=]
139 alSourceStop(source_);
140 alDeleteSources(1, &source_);
143 for (auto& buffer : buffers_)
146 alDeleteBuffers(1, &buffer);
153 void initialize(const core::video_format_desc& format_desc, int channel_index) override
155 format_desc_ = format_desc;
156 channel_index_ = channel_index;
157 graph_->set_text(print());
159 executor_.begin_invoke([=]
161 alGenBuffers(static_cast<ALsizei>(buffers_.size()), buffers_.data());
162 alGenSources(1, &source_);
164 for(std::size_t n = 0; n < buffers_.size(); ++n)
166 std::vector<int16_t> audio(format_desc_.audio_cadence[n % format_desc_.audio_cadence.size()]*format_desc_.audio_channels, 0);
167 alBufferData(buffers_[n], AL_FORMAT_STEREO16, audio.data(), static_cast<ALsizei>(audio.size()*sizeof(int16_t)), format_desc_.audio_sample_rate);
168 alSourceQueueBuffers(source_, 1, &buffers_[n]);
171 alSourcei(source_, AL_LOOPING, AL_FALSE);
173 alSourcePlay(source_);
177 std::future<bool> send(core::const_frame frame) override
179 // Will only block if the default executor queue capacity of 512 is
180 // exhausted, which should not happen
181 executor_.begin_invoke([=]
184 alGetSourcei(source_, AL_SOURCE_STATE,&state);
185 if(state != AL_PLAYING)
187 for(int n = 0; n < buffers_.size()-1; ++n)
190 alSourceUnqueueBuffers(source_, 1, &buffer);
193 std::vector<int16_t> audio(format_desc_.audio_cadence[n % format_desc_.audio_cadence.size()] * format_desc_.audio_channels, 0);
194 alBufferData(buffer, AL_FORMAT_STEREO16, audio.data(), static_cast<ALsizei>(audio.size()*sizeof(int16_t)), format_desc_.audio_sample_rate);
195 alSourceQueueBuffers(source_, 1, &buffer);
198 alSourcePlay(source_);
199 graph_->set_tag("late-frame");
202 auto audio = core::audio_32_to_16(frame.audio_data());
205 alSourceUnqueueBuffers(source_, 1, &buffer);
208 alBufferData(buffer, AL_FORMAT_STEREO16, audio.data(), static_cast<ALsizei>(audio.size()*sizeof(int16_t)), format_desc_.audio_sample_rate);
209 alSourceQueueBuffers(source_, 1, &buffer);
212 graph_->set_tag("dropped-frame");
214 graph_->set_value("tick-time", perf_timer_.elapsed()*format_desc_.fps*0.5);
215 perf_timer_.restart();
218 return make_ready_future(true);
221 std::wstring print() const override
223 return L"oal[" + boost::lexical_cast<std::wstring>(channel_index_) + L"|" + format_desc_.name + L"]";
226 std::wstring name() const override
228 return L"system-audio";
231 boost::property_tree::wptree info() const override
233 boost::property_tree::wptree info;
234 info.add(L"type", L"system-audio");
238 bool has_synchronization_clock() const override
243 int delay_millis() const
248 int buffer_depth() const override
250 int delay_in_frames = static_cast<int>(delay_millis() / (1000.0 / format_desc_.fps));
252 return delay_in_frames;
255 int index() const override
260 core::monitor::subject& monitor_output()
262 return monitor_subject_;
266 void describe_consumer(core::help_sink& sink, const core::help_repository& repo)
268 sink.short_description(L"A system audio consumer.");
269 sink.syntax(L"AUDIO");
270 sink.para()->text(L"Uses the system's default audio playback device.");
271 sink.para()->text(L"Examples:");
272 sink.example(L">> ADD 1 AUDIO");
275 spl::shared_ptr<core::frame_consumer> create_consumer(const std::vector<std::wstring>& params, core::interaction_sink*)
277 if(params.size() < 1 || !boost::iequals(params.at(0), L"AUDIO"))
278 return core::frame_consumer::empty();
280 return spl::make_shared<oal_consumer>();
283 spl::shared_ptr<core::frame_consumer> create_preconfigured_consumer(const boost::property_tree::wptree&, core::interaction_sink*)
285 return spl::make_shared<oal_consumer>();