git.sesse.net Git - vlc/blob - include/aout_internal.h

   1 /*****************************************************************************
   2  * aout_internal.h : internal defines for audio output
   3  *****************************************************************************
   4  * Copyright (C) 2002 VideoLAN
   5  * $Id: aout_internal.h,v 1.16 2002/09/06 23:15:44 massiot Exp $
   6  *
   7  * Authors: Christophe Massiot <massiot@via.ecp.fr>
   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  * aout_alloc_t : allocation of memory in the audio output
  26  *****************************************************************************/
  27 typedef struct aout_alloc_t
  28 {
  29     int                     i_alloc_type;
  30     int                     i_bytes_per_sec;
  31 } aout_alloc_t;
  32
  33 #define AOUT_ALLOC_NONE     0
  34 #define AOUT_ALLOC_STACK    1
  35 #define AOUT_ALLOC_HEAP     2
  36
  37 #define aout_BufferAlloc( p_alloc, i_nb_usec, p_previous_buffer,            \
  38                           p_new_buffer )                                    \
  39     if ( (p_alloc)->i_alloc_type == AOUT_ALLOC_NONE )                       \
  40     {                                                                       \
  41         (p_new_buffer) = p_previous_buffer;                                 \
  42     }                                                                       \
  43     else                                                                    \
  44     {                                                                       \
  45         int i_alloc_size;                                                   \
  46         i_alloc_size = (u64)(p_alloc)->i_bytes_per_sec                      \
  47                                             * (i_nb_usec) / 1000000 + 1;    \
  48         if ( (p_alloc)->i_alloc_type == AOUT_ALLOC_STACK )                  \
  49         {                                                                   \
  50             (p_new_buffer) = alloca( i_alloc_size + sizeof(aout_buffer_t) );\
  51         }                                                                   \
  52         else                                                                \
  53         {                                                                   \
  54             (p_new_buffer) = malloc( i_alloc_size + sizeof(aout_buffer_t) );\
  55         }                                                                   \
  56         if ( p_new_buffer != NULL )                                         \
  57         {                                                                   \
  58             (p_new_buffer)->i_alloc_type = (p_alloc)->i_alloc_type;         \
  59             (p_new_buffer)->i_size = i_alloc_size;                          \
  60             (p_new_buffer)->p_buffer = (byte_t *)(p_new_buffer)             \
  61                                          + sizeof(aout_buffer_t);           \
  62             if ( (p_previous_buffer) != NULL )                              \
  63             {                                                               \
  64                 (p_new_buffer)->start_date =                                \
  65                            ((aout_buffer_t *)p_previous_buffer)->start_date;\
  66                 (p_new_buffer)->end_date =                                  \
  67                            ((aout_buffer_t *)p_previous_buffer)->end_date;  \
  68             }                                                               \
  69         }                                                                   \
  70         /* we'll keep that for a while --Meuuh */                           \
  71         /* else printf("%s:%d\n", __FILE__, __LINE__); */                   \
  72     }
  73
  74 #define aout_BufferFree( p_buffer )                                         \
  75     if ( (p_buffer)->i_alloc_type == AOUT_ALLOC_HEAP )                      \
  76     {                                                                       \
  77         free( p_buffer );                                                   \
  78     }
  79
  80 /*****************************************************************************
  81  * aout_fifo_t : audio output buffer FIFO
  82  *****************************************************************************/
  83 struct aout_fifo_t
  84 {
  85     aout_buffer_t *         p_first;
  86     aout_buffer_t **        pp_last;
  87     audio_date_t            end_date;
  88 };
  89
  90 /*****************************************************************************
  91  * aout_filter_t : audio output filter
  92  *****************************************************************************/
  93 typedef struct aout_filter_t
  94 {
  95     VLC_COMMON_MEMBERS
  96
  97     audio_sample_format_t   input;
  98     audio_sample_format_t   output;
  99     aout_alloc_t            output_alloc;
 100
 101     module_t *              p_module;
 102     struct aout_filter_sys_t * p_sys;
 103     void                 (* pf_do_work)( struct aout_instance_t *,
 104                                          struct aout_filter_t *,
 105                                          struct aout_buffer_t *,
 106                                          struct aout_buffer_t * );
 107     vlc_bool_t              b_in_place;
 108 } aout_filter_t;
 109
 110 /*****************************************************************************
 111  * aout_mixer_t : audio output mixer
 112  *****************************************************************************/
 113 typedef struct aout_mixer_t
 114 {
 115     audio_sample_format_t   mixer;
 116     aout_alloc_t            output_alloc;
 117
 118     module_t *              p_module;
 119     struct aout_mixer_sys_t * p_sys;
 120     void                 (* pf_do_work)( struct aout_instance_t *,
 121                                          struct aout_buffer_t * );
 122 } aout_mixer_t;
 123
 124 /*****************************************************************************
 125  * aout_input_t : input stream for the audio output
 126  *****************************************************************************/
 127 struct aout_input_t
 128 {
 129     /* When this lock is taken, the pipeline cannot be changed by a
 130      * third-party. */
 131     vlc_mutex_t             lock;
 132
 133     audio_sample_format_t   input;
 134     aout_alloc_t            input_alloc;
 135
 136     /* pre-filters */
 137     aout_filter_t *         pp_filters[AOUT_MAX_FILTERS];
 138     int                     i_nb_filters;
 139
 140     aout_fifo_t             fifo;
 141
 142     /* Mixer information */
 143     byte_t *                p_first_byte_to_mix;
 144 };
 145
 146 /*****************************************************************************
 147  * aout_output_t : output stream for the audio output
 148  *****************************************************************************/
 149 typedef struct aout_output_t
 150 {
 151     audio_sample_format_t   output;
 152
 153     /* post-filters */
 154     aout_filter_t *         pp_filters[AOUT_MAX_FILTERS];
 155     int                     i_nb_filters;
 156
 157     aout_fifo_t             fifo;
 158
 159     struct module_t *       p_module;
 160     struct aout_sys_t *     p_sys;
 161     void                 (* pf_play)( aout_instance_t * );
 162     int                     i_nb_samples;
 163 } aout_output_t;
 164
 165 /*****************************************************************************
 166  * aout_instance_t : audio output thread descriptor
 167  *****************************************************************************/
 168 struct aout_instance_t
 169 {
 170     VLC_COMMON_MEMBERS
 171
 172     /* Locks : please note that if you need several of these locks, it is
 173      * mandatory (to avoid deadlocks) to take them in the following order :
 174      * p_input->lock, mixer_lock, output_fifo_lock, input_fifos_lock.
 175      * --Meuuh */
 176     /* When input_fifos_lock is taken, none of the p_input->fifo structures
 177      * can be read or modified by a third-party thread. */
 178     vlc_mutex_t             input_fifos_lock;
 179     /* When mixer_lock is taken, all decoder threads willing to mix a
 180      * buffer must wait until it is released. The output pipeline cannot
 181      * be modified. No input stream can be added or removed. */
 182     vlc_mutex_t             mixer_lock;
 183     /* When output_fifo_lock is taken, the p_aout->output.fifo structure
 184      * cannot be read or written  by a third-party thread. */
 185     vlc_mutex_t             output_fifo_lock;
 186
 187     /* Input streams & pre-filters */
 188     aout_input_t *          pp_inputs[AOUT_MAX_INPUTS];
 189     int                     i_nb_inputs;
 190
 191     /* Mixer */
 192     aout_mixer_t            mixer;
 193
 194     /* Output plug-in */
 195     aout_output_t           output;
 196 };
 197
 198 /*****************************************************************************
 199  * Prototypes
 200  *****************************************************************************/
 201 void aout_InputPlay( aout_instance_t * p_aout, aout_input_t * p_input,
 202                      aout_buffer_t * p_buffer );
 203
 204 int aout_FiltersCreatePipeline( aout_instance_t * p_aout,
 205                                 aout_filter_t ** pp_filters,
 206                                 int * pi_nb_filters,
 207                                 const audio_sample_format_t * p_input_format,
 208                                 const audio_sample_format_t * p_output_format );
 209 void aout_FiltersDestroyPipeline( aout_instance_t * p_aout,
 210                                   aout_filter_t ** pp_filters,
 211                                   int i_nb_filters );
 212 void aout_FiltersHintBuffers( aout_instance_t * p_aout,
 213                               aout_filter_t ** pp_filters,
 214                               int i_nb_filters, aout_alloc_t * p_first_alloc );
 215 void aout_FiltersPlay( aout_instance_t * p_aout,
 216                        aout_filter_t ** pp_filters,
 217                        int i_nb_filters, aout_buffer_t ** pp_input_buffer );
 218
 219 int aout_MixerNew( aout_instance_t * p_aout );
 220 void aout_MixerDelete( aout_instance_t * p_aout );
 221 void aout_MixerRun( aout_instance_t * p_aout );
 222
 223 int aout_OutputNew( aout_instance_t * p_aout,
 224                     audio_sample_format_t * p_format );
 225 void aout_OutputPlay( aout_instance_t * p_aout, aout_buffer_t * p_buffer );
 226 void aout_OutputDelete( aout_instance_t * p_aout );
 227 VLC_EXPORT( aout_buffer_t *, aout_OutputNextBuffer, ( aout_instance_t *, mtime_t, vlc_bool_t ) );
 228
 229 VLC_EXPORT( int, aout_FormatNbChannels, ( audio_sample_format_t * p_format ) );
 230 void aout_FormatPrepare( audio_sample_format_t * p_format );
 231 void aout_FifoInit( aout_instance_t *, aout_fifo_t *, u32 );
 232 mtime_t aout_FifoNextStart( aout_instance_t *, aout_fifo_t * );
 233 void aout_FifoPush( aout_instance_t *, aout_fifo_t *, aout_buffer_t * );
 234 void aout_FifoSet( aout_instance_t *, aout_fifo_t *, mtime_t );
 235 void aout_FifoMoveDates( aout_instance_t *, aout_fifo_t *, mtime_t );
 236 VLC_EXPORT( aout_buffer_t *, aout_FifoPop, ( aout_instance_t * p_aout, aout_fifo_t * p_fifo ) );
 237 void aout_FifoDestroy( aout_instance_t * p_aout, aout_fifo_t * p_fifo );
 238