1 /*****************************************************************************
2 * vlc_filter.h: filter related structures and functions
3 *****************************************************************************
4 * Copyright (C) 1999-2008 the VideoLAN team
7 * Authors: Gildas Bazin <gbazin@videolan.org>
8 * Antoine Cellerier <dionoea at videolan dot org>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 *****************************************************************************/
26 #define VLC_FILTER_H 1
29 #include <vlc_picture.h>
30 #include <vlc_subpicture.h>
34 * This file defines the structure and types used by video and audio filters
37 typedef struct filter_owner_sys_t filter_owner_sys_t;
39 /** Structure describing a filter
40 * @warning BIG FAT WARNING : the code relies on the first 4 members of
41 * filter_t and decoder_t to be the same, so if you have anything to add,
42 * do it at the end of the structure.
48 /* Module properties */
55 /* Output format of filter */
57 bool b_allow_fmt_out_change;
59 /* Filter configuration */
60 config_chain_t * p_cfg;
62 picture_t * ( * pf_video_filter ) ( filter_t *, picture_t * );
63 block_t * ( * pf_audio_filter ) ( filter_t *, block_t * );
64 void ( * pf_video_blend ) ( filter_t *,
65 picture_t *, picture_t *,
68 subpicture_t * ( *pf_sub_filter ) ( filter_t *, mtime_t );
69 int ( *pf_render_text ) ( filter_t *, subpicture_region_t *,
70 subpicture_region_t * );
71 int ( *pf_render_html ) ( filter_t *, subpicture_region_t *,
72 subpicture_region_t * );
78 /* Audio output callbacks */
79 block_t * ( * pf_audio_buffer_new) ( filter_t *, int );
81 /* Video output callbacks */
82 picture_t * ( * pf_vout_buffer_new) ( filter_t * );
83 void ( * pf_vout_buffer_del) ( filter_t *, picture_t * );
84 /* void ( * pf_picture_link) ( picture_t * );
85 void ( * pf_picture_unlink) ( picture_t * ); */
87 /* SPU output callbacks */
88 subpicture_t * ( * pf_sub_buffer_new) ( filter_t * );
89 void ( * pf_sub_buffer_del) ( filter_t *, subpicture_t * );
91 /* Private structure for the owner of the decoder */
92 filter_owner_sys_t *p_owner;
96 * This function will return a new picture usable by p_filter as an output
97 * buffer. You have to release it using filter_DeletePicture or by returning
98 * it to the caller as a pf_video_filter return value.
99 * Provided for convenience.
101 * \param p_filter filter_t object
102 * \return new picture on success or NULL on failure
104 static inline picture_t *filter_NewPicture( filter_t *p_filter )
106 picture_t *p_picture = p_filter->pf_vout_buffer_new( p_filter );
108 msg_Warn( p_filter, "can't get output picture" );
113 * This function will release a picture create by filter_NewPicture.
114 * Provided for convenience.
116 * \param p_filter filter_t object
117 * \param p_picture picture to be deleted
119 static inline void filter_DeletePicture( filter_t *p_filter, picture_t *p_picture )
121 p_filter->pf_vout_buffer_del( p_filter, p_picture );
125 * This function will return a new subpicture usable by p_filter as an output
126 * buffer. You have to release it using filter_DeleteSubpicture or by returning
127 * it to the caller as a pf_sub_filter return value.
128 * Provided for convenience.
130 * \param p_filter filter_t object
131 * \return new subpicture
133 static inline subpicture_t *filter_NewSubpicture( filter_t *p_filter )
135 subpicture_t *p_subpicture = p_filter->pf_sub_buffer_new( p_filter );
137 msg_Warn( p_filter, "can't get output subpicture" );
142 * This function will release a subpicture create by filter_NewSubicture.
143 * Provided for convenience.
145 * \param p_filter filter_t object
146 * \param p_subpicture to be released
148 static inline void filter_DeleteSubpicture( filter_t *p_filter, subpicture_t *p_subpicture )
150 p_filter->pf_sub_buffer_del( p_filter, p_subpicture );
154 * This function will return a new audio buffer usable by p_filter as an
155 * output buffer. You have to release it using block_Release or by returning
156 * it to the caller as a pf_audio_filter return value.
157 * Provided for convenience.
159 * \param p_filter filter_t object
160 * \param i_size size of audio buffer requested
161 * \return block to be used as audio output buffer
163 static inline block_t *filter_NewAudioBuffer( filter_t *p_filter, int i_size )
165 block_t *p_block = p_filter->pf_audio_buffer_new( p_filter, i_size );
167 msg_Warn( p_filter, "can't get output block" );
172 * Create a picture_t *(*)( filter_t *, picture_t * ) compatible wrapper
173 * using a void (*)( filter_t *, picture_t *, picture_t * ) function
175 * Currently used by the chroma video filters
177 #define VIDEO_FILTER_WRAPPER( name ) \
178 static picture_t *name ## _Filter ( filter_t *p_filter, \
181 picture_t *p_outpic = filter_NewPicture( p_filter ); \
184 name( p_filter, p_pic, p_outpic ); \
185 picture_CopyProperties( p_outpic, p_pic ); \
187 picture_Release( p_pic ); \
192 * Filter chain management API
193 * The filter chain management API is used to dynamically construct filters
194 * and add them in a chain.
197 typedef struct filter_chain_t filter_chain_t;
200 * Create new filter chain
202 * \param p_object pointer to a vlc object
203 * \param psz_capability vlc capability of filters in filter chain
204 * \param b_allow_format_fmt_change allow changing of fmt
205 * \param pf_buffer_allocation_init callback function to initialize buffer allocations
206 * \param pf_buffer_allocation_clear callback function to clear buffer allocation initialization
207 * \param p_buffer_allocation_data pointer to private allocation data
208 * \return pointer to a filter chain
210 VLC_EXPORT( filter_chain_t *, __filter_chain_New, ( vlc_object_t *, const char *, bool, int (*)( filter_t *, void * ), void (*)( filter_t * ), void * ) );
211 #define filter_chain_New( a, b, c, d, e, f ) __filter_chain_New( VLC_OBJECT( a ), b, c, d, e, f )
214 * Delete filter chain will delete all filters in the chain and free all
215 * allocated data. The pointer to the filter chain is then no longer valid.
217 * \param p_chain pointer to filter chain
219 VLC_EXPORT( void, filter_chain_Delete, ( filter_chain_t * ) );
222 * Reset filter chain will delete all filters in the chain and
223 * reset p_fmt_in and p_fmt_out to the new values.
225 * \param p_chain pointer to filter chain
226 * \param p_fmt_in new fmt_in params
227 * \param p_fmt_out new fmt_out params
229 VLC_EXPORT( void, filter_chain_Reset, ( filter_chain_t *, const es_format_t *, const es_format_t * ) );
232 * Append filter to the end of the chain.
234 * \param p_chain pointer to filter chain
235 * \param psz_name name of filter
237 * \param p_fmt_in input es_format_t
238 * \param p_fmt_out output es_format_t
239 * \return pointer to filter chain
241 VLC_EXPORT( filter_t *, filter_chain_AppendFilter, ( filter_chain_t *, const char *, config_chain_t *, const es_format_t *, const es_format_t * ) );
244 * Append new filter to filter chain from string.
246 * \param p_chain pointer to filter chain
247 * \param psz_string string of filters
248 * \return 0 for success
250 VLC_EXPORT( int, filter_chain_AppendFromString, ( filter_chain_t *, const char * ) );
253 * Delete filter from filter chain. This function also releases the filter
254 * object and unloads the filter modules. The pointer to p_filter is no
255 * longer valid after this function successfully returns.
257 * \param p_chain pointer to filter chain
258 * \param p_filter pointer to filter object
259 * \return VLC_SUCCESS on succes, else VLC_EGENERIC
261 VLC_EXPORT( int, filter_chain_DeleteFilter, ( filter_chain_t *, filter_t * ) );
264 * Get filter by name of position in the filter chain.
266 * \param p_chain pointer to filter chain
267 * \param i_position position of filter in filter chain
268 * \param psz_name name of filter to get
269 * \return filter object based on position or name provided
271 VLC_EXPORT( filter_t *, filter_chain_GetFilter, ( filter_chain_t *, int, const char * ) );
274 * Get the number of filters in the filter chain.
276 * \param p_chain pointer to filter chain
277 * \return number of filters in this filter chain
279 VLC_EXPORT( int, filter_chain_GetLength, ( filter_chain_t * ) );
282 * Get last p_fmt_out in the chain.
284 * \param p_chain pointer to filter chain
285 * \return last p_fmt (es_format_t) of this filter chain
287 VLC_EXPORT( const es_format_t *, filter_chain_GetFmtOut, ( filter_chain_t * ) );
290 * Apply the filter chain to a video picture.
292 * \param p_chain pointer to filter chain
293 * \param p_picture picture to apply filters on
294 * \return modified picture after applying all video filters
296 VLC_EXPORT( picture_t *, filter_chain_VideoFilter, ( filter_chain_t *, picture_t * ) );
299 * Apply the filter chain to a audio block.
301 * \param p_chain pointer to filter chain
302 * \param p_block audio frame to apply filters on
303 * \return modified audio frame after applying all audio filters
305 VLC_EXPORT( block_t *, filter_chain_AudioFilter, ( filter_chain_t *, block_t * ) );
308 * Apply filter chain to subpictures.
310 * \param p_chain pointer to filter chain
311 * \param display_date of subpictures
313 VLC_EXPORT( void, filter_chain_SubFilter, ( filter_chain_t *, mtime_t ) );
315 #endif /* _VLC_FILTER_H */