annotate libaf/af.h @ 32594:24e4682ce6ec

Fix spelling in comment.
author reimar
date Sat, 11 Dec 2010 13:56:19 +0000
parents 71a04d45357c
children a93891202051
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
28229
72d0b1444141 Replace informal license notices by standard license header
diego
parents: 26203
diff changeset
1 /*
72d0b1444141 Replace informal license notices by standard license header
diego
parents: 26203
diff changeset
2 * This file is part of MPlayer.
72d0b1444141 Replace informal license notices by standard license header
diego
parents: 26203
diff changeset
3 *
72d0b1444141 Replace informal license notices by standard license header
diego
parents: 26203
diff changeset
4 * MPlayer is free software; you can redistribute it and/or modify
72d0b1444141 Replace informal license notices by standard license header
diego
parents: 26203
diff changeset
5 * it under the terms of the GNU General Public License as published by
72d0b1444141 Replace informal license notices by standard license header
diego
parents: 26203
diff changeset
6 * the Free Software Foundation; either version 2 of the License, or
72d0b1444141 Replace informal license notices by standard license header
diego
parents: 26203
diff changeset
7 * (at your option) any later version.
72d0b1444141 Replace informal license notices by standard license header
diego
parents: 26203
diff changeset
8 *
72d0b1444141 Replace informal license notices by standard license header
diego
parents: 26203
diff changeset
9 * MPlayer is distributed in the hope that it will be useful,
72d0b1444141 Replace informal license notices by standard license header
diego
parents: 26203
diff changeset
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
72d0b1444141 Replace informal license notices by standard license header
diego
parents: 26203
diff changeset
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
72d0b1444141 Replace informal license notices by standard license header
diego
parents: 26203
diff changeset
12 * GNU General Public License for more details.
72d0b1444141 Replace informal license notices by standard license header
diego
parents: 26203
diff changeset
13 *
72d0b1444141 Replace informal license notices by standard license header
diego
parents: 26203
diff changeset
14 * You should have received a copy of the GNU General Public License along
72d0b1444141 Replace informal license notices by standard license header
diego
parents: 26203
diff changeset
15 * with MPlayer; if not, write to the Free Software Foundation, Inc.,
72d0b1444141 Replace informal license notices by standard license header
diego
parents: 26203
diff changeset
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
72d0b1444141 Replace informal license notices by standard license header
diego
parents: 26203
diff changeset
17 */
72d0b1444141 Replace informal license notices by standard license header
diego
parents: 26203
diff changeset
18
26029
4129c8cfa742 Add MPLAYER_ prefix to multiple inclusion guards.
diego
parents: 25551
diff changeset
19 #ifndef MPLAYER_AF_H
4129c8cfa742 Add MPLAYER_ prefix to multiple inclusion guards.
diego
parents: 25551
diff changeset
20 #define MPLAYER_AF_H
12676
alex
parents: 12668
diff changeset
21
8167
e8832e66babd New features:
anders
parents: 8073
diff changeset
22 #include <stdio.h>
e8832e66babd New features:
anders
parents: 8073
diff changeset
23
29052
048aea3d4c2c Move config.h include directive up as a precaution measure.
bircoph
parents: 29051
diff changeset
24 #include "config.h"
048aea3d4c2c Move config.h include directive up as a precaution measure.
bircoph
parents: 29051
diff changeset
25
29051
6e6ce522142b Reorder includes alphabetically.
bircoph
parents: 29050
diff changeset
26 #include "af_format.h"
7745
1d3a3dc1f488 Adding volume control and moving control() call parameters to a seperate file
anders
parents: 7665
diff changeset
27 #include "control.h"
29051
6e6ce522142b Reorder includes alphabetically.
bircoph
parents: 29050
diff changeset
28 #include "cpudetect.h"
29049
8c706ce21c6f Remove af_msg special-casing API in libaf.
bircoph
parents: 28335
diff changeset
29 #include "mp_msg.h"
29050
ed5581922f0c Remove af_mp.h and add its content to af.h
bircoph
parents: 29049
diff changeset
30
7568
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
31 struct af_instance_s;
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
32
21233
0b17f818d393 Remove config.h and move its content to af.h. There are multiple files under
diego
parents: 21232
diff changeset
33 // Number of channels
0b17f818d393 Remove config.h and move its content to af.h. There are multiple files under
diego
parents: 21232
diff changeset
34 #ifndef AF_NCH
29826
4eae69f3f4f4 Add support for 8 channel audio.
tack
parents: 29263
diff changeset
35 #define AF_NCH 8
21233
0b17f818d393 Remove config.h and move its content to af.h. There are multiple files under
diego
parents: 21232
diff changeset
36 #endif
0b17f818d393 Remove config.h and move its content to af.h. There are multiple files under
diego
parents: 21232
diff changeset
37
7568
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
38 // Audio data chunk
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
39 typedef struct af_data_s
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
40 {
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
41 void* audio; // data buffer
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
42 int len; // buffer length
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
43 int rate; // sample rate
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
44 int nch; // number of channels
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
45 int format; // format
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
46 int bps; // bytes per sample
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
47 } af_data_t;
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
48
14433
95bb94a930a3 always cancel down fractions (frac_t) to avoid overflows and playback
reimar
parents: 14292
diff changeset
49
8167
e8832e66babd New features:
anders
parents: 8073
diff changeset
50 // Flags used for defining the behavior of an audio filter
7615
c67328dd459a Adding Support for non-reentrant audio filters
anders
parents: 7598
diff changeset
51 #define AF_FLAGS_REENTRANT 0x00000000
c67328dd459a Adding Support for non-reentrant audio filters
anders
parents: 7598
diff changeset
52 #define AF_FLAGS_NOT_REENTRANT 0x00000001
c67328dd459a Adding Support for non-reentrant audio filters
anders
parents: 7598
diff changeset
53
7568
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
54 /* Audio filter information not specific for current instance, but for
29263
0f1b5b68af32 whitespace cosmetics: Remove all trailing whitespace.
diego
parents: 29052
diff changeset
55 a specific filter */
0f1b5b68af32 whitespace cosmetics: Remove all trailing whitespace.
diego
parents: 29052
diff changeset
56 typedef struct af_info_s
7568
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
57 {
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
58 const char *info;
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
59 const char *name;
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
60 const char *author;
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
61 const char *comment;
7615
c67328dd459a Adding Support for non-reentrant audio filters
anders
parents: 7598
diff changeset
62 const int flags;
7568
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
63 int (*open)(struct af_instance_s* vf);
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
64 } af_info_t;
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
65
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
66 // Linked list of audio filters
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
67 typedef struct af_instance_s
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
68 {
32134
12db4ae0b3d1 const-correctness for af_info_t audio filter declarations
diego
parents: 31180
diff changeset
69 const af_info_t* info;
7568
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
70 int (*control)(struct af_instance_s* af, int cmd, void* arg);
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
71 void (*uninit)(struct af_instance_s* af);
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
72 af_data_t* (*play)(struct af_instance_s* af, af_data_t* data);
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
73 void* setup; // setup data for this specific instance and filter
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
74 af_data_t* data; // configuration for outgoing data stream
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
75 struct af_instance_s* next;
29263
0f1b5b68af32 whitespace cosmetics: Remove all trailing whitespace.
diego
parents: 29052
diff changeset
76 struct af_instance_s* prev;
24900
9079c9745ff9 A/V sync: take audio filter buffers into account
uau
parents: 24892
diff changeset
77 double delay; /* Delay caused by the filter, in units of bytes read without
9079c9745ff9 A/V sync: take audio filter buffers into account
uau
parents: 24892
diff changeset
78 * corresponding output */
24888
b2402b4f0afa libaf: change filter input/output ratio calculations
uau
parents: 24887
diff changeset
79 double mul; /* length multiplier: how much does this instance change
7568
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
80 the length of the buffer. */
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
81 }af_instance_t;
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
82
7745
1d3a3dc1f488 Adding volume control and moving control() call parameters to a seperate file
anders
parents: 7665
diff changeset
83 // Initialization flags
8167
e8832e66babd New features:
anders
parents: 8073
diff changeset
84 extern int* af_cpu_speed;
e8832e66babd New features:
anders
parents: 8073
diff changeset
85
7745
1d3a3dc1f488 Adding volume control and moving control() call parameters to a seperate file
anders
parents: 7665
diff changeset
86 #define AF_INIT_AUTO 0x00000000
1d3a3dc1f488 Adding volume control and moving control() call parameters to a seperate file
anders
parents: 7665
diff changeset
87 #define AF_INIT_SLOW 0x00000001
1d3a3dc1f488 Adding volume control and moving control() call parameters to a seperate file
anders
parents: 7665
diff changeset
88 #define AF_INIT_FAST 0x00000002
1d3a3dc1f488 Adding volume control and moving control() call parameters to a seperate file
anders
parents: 7665
diff changeset
89 #define AF_INIT_FORCE 0x00000003
1d3a3dc1f488 Adding volume control and moving control() call parameters to a seperate file
anders
parents: 7665
diff changeset
90 #define AF_INIT_TYPE_MASK 0x00000003
7571
8819fdf88b5d Adding support for multiple audio streams and removing annoying message from resample and format
anders
parents: 7568
diff changeset
91
8867
558f0b1f45ee New auto config for volume and resample and added support for float flag in configuration
anders
parents: 8674
diff changeset
92 #define AF_INIT_INT 0x00000000
8868
398e3fb7c103 10l bug for float conversion control + feature fix in volume control
anders
parents: 8867
diff changeset
93 #define AF_INIT_FLOAT 0x00000004
398e3fb7c103 10l bug for float conversion control + feature fix in volume control
anders
parents: 8867
diff changeset
94 #define AF_INIT_FORMAT_MASK 0x00000004
8867
558f0b1f45ee New auto config for volume and resample and added support for float flag in configuration
anders
parents: 8674
diff changeset
95
29263
0f1b5b68af32 whitespace cosmetics: Remove all trailing whitespace.
diego
parents: 29052
diff changeset
96 // Default init type
8167
e8832e66babd New features:
anders
parents: 8073
diff changeset
97 #ifndef AF_INIT_TYPE
e8832e66babd New features:
anders
parents: 8073
diff changeset
98 #define AF_INIT_TYPE (af_cpu_speed?*af_cpu_speed:AF_INIT_SLOW)
e8832e66babd New features:
anders
parents: 8073
diff changeset
99 #endif
e8832e66babd New features:
anders
parents: 8073
diff changeset
100
7571
8819fdf88b5d Adding support for multiple audio streams and removing annoying message from resample and format
anders
parents: 7568
diff changeset
101 // Configuration switches
8819fdf88b5d Adding support for multiple audio streams and removing annoying message from resample and format
anders
parents: 7568
diff changeset
102 typedef struct af_cfg_s{
8819fdf88b5d Adding support for multiple audio streams and removing annoying message from resample and format
anders
parents: 7568
diff changeset
103 int force; // Initialization type
8167
e8832e66babd New features:
anders
parents: 8073
diff changeset
104 char** list; /* list of names of filters that are added to filter
7571
8819fdf88b5d Adding support for multiple audio streams and removing annoying message from resample and format
anders
parents: 7568
diff changeset
105 list during first initialization of stream */
8819fdf88b5d Adding support for multiple audio streams and removing annoying message from resample and format
anders
parents: 7568
diff changeset
106 }af_cfg_t;
8819fdf88b5d Adding support for multiple audio streams and removing annoying message from resample and format
anders
parents: 7568
diff changeset
107
8819fdf88b5d Adding support for multiple audio streams and removing annoying message from resample and format
anders
parents: 7568
diff changeset
108 // Current audio stream
31180
0d18ce469b67 Drop pointless _s suffix from 'struct af_stream'.
diego
parents: 30413
diff changeset
109 typedef struct af_stream
7571
8819fdf88b5d Adding support for multiple audio streams and removing annoying message from resample and format
anders
parents: 7568
diff changeset
110 {
8819fdf88b5d Adding support for multiple audio streams and removing annoying message from resample and format
anders
parents: 7568
diff changeset
111 // The first and last filter in the list
8819fdf88b5d Adding support for multiple audio streams and removing annoying message from resample and format
anders
parents: 7568
diff changeset
112 af_instance_t* first;
8819fdf88b5d Adding support for multiple audio streams and removing annoying message from resample and format
anders
parents: 7568
diff changeset
113 af_instance_t* last;
8819fdf88b5d Adding support for multiple audio streams and removing annoying message from resample and format
anders
parents: 7568
diff changeset
114 // Storage for input and output data formats
8819fdf88b5d Adding support for multiple audio streams and removing annoying message from resample and format
anders
parents: 7568
diff changeset
115 af_data_t input;
8819fdf88b5d Adding support for multiple audio streams and removing annoying message from resample and format
anders
parents: 7568
diff changeset
116 af_data_t output;
8167
e8832e66babd New features:
anders
parents: 8073
diff changeset
117 // Configuration for this stream
7571
8819fdf88b5d Adding support for multiple audio streams and removing annoying message from resample and format
anders
parents: 7568
diff changeset
118 af_cfg_t cfg;
8819fdf88b5d Adding support for multiple audio streams and removing annoying message from resample and format
anders
parents: 7568
diff changeset
119 }af_stream_t;
8819fdf88b5d Adding support for multiple audio streams and removing annoying message from resample and format
anders
parents: 7568
diff changeset
120
7568
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
121 /*********************************************
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
122 // Return values
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
123 */
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
124
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
125 #define AF_DETACH 2
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
126 #define AF_OK 1
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
127 #define AF_TRUE 1
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
128 #define AF_FALSE 0
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
129 #define AF_UNKNOWN -1
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
130 #define AF_ERROR -2
8167
e8832e66babd New features:
anders
parents: 8073
diff changeset
131 #define AF_FATAL -3
7568
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
132
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
133
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
134
7745
1d3a3dc1f488 Adding volume control and moving control() call parameters to a seperate file
anders
parents: 7665
diff changeset
135 /*********************************************
7568
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
136 // Export functions
7745
1d3a3dc1f488 Adding volume control and moving control() call parameters to a seperate file
anders
parents: 7665
diff changeset
137 */
7568
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
138
16627
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
139 /**
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
140 * \defgroup af_chain Audio filter chain functions
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
141 * \{
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
142 * \param s filter chain
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
143 */
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
144
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
145 /**
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
146 * \brief Initialize the stream "s".
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
147 * \return 0 on success, -1 on failure
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
148 *
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
149 * This function creates a new filter list if necessary, according
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
150 * to the values set in input and output. Input and output should contain
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
151 * the format of the current movie and the format of the preferred output
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
152 * respectively.
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
153 * Filters to convert to the preferred output format are inserted
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
154 * automatically, except when they are set to 0.
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
155 * The function is reentrant i.e. if called with an already initialized
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
156 * stream the stream will be reinitialized.
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
157 */
15811
9b4bbb6098f6 make -srate work again, unify audio filter init and preinit.
reimar
parents: 14883
diff changeset
158 int af_init(af_stream_t* s);
7649
90e16aa8ae5f Adding functionality for adding filters during execution
anders
parents: 7615
diff changeset
159
16627
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
160 /**
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
161 * \brief Uninit and remove all filters from audio filter chain
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
162 */
7571
8819fdf88b5d Adding support for multiple audio streams and removing annoying message from resample and format
anders
parents: 7568
diff changeset
163 void af_uninit(af_stream_t* s);
7649
90e16aa8ae5f Adding functionality for adding filters during execution
anders
parents: 7615
diff changeset
164
16627
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
165 /**
32418
71a04d45357c Make af_reinit "public", to allow using it in future patches.
reimar
parents: 32134
diff changeset
166 * \brief Reinit the filter list from the given filter on downwards
71a04d45357c Make af_reinit "public", to allow using it in future patches.
reimar
parents: 32134
diff changeset
167 * \param Filter instance to begin the reinit from
71a04d45357c Make af_reinit "public", to allow using it in future patches.
reimar
parents: 32134
diff changeset
168 * \return AF_OK on success or AF_ERROR on failure
71a04d45357c Make af_reinit "public", to allow using it in future patches.
reimar
parents: 32134
diff changeset
169 */
71a04d45357c Make af_reinit "public", to allow using it in future patches.
reimar
parents: 32134
diff changeset
170 int af_reinit(af_stream_t* s, af_instance_t* af);
71a04d45357c Make af_reinit "public", to allow using it in future patches.
reimar
parents: 32134
diff changeset
171
71a04d45357c Make af_reinit "public", to allow using it in future patches.
reimar
parents: 32134
diff changeset
172 /**
16627
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
173 * \brief This function adds the filter "name" to the stream s.
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
174 * \param name name of filter to add
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
175 * \return pointer to the new filter, NULL if insert failed
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
176 *
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
177 * The filter will be inserted somewhere nice in the
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
178 * list of filters (i.e. at the beginning unless the
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
179 * first filter is the format filter (why??).
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
180 */
7649
90e16aa8ae5f Adding functionality for adding filters during execution
anders
parents: 7615
diff changeset
181 af_instance_t* af_add(af_stream_t* s, char* name);
90e16aa8ae5f Adding functionality for adding filters during execution
anders
parents: 7615
diff changeset
182
16627
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
183 /**
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
184 * \brief Uninit and remove the filter "af"
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
185 * \param af filter to remove
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
186 */
7649
90e16aa8ae5f Adding functionality for adding filters during execution
anders
parents: 7615
diff changeset
187 void af_remove(af_stream_t* s, af_instance_t* af);
90e16aa8ae5f Adding functionality for adding filters during execution
anders
parents: 7615
diff changeset
188
16627
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
189 /**
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
190 * \brief find filter in chain by name
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
191 * \param name name of the filter to find
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
192 * \return first filter with right name or NULL if not found
29263
0f1b5b68af32 whitespace cosmetics: Remove all trailing whitespace.
diego
parents: 29052
diff changeset
193 *
16627
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
194 * This function is used for finding already initialized filters
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
195 */
7649
90e16aa8ae5f Adding functionality for adding filters during execution
anders
parents: 7615
diff changeset
196 af_instance_t* af_get(af_stream_t* s, char* name);
90e16aa8ae5f Adding functionality for adding filters during execution
anders
parents: 7615
diff changeset
197
16627
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
198 /**
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
199 * \brief filter data chunk through the filters in the list
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
200 * \param data data to play
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
201 * \return resulting data
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
202 * \ingroup af_chain
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
203 */
7571
8819fdf88b5d Adding support for multiple audio streams and removing annoying message from resample and format
anders
parents: 7568
diff changeset
204 af_data_t* af_play(af_stream_t* s, af_data_t* data);
7649
90e16aa8ae5f Adding functionality for adding filters during execution
anders
parents: 7615
diff changeset
205
16627
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
206 /**
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
207 * \brief send control to all filters, starting with the last until
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
208 * one accepts the command with AF_OK.
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
209 * \param cmd filter control command
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
210 * \param arg argument for filter command
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
211 * \return the accepting filter or NULL if none was found
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
212 */
14292
12239a0d5408 Make af_control_any_rev return the matching filter
reimar
parents: 13269
diff changeset
213 af_instance_t *af_control_any_rev (af_stream_t* s, int cmd, void* arg);
12668
ce6ab8cb8597 Send a command throught the filter chain until some item returns AF_OK. Patch by Reimar Doeffinger
alex
parents: 8969
diff changeset
214
16627
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
215 /**
24892
80180dc13565 Change decode_audio() interface
uau
parents: 24889
diff changeset
216 * \brief calculate average ratio of filter output lenth to input length
80180dc13565 Change decode_audio() interface
uau
parents: 24889
diff changeset
217 * \return the ratio
80180dc13565 Change decode_audio() interface
uau
parents: 24889
diff changeset
218 */
80180dc13565 Change decode_audio() interface
uau
parents: 24889
diff changeset
219 double af_calc_filter_multiplier(af_stream_t* s);
7568
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
220
16627
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
221 /**
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
222 * \brief Calculate the total delay caused by the filters
24900
9079c9745ff9 A/V sync: take audio filter buffers into account
uau
parents: 24892
diff changeset
223 * \return delay in bytes of "missing" output
16627
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
224 */
7665
fbd5445cc853 Adding function for calculating the delay caused by the filters
anders
parents: 7649
diff changeset
225 double af_calc_delay(af_stream_t* s);
7568
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
226
16627
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
227 /** \} */ // end of af_chain group
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
228
7568
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
229 // Helper functions and macros used inside the audio filters
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
230
16627
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
231 /**
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
232 * \defgroup af_filter Audio filter helper functions
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
233 * \{
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
234 */
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
235
7568
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
236 /* Helper function called by the macro with the same name only to be
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
237 called from inside filters */
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
238 int af_resize_local_buffer(af_instance_t* af, af_data_t* data);
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
239
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
240 /* Helper function used to calculate the exact buffer length needed
7589
443b440798a5 Redesign of buffer length calculation
anders
parents: 7571
diff changeset
241 when buffers are resized. The returned length is >= than what is
443b440798a5 Redesign of buffer length calculation
anders
parents: 7571
diff changeset
242 needed */
24888
b2402b4f0afa libaf: change filter input/output ratio calculations
uau
parents: 24887
diff changeset
243 int af_lencalc(double mul, af_data_t* data);
7568
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
244
16627
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
245 /**
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
246 * \brief convert dB to gain value
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
247 * \param n number of values to convert
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
248 * \param in [in] values in dB, <= -200 will become 0 gain
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
249 * \param out [out] gain values
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
250 * \param k input values are divided by this
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
251 * \param mi minimum dB value, input will be clamped to this
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
252 * \param ma maximum dB value, input will be clamped to this
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
253 * \return AF_ERROR on error, AF_OK otherwise
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
254 */
8607
d6f40a06867b Changes includes:
anders
parents: 8180
diff changeset
255 int af_from_dB(int n, float* in, float* out, float k, float mi, float ma);
16627
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
256
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
257 /**
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
258 * \brief convert gain value to dB
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
259 * \param n number of values to convert
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
260 * \param in [in] gain values, 0 wil become -200 dB
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
261 * \param out [out] values in dB
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
262 * \param k output values will be multiplied by this
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
263 * \return AF_ERROR on error, AF_OK otherwise
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
264 */
8607
d6f40a06867b Changes includes:
anders
parents: 8180
diff changeset
265 int af_to_dB(int n, float* in, float* out, float k);
16627
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
266
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
267 /**
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
268 * \brief convert milliseconds to sample time
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
269 * \param n number of values to convert
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
270 * \param in [in] values in milliseconds
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
271 * \param out [out] sample time values
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
272 * \param rate sample rate
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
273 * \param mi minimum ms value, input will be clamped to this
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
274 * \param ma maximum ms value, input will be clamped to this
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
275 * \return AF_ERROR on error, AF_OK otherwise
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
276 */
8674
93212da0032e 10l memory leak + bug fixes in ms to sample time conversion
anders
parents: 8607
diff changeset
277 int af_from_ms(int n, float* in, int* out, int rate, float mi, float ma);
16627
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
278
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
279 /**
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
280 * \brief convert sample time to milliseconds
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
281 * \param n number of values to convert
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
282 * \param in [in] sample time values
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
283 * \param out [out] values in milliseconds
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
284 * \param rate sample rate
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
285 * \return AF_ERROR on error, AF_OK otherwise
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
286 */
29263
0f1b5b68af32 whitespace cosmetics: Remove all trailing whitespace.
diego
parents: 29052
diff changeset
287 int af_to_ms(int n, int* in, float* out, int rate);
16627
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
288
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
289 /**
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
290 * \brief test if output format matches
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
291 * \param af audio filter
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
292 * \param out needed format, will be overwritten by available
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
293 * format if they do not match
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
294 * \return AF_FALSE if formats do not match, AF_OK if they match
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
295 *
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
296 * compares the format, bps, rate and nch values of af->data with out
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
297 */
8607
d6f40a06867b Changes includes:
anders
parents: 8180
diff changeset
298 int af_test_output(struct af_instance_s* af, af_data_t* out);
d6f40a06867b Changes includes:
anders
parents: 8180
diff changeset
299
16627
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
300 /**
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
301 * \brief soft clipping function using sin()
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
302 * \param a input value
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
303 * \return clipped value
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
304 */
14622
637fbaa8f56c af_softclip
alex
parents: 14433
diff changeset
305 float af_softclip(float a);
637fbaa8f56c af_softclip
alex
parents: 14433
diff changeset
306
16627
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
307 /** \} */ // end of af_filter group, but more functions of this group below
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
308
13269
aa13937da8a0 mplayer -af help now lists all available audio filters.
ivo
parents: 12676
diff changeset
309 /** Print a list of all available audio filters */
aa13937da8a0 mplayer -af help now lists all available audio filters.
ivo
parents: 12676
diff changeset
310 void af_help(void);
aa13937da8a0 mplayer -af help now lists all available audio filters.
ivo
parents: 12676
diff changeset
311
16627
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
312 /**
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
313 * \brief fill the missing parameters in the af_data_t structure
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
314 * \param data structure to fill
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
315 * \ingroup af_filter
29263
0f1b5b68af32 whitespace cosmetics: Remove all trailing whitespace.
diego
parents: 29052
diff changeset
316 *
16627
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
317 * Currently only sets bps based on format
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
318 */
14883
0c0ef2177115 obvious typo
rathann
parents: 14818
diff changeset
319 void af_fix_parameters(af_data_t *data);
14818
663c1ea5f595 finally remove the refences to bps outside libaf. also simplification of some messages and removed redundants
alex
parents: 14622
diff changeset
320
16627
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
321 /** Memory reallocation macro: if a local buffer is used (i.e. if the
7568
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
322 filter doesn't operate on the incoming buffer this macro must be
16627
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
323 called to ensure the buffer is big enough.
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
324 * \ingroup af_filter
584bd8980d57 documentation-only patch: make doxygen compatible and create
reimar
parents: 15811
diff changeset
325 */
7568
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
326 #define RESIZE_LOCAL_BUFFER(a,d)\
7591
5ef4d009f950 Correcting error in macro
anders
parents: 7589
diff changeset
327 ((a->data->len < af_lencalc(a->mul,d))?af_resize_local_buffer(a,d):AF_OK)
7568
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
328
7745
1d3a3dc1f488 Adding volume control and moving control() call parameters to a seperate file
anders
parents: 7665
diff changeset
329 /* Some other useful macro definitions*/
7568
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
330 #ifndef min
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
331 #define min(a,b)(((a)>(b))?(b):(a))
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
332 #endif
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
333
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
334 #ifndef max
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
335 #define max(a,b)(((a)>(b))?(a):(b))
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
336 #endif
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
337
7745
1d3a3dc1f488 Adding volume control and moving control() call parameters to a seperate file
anders
parents: 7665
diff changeset
338 #ifndef clamp
1d3a3dc1f488 Adding volume control and moving control() call parameters to a seperate file
anders
parents: 7665
diff changeset
339 #define clamp(a,min,max) (((a)>(max))?(max):(((a)<(min))?(min):(a)))
7568
d08513b9fed6 Adding new audio output filter layer libaf
anders
parents:
diff changeset
340 #endif
7745
1d3a3dc1f488 Adding volume control and moving control() call parameters to a seperate file
anders
parents: 7665
diff changeset
341
1d3a3dc1f488 Adding volume control and moving control() call parameters to a seperate file
anders
parents: 7665
diff changeset
342 #ifndef sign
29263
0f1b5b68af32 whitespace cosmetics: Remove all trailing whitespace.
diego
parents: 29052
diff changeset
343 #define sign(a) (((a)>0)?(1):(-1))
8073
c0e556f9986b Adding equalizer filter + some cosmetics
anders
parents: 7745
diff changeset
344 #endif
c0e556f9986b Adding equalizer filter + some cosmetics
anders
parents: 7745
diff changeset
345
8167
e8832e66babd New features:
anders
parents: 8073
diff changeset
346 #ifndef lrnd
e8832e66babd New features:
anders
parents: 8073
diff changeset
347 #define lrnd(a,b) ((b)((a)>=0.0?(a)+0.5:(a)-0.5))
7745
1d3a3dc1f488 Adding volume control and moving control() call parameters to a seperate file
anders
parents: 7665
diff changeset
348 #endif
1d3a3dc1f488 Adding volume control and moving control() call parameters to a seperate file
anders
parents: 7665
diff changeset
349
26029
4129c8cfa742 Add MPLAYER_ prefix to multiple inclusion guards.
diego
parents: 25551
diff changeset
350 #endif /* MPLAYER_AF_H */