libaf/af.h

   1 #ifndef __af_h__
   2 #define __af_h__
   3
   4 #include <stdio.h>
   5
   6 #include "af_mp.h"
   7 #include "config.h"
   8 #include "control.h"
   9 #include "af_format.h"
  10
  11 struct af_instance_s;
  12
  13 // Number of channels
  14 #ifndef AF_NCH
  15 #define AF_NCH 6
  16 #endif
  17
  18 // Audio data chunk
  19 typedef struct af_data_s
  20 {
  21   void* audio;  // data buffer
  22   int len;      // buffer length
  23   int rate;     // sample rate
  24   int nch;      // number of channels
  25   int format;   // format
  26   int bps;      // bytes per sample
  27 } af_data_t;
  28
  29
  30 // Flags used for defining the behavior of an audio filter
  31 #define AF_FLAGS_REENTRANT      0x00000000
  32 #define AF_FLAGS_NOT_REENTRANT  0x00000001
  33
  34 /* Audio filter information not specific for current instance, but for
  35    a specific filter */
  36 typedef struct af_info_s
  37 {
  38   const char *info;
  39   const char *name;
  40   const char *author;
  41   const char *comment;
  42   const int flags;
  43   int (*open)(struct af_instance_s* vf);
  44 } af_info_t;
  45
  46 // Linked list of audio filters
  47 typedef struct af_instance_s
  48 {
  49   af_info_t* info;
  50   int (*control)(struct af_instance_s* af, int cmd, void* arg);
  51   void (*uninit)(struct af_instance_s* af);
  52   af_data_t* (*play)(struct af_instance_s* af, af_data_t* data);
  53   void* setup;    // setup data for this specific instance and filter
  54   af_data_t* data; // configuration for outgoing data stream
  55   struct af_instance_s* next;
  56   struct af_instance_s* prev;
  57   double delay; /* Delay caused by the filter, in units of bytes read without
  58                  * corresponding output */
  59   double mul; /* length multiplier: how much does this instance change
  60                  the length of the buffer. */
  61 }af_instance_t;
  62
  63 // Initialization flags
  64 extern int* af_cpu_speed;
  65
  66 #define AF_INIT_AUTO            0x00000000
  67 #define AF_INIT_SLOW            0x00000001
  68 #define AF_INIT_FAST            0x00000002
  69 #define AF_INIT_FORCE           0x00000003
  70 #define AF_INIT_TYPE_MASK       0x00000003
  71
  72 #define AF_INIT_INT             0x00000000
  73 #define AF_INIT_FLOAT           0x00000004
  74 #define AF_INIT_FORMAT_MASK     0x00000004
  75
  76 // Default init type
  77 #ifndef AF_INIT_TYPE
  78 #if defined(HAVE_SSE) || defined(HAVE_3DNOW)
  79 #define AF_INIT_TYPE (af_cpu_speed?*af_cpu_speed:AF_INIT_FAST)
  80 #else
  81 #define AF_INIT_TYPE (af_cpu_speed?*af_cpu_speed:AF_INIT_SLOW)
  82 #endif
  83 #endif
  84
  85 // Configuration switches
  86 typedef struct af_cfg_s{
  87   int force;    // Initialization type
  88   char** list;  /* list of names of filters that are added to filter
  89                    list during first initialization of stream */
  90 }af_cfg_t;
  91
  92 // Current audio stream
  93 typedef struct af_stream_s
  94 {
  95   // The first and last filter in the list
  96   af_instance_t* first;
  97   af_instance_t* last;
  98   // Storage for input and output data formats
  99   af_data_t input;
 100   af_data_t output;
 101   // Configuration for this stream
 102   af_cfg_t cfg;
 103 }af_stream_t;
 104
 105 /*********************************************
 106 // Return values
 107 */
 108
 109 #define AF_DETACH   2
 110 #define AF_OK       1
 111 #define AF_TRUE     1
 112 #define AF_FALSE    0
 113 #define AF_UNKNOWN -1
 114 #define AF_ERROR   -2
 115 #define AF_FATAL   -3
 116
 117
 118
 119 /*********************************************
 120 // Export functions
 121 */
 122
 123 /**
 124  * \defgroup af_chain Audio filter chain functions
 125  * \{
 126  * \param s filter chain
 127  */
 128
 129 /**
 130  * \brief Initialize the stream "s".
 131  * \return 0 on success, -1 on failure
 132  *
 133  * This function creates a new filter list if necessary, according
 134  * to the values set in input and output. Input and output should contain
 135  * the format of the current movie and the format of the preferred output
 136  * respectively.
 137  * Filters to convert to the preferred output format are inserted
 138  * automatically, except when they are set to 0.
 139  * The function is reentrant i.e. if called with an already initialized
 140  * stream the stream will be reinitialized.
 141  */
 142 int af_init(af_stream_t* s);
 143
 144 /**
 145  * \brief Uninit and remove all filters from audio filter chain
 146  */
 147 void af_uninit(af_stream_t* s);
 148
 149 /**
 150  * \brief This function adds the filter "name" to the stream s.
 151  * \param name name of filter to add
 152  * \return pointer to the new filter, NULL if insert failed
 153  *
 154  * The filter will be inserted somewhere nice in the
 155  * list of filters (i.e. at the beginning unless the
 156  * first filter is the format filter (why??).
 157  */
 158 af_instance_t* af_add(af_stream_t* s, char* name);
 159
 160 /**
 161  * \brief Uninit and remove the filter "af"
 162  * \param af filter to remove
 163  */
 164 void af_remove(af_stream_t* s, af_instance_t* af);
 165
 166 /**
 167  * \brief find filter in chain by name
 168  * \param name name of the filter to find
 169  * \return first filter with right name or NULL if not found
 170  *
 171  * This function is used for finding already initialized filters
 172  */
 173 af_instance_t* af_get(af_stream_t* s, char* name);
 174
 175 /**
 176  * \brief filter data chunk through the filters in the list
 177  * \param data data to play
 178  * \return resulting data
 179  * \ingroup af_chain
 180  */
 181 af_data_t* af_play(af_stream_t* s, af_data_t* data);
 182
 183 /**
 184  * \brief send control to all filters, starting with the last until
 185  *        one accepts the command with AF_OK.
 186  * \param cmd filter control command
 187  * \param arg argument for filter command
 188  * \return the accepting filter or NULL if none was found
 189  */
 190 af_instance_t *af_control_any_rev (af_stream_t* s, int cmd, void* arg);
 191
 192 /**
 193  * \brief calculate average ratio of filter output lenth to input length
 194  * \return the ratio
 195  */
 196 double af_calc_filter_multiplier(af_stream_t* s);
 197
 198 /**
 199  * \brief Calculate the total delay caused by the filters
 200  * \return delay in bytes of "missing" output
 201  */
 202 double af_calc_delay(af_stream_t* s);
 203
 204 /** \} */ // end of af_chain group
 205
 206 // Helper functions and macros used inside the audio filters
 207
 208 /**
 209  * \defgroup af_filter Audio filter helper functions
 210  * \{
 211  */
 212
 213 /* Helper function called by the macro with the same name only to be
 214    called from inside filters */
 215 int af_resize_local_buffer(af_instance_t* af, af_data_t* data);
 216
 217 /* Helper function used to calculate the exact buffer length needed
 218    when buffers are resized. The returned length is >= than what is
 219    needed */
 220 int af_lencalc(double mul, af_data_t* data);
 221
 222 /**
 223  * \brief convert dB to gain value
 224  * \param n number of values to convert
 225  * \param in [in] values in dB, <= -200 will become 0 gain
 226  * \param out [out] gain values
 227  * \param k input values are divided by this
 228  * \param mi minimum dB value, input will be clamped to this
 229  * \param ma maximum dB value, input will be clamped to this
 230  * \return AF_ERROR on error, AF_OK otherwise
 231  */
 232 int af_from_dB(int n, float* in, float* out, float k, float mi, float ma);
 233
 234 /**
 235  * \brief convert gain value to dB
 236  * \param n number of values to convert
 237  * \param in [in] gain values, 0 wil become -200 dB
 238  * \param out [out] values in dB
 239  * \param k output values will be multiplied by this
 240  * \return AF_ERROR on error, AF_OK otherwise
 241  */
 242 int af_to_dB(int n, float* in, float* out, float k);
 243
 244 /**
 245  * \brief convert milliseconds to sample time
 246  * \param n number of values to convert
 247  * \param in [in] values in milliseconds
 248  * \param out [out] sample time values
 249  * \param rate sample rate
 250  * \param mi minimum ms value, input will be clamped to this
 251  * \param ma maximum ms value, input will be clamped to this
 252  * \return AF_ERROR on error, AF_OK otherwise
 253  */
 254 int af_from_ms(int n, float* in, int* out, int rate, float mi, float ma);
 255
 256 /**
 257  * \brief convert sample time to milliseconds
 258  * \param n number of values to convert
 259  * \param in [in] sample time values
 260  * \param out [out] values in milliseconds
 261  * \param rate sample rate
 262  * \return AF_ERROR on error, AF_OK otherwise
 263  */
 264 int af_to_ms(int n, int* in, float* out, int rate);
 265
 266 /**
 267  * \brief test if output format matches
 268  * \param af audio filter
 269  * \param out needed format, will be overwritten by available
 270  *            format if they do not match
 271  * \return AF_FALSE if formats do not match, AF_OK if they match
 272  *
 273  * compares the format, bps, rate and nch values of af->data with out
 274  */
 275 int af_test_output(struct af_instance_s* af, af_data_t* out);
 276
 277 /**
 278  * \brief soft clipping function using sin()
 279  * \param a input value
 280  * \return clipped value
 281  */
 282 float af_softclip(float a);
 283
 284 /** \} */ // end of af_filter group, but more functions of this group below
 285
 286 /** Print a list of all available audio filters */
 287 void af_help(void);
 288
 289 /**
 290  * \brief fill the missing parameters in the af_data_t structure
 291  * \param data structure to fill
 292  * \ingroup af_filter
 293  *
 294  * Currently only sets bps based on format
 295  */
 296 void af_fix_parameters(af_data_t *data);
 297
 298 /** Memory reallocation macro: if a local buffer is used (i.e. if the
 299    filter doesn't operate on the incoming buffer this macro must be
 300    called to ensure the buffer is big enough.
 301  * \ingroup af_filter
 302  */
 303 #define RESIZE_LOCAL_BUFFER(a,d)\
 304 ((a->data->len < af_lencalc(a->mul,d))?af_resize_local_buffer(a,d):AF_OK)
 305
 306 /* Some other useful macro definitions*/
 307 #ifndef min
 308 #define min(a,b)(((a)>(b))?(b):(a))
 309 #endif
 310
 311 #ifndef max
 312 #define max(a,b)(((a)>(b))?(a):(b))
 313 #endif
 314
 315 #ifndef clamp
 316 #define clamp(a,min,max) (((a)>(max))?(max):(((a)<(min))?(min):(a)))
 317 #endif
 318
 319 #ifndef sign
 320 #define sign(a) (((a)>0)?(1):(-1))
 321 #endif
 322
 323 #ifndef lrnd
 324 #define lrnd(a,b) ((b)((a)>=0.0?(a)+0.5:(a)-0.5))
 325 #endif
 326
 327 /* Error messages */
 328
 329 typedef struct af_msg_cfg_s
 330 {
 331   int level;    /* Message level for debug and error messages max = 2
 332                    min = -2 default = 0 */
 333   FILE* err;    // Stream to print error messages to
 334   FILE* msg;    // Stream to print information messages to
 335 }af_msg_cfg_t;
 336
 337 extern af_msg_cfg_t af_msg_cfg; // Message
 338
 339 //! \addtogroup af_filter
 340 //! \{
 341 #define AF_MSG_FATAL    -3 ///< Fatal error exit immediately
 342 #define AF_MSG_ERROR    -2 ///< Error return gracefully
 343 #define AF_MSG_WARN     -1 ///< Print warning but do not exit (can be suppressed)
 344 #define AF_MSG_INFO      0 ///< Important information
 345 #define AF_MSG_VERBOSE   1 ///< Print this if verbose is enabled
 346 #define AF_MSG_DEBUG0    2 ///< Print if very verbose
 347 #define AF_MSG_DEBUG1    3 ///< Print if very very verbose
 348
 349 //! Macro for printing error messages
 350 #ifndef af_msg
 351 #define af_msg(lev, args... ) \
 352 (((lev)<AF_MSG_WARN)?(fprintf(af_msg_cfg.err?af_msg_cfg.err:stderr, ## args )): \
 353 (((lev)<=af_msg_cfg.level)?(fprintf(af_msg_cfg.msg?af_msg_cfg.msg:stdout, ## args )):0))
 354 #endif
 355 //! \}
 356
 357 #endif /* __af_h__ */