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.31 2002/11/11 14:39:11 sam 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 #ifdef HAVE_ALLOCA
  38 #   define ALLOCA_TEST( p_alloc, p_new_buffer )                             \
  39         if ( (p_alloc)->i_alloc_type == AOUT_ALLOC_STACK )                  \
  40         {                                                                   \
  41             (p_new_buffer) = alloca( i_alloc_size + sizeof(aout_buffer_t) );\
  42         }                                                                   \
  43         else
  44 #else
  45 #   define ALLOCA_TEST( p_alloc, p_new_buffer )
  46 #endif
  47
  48 #define aout_BufferAlloc( p_alloc, i_nb_usec, p_previous_buffer,            \
  49                           p_new_buffer )                                    \
  50     if ( (p_alloc)->i_alloc_type == AOUT_ALLOC_NONE )                       \
  51     {                                                                       \
  52         (p_new_buffer) = p_previous_buffer;                                 \
  53     }                                                                       \
  54     else                                                                    \
  55     {                                                                       \
  56         int i_alloc_size;                                                   \
  57         i_alloc_size = (uint64_t)(p_alloc)->i_bytes_per_sec                 \
  58                                             * (i_nb_usec) / 1000000 + 1;    \
  59         ALLOCA_TEST( p_alloc, p_new_buffer )                                \
  60         {                                                                   \
  61             (p_new_buffer) = malloc( i_alloc_size + sizeof(aout_buffer_t) );\
  62         }                                                                   \
  63         if ( p_new_buffer != NULL )                                         \
  64         {                                                                   \
  65             (p_new_buffer)->i_alloc_type = (p_alloc)->i_alloc_type;         \
  66             (p_new_buffer)->i_size = i_alloc_size;                          \
  67             (p_new_buffer)->p_buffer = (byte_t *)(p_new_buffer)             \
  68                                          + sizeof(aout_buffer_t);           \
  69             if ( (p_previous_buffer) != NULL )                              \
  70             {                                                               \
  71                 (p_new_buffer)->start_date =                                \
  72                            ((aout_buffer_t *)p_previous_buffer)->start_date;\
  73                 (p_new_buffer)->end_date =                                  \
  74                            ((aout_buffer_t *)p_previous_buffer)->end_date;  \
  75             }                                                               \
  76         }                                                                   \
  77         /* we'll keep that for a while --Meuuh */                           \
  78         /* else printf("%s:%d\n", __FILE__, __LINE__); */                   \
  79     }
  80
  81 #define aout_BufferFree( p_buffer )                                         \
  82     if ( (p_buffer)->i_alloc_type == AOUT_ALLOC_HEAP )                      \
  83     {                                                                       \
  84         free( p_buffer );                                                   \
  85     }
  86
  87 /*****************************************************************************
  88  * aout_fifo_t : audio output buffer FIFO
  89  *****************************************************************************/
  90 struct aout_fifo_t
  91 {
  92     aout_buffer_t *         p_first;
  93     aout_buffer_t **        pp_last;
  94     audio_date_t            end_date;
  95 };
  96
  97 /*****************************************************************************
  98  * aout_filter_t : audio output filter
  99  *****************************************************************************/
 100 typedef struct aout_filter_t
 101 {
 102     VLC_COMMON_MEMBERS
 103
 104     audio_sample_format_t   input;
 105     audio_sample_format_t   output;
 106     aout_alloc_t            output_alloc;
 107
 108     module_t *              p_module;
 109     struct aout_filter_sys_t * p_sys;
 110     void                 (* pf_do_work)( struct aout_instance_t *,
 111                                          struct aout_filter_t *,
 112                                          struct aout_buffer_t *,
 113                                          struct aout_buffer_t * );
 114     vlc_bool_t              b_in_place;
 115 } aout_filter_t;
 116
 117 /*****************************************************************************
 118  * aout_mixer_t : audio output mixer
 119  *****************************************************************************/
 120 typedef struct aout_mixer_t
 121 {
 122     audio_sample_format_t   mixer;
 123     aout_alloc_t            output_alloc;
 124
 125     module_t *              p_module;
 126     struct aout_mixer_sys_t * p_sys;
 127     void                 (* pf_do_work)( struct aout_instance_t *,
 128                                          struct aout_buffer_t * );
 129
 130     /* If b_error == 1, there is no mixer nor audio output pipeline. */
 131     vlc_bool_t              b_error;
 132     /* Multiplier used to raise or lower the volume of the sound in
 133      * software. Beware, this creates sound distortion and should be avoided
 134      * as much as possible. This isn't available for non-float32 mixer. */
 135     float                   f_multiplier;
 136 } aout_mixer_t;
 137
 138 /*****************************************************************************
 139  * aout_input_t : input stream for the audio output
 140  *****************************************************************************/
 141 #define AOUT_RESAMPLING_NONE     0
 142 #define AOUT_RESAMPLING_UP       1
 143 #define AOUT_RESAMPLING_DOWN     2
 144 struct aout_input_t
 145 {
 146     /* When this lock is taken, the pipeline cannot be changed by a
 147      * third-party. */
 148     vlc_mutex_t             lock;
 149
 150     audio_sample_format_t   input;
 151     aout_alloc_t            input_alloc;
 152
 153     /* pre-filters */
 154     aout_filter_t *         pp_filters[AOUT_MAX_FILTERS];
 155     int                     i_nb_filters;
 156
 157     /* resamplers */
 158     aout_filter_t *         pp_resamplers[AOUT_MAX_FILTERS];
 159     int                     i_nb_resamplers;
 160     int                     i_resampling_type;
 161     mtime_t                 i_resamp_start_date;
 162     int                     i_resamp_start_drift;
 163
 164     aout_fifo_t             fifo;
 165
 166     /* Mixer information */
 167     byte_t *                p_first_byte_to_mix;
 168
 169     /* If b_error == 1, there is no input pipeline. */
 170     vlc_bool_t              b_error;
 171     /* Did we just change the output format ? (expect buffer inconsistencies) */
 172     vlc_bool_t              b_changed;
 173 };
 174
 175 /*****************************************************************************
 176  * aout_output_t : output stream for the audio output
 177  *****************************************************************************/
 178 typedef struct aout_output_t
 179 {
 180     audio_sample_format_t   output;
 181     /* Indicates whether the audio output is currently starving, to avoid
 182      * printing a 1,000 "output is starving" messages. */
 183     vlc_bool_t              b_starving;
 184
 185     /* post-filters */
 186     aout_filter_t *         pp_filters[AOUT_MAX_FILTERS];
 187     int                     i_nb_filters;
 188
 189     aout_fifo_t             fifo;
 190
 191     struct module_t *       p_module;
 192     struct aout_sys_t *     p_sys;
 193     void                 (* pf_play)( aout_instance_t * );
 194     int                  (* pf_volume_get )( aout_instance_t *, audio_volume_t * );
 195     int                  (* pf_volume_set )( aout_instance_t *, audio_volume_t );
 196     int                  (* pf_volume_infos )( aout_instance_t *, audio_volume_t * );
 197     int                     i_nb_samples;
 198
 199     /* Current volume for the output - it's just a placeholder, the plug-in
 200      * may or may not use it. */
 201     audio_volume_t          i_volume;
 202 } aout_output_t;
 203
 204 /*****************************************************************************
 205  * aout_instance_t : audio output thread descriptor
 206  *****************************************************************************/
 207 struct aout_instance_t
 208 {
 209     VLC_COMMON_MEMBERS
 210
 211     /* Locks : please note that if you need several of these locks, it is
 212      * mandatory (to avoid deadlocks) to take them in the following order :
 213      * mixer_lock, p_input->lock, output_fifo_lock, input_fifos_lock.
 214      * --Meuuh */
 215     /* When input_fifos_lock is taken, none of the p_input->fifo structures
 216      * can be read or modified by a third-party thread. */
 217     vlc_mutex_t             input_fifos_lock;
 218     /* When mixer_lock is taken, all decoder threads willing to mix a
 219      * buffer must wait until it is released. The output pipeline cannot
 220      * be modified. No input stream can be added or removed. */
 221     vlc_mutex_t             mixer_lock;
 222     /* When output_fifo_lock is taken, the p_aout->output.fifo structure
 223      * cannot be read or written  by a third-party thread. */
 224     vlc_mutex_t             output_fifo_lock;
 225
 226     /* Input streams & pre-filters */
 227     aout_input_t *          pp_inputs[AOUT_MAX_INPUTS];
 228     int                     i_nb_inputs;
 229
 230     /* Mixer */
 231     aout_mixer_t            mixer;
 232
 233     /* Output plug-in */
 234     aout_output_t           output;
 235 };
 236
 237 /*****************************************************************************
 238  * Prototypes
 239  *****************************************************************************/
 240 /* From input.c : */
 241 int aout_InputNew( aout_instance_t * p_aout, aout_input_t * p_input );
 242 int aout_InputDelete( aout_instance_t * p_aout, aout_input_t * p_input );
 243 int aout_InputPlay( aout_instance_t * p_aout, aout_input_t * p_input,
 244                     aout_buffer_t * p_buffer );
 245
 246 /* From filters.c : */
 247 int aout_FiltersCreatePipeline( aout_instance_t * p_aout,
 248                                 aout_filter_t ** pp_filters,
 249                                 int * pi_nb_filters,
 250                                 const audio_sample_format_t * p_input_format,
 251                                 const audio_sample_format_t * p_output_format );
 252 void aout_FiltersDestroyPipeline( aout_instance_t * p_aout,
 253                                   aout_filter_t ** pp_filters,
 254                                   int i_nb_filters );
 255 void aout_FiltersHintBuffers( aout_instance_t * p_aout,
 256                               aout_filter_t ** pp_filters,
 257                               int i_nb_filters, aout_alloc_t * p_first_alloc );
 258 void aout_FiltersPlay( aout_instance_t * p_aout,
 259                        aout_filter_t ** pp_filters,
 260                        int i_nb_filters, aout_buffer_t ** pp_input_buffer );
 261
 262 /* From mixer.c : */
 263 int aout_MixerNew( aout_instance_t * p_aout );
 264 int aout_MixerDelete( aout_instance_t * p_aout );
 265 void aout_MixerRun( aout_instance_t * p_aout );
 266 int aout_MixerMultiplierSet( aout_instance_t * p_aout, float f_multiplier );
 267 int aout_MixerMultiplierGet( aout_instance_t * p_aout, float * pf_multiplier );
 268
 269 /* From output.c : */
 270 int aout_OutputNew( aout_instance_t * p_aout,
 271                     audio_sample_format_t * p_format );
 272 void aout_OutputPlay( aout_instance_t * p_aout, aout_buffer_t * p_buffer );
 273 void aout_OutputDelete( aout_instance_t * p_aout );
 274 VLC_EXPORT( aout_buffer_t *, aout_OutputNextBuffer, ( aout_instance_t *, mtime_t, vlc_bool_t ) );
 275
 276 /* From common.c : */
 277 VLC_EXPORT( int, aout_FormatNbChannels, ( audio_sample_format_t * p_format ) );
 278 VLC_EXPORT( void, aout_FormatPrepare, ( audio_sample_format_t * p_format ) );
 279 VLC_EXPORT( void, aout_FormatPrint, ( aout_instance_t * p_aout, const char * psz_text, const audio_sample_format_t * p_format ) );
 280 VLC_EXPORT( void, aout_FormatsPrint, ( aout_instance_t * p_aout, const char * psz_text, const audio_sample_format_t * p_format1, const audio_sample_format_t * p_format2 ) );
 281 void aout_FifoInit( aout_instance_t *, aout_fifo_t *, uint32_t );
 282 mtime_t aout_FifoNextStart( aout_instance_t *, aout_fifo_t * );
 283 void aout_FifoPush( aout_instance_t *, aout_fifo_t *, aout_buffer_t * );
 284 void aout_FifoSet( aout_instance_t *, aout_fifo_t *, mtime_t );
 285 void aout_FifoMoveDates( aout_instance_t *, aout_fifo_t *, mtime_t );
 286 VLC_EXPORT( aout_buffer_t *, aout_FifoPop, ( aout_instance_t * p_aout, aout_fifo_t * p_fifo ) );
 287 void aout_FifoDestroy( aout_instance_t * p_aout, aout_fifo_t * p_fifo );
 288 VLC_EXPORT( mtime_t, aout_FifoFirstDate, ( aout_instance_t *, aout_fifo_t * ) );
 289
 290 /* From intf.c :*/
 291 VLC_EXPORT( void, aout_VolumeSoftInit, ( aout_instance_t * ) );
 292 int aout_VolumeSoftGet( aout_instance_t *, audio_volume_t * );
 293 int aout_VolumeSoftSet( aout_instance_t *, audio_volume_t );
 294 int aout_VolumeSoftInfos( aout_instance_t *, audio_volume_t * );
 295 VLC_EXPORT( void, aout_VolumeNoneInit, ( aout_instance_t * ) );
 296 int aout_VolumeNoneGet( aout_instance_t *, audio_volume_t * );
 297 int aout_VolumeNoneSet( aout_instance_t *, audio_volume_t );
 298 int aout_VolumeNoneInfos( aout_instance_t *, audio_volume_t * );
 299