oss: use software volume on non-FreeBSD targets (refs #11880)
[vlc.git] / modules / audio_output / oss.c
1 /*****************************************************************************
2  * oss.c: Open Sound System audio output plugin for VLC
3  *****************************************************************************
4  * Copyright (C) 2000-2002 VLC authors and VideoLAN
5  * Copyright (C) 2007-2012 RĂ©mi Denis-Courmont
6  *
7  * Authors: Michel Kaempf <maxx@via.ecp.fr>
8  *          Sam Hocevar <sam@zoy.org>
9  *          Christophe Massiot <massiot@via.ecp.fr>
10  *
11  * This program is free software; you can redistribute it and/or modify it
12  * under the terms of the GNU Lesser General Public License as published by
13  * the Free Software Foundation; either version 2.1 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19  * GNU Lesser General Public License for more details.
20  *
21  * You should have received a copy of the GNU Lesser General Public License
22  * along with this program; if not, write to the Free Software Foundation,
23  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24  *****************************************************************************/
25
26 #ifdef HAVE_CONFIG_H
27 # include "config.h"
28 #endif
29
30 #include <stdlib.h>
31 #include <math.h>
32 #include <errno.h>
33 #include <sys/types.h>
34 #include <fcntl.h>
35 #include <sys/ioctl.h>
36 #ifdef HAVE_SOUNDCARD_H
37 # include <soundcard.h>
38 #else
39 # include <sys/soundcard.h>
40 #endif
41
42 #ifndef SNDCTL_DSP_HALT
43 # define SNDCTL_DSP_HALT SNDCTL_DSP_RESET
44 #endif
45
46 #include <vlc_common.h>
47 #include <vlc_plugin.h>
48 #include <vlc_fs.h>
49 #include <vlc_cpu.h>
50 #include <vlc_aout.h>
51
52 #if !defined (__FreeBSD__) && !defined (__FreeBSD_kernel__)
53 # define USE_SOFTVOL
54 # include "volume.h"
55 #endif
56
57 #define A52_FRAME_NB 1536
58
59 struct aout_sys_t
60 {
61     int fd;
62     audio_sample_format_t format;
63     bool starting;
64
65     bool mute;
66     uint8_t level;
67     char *device;
68 };
69
70 static int Open (vlc_object_t *);
71 static void Close (vlc_object_t *);
72
73 #define AUDIO_DEV_TEXT N_("Audio output device")
74 #define AUDIO_DEV_LONGTEXT N_("OSS device node path.")
75
76 vlc_module_begin ()
77     set_shortname( "OSS" )
78     set_description (N_("Open Sound System audio output"))
79     set_category( CAT_AUDIO )
80     set_subcategory( SUBCAT_AUDIO_AOUT )
81     add_string ("oss-audio-device", "",
82                 AUDIO_DEV_TEXT, AUDIO_DEV_LONGTEXT, false)
83 #ifdef USE_SOFTVOL
84     add_sw_gain ()
85 #endif
86     set_capability( "audio output", 100 )
87     set_callbacks (Open, Close)
88 vlc_module_end ()
89
90 static int TimeGet (audio_output_t *, mtime_t *);
91 static void Play (audio_output_t *, block_t *);
92 static void Pause (audio_output_t *, bool, mtime_t);
93 static void Flush (audio_output_t *, bool);
94 #ifndef USE_SOFTVOL
95 static int VolumeSync (audio_output_t *);
96 #endif
97
98 static int Start (audio_output_t *aout, audio_sample_format_t *restrict fmt)
99 {
100     aout_sys_t* sys = aout->sys;
101
102     /* Open the device */
103     const char *device = sys->device;
104     if (device == NULL)
105         device = getenv ("OSS_AUDIODEV");
106     if (device == NULL)
107         device = "/dev/dsp";
108
109     int fd = vlc_open (device, O_WRONLY);
110     if (fd == -1)
111     {
112         msg_Err (aout, "cannot open OSS device %s: %s", device,
113                  vlc_strerror_c(errno));
114         return VLC_EGENERIC;
115     }
116     msg_Dbg (aout, "using OSS device: %s", device);
117
118     /* Select audio format */
119     int format;
120     bool spdif = false;
121
122     switch (fmt->i_format)
123     {
124 #ifdef AFMT_FLOAT
125         case VLC_CODEC_FL64:
126         case VLC_CODEC_FL32:
127             format = AFMT_FLOAT;
128             break;
129 #endif
130         case VLC_CODEC_S32N:
131             format = AFMT_S32_NE;
132             break;
133         case VLC_CODEC_S16N:
134             format = AFMT_S16_NE;
135             break;
136         case VLC_CODEC_U8:
137             format = AFMT_U8;
138             break;
139         default:
140             if (AOUT_FMT_SPDIF(fmt))
141                 spdif = var_InheritBool (aout, "spdif");
142             if (spdif)
143                 format = AFMT_AC3;
144 #ifdef AFMT_FLOAT
145             else if (HAVE_FPU)
146                 format = AFMT_FLOAT;
147 #endif
148             else
149                 format = AFMT_S16_NE;
150     }
151
152     if (ioctl (fd, SNDCTL_DSP_SETFMT, &format) < 0)
153     {
154         msg_Err (aout, "cannot set audio format 0x%X: %s", format,
155                  vlc_strerror_c(errno));
156         goto error;
157     }
158
159     switch (format)
160     {
161         case AFMT_U8:     fmt->i_format = VLC_CODEC_U8;   break;
162         case AFMT_S16_NE: fmt->i_format = VLC_CODEC_S16N; break;
163         case AFMT_S32_NE: fmt->i_format = VLC_CODEC_S32N; break;
164 #ifdef AFMT_FLOAT
165         case AFMT_FLOAT:  fmt->i_format = VLC_CODEC_FL32; break;
166 #endif
167         case AFMT_AC3:
168             if (spdif)
169             {
170                 fmt->i_format = VLC_CODEC_SPDIFL;
171                 break;
172             }
173         default:
174             msg_Err (aout, "unsupported audio format 0x%X", format);
175             goto error;
176     }
177
178     /* Select channels count */
179     int channels = spdif ? 2 : aout_FormatNbChannels (fmt);
180     if (ioctl (fd, SNDCTL_DSP_CHANNELS, &channels) < 0)
181     {
182         msg_Err (aout, "cannot set %d channels: %s", channels,
183                  vlc_strerror_c(errno));
184         goto error;
185     }
186
187     switch (channels)
188     {
189         case 1: channels = AOUT_CHAN_CENTER;  break;
190         case 2: channels = AOUT_CHANS_STEREO; break;
191         case 4: channels = AOUT_CHANS_4_0;    break;
192         case 6: channels = AOUT_CHANS_5_1;    break;
193         case 8: channels = AOUT_CHANS_7_1;    break;
194         default:
195             msg_Err (aout, "unsupported channels count %d", channels);
196             goto error;
197     }
198
199     /* Select sample rate */
200     int rate = spdif ? 48000 : fmt->i_rate;
201     if (ioctl (fd, SNDCTL_DSP_SPEED, &rate) < 0)
202     {
203         msg_Err (aout, "cannot set %d Hz sample rate: %s", rate,
204                  vlc_strerror_c(errno));
205         goto error;
206     }
207
208     /* Setup audio_output_t */
209     aout->time_get = TimeGet;
210     aout->play = Play;
211     aout->pause = Pause;
212     aout->flush = Flush;
213
214     if (spdif)
215     {
216         fmt->i_bytes_per_frame = AOUT_SPDIF_SIZE;
217         fmt->i_frame_length = A52_FRAME_NB;
218     }
219     else
220     {
221         fmt->i_rate = rate;
222         fmt->i_original_channels =
223         fmt->i_physical_channels = channels;
224     }
225     aout_FormatPrepare (fmt);
226
227     /* Select timing */
228     unsigned bytes;
229     if (spdif)
230         bytes = AOUT_SPDIF_SIZE;
231     else
232         bytes = fmt->i_rate / (CLOCK_FREQ / AOUT_MIN_PREPARE_TIME)
233                 * fmt->i_bytes_per_frame;
234     if (unlikely(bytes < 16))
235         bytes = 16;
236
237     int frag = (AOUT_MAX_ADVANCE_TIME / AOUT_MIN_PREPARE_TIME) << 16
238              | (32 - clz32(bytes - 1));
239     if (ioctl (fd, SNDCTL_DSP_SETFRAGMENT, &frag) < 0)
240         msg_Err (aout, "cannot set 0x%08x fragment: %s", frag,
241                  vlc_strerror_c(errno));
242
243     sys->fd = fd;
244 #ifndef USE_SOFTVOL
245     VolumeSync (aout);
246 #else
247     aout_SoftVolumeStart (aout);
248 #endif
249     sys->starting = true;
250     sys->format = *fmt;
251     return VLC_SUCCESS;
252 error:
253     close (fd);
254     return VLC_EGENERIC;
255 }
256
257 static int TimeGet (audio_output_t *aout, mtime_t *restrict pts)
258 {
259     aout_sys_t *sys = aout->sys;
260     int delay;
261
262     if (ioctl (sys->fd, SNDCTL_DSP_GETODELAY, &delay) < 0)
263     {
264         msg_Warn (aout, "cannot get delay: %s", vlc_strerror_c(errno));
265         return -1;
266     }
267
268     *pts = (delay * CLOCK_FREQ * sys->format.i_frame_length)
269                         / (sys->format.i_rate * sys->format.i_bytes_per_frame);
270     return 0;
271 }
272
273 /**
274  * Queues one audio buffer to the hardware.
275  */
276 static void Play (audio_output_t *aout, block_t *block)
277 {
278     aout_sys_t *sys = aout->sys;
279     int fd = sys->fd;
280
281     while (block->i_buffer > 0)
282     {
283         ssize_t bytes = write (fd, block->p_buffer, block->i_buffer);
284         if (bytes >= 0)
285         {
286             block->p_buffer += bytes;
287             block->i_buffer -= bytes;
288         }
289         else
290             msg_Err (aout, "cannot write samples: %s", vlc_strerror_c(errno));
291     }
292     block_Release (block);
293
294 #ifndef USE_SOFTVOL
295     /* Dumb OSS cannot send any kind of events for this... */
296     VolumeSync (aout);
297 #endif
298 }
299
300 /**
301  * Pauses/resumes the audio playback.
302  */
303 static void Pause (audio_output_t *aout, bool pause, mtime_t date)
304 {
305     aout_sys_t *sys = aout->sys;
306     int fd = sys->fd;
307
308     (void) date;
309     ioctl (fd, pause ? SNDCTL_DSP_SILENCE : SNDCTL_DSP_SKIP, NULL);
310 }
311
312 /**
313  * Flushes/drains the audio playback buffer.
314  */
315 static void Flush (audio_output_t *aout, bool wait)
316 {
317     aout_sys_t *sys = aout->sys;
318     int fd = sys->fd;
319
320     if (wait)
321         return; /* drain is implicit with OSS */
322     ioctl (fd, SNDCTL_DSP_HALT, NULL);
323 }
324
325 #ifndef USE_SOFTVOL
326 static int VolumeSync (audio_output_t *aout)
327 {
328     aout_sys_t *sys = aout->sys;
329     int fd = sys->fd;
330
331     int level;
332     if (ioctl (fd, SNDCTL_DSP_GETPLAYVOL, &level) < 0)
333         return -1;
334
335     sys->mute = !level;
336     if (level) /* try to keep last volume before mute */
337         sys->level = level;
338     aout_MuteReport (aout, !level);
339     aout_VolumeReport (aout, (float)(level & 0xFF) / 100.f);
340     return 0;
341 }
342 #endif
343
344 /**
345  * Releases the audio output device.
346  */
347 static void Stop (audio_output_t *aout)
348 {
349     aout_sys_t *sys = aout->sys;
350     int fd = sys->fd;
351
352     ioctl (fd, SNDCTL_DSP_HALT, NULL);
353     close (fd);
354     sys->fd = -1;
355 }
356
357 static int VolumeSet (audio_output_t *aout, float vol)
358 {
359     aout_sys_t *sys = aout->sys;
360     int fd = sys->fd;
361     if (fd == -1)
362         return -1;
363
364     int level = lroundf (vol * 100.f);
365     if (level > 0xFF)
366         level = 0xFFFF;
367     else
368         level |= level << 8;
369     if (!sys->mute && ioctl (fd, SNDCTL_DSP_SETPLAYVOL, &level) < 0)
370     {
371         msg_Err (aout, "cannot set volume: %s", vlc_strerror_c(errno));
372         return -1;
373     }
374
375     sys->level = level;
376     aout_VolumeReport (aout, (float)(level & 0xFF) / 100.f);
377     return 0;
378 }
379
380 static int MuteSet (audio_output_t *aout, bool mute)
381 {
382     aout_sys_t *sys = aout->sys;
383     int fd = sys->fd;
384     if (fd == -1)
385         return -1;
386
387     int level = mute ? 0 : (sys->level | (sys->level << 8));
388     if (ioctl (fd, SNDCTL_DSP_SETPLAYVOL, &level) < 0)
389     {
390         msg_Err (aout, "cannot mute: %s", vlc_strerror_c(errno));
391         return -1;
392     }
393
394     sys->mute = mute;
395     aout_MuteReport (aout, mute);
396     return 0;
397 }
398
399 static int DevicesEnum (audio_output_t *aout)
400 {
401     int fd = vlc_open ("/dev/dsp", O_WRONLY);
402     if (fd == -1)
403         return -1;
404
405     oss_sysinfo si;
406     int n = -1;
407
408     if (ioctl (fd, SNDCTL_SYSINFO, &si) < 0)
409     {
410         msg_Err (aout, "cannot get system infos: %s", vlc_strerror(errno));
411         goto out;
412     }
413
414     msg_Dbg (aout, "using %s version %s (0x%06X) under %s", si.product,
415              si.version, si.versionnum, si.license);
416
417     for (int i = 0; i < si.numaudios; i++)
418     {
419         oss_audioinfo ai = { .dev = i };
420
421         if (ioctl (fd, SNDCTL_AUDIOINFO, &ai) < 0)
422         {
423             msg_Warn (aout, "cannot get device %d infos: %s", i,
424                       vlc_strerror_c(errno));
425             continue;
426         }
427         if (ai.caps & (PCM_CAP_HIDDEN|PCM_CAP_MODEM))
428             continue;
429         if (!(ai.caps & PCM_CAP_OUTPUT))
430             continue;
431         if (!ai.enabled)
432             continue;
433
434         aout_HotplugReport (aout, ai.devnode, ai.name);
435         n++;
436     }
437 out:
438     close (fd);
439     return n;
440 }
441
442 static int DeviceSelect (audio_output_t *aout, const char *id)
443 {
444     aout_sys_t *sys = aout->sys;
445     char *path = NULL;
446
447     if (id != NULL)
448     {
449         path = strdup (id);
450         if (unlikely(path == NULL))
451             return -1;
452     }
453
454     free (sys->device);
455     sys->device = path;
456     aout_DeviceReport (aout, path);
457     aout_RestartRequest (aout, AOUT_RESTART_OUTPUT);
458     return 0;
459 }
460
461 static int Open (vlc_object_t *obj)
462 {
463     audio_output_t *aout = (audio_output_t *)obj;
464
465     aout_sys_t *sys = malloc (sizeof (*sys));
466     if(unlikely( sys == NULL ))
467         return VLC_ENOMEM;
468
469     sys->fd = -1;
470
471     sys->level = 100;
472     sys->mute = false;
473     sys->device = var_InheritString (aout, "oss-audio-device");
474
475     aout->sys = sys;
476     aout->start = Start;
477     aout->stop = Stop;
478     aout->volume_set = VolumeSet;
479     aout->mute_set = MuteSet;
480     aout->device_select = DeviceSelect;
481
482 #ifdef USE_SOFTVOL
483     aout_SoftVolumeInit (aout);
484 #endif
485     DevicesEnum (aout);
486     return VLC_SUCCESS;
487 }
488
489 static void Close (vlc_object_t *obj)
490 {
491     audio_output_t *aout = (audio_output_t *)obj;
492     aout_sys_t *sys = aout->sys;
493
494     free (sys->device);
495     free (sys);
496 }