b4b10e25d2e345c68558ff84c5e5557fb9b1720b
[vlc.git] / modules / audio_output / esd.c
1 /*****************************************************************************
2  * esd.c : EsounD module
3  *****************************************************************************
4  * Copyright (C) 2000, 2001 VideoLAN
5  * $Id: esd.c,v 1.20 2004/01/25 17:32:29 murray Exp $
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_capability( "audio output", 50 );
68     set_callbacks( Open, Close );
69     add_shortcut( "esound" );
70 vlc_module_end();
71
72 /*****************************************************************************
73  * Open: open an esd socket
74  *****************************************************************************/
75 static int Open( vlc_object_t *p_this )
76 {
77     aout_instance_t *p_aout = (aout_instance_t *)p_this;
78     struct aout_sys_t * p_sys;
79     int i_nb_channels;
80     int fl;
81
82     /* Allocate structure */
83     p_sys = malloc( sizeof( aout_sys_t ) );
84     if( p_sys == NULL )
85     {
86         msg_Err( p_aout, "out of memory" );
87         return VLC_ENOMEM;
88     }
89
90     p_aout->output.p_sys = p_sys;
91
92     p_aout->output.pf_play = Play;
93     aout_VolumeSoftInit( p_aout );
94
95     /* Initialize some variables */
96     p_sys->esd_format = ESD_BITS16 | ESD_STREAM | ESD_PLAY;
97     p_sys->esd_format &= ~ESD_MASK_CHAN;
98
99     p_aout->output.output.i_format = AOUT_FMT_S16_NE;
100     i_nb_channels = aout_FormatNbChannels( &p_aout->output.output );
101     if ( i_nb_channels > 2 )
102     {
103         /* EsounD doesn't support more than two channels. */
104         i_nb_channels = 2;
105         p_aout->output.output.i_physical_channels =
106             AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT;
107     }
108
109     switch( i_nb_channels )
110     {
111     case 1:
112         p_sys->esd_format |= ESD_MONO;
113         break;
114     case 2:
115         p_sys->esd_format |= ESD_STEREO;
116         break;
117     }
118
119     /* Force the rate, otherwise the sound is very noisy */
120     p_aout->output.output.i_rate = ESD_DEFAULT_RATE;
121     
122     /* open a socket for playing a stream
123      * and try to open /dev/dsp if there's no EsounD */
124     p_sys->i_fd = esd_play_stream_fallback( p_sys->esd_format,
125                               p_aout->output.output.i_rate, NULL, "vlc" );
126     if( p_sys->i_fd < 0 )
127     {
128         msg_Err( p_aout, "cannot open esound socket (format 0x%08x at %d Hz)",
129                          p_sys->esd_format, p_aout->output.output.i_rate );
130         free( p_sys );
131         return VLC_EGENERIC;
132     }
133
134     p_aout->output.i_nb_samples = ESD_BUF_SIZE * 2;
135
136     /* ESD latency is calculated for 44100 Hz. We don't have any way to get the
137      * number of buffered samples, so I assume ESD_BUF_SIZE/2 */
138     p_sys->latency =
139         (mtime_t)( esd_get_latency( esd_open_sound(NULL) ) + ESD_BUF_SIZE/2
140                     * p_aout->output.output.i_bytes_per_frame
141                     * p_aout->output.output.i_rate
142                     / ESD_DEFAULT_RATE )
143       * (mtime_t)1000000
144       / p_aout->output.output.i_bytes_per_frame
145       / p_aout->output.output.i_rate;
146
147     return VLC_SUCCESS;
148 }
149
150 /*****************************************************************************
151  * Play: nothing to do
152  *****************************************************************************/
153 static void Play( aout_instance_t *p_aout )
154 {
155     struct aout_sys_t * p_sys = p_aout->output.p_sys;
156     aout_buffer_t * p_buffer;
157     int i_tmp;
158
159     p_buffer = aout_FifoPop( p_aout, &p_aout->output.fifo );
160
161     if ( p_buffer != NULL )
162     {
163         int pos;
164         char *data = p_buffer->p_buffer;
165
166         for( pos = 0; pos + ESD_BUF_SIZE <= p_buffer->i_nb_bytes; 
167              pos += ESD_BUF_SIZE )
168         {
169             i_tmp = write( p_sys->i_fd, data + pos, ESD_BUF_SIZE );
170             if( i_tmp < 0 )
171             {
172                 msg_Err( p_aout, "write failed (%s)", strerror(errno) );
173             }
174         }
175         aout_BufferFree( p_buffer );
176     }
177 }
178
179 /*****************************************************************************
180  * Close: close the Esound socket
181  *****************************************************************************/
182 static void Close( vlc_object_t *p_this )
183 {
184     aout_instance_t *p_aout = (aout_instance_t *)p_this;
185     struct aout_sys_t * p_sys = p_aout->output.p_sys;
186
187     close( p_sys->i_fd );
188     free( p_sys );
189 }
190
191 #if 0
192 /*****************************************************************************
193  * Play: play a sound samples buffer
194  *****************************************************************************
195  * This function writes a buffer of i_length bytes in the socket
196  *****************************************************************************/
197 static void Play( aout_thread_t *p_aout, byte_t *buffer, int i_size )
198 {
199     int i_amount;
200
201     int m1 = p_aout->output.p_sys->esd_format & ESD_STEREO ? 1 : 2;
202     int m2 = p_aout->output.p_sys->esd_format & ESD_BITS16 ? 64 : 128;
203
204     i_amount = (m1 * 44100 * (ESD_BUF_SIZE + m1 * m2)) / p_aout->i_rate;
205
206     write( p_aout->output.p_sys->i_fd, buffer, i_size );
207 }
208 #endif
209