]> git.sesse.net Git - casparcg/blob - modules/oal/consumer/oal_consumer.cpp
Fixed bug with monitor subject lifetime
[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         monitor::subject                                                                        monitor_subject_;
108
109         spl::shared_ptr<diagnostics::graph>                                     graph_;
110         boost::timer                                                                            perf_timer_;
111         int                                                                                                     channel_index_;
112         
113         core::video_format_desc                                                         format_desc_;
114
115         ALuint                                                                                          source_;
116         std::array<ALuint, 3>                                                           buffers_;
117
118         executor                                                                                        executor_;
119
120 public:
121         oal_consumer() 
122                 : channel_index_(-1)
123                 , source_(0)
124                 , executor_(L"oal_consumer")
125         {
126                 buffers_.assign(0);
127
128                 init_device();
129
130                 graph_->set_color("tick-time", diagnostics::color(0.0f, 0.6f, 0.9f));   
131                 graph_->set_color("dropped-frame", diagnostics::color(0.3f, 0.6f, 0.3f));
132                 graph_->set_color("late-frame", diagnostics::color(0.6f, 0.3f, 0.3f));
133                 diagnostics::register_graph(graph_);
134         }
135
136         ~oal_consumer()
137         {
138                 executor_.begin_invoke([=]
139                 {               
140                         if(source_)
141                         {
142                                 alSourceStop(source_);
143                                 alDeleteSources(1, &source_);
144                         }
145
146                         BOOST_FOREACH(auto& buffer, buffers_)
147                         {
148                                 if(buffer)
149                                         alDeleteBuffers(1, &buffer);
150                         };
151                 });
152         }
153
154         // frame consumer
155
156         void initialize(const core::video_format_desc& format_desc, int channel_index) override
157         {
158                 format_desc_    = format_desc;          
159                 channel_index_  = channel_index;
160                 graph_->set_text(print());
161                 
162                 executor_.begin_invoke([=]
163                 {               
164                         alGenBuffers(static_cast<ALsizei>(buffers_.size()), buffers_.data());
165                         alGenSources(1, &source_);
166
167                         for(std::size_t n = 0; n < buffers_.size(); ++n)
168                         {
169                                 std::vector<int16_t> audio(format_desc_.audio_cadence[n % format_desc_.audio_cadence.size()]*format_desc_.audio_channels, 0);
170                                 alBufferData(buffers_[n], AL_FORMAT_STEREO16, audio.data(), static_cast<ALsizei>(audio.size()*sizeof(int16_t)), format_desc_.audio_sample_rate);
171                                 alSourceQueueBuffers(source_, 1, &buffers_[n]);
172                         }
173                         
174                         alSourcei(source_, AL_LOOPING, AL_FALSE);
175
176                         alSourcePlay(source_);  
177                 });
178         }
179         
180         boost::unique_future<bool> send(core::const_frame frame) override
181         {
182                 // Will only block if the default executor queue capacity of 512 is
183                 // exhausted, which should not happen
184                 executor_.begin_invoke([=]
185                 {
186                         ALenum state; 
187                         alGetSourcei(source_, AL_SOURCE_STATE,&state);
188                         if(state != AL_PLAYING)
189                         {
190                                 for(int n = 0; n < buffers_.size()-1; ++n)
191                                 {                                       
192                                         ALuint buffer = 0;  
193                                         alSourceUnqueueBuffers(source_, 1, &buffer);
194                                         if(buffer)
195                                         {
196                                                 std::vector<int16_t> audio(format_desc_.audio_cadence[n % format_desc_.audio_cadence.size()] * format_desc_.audio_channels, 0);
197                                                 alBufferData(buffer, AL_FORMAT_STEREO16, audio.data(), static_cast<ALsizei>(audio.size()*sizeof(int16_t)), format_desc_.audio_sample_rate);
198                                                 alSourceQueueBuffers(source_, 1, &buffer);
199                                         }
200                                 }
201                                 alSourcePlay(source_);          
202                                 graph_->set_tag("late-frame");  
203                         }
204
205                         auto audio = core::audio_32_to_16(frame.audio_data());
206                         
207                         ALuint buffer = 0;  
208                         alSourceUnqueueBuffers(source_, 1, &buffer);
209                         if(buffer)
210                         {
211                                 alBufferData(buffer, AL_FORMAT_STEREO16, audio.data(), static_cast<ALsizei>(audio.size()*sizeof(int16_t)), format_desc_.audio_sample_rate);
212                                 alSourceQueueBuffers(source_, 1, &buffer);
213                         }
214                         else
215                                 graph_->set_tag("dropped-frame");
216
217                         graph_->set_value("tick-time", perf_timer_.elapsed()*format_desc_.fps*0.5);             
218                         perf_timer_.restart();
219                 });
220
221                 return wrap_as_future(true);
222         }
223         
224         std::wstring print() const override
225         {
226                 return L"oal[" + boost::lexical_cast<std::wstring>(channel_index_) + L"|" + format_desc_.name + L"]";
227         }
228
229         std::wstring name() const override
230         {
231                 return L"system-audio";
232         }
233
234         boost::property_tree::wptree info() const override
235         {
236                 boost::property_tree::wptree info;
237                 info.add(L"type", L"system-audio");
238                 return info;
239         }
240         
241         bool has_synchronization_clock() const override
242         {
243                 return false;
244         }
245
246         int delay_millis() const
247         {
248                 return 60;
249         }
250         
251         int buffer_depth() const override
252         {
253                 int delay_in_frames = static_cast<int>(delay_millis() / (1000.0 / format_desc_.fps));
254                 
255                 return delay_in_frames;
256         }
257                 
258         int index() const override
259         {
260                 return 500;
261         }
262
263         monitor::source& monitor_output()
264         {
265                 return monitor_subject_;
266         }
267 };
268
269 spl::shared_ptr<core::frame_consumer> create_consumer(const std::vector<std::wstring>& params)
270 {
271         if(params.size() < 1 || params[0] != L"AUDIO")
272                 return core::frame_consumer::empty();
273
274         return spl::make_shared<oal_consumer>();
275 }
276
277 spl::shared_ptr<core::frame_consumer> create_consumer()
278 {
279         return spl::make_shared<oal_consumer>();
280 }
281
282 }}