* all: added a new access_filter module: record + one hotkey to start/stop
[vlc.git] / modules / audio_output / esd.c
1 /*****************************************************************************
2  * esd.c : EsounD module
3  *****************************************************************************
4  * Copyright (C) 2000, 2001 VideoLAN
5  * $Id$
6  *
7  * Authors: Samuel Hocevar <sam@zoy.org>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
22  *****************************************************************************/
23
24 /*****************************************************************************
25  * Preamble
26  *****************************************************************************/
27 #include <errno.h>                                                 /* ENOMEM */
28 #include <fcntl.h>                                       /* open(), O_WRONLY */
29 #include <string.h>                                            /* strerror() */
30 #include <unistd.h>                                      /* write(), close() */
31 #include <stdlib.h>                            /* calloc(), malloc(), free() */
32
33 #include <vlc/vlc.h>
34 #include <vlc/aout.h>
35 #include "aout_internal.h"
36
37 #include <sys/socket.h>
38
39 #include <esd.h>
40
41 /*****************************************************************************
42  * aout_sys_t: esd audio output method descriptor
43  *****************************************************************************
44  * This structure is part of the audio output thread descriptor.
45  * It describes some esd specific variables.
46  *****************************************************************************/
47 struct aout_sys_t
48 {
49     esd_format_t esd_format;
50     int          i_fd;
51
52     mtime_t      latency;       /* unused, but we might do something with it */
53 };
54
55 /*****************************************************************************
56  * Local prototypes
57  *****************************************************************************/
58 static int  Open         ( vlc_object_t * );
59 static void Close        ( vlc_object_t * );
60 static void Play         ( aout_instance_t * );
61
62 /*****************************************************************************
63  * Module descriptor
64  *****************************************************************************/
65 vlc_module_begin();
66     set_description( _("EsounD audio output") );
67     set_shortname( "EsounD" );
68     set_capability( "audio output", 50 );
69     set_category( CAT_AUDIO );
70     set_subcategory( SUBCAT_AUDIO_AOUT );
71     set_callbacks( Open, Close );
72     add_shortcut( "esound" );
73 vlc_module_end();
74
75 /*****************************************************************************
76  * Open: open an esd socket
77  *****************************************************************************/
78 static int Open( vlc_object_t *p_this )
79 {
80     aout_instance_t *p_aout = (aout_instance_t *)p_this;
81     struct aout_sys_t * p_sys;
82     int i_nb_channels;
83     int i_newfd = -1;
84     int fl;
85
86     /* Allocate structure */
87     p_sys = malloc( sizeof( aout_sys_t ) );
88     if( p_sys == NULL )
89     {
90         msg_Err( p_aout, "out of memory" );
91         return VLC_ENOMEM;
92     }
93
94     p_aout->output.p_sys = p_sys;
95
96     p_aout->output.pf_play = Play;
97     aout_VolumeSoftInit( p_aout );
98
99     /* Initialize some variables */
100     p_sys->esd_format = ESD_BITS16 | ESD_STREAM | ESD_PLAY;
101     p_sys->esd_format &= ~ESD_MASK_CHAN;
102
103     p_aout->output.output.i_format = AOUT_FMT_S16_NE;
104     i_nb_channels = aout_FormatNbChannels( &p_aout->output.output );
105     if ( i_nb_channels > 2 )
106     {
107         /* EsounD doesn't support more than two channels. */
108         i_nb_channels = 2;
109         p_aout->output.output.i_physical_channels =
110             AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT;
111     }
112
113     switch( i_nb_channels )
114     {
115     case 1:
116         p_sys->esd_format |= ESD_MONO;
117         break;
118     case 2:
119         p_sys->esd_format |= ESD_STEREO;
120         break;
121     }
122
123     /* Force the rate, otherwise the sound is very noisy */
124     p_aout->output.output.i_rate = ESD_DEFAULT_RATE;
125
126     /* open a socket for playing a stream
127      * and try to open /dev/dsp if there's no EsounD */
128     p_sys->i_fd = esd_play_stream_fallback( p_sys->esd_format,
129                               p_aout->output.output.i_rate, NULL, "vlc" );
130     if( p_sys->i_fd < 0 )
131     {
132         msg_Err( p_aout, "cannot open esound socket (format 0x%08x at %d Hz)",
133                          p_sys->esd_format, p_aout->output.output.i_rate );
134         free( p_sys );
135         return VLC_EGENERIC;
136     }
137
138     p_aout->output.i_nb_samples = ESD_BUF_SIZE * 2;
139
140     /* ESD latency is calculated for 44100 Hz. We don't have any way to get the
141      * number of buffered samples, so I assume ESD_BUF_SIZE/2 */
142     p_sys->latency =
143         (mtime_t)( esd_get_latency( i_newfd = esd_open_sound(NULL) ) +
144                       ESD_BUF_SIZE/2
145                     * p_aout->output.output.i_bytes_per_frame
146                     * p_aout->output.output.i_rate
147                     / ESD_DEFAULT_RATE )
148       * (mtime_t)1000000
149       / p_aout->output.output.i_bytes_per_frame
150       / p_aout->output.output.i_rate;
151
152     close( i_newfd );
153     return VLC_SUCCESS;
154 }
155
156 /*****************************************************************************
157  * Play: nothing to do
158  *****************************************************************************/
159 static void Play( aout_instance_t *p_aout )
160 {
161     struct aout_sys_t * p_sys = p_aout->output.p_sys;
162     aout_buffer_t * p_buffer;
163     int i_tmp;
164
165     p_buffer = aout_FifoPop( p_aout, &p_aout->output.fifo );
166
167     if ( p_buffer != NULL )
168     {
169         int pos;
170         char *data = p_buffer->p_buffer;
171
172         for( pos = 0; pos + ESD_BUF_SIZE <= p_buffer->i_nb_bytes; 
173              pos += ESD_BUF_SIZE )
174         {
175             i_tmp = write( p_sys->i_fd, data + pos, ESD_BUF_SIZE );
176             if( i_tmp < 0 )
177             {
178                 msg_Err( p_aout, "write failed (%s)", strerror(errno) );
179             }
180         }
181         aout_BufferFree( p_buffer );
182     }
183 }
184
185 /*****************************************************************************
186  * Close: close the Esound socket
187  *****************************************************************************/
188 static void Close( vlc_object_t *p_this )
189 {
190     aout_instance_t *p_aout = (aout_instance_t *)p_this;
191     struct aout_sys_t * p_sys = p_aout->output.p_sys;
192
193     close( p_sys->i_fd );
194     free( p_sys );
195 }
196
197 #if 0
198 /*****************************************************************************
199  * Play: play a sound samples buffer
200  *****************************************************************************
201  * This function writes a buffer of i_length bytes in the socket
202  *****************************************************************************/
203 static void Play( aout_thread_t *p_aout, byte_t *buffer, int i_size )
204 {
205     int i_amount;
206
207     int m1 = p_aout->output.p_sys->esd_format & ESD_STEREO ? 1 : 2;
208     int m2 = p_aout->output.p_sys->esd_format & ESD_BITS16 ? 64 : 128;
209
210     i_amount = (m1 * 44100 * (ESD_BUF_SIZE + m1 * m2)) / p_aout->i_rate;
211
212     write( p_aout->output.p_sys->i_fd, buffer, i_size );
213 }
214 #endif
215