1 /*****************************************************************************
2 * Copyright (C) 2000-2013 VLC authors and VideoLAN
5 * Authors: Felix Paul Kühne <fkuehne at videolan dot org>
7 * Rafaël Carré <funman at videolan dot org>
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU Lesser General Public License as published by
11 * the Free Software Foundation; either version 2.1 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public License
20 * along with this program; if not, write to the Free Software Foundation,
21 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
29 #import <vlc_common.h>
30 #import <vlc_plugin.h>
32 #import <AudioToolbox/AudioQueue.h>
33 #import <TargetConditionals.h>
35 #import <AudioToolbox/AudioSession.h>
37 #define AudioSessionSetActive(x)
41 #pragma mark private declarations
45 AudioQueueRef audioQueueRef;
46 AudioQueueTimelineRef timelineRef;
50 mtime_t i_played_length;
54 static int Open (vlc_object_t *);
55 static void Close (vlc_object_t *);
56 static void Play (audio_output_t *, block_t *);
57 static void Pause (audio_output_t *p_aout, bool pause, mtime_t date);
58 static void Flush (audio_output_t *p_aout, bool wait);
59 static int TimeGet (audio_output_t *aout, mtime_t *);
60 static void UnusedAudioQueueCallback (void *, AudioQueueRef, AudioQueueBufferRef);
61 static int Start(audio_output_t *, audio_sample_format_t *);
62 static void Stop(audio_output_t *);
63 static int VolumeSet(audio_output_t *, float );
65 set_shortname("AudioQueue")
66 set_description(N_("AudioQueue (iOS / Mac OS) audio output"))
67 set_capability("audio output", 40)
68 set_category(CAT_AUDIO)
69 set_subcategory(SUBCAT_AUDIO_AOUT)
70 add_shortcut("audioqueue")
71 set_callbacks(Open, Close)
75 #pragma mark initialization
77 static int Open(vlc_object_t *obj)
79 audio_output_t *aout = (audio_output_t *)obj;
80 aout_sys_t *sys = malloc(sizeof (*sys));
82 if (unlikely(sys == NULL))
88 aout->volume_set = VolumeSet;
91 aout_VolumeReport(aout, 1.0);
96 static void Close(vlc_object_t *obj)
98 audio_output_t *aout = (audio_output_t *)obj;
99 msg_Dbg( aout, "audioqueue: Close");
100 aout_sys_t *sys = aout->sys;
105 static int VolumeSet(audio_output_t * p_aout, float volume)
107 struct aout_sys_t *p_sys = p_aout->sys;
110 aout_VolumeReport(p_aout, volume);
111 p_sys->f_volume = volume;
113 /* Set volume for output unit */
114 ostatus = AudioQueueSetParameter(p_sys->audioQueueRef, kAudioQueueParam_Volume, volume * volume * volume);
119 static int Start(audio_output_t *p_aout, audio_sample_format_t *restrict fmt)
121 aout_sys_t *p_sys = p_aout->sys;
124 // prepare the format description for our output
125 AudioStreamBasicDescription streamDescription;
126 streamDescription.mSampleRate = fmt->i_rate;
127 streamDescription.mFormatID = kAudioFormatLinearPCM;
128 streamDescription.mFormatFlags = kAudioFormatFlagsNativeFloatPacked; // FL32
129 streamDescription.mFramesPerPacket = 1;
130 streamDescription.mChannelsPerFrame = 2;
131 streamDescription.mBitsPerChannel = 32;
132 streamDescription.mBytesPerFrame = streamDescription.mBitsPerChannel * streamDescription.mChannelsPerFrame / 8;
133 streamDescription.mBytesPerPacket = streamDescription.mBytesPerFrame * streamDescription.mFramesPerPacket;
135 // init new output instance
136 error = AudioQueueNewOutput(&streamDescription, // Format
137 UnusedAudioQueueCallback, // Unused Callback, which needs to be provided to have a proper instance
138 NULL, // User data, passed to the callback
140 kCFRunLoopCommonModes, // RunLoop mode
141 0, // Flags ; must be zero (per documentation)...
142 &(p_sys->audioQueueRef)); // Output
143 msg_Dbg(p_aout, "New AudioQueue instance created (status = %li)", error);
146 fmt->i_format = VLC_CODEC_FL32;
147 fmt->i_physical_channels = AOUT_CHANS_STEREO;
148 aout_FormatPrepare(fmt);
149 p_aout->sys->i_rate = fmt->i_rate;
152 error = AudioQueueStart(p_sys->audioQueueRef, NULL);
153 msg_Dbg(p_aout, "Starting AudioQueue (status = %li)", error);
155 // start timeline for synchro
156 error = AudioQueueCreateTimeline(p_sys->audioQueueRef, &p_sys->timelineRef);
157 msg_Dbg(p_aout, "AudioQueue Timeline started (status = %li)", error);
162 // start audio session so playback continues if mute switch is on
163 AudioSessionInitialize (NULL,
164 kCFRunLoopCommonModes,
168 // Set audio session to mediaplayback
169 UInt32 sessionCategory = kAudioSessionCategory_MediaPlayback;
170 AudioSessionSetProperty(kAudioSessionProperty_AudioCategory, sizeof(sessionCategory),&sessionCategory);
171 AudioSessionSetActive(true);
174 p_aout->sys->b_started = true;
176 p_aout->time_get = TimeGet;
178 p_aout->pause = Pause;
179 p_aout->flush = Flush;
183 static void Stop(audio_output_t *p_aout)
185 AudioSessionSetActive(false);
187 p_aout->sys->i_played_length = 0;
188 AudioQueueDisposeTimeline(p_aout->sys->audioQueueRef, p_aout->sys->timelineRef);
189 AudioQueueStop(p_aout->sys->audioQueueRef, true);
190 AudioQueueDispose(p_aout->sys->audioQueueRef, true);
191 msg_Dbg(p_aout, "audioqueue stopped and disposed");
195 #pragma mark actual playback
197 static void Play(audio_output_t *p_aout, block_t *p_block)
199 AudioQueueBufferRef inBuffer = NULL;
202 status = AudioQueueAllocateBuffer(p_aout->sys->audioQueueRef, p_block->i_buffer, &inBuffer);
203 if (status == noErr) {
204 memcpy(inBuffer->mAudioData, p_block->p_buffer, p_block->i_buffer);
205 inBuffer->mAudioDataByteSize = p_block->i_buffer;
207 status = AudioQueueEnqueueBuffer(p_aout->sys->audioQueueRef, inBuffer, 0, NULL);
209 p_aout->sys->i_played_length += p_block->i_length;
211 msg_Err(p_aout, "enqueuing buffer failed (%li)", status);
213 msg_Err(p_aout, "buffer alloction failed (%li)", status);
215 block_Release(p_block);
218 void UnusedAudioQueueCallback(void * inUserData, AudioQueueRef inAQ, AudioQueueBufferRef inBuffer) {
219 /* this function does nothing, but needs to be here to make the AudioQueue API happy.
220 * additionally, we clean-up after empty buffers */
221 VLC_UNUSED(inUserData);
222 AudioQueueFreeBuffer(inAQ, inBuffer);
225 static void Pause(audio_output_t *p_aout, bool pause, mtime_t date)
230 AudioQueuePause(p_aout->sys->audioQueueRef);
231 AudioSessionSetActive(false);
233 AudioQueueStart(p_aout->sys->audioQueueRef, NULL);
234 AudioSessionSetActive(true);
238 static void Flush(audio_output_t *p_aout, bool wait)
240 if (!p_aout->sys->audioQueueRef)
243 AudioQueueDisposeTimeline(p_aout->sys->audioQueueRef, p_aout->sys->timelineRef);
246 AudioQueueStop(p_aout->sys->audioQueueRef, false);
248 AudioQueueStop(p_aout->sys->audioQueueRef, true);
250 p_aout->sys->b_started = false;
251 p_aout->sys->i_played_length = 0;
252 AudioQueueStart(p_aout->sys->audioQueueRef, NULL);
253 AudioQueueCreateTimeline(p_aout->sys->audioQueueRef, &p_aout->sys->timelineRef);
254 p_aout->sys->b_started = true;
257 static int TimeGet(audio_output_t *p_aout, mtime_t *restrict delay)
259 AudioTimeStamp outTimeStamp;
260 Boolean b_discontinuity;
261 OSStatus status = AudioQueueGetCurrentTime(p_aout->sys->audioQueueRef, p_aout->sys->timelineRef, &outTimeStamp, &b_discontinuity);
266 bool b_started = p_aout->sys->b_started;
271 if (b_discontinuity) {
272 msg_Dbg(p_aout, "detected output discontinuity");
276 mtime_t i_pos = (mtime_t) outTimeStamp.mSampleTime * CLOCK_FREQ / p_aout->sys->i_rate;
278 *delay = p_aout->sys->i_played_length - i_pos;