8f7f63df3df88947909522f2defaa8be24286a03
[vlc.git] / modules / audio_output / audioqueue.c
1 /*****************************************************************************
2  * audioqueue.c : AudioQueue audio output plugin for vlc
3  *****************************************************************************
4  * Copyright (C) 2000-2013 VLC authors and VideoLAN
5  * $Id$
6  *
7  * Authors: Romain Goyet <romain.goyet@likid.org>
8  *          Felix Paul Kühne <fkuehne at videolan dot org>
9  *          Rémi Denis-Courmont
10  *          Rafaël Carré <funman at videolan dot org>
11  *
12  * This program is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation; either version 2 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software
24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25  *****************************************************************************/
26
27 #pragma mark includes
28
29 #ifdef HAVE_CONFIG_H
30 # import "config.h"
31 #endif
32
33 #import <vlc_common.h>
34 #import <vlc_plugin.h>
35 #import <vlc_aout.h>
36 #import <AudioToolBox/AudioQueue.h>
37
38 #pragma mark -
39 #pragma mark private declarations
40
41 struct aout_sys_t
42 {
43     AudioQueueRef           audioQueue;
44     AudioQueueTimelineRef   outTimeline;
45
46     int                     i_rate;
47     mtime_t                 i_played_length;
48     bool                    b_stopped;
49     float                   f_volume;
50 };
51
52 static int  Open                     (vlc_object_t *);
53 static void Close                    (vlc_object_t *);
54 static void Play                     (audio_output_t *, block_t *);
55 static void Pause                    (audio_output_t *p_aout, bool pause, mtime_t date);
56 static void Flush                    (audio_output_t *p_aout, bool wait);
57 static int  TimeGet                  (audio_output_t *aout, mtime_t *);
58 static void UnusedAudioQueueCallback (void *, AudioQueueRef, AudioQueueBufferRef);
59
60 static int Start(audio_output_t *, audio_sample_format_t *);
61 static void Stop(audio_output_t *);
62 static int VolumeSet(audio_output_t *, float );
63
64 vlc_module_begin ()
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)
72 vlc_module_end ()
73
74 #pragma mark -
75 #pragma mark initialization
76
77 static int Open(vlc_object_t *obj)
78 {
79     audio_output_t *aout = (audio_output_t *)obj;
80     aout_sys_t *sys = malloc(sizeof (*sys));
81
82     if (unlikely(sys == NULL))
83         return VLC_ENOMEM;
84
85     aout->sys = sys;
86     aout->start = Start;
87     aout->stop = Stop;
88     aout->volume_set = VolumeSet;
89
90     /* reset volume */
91     aout_VolumeReport(aout, 1.0);
92
93     return VLC_SUCCESS;
94 }
95
96 static void Close(vlc_object_t *obj)
97 {
98     audio_output_t *aout = (audio_output_t *)obj;
99     msg_Dbg( aout, "audioqueue: Close");
100     aout_sys_t *sys = aout->sys;
101
102     free(sys);
103 }
104
105 static int VolumeSet(audio_output_t * p_aout, float volume)
106 {
107     struct aout_sys_t *p_sys = p_aout->sys;
108     OSStatus ostatus;
109
110     aout_VolumeReport(p_aout, volume);
111     p_sys->f_volume = volume;
112
113     /* Set volume for output unit */
114     ostatus = AudioQueueSetParameter(p_sys->audioQueue, kAudioQueueParam_Volume, volume * volume * volume);
115
116     return ostatus;
117 }
118
119 static int Start(audio_output_t *p_aout, audio_sample_format_t *restrict fmt)
120 {
121     aout_sys_t *p_sys = p_aout->sys;
122     OSStatus error = 0;
123
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;
134
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
139                                  NULL,                        // RunLoop
140                                  kCFRunLoopCommonModes,       // RunLoop mode
141                                  0,                           // Flags ; must be zero (per documentation)...
142                                  &(p_sys->audioQueue));       // Output
143
144     msg_Dbg(p_aout, "New AudioQueue output created (status = %li)", error);
145     if (error != noErr)
146         return VLC_EGENERIC;
147
148     fmt->i_format = VLC_CODEC_FL32;
149     fmt->i_physical_channels = AOUT_CHANS_STEREO;
150     aout_FormatPrepare(fmt);
151
152     p_aout->sys->b_stopped = false;
153     p_aout->sys->i_rate = fmt->i_rate;
154
155     // start queue
156     error = AudioQueueStart(p_sys->audioQueue, NULL);
157     msg_Dbg(p_aout, "Starting AudioQueue (status = %li)", error);
158
159     // start timeline for synchro
160     error = AudioQueueCreateTimeline(p_sys->audioQueue, &p_sys->outTimeline);
161     msg_Dbg(p_aout, "AudioQueue Timeline started (status = %li)", error);
162
163     if (error != noErr)
164         return VLC_EGENERIC;
165
166     p_aout->time_get = TimeGet;
167     p_aout->play = Play;
168     p_aout->pause = Pause;
169     p_aout->flush = Flush;
170
171     return VLC_SUCCESS;
172 }
173
174 static void Stop(audio_output_t *p_aout)
175 {
176     p_aout->sys->b_stopped = true;
177     p_aout->sys->i_played_length = 0;
178
179     AudioQueueDisposeTimeline(p_aout->sys->audioQueue, p_aout->sys->outTimeline);
180     AudioQueueStop(p_aout->sys->audioQueue, true);
181     AudioQueueDispose(p_aout->sys->audioQueue, true);
182
183     msg_Dbg(p_aout, "audioqueue stopped and disposed");
184 }
185
186 #pragma mark -
187 #pragma mark actual playback
188
189 static void Play(audio_output_t *p_aout, block_t *p_block)
190 {
191     AudioQueueBufferRef inBuffer = NULL;
192     OSStatus status;
193
194     status = AudioQueueAllocateBuffer(p_aout->sys->audioQueue, p_block->i_buffer, &inBuffer);
195     if (status != noErr) {
196         msg_Err(p_aout, "buffer alloction failed (%li)", status);
197         return;
198     }
199
200     memcpy(inBuffer->mAudioData, p_block->p_buffer, p_block->i_buffer);
201     inBuffer->mAudioDataByteSize = p_block->i_buffer;
202
203     status = AudioQueueEnqueueBuffer(p_aout->sys->audioQueue, inBuffer, 0, NULL);
204     if (status == noErr)
205         p_aout->sys->i_played_length += p_block->i_length;
206     else
207         msg_Err(p_aout, "enqueuing buffer failed (%li)", status);
208
209     block_Release(p_block);
210 }
211
212 void UnusedAudioQueueCallback(void * inUserData, AudioQueueRef inAQ, AudioQueueBufferRef inBuffer) {
213     /* this function does nothing, but needs to be here to make the AudioQueue API happy.
214      * without a callback, it will refuse to create an AudioQueue instance. */
215     VLC_UNUSED(inUserData);
216     VLC_UNUSED(inAQ);
217     VLC_UNUSED(inBuffer);
218 }
219
220 static void Pause(audio_output_t *p_aout, bool pause, mtime_t date)
221 {
222     VLC_UNUSED(date);
223
224     if (pause)
225         AudioQueuePause(p_aout->sys->audioQueue);
226     else
227         AudioQueueStart(p_aout->sys->audioQueue, NULL);
228 }
229
230 static void Flush(audio_output_t *p_aout, bool wait)
231 {
232     if (p_aout->sys->b_stopped || !p_aout->sys->audioQueue)
233         return;
234
235     AudioQueueDisposeTimeline(p_aout->sys->audioQueue, p_aout->sys->outTimeline);
236
237     if (wait)
238         AudioQueueStop(p_aout->sys->audioQueue, false);
239     else
240         AudioQueueStop(p_aout->sys->audioQueue, true);
241
242     p_aout->sys->i_played_length = 0;
243     AudioQueueStart(p_aout->sys->audioQueue, NULL);
244     AudioQueueCreateTimeline(p_aout->sys->audioQueue, &p_aout->sys->outTimeline);
245 }
246
247 static int TimeGet(audio_output_t *p_aout, mtime_t *restrict delay)
248 {
249     AudioTimeStamp outTimeStamp;
250     Boolean b_discontinuity;
251     OSStatus status = AudioQueueGetCurrentTime(p_aout->sys->audioQueue, p_aout->sys->outTimeline, &outTimeStamp, &b_discontinuity);
252
253     if (status != noErr)
254         return -1;
255
256     if (b_discontinuity)
257         msg_Dbg(p_aout, "detected output discontinuity");
258
259     mtime_t i_pos = (mtime_t) outTimeStamp.mSampleTime * CLOCK_FREQ / p_aout->sys->i_rate;
260     *delay = p_aout->sys->i_played_length - i_pos;
261
262     return 0;
263 }