1 /*****************************************************************************
2 * audiounit_ios.c: AudioUnit output plugin for iOS
3 *****************************************************************************
4 * Copyright (C) 2012 - 2013 VLC authors and VideoLAN
7 * Authors: Felix Paul Kühne <fkuehne 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 *****************************************************************************/
30 #import <vlc_common.h>
31 #import <vlc_plugin.h>
34 #import <AudioUnit/AudioUnit.h>
35 #import <CoreAudio/CoreAudioTypes.h>
36 #import <AudioToolbox/AudioToolbox.h>
37 #import <mach/mach_time.h>
39 #import "TPCircularBuffer.h"
42 #pragma mark private declarations
44 #define STREAM_FORMAT_MSG(pre, sfm) \
45 pre "[%f][%4.4s][%u][%u][%u][%u][%u][%u]", \
46 sfm.mSampleRate, (char *)&sfm.mFormatID, \
47 (unsigned int)sfm.mFormatFlags, (unsigned int)sfm.mBytesPerPacket, \
48 (unsigned int)sfm.mFramesPerPacket, (unsigned int)sfm.mBytesPerFrame, \
49 (unsigned int)sfm.mChannelsPerFrame, (unsigned int)sfm.mBitsPerChannel
51 #define AUDIO_BUFFER_SIZE_IN_SECONDS (AOUT_MAX_ADVANCE_TIME / CLOCK_FREQ)
53 /*****************************************************************************
54 * aout_sys_t: private audio output method descriptor
55 *****************************************************************************
56 * This structure is part of the audio output thread descriptor.
57 * It describes the CoreAudio specific properties of an output thread.
58 *****************************************************************************/
61 TPCircularBuffer circular_buffer; /* circular buffer to swap the audio data */
64 AudioComponent au_component; /* The AudioComponent we use */
65 AudioUnit au_unit; /* The AudioUnit we use */
67 int i_rate; /* media sample rate */
68 int i_bytes_per_sample;
77 #pragma mark local prototypes & module descriptor
79 static int Open (vlc_object_t *);
80 static void Close (vlc_object_t *);
81 static int Start (audio_output_t *, audio_sample_format_t *);
82 static int StartAnalog (audio_output_t *, audio_sample_format_t *);
83 static void Stop (audio_output_t *);
85 static void Play (audio_output_t *, block_t *);
86 static void Pause (audio_output_t *, bool, mtime_t);
87 static void Flush (audio_output_t *, bool);
88 static int TimeGet (audio_output_t *, mtime_t *);
89 static OSStatus RenderCallback (vlc_object_t *, AudioUnitRenderActionFlags *, const AudioTimeStamp *,
90 UInt32 , UInt32, AudioBufferList *);
93 set_shortname("audiounit_ios")
94 set_description(N_("AudioUnit output for iOS"))
95 set_capability("audio output", 101)
96 set_category(CAT_AUDIO)
97 set_subcategory(SUBCAT_AUDIO_AOUT)
98 set_callbacks(Open, Close)
102 #pragma mark initialization
104 static int Open(vlc_object_t *obj)
106 audio_output_t *aout = (audio_output_t *)obj;
107 aout_sys_t *sys = malloc(sizeof (*sys));
109 if (unlikely(sys == NULL))
112 vlc_mutex_init(&sys->lock);
113 vlc_cond_init(&sys->cond);
114 sys->b_paused = false;
123 static void Close(vlc_object_t *obj)
125 audio_output_t *aout = (audio_output_t *)obj;
126 aout_sys_t *sys = aout->sys;
128 vlc_mutex_destroy(&sys->lock);
129 vlc_cond_destroy(&sys->cond);
134 static int Start(audio_output_t *p_aout, audio_sample_format_t *restrict fmt)
136 struct aout_sys_t *p_sys = NULL;
139 p_sys->au_component = NULL;
140 p_sys->au_unit = NULL;
141 p_sys->i_bytes_per_sample = 0;
143 aout_FormatPrint(p_aout, "VLC is looking for:", fmt);
145 if (StartAnalog(p_aout, fmt)) {
146 msg_Dbg(p_aout, "analog AudioUnit output successfully opened");
148 p_aout->flush = Flush;
149 p_aout->time_get = TimeGet;
150 p_aout->pause = Pause;
154 /* If we reach this, this aout has failed */
155 msg_Err(p_aout, "opening AudioUnit output failed");
160 * StartAnalog: open and setup a HAL AudioUnit to do PCM audio output
162 static int StartAnalog(audio_output_t *p_aout, audio_sample_format_t *fmt)
164 struct aout_sys_t *p_sys = p_aout->sys;
165 UInt32 i_param_size = 0;
166 AudioComponentDescription desc;
167 AURenderCallbackStruct callback;
170 /* Lets go find our Component */
171 desc.componentType = kAudioUnitType_Output;
172 desc.componentSubType = kAudioUnitSubType_RemoteIO;
173 desc.componentManufacturer = kAudioUnitManufacturer_Apple;
174 desc.componentFlags = 0;
175 desc.componentFlagsMask = 0;
177 p_sys->au_component = AudioComponentFindNext(NULL, &desc);
178 if (p_sys->au_component == NULL) {
179 msg_Warn(p_aout, "we cannot find our audio component");
183 status = AudioComponentInstanceNew(p_sys->au_component, &p_sys->au_unit);
184 if (status != noErr) {
185 msg_Warn(p_aout, "we cannot open our audio component (%li)", status);
190 status = AudioUnitSetProperty(p_sys->au_unit,
191 kAudioOutputUnitProperty_EnableIO,
192 kAudioUnitScope_Output,
197 msg_Warn(p_aout, "failed to set IO mode (%li)", status);
199 /* Get the current format */
200 AudioStreamBasicDescription streamDescription;
201 streamDescription.mSampleRate = fmt->i_rate;
202 fmt->i_format = VLC_CODEC_FL32;
203 fmt->i_physical_channels = AOUT_CHANS_STEREO;
204 streamDescription.mFormatID = kAudioFormatLinearPCM;
205 streamDescription.mFormatFlags = kAudioFormatFlagsNativeFloatPacked; // FL32
206 streamDescription.mChannelsPerFrame = aout_FormatNbChannels(fmt);
207 streamDescription.mFramesPerPacket = 1;
208 streamDescription.mBitsPerChannel = 32;
209 streamDescription.mBytesPerFrame = streamDescription.mBitsPerChannel * streamDescription.mChannelsPerFrame / 8;
210 streamDescription.mBytesPerPacket = streamDescription.mBytesPerFrame * streamDescription.mFramesPerPacket;
211 i_param_size = sizeof(streamDescription);
212 p_sys->i_rate = fmt->i_rate;
214 /* Set the desired format */
215 i_param_size = sizeof(AudioStreamBasicDescription);
216 status = AudioUnitSetProperty(p_sys->au_unit,
217 kAudioUnitProperty_StreamFormat,
218 kAudioUnitScope_Input,
222 if (status != noErr) {
223 msg_Err(p_aout, "failed to set stream format (%li)", status);
226 msg_Dbg(p_aout, STREAM_FORMAT_MSG("we set the AU format: " , streamDescription));
228 /* Retrieve actual format */
229 status = AudioUnitGetProperty(p_sys->au_unit,
230 kAudioUnitProperty_StreamFormat,
231 kAudioUnitScope_Input,
236 msg_Warn(p_aout, "failed to verify stream format (%li)", status);
237 msg_Dbg(p_aout, STREAM_FORMAT_MSG("the actual set AU format is " , streamDescription));
239 /* Do the last VLC aout setups */
240 aout_FormatPrepare(fmt);
242 /* set the IOproc callback */
243 callback.inputProc = (AURenderCallback) RenderCallback;
244 callback.inputProcRefCon = p_aout;
246 status = AudioUnitSetProperty(p_sys->au_unit,
247 kAudioUnitProperty_SetRenderCallback,
248 kAudioUnitScope_Input,
249 0, &callback, sizeof(callback));
250 if (status != noErr) {
251 msg_Err(p_aout, "render callback setup failed (%li)", status);
256 status = AudioUnitInitialize(p_sys->au_unit);
257 if (status != noErr) {
258 msg_Err(p_aout, "failed to init AudioUnit (%li)", status);
262 /* setup circular buffer */
263 TPCircularBufferInit(&p_sys->circular_buffer, AUDIO_BUFFER_SIZE_IN_SECONDS * fmt->i_rate * fmt->i_bytes_per_frame);
265 /* start audio session so playback continues if mute switch is on */
266 AudioSessionInitialize (NULL,
267 kCFRunLoopCommonModes,
271 /* Set audio session to mediaplayback */
272 UInt32 sessionCategory = kAudioSessionCategory_MediaPlayback;
273 AudioSessionSetProperty(kAudioSessionProperty_AudioCategory, sizeof(sessionCategory),&sessionCategory);
274 AudioSessionSetActive(true);
276 status = AudioOutputUnitStart(p_sys->au_unit);
277 msg_Dbg(p_aout, "audio output unit started: %li", status);
282 static void Stop(audio_output_t *p_aout)
284 struct aout_sys_t *p_sys = p_aout->sys;
287 AudioSessionSetActive(false);
289 if (p_sys->au_unit) {
290 status = AudioOutputUnitStop(p_sys->au_unit);
292 msg_Warn(p_aout, "failed to stop AudioUnit (%li)", status);
294 status = AudioComponentInstanceDispose(p_sys->au_unit);
296 msg_Warn(p_aout, "failed to dispose Audio Component instance (%li)", status);
298 p_sys->i_bytes_per_sample = 0;
300 /* clean-up circular buffer */
301 TPCircularBufferCleanup(&p_sys->circular_buffer);
305 #pragma mark actual playback
307 static void Play (audio_output_t * p_aout, block_t * p_block)
309 struct aout_sys_t *p_sys = p_aout->sys;
311 if (p_block->i_nb_samples > 0) {
312 /* move data to buffer */
313 if (unlikely(!TPCircularBufferProduceBytes(&p_sys->circular_buffer, p_block->p_buffer, p_block->i_buffer)))
314 msg_Warn(p_aout, "Audio buffer was dropped");
316 if (!p_sys->i_bytes_per_sample)
317 p_sys->i_bytes_per_sample = p_block->i_buffer / p_block->i_nb_samples;
320 block_Release(p_block);
323 static void Pause (audio_output_t *p_aout, bool pause, mtime_t date)
325 struct aout_sys_t * p_sys = p_aout->sys;
328 vlc_mutex_lock(&p_sys->lock);
329 p_sys->b_paused = pause;
330 vlc_mutex_unlock(&p_sys->lock);
332 /* we need to start / stop the audio unit here because otherwise
333 * the OS won't believe us that we stopped the audio output
334 * so in case of an interruption, our unit would be permanently
336 * in case of multi-tasking, the multi-tasking view would still
337 * show a playing state despite we are paused, same for lock screen */
339 AudioOutputUnitStop(p_sys->au_unit);
340 AudioSessionSetActive(false);
342 AudioOutputUnitStart(p_sys->au_unit);
343 UInt32 sessionCategory = kAudioSessionCategory_MediaPlayback;
344 AudioSessionSetProperty(kAudioSessionProperty_AudioCategory, sizeof(sessionCategory),&sessionCategory);
345 AudioSessionSetActive(true);
349 static void Flush(audio_output_t *p_aout, bool wait)
351 struct aout_sys_t *p_sys = p_aout->sys;
353 int32_t availableBytes;
354 vlc_mutex_lock(&p_sys->lock);
355 TPCircularBufferTail(&p_sys->circular_buffer, &availableBytes);
358 while (availableBytes > 0) {
359 vlc_cond_wait(&p_sys->cond, &p_sys->lock);
360 TPCircularBufferTail(&p_sys->circular_buffer, &availableBytes);
363 /* flush circular buffer if data is left */
364 if (availableBytes > 0)
365 TPCircularBufferClear(&p_aout->sys->circular_buffer);
368 vlc_mutex_unlock(&p_sys->lock);
371 static int TimeGet(audio_output_t *p_aout, mtime_t *delay)
373 struct aout_sys_t * p_sys = p_aout->sys;
375 if (!p_sys->i_bytes_per_sample)
378 int32_t availableBytes;
379 TPCircularBufferTail(&p_sys->circular_buffer, &availableBytes);
381 *delay = (availableBytes / p_sys->i_bytes_per_sample) * CLOCK_FREQ / p_sys->i_rate;
386 /*****************************************************************************
387 * RenderCallback: This function is called everytime the AudioUnit wants
388 * us to provide some more audio data.
389 * Don't print anything during normal playback, calling blocking function from
390 * this callback is not allowed.
391 *****************************************************************************/
392 static OSStatus RenderCallback(vlc_object_t *p_obj,
393 AudioUnitRenderActionFlags *ioActionFlags,
394 const AudioTimeStamp *inTimeStamp,
396 UInt32 inNumberFrames,
397 AudioBufferList *ioData) {
398 VLC_UNUSED(ioActionFlags);
399 VLC_UNUSED(inTimeStamp);
400 VLC_UNUSED(inBusNumber);
401 VLC_UNUSED(inNumberFrames);
403 audio_output_t * p_aout = (audio_output_t *)p_obj;
404 struct aout_sys_t * p_sys = p_aout->sys;
406 int bytesRequested = ioData->mBuffers[0].mDataByteSize;
407 Float32 *targetBuffer = (Float32*)ioData->mBuffers[0].mData;
409 vlc_mutex_lock(&p_sys->lock);
410 /* Pull audio from buffer */
411 int32_t availableBytes;
412 Float32 *buffer = TPCircularBufferTail(&p_sys->circular_buffer, &availableBytes);
414 /* check if we have enough data */
415 if (!availableBytes || p_sys->b_paused) {
416 /* return an empty buffer so silence is played until we have data */
417 memset(targetBuffer, 0, ioData->mBuffers[0].mDataByteSize);
419 int32_t bytesToCopy = __MIN(bytesRequested, availableBytes);
421 if (likely(bytesToCopy > 0)) {
422 memcpy(targetBuffer, buffer, bytesToCopy);
423 TPCircularBufferConsume(&p_sys->circular_buffer, bytesToCopy);
424 ioData->mBuffers[0].mDataByteSize = bytesToCopy;
428 vlc_cond_signal(&p_sys->cond);
429 vlc_mutex_unlock(&p_sys->lock);