* ./modules/audio_output/oss.c: we spare a variable by using p_aout->b_die
[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.2 2002/08/13 11:59:36 sam 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 <esd.h>
38
39 #define DEFAULT_FRAME_SIZE 2048*2
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     vlc_bool_t   b_initialized;
52 };
53
54 /*****************************************************************************
55  * Local prototypes
56  *****************************************************************************/
57 static int  Open         ( vlc_object_t * );
58 static void Close        ( vlc_object_t * );
59
60 static int  SetFormat    ( aout_instance_t * );
61 static void Play         ( aout_instance_t *, aout_buffer_t * );
62 static int  ESDThread    ( aout_instance_t * );
63
64 /*****************************************************************************
65  * Module descriptor
66  *****************************************************************************/
67 vlc_module_begin();
68     set_description( _("EsounD audio module") );
69     set_capability( "audio output", 50 );
70     set_callbacks( Open, Close );
71     add_shortcut( "esound" );
72 vlc_module_end();
73
74 /*****************************************************************************
75  * Open: open an esd socket
76  *****************************************************************************/
77 static int Open( vlc_object_t *p_this )
78 {
79     aout_instance_t *p_aout = (aout_instance_t *)p_this;
80     struct aout_sys_t * p_sys;
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 -1;
88     }
89
90     p_aout->output.p_sys = p_sys;
91
92     /* Create ESD thread and wait for its readiness. */
93     p_sys->b_initialized = VLC_FALSE;
94     if( vlc_thread_create( p_aout, "aout", ESDThread, VLC_FALSE ) )
95     {
96         msg_Err( p_aout, "cannot create ESD thread (%s)", strerror(errno) );
97         free( p_sys );
98         return -1;
99     }
100
101     p_aout->output.pf_setformat = SetFormat;
102     p_aout->output.pf_play = Play;
103
104     return( 0 );
105 }
106
107 /*****************************************************************************
108  * SetFormat: set the output format
109  *****************************************************************************/
110 static int SetFormat( aout_instance_t *p_aout )
111 {
112     struct aout_sys_t * p_sys = p_aout->output.p_sys;
113
114     p_sys->b_initialized = VLC_FALSE;
115
116     /* Initialize some variables */
117     p_sys->esd_format = ESD_BITS16 | ESD_STREAM | ESD_PLAY;
118     p_sys->esd_format &= ~ESD_MASK_CHAN;
119
120     switch( p_aout->output.output.i_channels )
121     {
122     case 1:
123         p_sys->esd_format |= ESD_MONO;
124         break;
125     case 2:
126         p_sys->esd_format |= ESD_STEREO;
127         break;
128     default:
129         return -1;
130     }
131
132     /* open a socket for playing a stream
133      * and try to open /dev/dsp if there's no EsounD */
134     p_sys->i_fd = esd_play_stream_fallback( p_sys->esd_format,
135                               p_aout->output.output.i_rate, NULL, "vlc" );
136     if( p_sys->i_fd < 0 )
137     {
138         msg_Err( p_aout, "cannot open esound socket (format 0x%08x at %ld Hz)",
139                          p_sys->esd_format, p_aout->output.output.i_rate );
140         return -1;
141     }
142
143     p_aout->output.output.i_format = AOUT_FMT_S16_NE;
144     p_aout->output.i_nb_samples = DEFAULT_FRAME_SIZE;
145
146     p_sys->b_initialized = VLC_TRUE;
147
148     return 0;
149 }
150
151 /*****************************************************************************
152  * Play: queue a buffer for playing by ESDThread
153  *****************************************************************************/
154 static void Play( aout_instance_t *p_aout, aout_buffer_t * p_buffer )
155 {
156     aout_FifoPush( p_aout, &p_aout->output.fifo, p_buffer );
157 }
158
159 /*****************************************************************************
160  * Close: close the Esound socket
161  *****************************************************************************/
162 static void Close( vlc_object_t *p_this )
163 {
164     aout_instance_t *p_aout = (aout_instance_t *)p_this;
165     struct aout_sys_t * p_sys = p_aout->output.p_sys;
166
167     p_aout->b_die = 1;
168     vlc_thread_join( p_aout );
169
170     close( p_sys->i_fd );
171     free( p_sys );
172 }
173
174 /*****************************************************************************
175  * ESDThread: asynchronous thread used to DMA the data to the device
176  *****************************************************************************/
177 static int ESDThread( aout_instance_t * p_aout )
178 {
179     struct aout_sys_t * p_sys = p_aout->output.p_sys;
180
181     while ( !p_aout->b_die )
182     {
183         aout_buffer_t * p_buffer;
184         mtime_t next_date = 0;
185         int i_tmp, i_size;
186         byte_t * p_bytes;
187
188         if( !p_sys->b_initialized )
189         {
190             msleep( THREAD_SLEEP );
191             continue;
192         }
193
194         if ( p_aout->output.output.i_format != AOUT_FMT_SPDIF )
195         {
196             /* Get the presentation date of the next write() operation. It
197              * is equal to the current date + esd latency */
198             /* FIXME: wtf ? it works better with a - here */
199             next_date = -(mtime_t)esd_get_latency(esd_open_sound(NULL))
200                       * 1000000
201                       / aout_FormatToByterate( &p_aout->output.output,
202                                                p_aout->output.output.i_rate );
203             next_date += mdate();
204         }
205
206         p_buffer = aout_OutputNextBuffer( p_aout, next_date );
207
208         if ( p_buffer != NULL )
209         {
210             p_bytes = p_buffer->p_buffer;
211             i_size = aout_FormatToSize( &p_aout->output.output,
212                                         p_buffer->i_nb_samples );
213         }
214         else
215         {
216             i_size = aout_FormatToSize( &p_aout->output.output,
217                                         DEFAULT_FRAME_SIZE );
218             p_bytes = alloca( i_size );
219             memset( p_bytes, 0, i_size );
220         }
221
222         i_tmp = write( p_sys->i_fd, p_bytes, i_size );
223
224         if( i_tmp < 0 )
225         {
226             msg_Err( p_aout, "write failed (%s)", strerror(errno) );
227         }
228
229         if ( p_buffer != NULL )
230         {
231             aout_BufferFree( p_buffer );
232         }
233     }
234
235     return 0;
236 }
237
238 #if 0
239 /*****************************************************************************
240  * Play: play a sound samples buffer
241  *****************************************************************************
242  * This function writes a buffer of i_length bytes in the socket
243  *****************************************************************************/
244 static void Play( aout_thread_t *p_aout, byte_t *buffer, int i_size )
245 {
246     int i_amount;
247
248     int m1 = p_aout->output.p_sys->esd_format & ESD_STEREO ? 1 : 2;
249     int m2 = p_aout->output.p_sys->esd_format & ESD_BITS16 ? 64 : 128;
250
251     i_amount = (m1 * 44100 * (ESD_BUF_SIZE + m1 * m2)) / p_aout->i_rate;
252
253     write( p_aout->output.p_sys->i_fd, buffer, i_size );
254 }
255 #endif
256