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