]> git.sesse.net Git - vlc/blobdiff - include/audio_output.h
* ./configure.in: fixed a typo in my previous commit (thx fenrir).
[vlc] / include / audio_output.h
index a8f1d15ecae9dd05f99ca059e3e0bf8bb81dbea7..5814e9bb64500c6a26816ac048ee4627c0314811 100644 (file)
@@ -2,9 +2,10 @@
  * audio_output.h : audio output thread interface
  *****************************************************************************
  * Copyright (C) 1999, 2000 VideoLAN
- * $Id: audio_output.h,v 1.37 2001/05/30 17:03:11 sam Exp $
+ * $Id: audio_output.h,v 1.48 2002/06/01 18:04:48 sam Exp $
  *
  * Authors: Michel Kaempf <maxx@via.ecp.fr>
+ *          Cyril Deguet <asmax@via.ecp.fr>
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  *****************************************************************************/
 
-/*****************************************************************************
- * aout_bank_t, p_aout_bank (global variable)
- *****************************************************************************
- * This global variable is accessed by any function using the audio output.
- *****************************************************************************/
-typedef struct aout_bank_s
-{
-    /* Array to all the audio outputs */
-    struct aout_thread_s *pp_aout[ AOUT_MAX_THREADS ];
-
-    int                    i_count;
-    vlc_mutex_t            lock;  /* Global lock */
-
-} aout_bank_t;
-
-extern aout_bank_t *p_aout_bank;
-
 /*****************************************************************************
  * aout_increment_t
  *****************************************************************************
@@ -49,97 +33,98 @@ typedef struct aout_increment_s
 {
     /* The remainder is used to keep track of the fractional part of the
      * index. */
-    long                l_remainder;
+    int i_r;
 
     /*
      * The increment structure is initialized with the result of an euclidean
      * division :
      *
-     *  l_euclidean_numerator                           l_euclidean_remainder
-     * ----------------------- = l_euclidean_integer + -----------------------
-     * l_euclidean_denominator                         l_euclidean_denominator
+     *  i_x           i_b
+     * ----- = i_a + -----
+     *  i_y           i_c
      *
      */
-    long                l_euclidean_integer;
-    long                l_euclidean_remainder;
-    long                l_euclidean_denominator;
+    int i_a, i_b, i_c;
 
 } aout_increment_t;
 
 /*****************************************************************************
  * aout_fifo_t
  *****************************************************************************/
-typedef struct aout_fifo_s
+struct aout_fifo_s
 {
-    /* See the fifo types below */
-    int                 i_type;
-    boolean_t           b_die;
-    int                 i_fifo;      /* Just to keep track of the fifo index */
-
+    /* See the fifo formats below */
+    int                 i_format;
     int                 i_channels;
-    boolean_t           b_stereo;
-    long                l_rate;
+    int                 i_rate;
+    int                 i_frame_size;
+
+    vlc_bool_t          b_die;
+    int                 i_fifo;      /* Just to keep track of the fifo index */
 
     vlc_mutex_t         data_lock;
     vlc_cond_t          data_wait;
 
-    long                l_frame_size;
-    void *              buffer;
+    u8 *                buffer;
     mtime_t *           date;
+
     /* The start frame is the first frame in the buffer that contains decoded
      * audio data. It it also the first frame in the current timestamped frame
      * area, ie the first dated frame in the decoded part of the buffer. :-p */
-    long                l_start_frame;
-    boolean_t           b_start_frame;
+    int                 i_start_frame;
+    vlc_bool_t          b_start_frame;
     /* The next frame is the end frame of the current timestamped frame area,
      * ie the first dated frame after the start frame. */
-    long                l_next_frame;
-    boolean_t           b_next_frame;
+    int                 i_next_frame;
+    vlc_bool_t          b_next_frame;
     /* The end frame is the first frame, after the start frame, that doesn't
      * contain decoded audio data. That's why the end frame is the first frame
      * where the audio decoder can store its decoded audio frames. */
-    long                l_end_frame;
+    int                 i_end_frame;
 
-    long                l_unit;
+    /* Current index in p_aout->buffer */
+    int                 i_unit;
+    /* Max index in p_aout->buffer */
+    int                 i_unit_limit;
+    /* Structure used to calculate i_unit with a Bresenham algorithm */
     aout_increment_t    unit_increment;
+
     /* The following variable is used to store the number of remaining audio
      * units in the current timestamped frame area. */
-    long                l_units;
-
-} aout_fifo_t;
+    int                 i_units;
+};
 
 #define AOUT_FIFO_ISEMPTY( fifo ) \
-  ( (fifo).l_end_frame == (fifo).l_start_frame )
+  ( (fifo).i_end_frame == (fifo).i_start_frame )
 
 #define AOUT_FIFO_ISFULL( fifo ) \
-  ( ((((fifo).l_end_frame + 1) - (fifo).l_start_frame) & AOUT_FIFO_SIZE) == 0 )
+  ( ((((fifo).i_end_frame + 1) - (fifo).i_start_frame) & AOUT_FIFO_SIZE) == 0 )
+
+#define AOUT_FIFO_INC( i_index ) \
+  ( ((i_index) + 1) & AOUT_FIFO_SIZE )
 
-#define AOUT_EMPTY_FIFO         0
-#define AOUT_INTF_MONO_FIFO     1
-#define AOUT_INTF_STEREO_FIFO   2
-#define AOUT_ADEC_MONO_FIFO     3
-#define AOUT_ADEC_STEREO_FIFO   4
-#define AOUT_ADEC_SPDIF_FIFO    5
+/* List of known fifo formats */
+#define AOUT_FIFO_NONE    0
+#define AOUT_FIFO_PCM     1
+#define AOUT_FIFO_SPDIF   2
 
 /*****************************************************************************
  * aout_thread_t : audio output thread descriptor
  *****************************************************************************/
-typedef struct aout_thread_s
+struct aout_thread_s
 {
-    vlc_thread_t        thread_id;
-    boolean_t           b_die;
-    boolean_t           b_active;
+    VLC_COMMON_MEMBERS
 
     vlc_mutex_t         fifos_lock;
     aout_fifo_t         fifo[ AOUT_MAX_FIFOS ];
 
     /* Plugin used and shortcuts to access its capabilities */
-    struct module_s *   p_module;
-    int              ( *pf_open )       ( p_aout_thread_t );
-    int              ( *pf_setformat )  ( p_aout_thread_t );
-    long             ( *pf_getbufinfo ) ( p_aout_thread_t, long );
-    void             ( *pf_play )       ( p_aout_thread_t, byte_t *, int );
-    void             ( *pf_close )      ( p_aout_thread_t );
+    module_t *   p_module;
+    int       ( *pf_open )       ( aout_thread_t * );
+    int       ( *pf_setformat )  ( aout_thread_t * );
+    int       ( *pf_getbufinfo ) ( aout_thread_t * , int );
+    void      ( *pf_play )       ( aout_thread_t * , byte_t *, int );
+    void      ( *pf_close )      ( aout_thread_t * );
 
     void *              buffer;
     /* The s32 buffer is used to mix all the audio fifos together before
@@ -148,35 +133,29 @@ typedef struct aout_thread_s
 
     /* The size of the audio output buffer is kept in audio units, as this is
      * the only unit that is common with every audio decoder and audio fifo */
-    long                l_units;
-    long                l_msleep;
+    int                 i_units;
 
     /* date is the moment where the first audio unit of the output buffer
      * will be played */
     mtime_t             date;
 
-    /* Path to the audio output device (default is set to "/dev/dsp") */
-    char *              psz_device;
-    int                 i_fd;
-
     /* The current volume */
     int                 i_volume;
     int                 i_savedvolume;
-    /* Format of the audio output samples */
+
+    /* Format of the audio output samples, number of channels, and
+     * rate and gain (in Hz) of the audio output sound */
     int                 i_format;
-    /* Number of channels */
     int                 i_channels;
-    /* Mono or Stereo sound */
-    boolean_t           b_stereo;
-    /* Rate and gain of the audio output sound (in Hz) */
-    long                l_rate;
-    long                l_gain;
+    int                 i_rate;
+
+    /* Latency of the audio output plugin, in bytes */
+    int                 i_latency;
 
     /* there might be some useful private structure, such as audio_buf_info
      * for the OSS output */
-    p_aout_sys_t        p_sys;
-
-} aout_thread_t;
+    aout_sys_t *        p_sys;
+};
 
 /* Those are from <linux/soundcard.h> but are needed because of formats
  * on other platforms */
@@ -203,13 +182,11 @@ typedef struct aout_thread_s
 /*****************************************************************************
  * Prototypes
  *****************************************************************************/
-void            aout_InitBank           ( void );
-void            aout_EndBank            ( void );
-
-aout_thread_t * aout_CreateThread       ( int *pi_status );
-void            aout_DestroyThread      ( aout_thread_t *, int * );
+aout_thread_t * aout_CreateThread       ( vlc_object_t *, int, int );
+void            aout_DestroyThread      ( aout_thread_t * );
 
-aout_fifo_t *   aout_CreateFifo         ( int, int, long, long, long, void * );
-void            aout_DestroyFifo        ( aout_fifo_t *p_fifo );
-void            aout_FreeFifo           ( aout_fifo_t *p_fifo );
+#define aout_CreateFifo(a,b,c,d,e,f) __aout_CreateFifo(CAST_TO_VLC_OBJECT(a),b,c,d,e,f)
+VLC_EXPORT( aout_fifo_t *, __aout_CreateFifo,  ( vlc_object_t *, int, int, int, int, void * ) );
+VLC_EXPORT( void,            aout_DestroyFifo, ( aout_fifo_t *p_fifo ) );
+            void             aout_FreeFifo     ( aout_fifo_t *p_fifo );