git.sesse.net Git - vlc/blob - modules/audio_output/sndio.c

   1 /*****************************************************************************
   2  * sndio.c : sndio plugin for VLC
   3  *****************************************************************************
   4  * Copyright (C) 2012 Rémi Denis-Courmont
   5  *
   6  * This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU Lesser General Public License as published by
   8  * the Free Software Foundation; either version 2.1 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program 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 Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public License
  17  * along with this program; if not, write to the Free Software Foundation,
  18  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  19  *****************************************************************************/
  20
  21 #ifdef HAVE_CONFIG_H
  22 # include "config.h"
  23 #endif
  24
  25 #include <math.h>
  26 #include <assert.h>
  27
  28 #include <vlc_common.h>
  29 #include <vlc_plugin.h>
  30 #include <vlc_aout.h>
  31
  32 #include <sndio.h>
  33
  34 static int Open (vlc_object_t *);
  35 static void Close (vlc_objec_t *);
  36
  37 vlc_module_begin ()
  38     set_shortname ("sndio")
  39     set_description (N_("OpenBSD sndio audio output"))
  40     set_category (CAT_AUDIO)
  41     set_subcategory (SUBCAT_AUDIO_AOUT)
  42     set_capability ("audio output", 120)
  43     set_callbacks (Open, Close)
  44 vlc_module_end ()
  45
  46 static int TimeGet (audio_output, mtime_t *);
  47 static void Play (audio_output_t *, block_t *);
  48 static void Flush (audio_output_t *, bool);
  49 static int VolumeSet (audio_output_t *, float);
  50 static int MuteSet (audio_output_t *, bool);
  51 static void VolumeChanged (void *, unsigned);
  52 static void PositionChanged (void *, int);
  53
  54 struct aout_sys_t
  55 {
  56     struct sio_hdl *hdl;
  57     unsigned long long read_offset;
  58     unsigned long long write_offset;
  59     unsigned rate;
  60     unsigned volume;
  61     bool mute;
  62 };
  63
  64 /** Initializes an sndio playback stream */
  65 static int Start (audio_output_t *aout, audio_sample_format_t *restrict fmt)
  66 {
  67     aout_sys_t *sys = aout->sys;
  68
  69     sys->hdl = sio_open (NULL, SIO_PLAY, 0 /* blocking */);
  70     if (sys->hdl == NULL)
  71     {
  72         msg_Err (obj, "cannot create audio playback stream");
  73         free (sys);
  74         return VLC_EGENERIC;
  75     }
  76     aout->sys = sys;
  77
  78     struct sio_par par;
  79     sio_initpar (&par);
  80     par.bits = 16;
  81     par.bps = par.bits >> 3;
  82     par.sig = 1;
  83     par.le = SIO_LE_NATIVE;
  84     par.pchan = aout_FormatNbChannels (fmt);
  85     par.rate = fmt->i_rate;
  86     par.xrun = SIO_SYNC;
  87
  88     if (!sio_setpar (sys->hdl, &par) || !sio_getpar (sys->hdl, &par))
  89     {
  90         msg_Err (obj, "cannot negotiate audio playback parameters");
  91         goto error;
  92     }
  93
  94     if (par.bps != par.bits >> 3)
  95     {
  96         msg_Err (obj, "unsupported audio sample format (%u bits in %u bytes)",
  97                  par.bits, par.bps);
  98         goto error;
  99     }
 100     if (par.sig != (par.bits != 8))
 101     {
 102         msg_Err (obj, "unsupported audio sample format (%ssigned)",
 103                  par.sig ? "" : "un");
 104         goto error;
 105     }
 106 #ifdef WORDS_BIGENDIAN
 107     if (par.le)
 108     {
 109         msg_Err (obj, "unsupported audio sample format (little endian)");
 110         goto error;
 111     }
 112 #else
 113     if (!par.le)
 114     {
 115         msg_Err (obj, "unsupported audio sample format (big endian)");
 116         goto error;
 117     }
 118 #endif
 119     switch (par.bits)
 120     {
 121         case 8:
 122             fmt->i_format = VLC_CODEC_U8;
 123             break;
 124         case 16:
 125             fmt->i_format = VLC_CODEC_S16N;
 126             break;
 127         case 32:
 128             fmt->i_format = VLC_CODEC_S32N;
 129             break;
 130         default:
 131             msg_Err (obj, "unsupported audio sample format (%u bits)",
 132                      par.bits);
 133             goto error;
 134     }
 135
 136     fmt->i_rate = par.rate;
 137     sys->rate = par.rate;
 138
 139     /* Channel map */
 140     unsigned chans;
 141     switch (par.pchan)
 142     {
 143         case 1:
 144             chans = AOUT_CHAN_CENTER;
 145             break;
 146         case 2:
 147             chans = AOUT_CHANS_STEREO;
 148             break;
 149         case 4:
 150             chans = AOUT_CHANS_4_0;
 151             break;
 152         case 6:
 153             chans = AOUT_CHANS_5_1;
 154             break;
 155         case 8:
 156             chans = AOUT_CHANS_7_1;
 157             break;
 158         default:
 159             msg_Err (aout, "unknown %u channels map", par.pchan);
 160             goto error;
 161     }
 162
 163     fmt->i_original_channels = fmt->i_physical_channels = chans;
 164     aout_FormatPrepare (fmt);
 165
 166     aout->sys = sys;
 167     aout->time_get = TimeGet;
 168     aout->play = Play;
 169     aout->pause = NULL;
 170     aout->flush = Flush;
 171     if (sio_onvol(sys->hdl, VolumeChanged, aout))
 172     {
 173         aout->volume_set = VolumeSet;
 174         aout->mute_set = MuteSet;
 175     }
 176     else
 177     {
 178         aout->volume_set = NULL;
 179         aout->mute_set = NULL;
 180     }
 181
 182     sys->read_offset = 0;
 183     sys->write_offset = 0;
 184     sio_onmove (sys->hdl, PositionChanged, aout);
 185     sio_start (sys->hdl);
 186     return VLC_SUCCESS;
 187
 188 error:
 189     sio_close (sys->hdl);
 190     return VLC_EGENERIC;
 191 }
 192
 193 static void Close (vlc_object_t *obj)
 194 {
 195     audio_output_t *aout = (audio_output_t *)obj;
 196     aout_sys_t *sys = aout->sys;
 197
 198     sio_close (sys->hdl);
 199 }
 200
 201 static void PositionChanged (void *arg, int delta)
 202 {
 203     audio_output_t *aout = arg;
 204     aout_sys_t *sys = aout->sys;
 205
 206     sys->read_offset += delta;
 207 }
 208
 209 static int TimeGet (audio_output_t *aout, mtime_t *restrict delay)
 210 {
 211     aout_sys_t *sys = aout->sys;
 212     long long frames = sys->write_offset - sys->read_offset;
 213
 214     if (frames == 0)
 215         return -1;
 216
 217     *delay = frames * CLOCK_FREQ / sys->rate;
 218     return 0;
 219 }
 220
 221 static void Play (audio_output_t *aout, block_t *block)
 222 {
 223     aout_sys_t *sys = aout->sys;
 224
 225     sys->write_offset += block->i_nb_samples;
 226
 227     while (block->i_buffer > 0 && !sio_eof (sys->hdl))
 228     {
 229         size_t bytes = sio_write (sys->hdl, block->p_buffer, block->i_buffer);
 230
 231         block->p_buffer += bytes;
 232         block->i_buffer -= bytes;
 233         /* Note that i_nb_samples and i_pts are not updated here. */
 234     }
 235     block_Release (block);
 236 }
 237
 238 static void Flush (audio_output_t *aout, bool wait)
 239 {
 240     if (wait)
 241     {
 242         long long frames = sys->write_offset - sys->read_offset;
 243
 244         if (frames > 0)
 245             msleep (frames * CLOCK_FREQ / sys->rate);
 246     }
 247     else
 248     {
 249         sio_stop (sys->hdl);
 250         sys->read_offset = 0;
 251         sys->write_offset = 0;
 252         sio_start (sys->hdl);
 253     }
 254 }
 255
 256 static void VolumeChanged (void *arg, unsigned volume)
 257 {
 258     audio_output_t *aout = arg;
 259     float fvol = (float)volume / (float)SIO_MAXVOL;
 260
 261     aout_VolumeReport (aout, fvol);
 262     aout_MuteReport (aout, volume == 0);
 263     if (volume) /* remember last non-zero volume to unmute later */
 264         aout->sys->volume = volume;
 265 }
 266
 267 static int VolumeSet (audio_output_t *aout, float fvol)
 268 {
 269     aout_sys_t *sys = aout->sys;
 270     unsigned volume = lroundf (fvol * SIO_MAXVOL);
 271
 272     if (!sys->mute && !sio_setvol (sys->hdl, volume))
 273         return -1;
 274     sys->volume = volume;
 275     return 0;
 276 }
 277
 278 static int MuteSet (audio_output_t *aout, bool mute)
 279 {
 280     aout_sys_t *sys = aout->sys;
 281
 282     if (!sio_setvol (sys->hdl, mute ? 0 : sys->volume))
 283         return -1;
 284
 285     sys->mute = mute;
 286     return 0;
 287 }
 288
 289 static int Open (vlc_object_t *obj)
 290 {
 291     audio_output_t *aout = (audio_output_t *)obj;
 292     aout_sys_t *sys = malloc (sizeof (*sys));
 293     if (unlikely(sys == NULL))
 294         return VLC_ENOMEM;
 295
 296     aout->sys = sys;
 297     aout->start = Start;
 298     aout->stop = Stop;
 299     /* FIXME: set volume/mute here */
 300     return VLC_SUCCESS;
 301 }
 302
 303 static int Close (vlc_object_t *obj)
 304 {
 305     audio_output_t *aout = (audio_output_t *)obj;
 306     aout_sys_t *sys = aout->sys;
 307
 308     free (sys);
 309 }
 310