git.sesse.net Git - vlc/blob - 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           audioQueueRef;
  44     AudioQueueTimelineRef   timelineRef;
  45
  46     mtime_t                 i_played_length;
  47     int                     i_rate;
  48     float                   f_volume;
  49 };
  50
  51 static int  Open                     (vlc_object_t *);
  52 static void Close                    (vlc_object_t *);
  53 static void Play                     (audio_output_t *, block_t *);
  54 static void Pause                    (audio_output_t *p_aout, bool pause, mtime_t date);
  55 static void Flush                    (audio_output_t *p_aout, bool wait);
  56 static int  TimeGet                  (audio_output_t *aout, mtime_t *);
  57 static void UnusedAudioQueueCallback (void *, AudioQueueRef, AudioQueueBufferRef);
  58
  59 static int Start(audio_output_t *, audio_sample_format_t *);
  60 static void Stop(audio_output_t *);
  61 static int VolumeSet(audio_output_t *, float );
  62
  63 vlc_module_begin ()
  64 set_shortname("AudioQueue")
  65 set_description(N_("AudioQueue (iOS / Mac OS) audio output"))
  66 set_capability("audio output", 40)
  67 set_category(CAT_AUDIO)
  68 set_subcategory(SUBCAT_AUDIO_AOUT)
  69 add_shortcut("audioqueue")
  70 set_callbacks(Open, Close)
  71 vlc_module_end ()
  72
  73 #pragma mark -
  74 #pragma mark initialization
  75
  76 static int Open(vlc_object_t *obj)
  77 {
  78     audio_output_t *aout = (audio_output_t *)obj;
  79     aout_sys_t *sys = malloc(sizeof (*sys));
  80
  81     if (unlikely(sys == NULL))
  82         return VLC_ENOMEM;
  83
  84     aout->sys = sys;
  85     aout->start = Start;
  86     aout->stop = Stop;
  87     aout->volume_set = VolumeSet;
  88
  89     /* reset volume */
  90     aout_VolumeReport(aout, 1.0);
  91
  92     return VLC_SUCCESS;
  93 }
  94
  95 static void Close(vlc_object_t *obj)
  96 {
  97     audio_output_t *aout = (audio_output_t *)obj;
  98     msg_Dbg( aout, "audioqueue: Close");
  99     aout_sys_t *sys = aout->sys;
 100
 101     free(sys);
 102 }
 103
 104 static int VolumeSet(audio_output_t * p_aout, float volume)
 105 {
 106     struct aout_sys_t *p_sys = p_aout->sys;
 107     OSStatus ostatus;
 108
 109     aout_VolumeReport(p_aout, volume);
 110     p_sys->f_volume = volume;
 111
 112     /* Set volume for output unit */
 113     ostatus = AudioQueueSetParameter(p_sys->audioQueueRef, kAudioQueueParam_Volume, volume * volume * volume);
 114
 115     return ostatus;
 116 }
 117
 118 static int Start(audio_output_t *p_aout, audio_sample_format_t *restrict fmt)
 119 {
 120     aout_sys_t *p_sys = p_aout->sys;
 121     OSStatus error = 0;
 122
 123     // prepare the format description for our output
 124     AudioStreamBasicDescription streamDescription;
 125     streamDescription.mSampleRate = fmt->i_rate;
 126     streamDescription.mFormatID = kAudioFormatLinearPCM;
 127     streamDescription.mFormatFlags = kAudioFormatFlagsNativeFloatPacked; // FL32
 128     streamDescription.mFramesPerPacket = 1;
 129     streamDescription.mChannelsPerFrame = 2;
 130     streamDescription.mBitsPerChannel = 32;
 131     streamDescription.mBytesPerFrame = streamDescription.mBitsPerChannel * streamDescription.mChannelsPerFrame / 8;
 132     streamDescription.mBytesPerPacket = streamDescription.mBytesPerFrame * streamDescription.mFramesPerPacket;
 133
 134     // init new output instance
 135     error = AudioQueueNewOutput(&streamDescription,           // Format
 136                                  UnusedAudioQueueCallback,    // Unused Callback, which needs to be provided to have a proper instance
 137                                  NULL,                        // User data, passed to the callback
 138                                  NULL,                        // RunLoop
 139                                  kCFRunLoopCommonModes,       // RunLoop mode
 140                                  0,                           // Flags ; must be zero (per documentation)...
 141                                  &(p_sys->audioQueueRef));       // Output
 142
 143     msg_Dbg(p_aout, "New AudioQueue instance created (status = %li)", error);
 144     if (error != noErr)
 145         return VLC_EGENERIC;
 146
 147     fmt->i_format = VLC_CODEC_FL32;
 148     fmt->i_physical_channels = AOUT_CHANS_STEREO;
 149     aout_FormatPrepare(fmt);
 150
 151     p_aout->sys->i_rate = fmt->i_rate;
 152
 153     // start queue
 154     error = AudioQueueStart(p_sys->audioQueueRef, NULL);
 155     msg_Dbg(p_aout, "Starting AudioQueue (status = %li)", error);
 156
 157     // start timeline for synchro
 158     error = AudioQueueCreateTimeline(p_sys->audioQueueRef, &p_sys->timelineRef);
 159     msg_Dbg(p_aout, "AudioQueue Timeline started (status = %li)", error);
 160
 161     if (error != noErr)
 162         return VLC_EGENERIC;
 163
 164     p_aout->time_get = TimeGet;
 165     p_aout->play = Play;
 166     p_aout->pause = Pause;
 167     p_aout->flush = Flush;
 168
 169     return VLC_SUCCESS;
 170 }
 171
 172 static void Stop(audio_output_t *p_aout)
 173 {
 174     p_aout->sys->i_played_length = 0;
 175
 176     AudioQueueDisposeTimeline(p_aout->sys->audioQueueRef, p_aout->sys->timelineRef);
 177     AudioQueueStop(p_aout->sys->audioQueueRef, true);
 178     AudioQueueDispose(p_aout->sys->audioQueueRef, true);
 179
 180     msg_Dbg(p_aout, "audioqueue stopped and disposed");
 181 }
 182
 183 #pragma mark -
 184 #pragma mark actual playback
 185
 186 static void Play(audio_output_t *p_aout, block_t *p_block)
 187 {
 188     AudioQueueBufferRef inBuffer = NULL;
 189     OSStatus status;
 190
 191     status = AudioQueueAllocateBuffer(p_aout->sys->audioQueueRef, p_block->i_buffer, &inBuffer);
 192     if (status != noErr) {
 193         msg_Err(p_aout, "buffer alloction failed (%li)", status);
 194         return;
 195     }
 196
 197     memcpy(inBuffer->mAudioData, p_block->p_buffer, p_block->i_buffer);
 198     inBuffer->mAudioDataByteSize = p_block->i_buffer;
 199
 200     status = AudioQueueEnqueueBuffer(p_aout->sys->audioQueueRef, inBuffer, 0, NULL);
 201     if (status == noErr)
 202         p_aout->sys->i_played_length += p_block->i_length;
 203     else
 204         msg_Err(p_aout, "enqueuing buffer failed (%li)", status);
 205
 206     block_Release(p_block);
 207 }
 208
 209 void UnusedAudioQueueCallback(void * inUserData, AudioQueueRef inAQ, AudioQueueBufferRef inBuffer) {
 210     /* this function does nothing, but needs to be here to make the AudioQueue API happy.
 211      * without a callback, it will refuse to create an AudioQueue instance. */
 212     VLC_UNUSED(inUserData);
 213     VLC_UNUSED(inAQ);
 214     VLC_UNUSED(inBuffer);
 215 }
 216
 217 static void Pause(audio_output_t *p_aout, bool pause, mtime_t date)
 218 {
 219     VLC_UNUSED(date);
 220
 221     if (pause)
 222         AudioQueuePause(p_aout->sys->audioQueueRef);
 223     else
 224         AudioQueueStart(p_aout->sys->audioQueueRef, NULL);
 225 }
 226
 227 static void Flush(audio_output_t *p_aout, bool wait)
 228 {
 229     if (!p_aout->sys->audioQueueRef)
 230         return;
 231
 232     AudioQueueDisposeTimeline(p_aout->sys->audioQueueRef, p_aout->sys->timelineRef);
 233
 234     if (wait)
 235         AudioQueueStop(p_aout->sys->audioQueueRef, false);
 236     else
 237         AudioQueueStop(p_aout->sys->audioQueueRef, true);
 238
 239     p_aout->sys->i_played_length = 0;
 240     AudioQueueStart(p_aout->sys->audioQueueRef, NULL);
 241     AudioQueueCreateTimeline(p_aout->sys->audioQueueRef, &p_aout->sys->timelineRef);
 242 }
 243
 244 static int TimeGet(audio_output_t *p_aout, mtime_t *restrict delay)
 245 {
 246     AudioTimeStamp outTimeStamp;
 247     Boolean b_discontinuity;
 248     OSStatus status = AudioQueueGetCurrentTime(p_aout->sys->audioQueueRef, p_aout->sys->timelineRef, &outTimeStamp, &b_discontinuity);
 249
 250     if (status != noErr)
 251         return -1;
 252
 253     if (b_discontinuity)
 254         msg_Dbg(p_aout, "detected output discontinuity");
 255
 256     mtime_t i_pos = (mtime_t) outTimeStamp.mSampleTime * CLOCK_FREQ / p_aout->sys->i_rate;
 257     *delay = p_aout->sys->i_played_length - i_pos;
 258
 259     return 0;
 260 }