]> git.sesse.net Git - vlc/blob - modules/access/oss.c
Fix confusing variable name.
[vlc] / modules / access / oss.c
1 /*****************************************************************************
2  * oss.c : OSS input module for vlc
3  *****************************************************************************
4  * Copyright (C) 2002-2009 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Benjamin Pracht <bigben at videolan dot org>
8  *          Richard Hosking <richard at hovis dot net>
9  *          Antoine Cellerier <dionoea at videolan d.t org>
10  *          Dennis Lou <dlou99 at yahoo dot com>
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 /*****************************************************************************
28  * Preamble
29  *****************************************************************************/
30
31 #ifdef HAVE_CONFIG_H
32 # include "config.h"
33 #endif
34
35 #include <vlc_common.h>
36 #include <vlc_plugin.h>
37 #include <vlc_access.h>
38 #include <vlc_demux.h>
39 #include <vlc_input.h>
40 #include <vlc_vout.h>
41
42 #include <ctype.h>
43 #include <fcntl.h>
44 #include <unistd.h>
45 #include <sys/ioctl.h>
46 #include <sys/mman.h>
47
48 #include <sys/soundcard.h>
49
50 #include <poll.h>
51
52 /*****************************************************************************
53  * Module descriptior
54  *****************************************************************************/
55
56 static int  DemuxOpen ( vlc_object_t * );
57 static void DemuxClose( vlc_object_t * );
58
59
60 #define STEREO_TEXT N_( "Stereo" )
61 #define STEREO_LONGTEXT N_( \
62     "Capture the audio stream in stereo." )
63 #define SAMPLERATE_TEXT N_( "Samplerate" )
64 #define SAMPLERATE_LONGTEXT N_( \
65     "Samplerate of the captured audio stream, in Hz (eg: 11025, 22050, 44100, 48000)" )
66
67 #define CACHING_TEXT N_("Caching value in ms")
68 #define CACHING_LONGTEXT N_( \
69     "Caching value for OSS captures. This " \
70     "value should be set in milliseconds." )
71
72 #define OSS_DEFAULT "/dev/dsp"
73
74 #define CFG_PREFIX "oss-"
75
76 vlc_module_begin ()
77     set_shortname( N_("OSS") )
78     set_description( N_("OSS input") )
79     set_category( CAT_INPUT )
80     set_subcategory( SUBCAT_INPUT_ACCESS )
81
82     add_shortcut( "oss" )
83     set_capability( "access_demux", 10 )
84     set_callbacks( DemuxOpen, DemuxClose )
85
86     add_bool( CFG_PREFIX "stereo", true, NULL, STEREO_TEXT, STEREO_LONGTEXT,
87                 true );
88     add_integer( CFG_PREFIX "samplerate", 48000, NULL, SAMPLERATE_TEXT,
89                 SAMPLERATE_LONGTEXT, true );
90     add_integer( CFG_PREFIX "caching", DEFAULT_PTS_DELAY / 1000, NULL,
91                 CACHING_TEXT, CACHING_LONGTEXT, true );
92 vlc_module_end ()
93
94 /*****************************************************************************
95  * Access: local prototypes
96  *****************************************************************************/
97
98 static int DemuxControl( demux_t *, int, va_list );
99
100 static int Demux( demux_t * );
101
102 static block_t* GrabAudio( demux_t *p_demux );
103
104 static int OpenAudioDev( demux_t * );
105 static int OpenAudioDevOss( demux_t * );
106 static bool ProbeAudioDevOss( demux_t *, const char *psz_device );
107
108 struct buffer_t
109 {
110     void *  start;
111     size_t  length;
112 };
113
114 struct demux_sys_t
115 {
116     const char *psz_device;  /* OSS device from MRL */
117
118     int  i_fd;
119
120     /* Audio */
121     int i_cache;
122     unsigned int i_sample_rate;
123     bool b_stereo;
124     size_t i_max_frame_size;
125     block_t *p_block;
126     es_out_id_t *p_es;
127
128     int64_t i_next_demux_date; /* Used to handle oss:// as input-slave properly */
129 };
130
131 static int FindMainDevice( demux_t *p_demux )
132 {
133     msg_Dbg( p_demux, "opening device '%s'", p_demux->p_sys->psz_device );
134     if( ProbeAudioDevOss( p_demux, p_demux->p_sys->psz_device ) )
135     {
136         msg_Dbg( p_demux, "'%s' is an audio device", p_demux->p_sys->psz_device );
137         p_demux->p_sys->i_fd = OpenAudioDev( p_demux );
138     }
139
140     if( p_demux->p_sys->i_fd < 0 )
141         return VLC_EGENERIC;
142     return VLC_SUCCESS;
143 }
144
145 /*****************************************************************************
146  * DemuxOpen: opens oss device, access_demux callback
147  *****************************************************************************
148  *
149  * url: <oss device>::::
150  *
151  *****************************************************************************/
152 static int DemuxOpen( vlc_object_t *p_this )
153 {
154     demux_t     *p_demux = (demux_t*)p_this;
155     demux_sys_t *p_sys;
156
157     /* Only when selected */
158     if( *p_demux->psz_access == '\0' ) return VLC_EGENERIC;
159
160     /* Set up p_demux */
161     p_demux->pf_control = DemuxControl;
162     p_demux->pf_demux = Demux;
163     p_demux->info.i_update = 0;
164     p_demux->info.i_title = 0;
165     p_demux->info.i_seekpoint = 0;
166
167     p_demux->p_sys = p_sys = calloc( 1, sizeof( demux_sys_t ) );
168     if( p_sys == NULL ) return VLC_ENOMEM;
169
170     p_sys->i_sample_rate = var_CreateGetInteger( p_demux, CFG_PREFIX "samplerate" );
171     p_sys->b_stereo = var_CreateGetBool( p_demux, CFG_PREFIX "stereo" );
172     p_sys->i_cache = var_CreateGetInteger( p_demux, CFG_PREFIX "caching" );
173     p_sys->i_fd = -1;
174     p_sys->p_es = NULL;
175     p_sys->p_block = NULL;
176     p_sys->i_next_demux_date = -1;
177
178     if( p_demux->psz_path && *p_demux->psz_path )
179         p_sys->psz_device = p_demux->psz_path;
180     else
181         p_sys->psz_device = OSS_DEFAULT;
182
183     if( FindMainDevice( p_demux ) != VLC_SUCCESS )
184     {
185         DemuxClose( p_this );
186         return VLC_EGENERIC;
187     }
188
189     return VLC_SUCCESS;
190 }
191
192 /*****************************************************************************
193  * Close: close device, free resources
194  *****************************************************************************/
195 static void DemuxClose( vlc_object_t *p_this )
196 {
197     demux_t     *p_demux = (demux_t *)p_this;
198     demux_sys_t *p_sys   = p_demux->p_sys;
199
200     if( p_sys->i_fd >= 0 ) close( p_sys->i_fd );
201
202     if( p_sys->p_block ) block_Release( p_sys->p_block );
203     free( p_sys );
204 }
205
206 /*****************************************************************************
207  * DemuxControl:
208  *****************************************************************************/
209 static int DemuxControl( demux_t *p_demux, int i_query, va_list args )
210 {
211     demux_sys_t *p_sys = p_demux->p_sys;
212     bool *pb;
213     int64_t    *pi64;
214
215     switch( i_query )
216     {
217         /* Special for access_demux */
218         case DEMUX_CAN_PAUSE:
219         case DEMUX_CAN_SEEK:
220         case DEMUX_SET_PAUSE_STATE:
221         case DEMUX_CAN_CONTROL_PACE:
222             pb = (bool*)va_arg( args, bool * );
223             *pb = false;
224             return VLC_SUCCESS;
225
226         case DEMUX_GET_PTS_DELAY:
227             pi64 = (int64_t*)va_arg( args, int64_t * );
228             *pi64 = (int64_t)p_sys->i_cache * 1000;
229             return VLC_SUCCESS;
230
231         case DEMUX_GET_TIME:
232             pi64 = (int64_t*)va_arg( args, int64_t * );
233             *pi64 = mdate();
234             return VLC_SUCCESS;
235
236         case DEMUX_SET_NEXT_DEMUX_TIME:
237             p_sys->i_next_demux_date = (int64_t)va_arg( args, int64_t );
238             return VLC_SUCCESS;
239
240         /* TODO implement others */
241         default:
242             return VLC_EGENERIC;
243     }
244
245     return VLC_EGENERIC;
246 }
247
248 /*****************************************************************************
249  * Demux: Processes the audio frame
250  *****************************************************************************/
251 static int Demux( demux_t *p_demux )
252 {
253     demux_sys_t *p_sys = p_demux->p_sys;
254
255     struct pollfd fd;
256     fd.fd = p_sys->i_fd;
257     fd.events = POLLIN|POLLPRI;
258     fd.revents = 0;
259
260     block_t *p_block = NULL;
261
262     do
263     {
264         if( p_block )
265         {
266             es_out_Send( p_demux->out, p_sys->p_es, p_block );
267             p_block = NULL;
268         }
269
270         /* Wait for data */
271         if( poll( &fd, 1, 500 ) ) /* Timeout after 0.5 seconds since I don't know if pf_demux can be blocking. */
272         {
273             if( fd.revents & (POLLIN|POLLPRI) )
274             {
275                 p_block = GrabAudio( p_demux );
276                 if( p_block )
277                     es_out_Control( p_demux->out, ES_OUT_SET_PCR, p_block->i_pts );
278             }
279         }
280     } while( p_block && p_sys->i_next_demux_date > 0 &&
281              p_block->i_pts < p_sys->i_next_demux_date );
282
283     if( p_block )
284         es_out_Send( p_demux->out, p_sys->p_es, p_block );
285
286     return 1;
287 }
288
289 /*****************************************************************************
290  * GrabAudio: Grab an audio frame
291  *****************************************************************************/
292 static block_t* GrabAudio( demux_t *p_demux )
293 {
294     demux_sys_t *p_sys = p_demux->p_sys;
295     struct audio_buf_info buf_info;
296     int i_read = 0, i_correct;
297     block_t *p_block;
298
299     if( p_sys->p_block ) p_block = p_sys->p_block;
300     else p_block = block_New( p_demux, p_sys->i_max_frame_size );
301
302     if( !p_block )
303     {
304         msg_Warn( p_demux, "cannot get block" );
305         return 0;
306     }
307
308     p_sys->p_block = p_block;
309
310     i_read = read( p_sys->i_fd, p_block->p_buffer,
311                 p_sys->i_max_frame_size );
312
313     if( i_read <= 0 ) return 0;
314
315     p_block->i_buffer = i_read;
316     p_sys->p_block = 0;
317
318     /* Correct the date because of kernel buffering */
319     i_correct = i_read;
320     if( ioctl( p_sys->i_fd, SNDCTL_DSP_GETISPACE, &buf_info ) == 0 )
321     {
322         i_correct += buf_info.bytes;
323     }
324
325     /* Timestamp */
326     p_block->i_pts = p_block->i_dts =
327         mdate() - INT64_C(1000000) * (mtime_t)i_correct /
328         2 / ( p_sys->b_stereo ? 2 : 1) / p_sys->i_sample_rate;
329
330     return p_block;
331 }
332
333 /*****************************************************************************
334  * OpenAudioDev: open and set up the audio device and probe for capabilities
335  *****************************************************************************/
336 static int OpenAudioDevOss( demux_t *p_demux )
337 {
338     int i_fd;
339     int i_format;
340
341     i_fd = open( p_demux->p_sys->psz_device, O_RDONLY | O_NONBLOCK );
342
343     if( i_fd < 0 )
344     {
345         msg_Err( p_demux, "cannot open OSS audio device (%m)" );
346         goto adev_fail;
347     }
348
349     i_format = AFMT_S16_LE;
350     if( ioctl( i_fd, SNDCTL_DSP_SETFMT, &i_format ) < 0
351         || i_format != AFMT_S16_LE )
352     {
353         msg_Err( p_demux,
354                  "cannot set audio format (16b little endian) (%m)" );
355         goto adev_fail;
356     }
357
358     if( ioctl( i_fd, SNDCTL_DSP_STEREO,
359                &p_demux->p_sys->b_stereo ) < 0 )
360     {
361         msg_Err( p_demux, "cannot set audio channels count (%m)" );
362         goto adev_fail;
363     }
364
365     if( ioctl( i_fd, SNDCTL_DSP_SPEED,
366                &p_demux->p_sys->i_sample_rate ) < 0 )
367     {
368         msg_Err( p_demux, "cannot set audio sample rate (%m)" );
369         goto adev_fail;
370     }
371
372     p_demux->p_sys->i_max_frame_size = 6 * 1024;
373
374     return i_fd;
375
376  adev_fail:
377
378     if( i_fd >= 0 ) close( i_fd );
379     return -1;
380 }
381
382 static int OpenAudioDev( demux_t *p_demux )
383 {
384     demux_sys_t *p_sys = p_demux->p_sys;
385     int i_fd = OpenAudioDevOss( p_demux );
386
387     if( i_fd < 0 )
388         return i_fd;
389
390     msg_Dbg( p_demux, "opened adev=`%s' %s %dHz",
391              p_sys->psz_device, p_sys->b_stereo ? "stereo" : "mono",
392              p_sys->i_sample_rate );
393
394     es_format_t fmt;
395     es_format_Init( &fmt, AUDIO_ES, VLC_FOURCC('a','r','a','w') );
396
397     fmt.audio.i_channels = p_sys->b_stereo ? 2 : 1;
398     fmt.audio.i_rate = p_sys->i_sample_rate;
399     fmt.audio.i_bitspersample = 16;
400     fmt.audio.i_blockalign = fmt.audio.i_channels * fmt.audio.i_bitspersample / 8;
401     fmt.i_bitrate = fmt.audio.i_channels * fmt.audio.i_rate * fmt.audio.i_bitspersample;
402
403     msg_Dbg( p_demux, "new audio es %d channels %dHz",
404              fmt.audio.i_channels, fmt.audio.i_rate );
405
406     p_sys->p_es = es_out_Add( p_demux->out, &fmt );
407
408     return i_fd;
409 }
410
411 /*****************************************************************************
412  * ProbeAudioDev: probe audio for capabilities
413  *****************************************************************************/
414 static bool ProbeAudioDevOss( demux_t *p_demux, const char *psz_device )
415 {
416     int i_caps;
417     int i_fd = open( psz_device, O_RDONLY | O_NONBLOCK );
418
419     if( i_fd < 0 )
420     {
421         msg_Err( p_demux, "cannot open device %s for OSS audio (%m)", psz_device );
422         goto open_failed;
423     }
424
425     /* this will fail if the device is video */
426     if( ioctl( i_fd, SNDCTL_DSP_GETCAPS, &i_caps ) < 0 )
427     {
428         msg_Err( p_demux, "cannot get audio caps (%m)" );
429         goto open_failed;
430     }
431
432     if( i_fd >= 0 ) close( i_fd );
433
434     return true;
435
436 open_failed:
437     if( i_fd >= 0 ) close( i_fd );
438     return false;
439 }