1 /*****************************************************************************
2 * filter_chain.c : Handle chains of filter_t objects.
3 *****************************************************************************
4 * Copyright (C) 2008 the VideoLAN team
7 * Author: Antoine Cellerier <dionoea at videolan dot org>
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.
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.
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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
28 #include <vlc_filter.h>
29 #include <vlc_arrays.h>
34 vlc_object_t *p_this; /* Parent object */
36 vlc_array_t filters; /* List of filters */
38 char *psz_capability; /* Capability of all the filters in the chain */
39 es_format_t fmt_in; /* Input format (read only) */
40 es_format_t fmt_out; /* Output format (writable depending on ... */
41 bool b_allow_fmt_out_change; /* allow changing fmt_out if true */
43 int (* pf_buffer_allocation_init)( filter_t *, void *p_data ); /* Callback called once filter allocation has succeeded to initialize the filter's buffer allocation callbacks. This function is responsible for setting p_owner if needed. */
44 void (* pf_buffer_allocation_clear)( filter_t * ); /* Callback called on filter removal from chain to clean up buffer allocation callbacks data (ie p_owner) */
45 void *p_buffer_allocation_data; /* Data for pf_buffer_allocation_init */
51 static filter_t *filter_chain_AppendFilterInternal( filter_chain_t *, const char *, config_chain_t *, const es_format_t *, const es_format_t * );
52 static int filter_chain_AppendFromStringInternal( filter_chain_t *, const char * );
53 static int filter_chain_DeleteFilterInternal( filter_chain_t *, filter_t * );
55 static int UpdateBufferFunctions( filter_chain_t * );
56 static picture_t *VideoBufferNew( filter_t * );
59 * Filter chain initialisation
61 filter_chain_t *__filter_chain_New( vlc_object_t *p_this,
62 const char *psz_capability,
63 bool b_allow_fmt_out_change,
64 int (*pf_buffer_allocation_init)( filter_t *, void * ),
65 void (*pf_buffer_allocation_clear)( filter_t * ),
66 void *p_buffer_allocation_data )
68 filter_chain_t *p_chain = (filter_chain_t *)
69 malloc( sizeof( filter_chain_t ) );
70 if( !p_chain ) return NULL;
71 p_chain->p_this = p_this;
72 vlc_array_init( &p_chain->filters );
73 p_chain->psz_capability = strdup( psz_capability );
74 if( !p_chain->psz_capability )
79 es_format_Init( &p_chain->fmt_in, UNKNOWN_ES, 0 );
80 es_format_Init( &p_chain->fmt_out, UNKNOWN_ES, 0 );
81 p_chain->b_allow_fmt_out_change = b_allow_fmt_out_change;
83 p_chain->pf_buffer_allocation_init = pf_buffer_allocation_init;
84 p_chain->pf_buffer_allocation_clear = pf_buffer_allocation_clear;
85 p_chain->p_buffer_allocation_data = p_buffer_allocation_data;
91 * Filter chain destruction
93 void filter_chain_Delete( filter_chain_t *p_chain )
95 while( p_chain->filters.i_count )
96 filter_chain_DeleteFilterInternal( p_chain,
97 (filter_t*)p_chain->filters.pp_elems[0] );
98 vlc_array_clear( &p_chain->filters );
99 free( p_chain->psz_capability );
100 es_format_Clean( &p_chain->fmt_in );
101 es_format_Clean( &p_chain->fmt_out );
105 * Filter chain reinitialisation
107 void filter_chain_Reset( filter_chain_t *p_chain, const es_format_t *p_fmt_in,
108 const es_format_t *p_fmt_out )
110 while( p_chain->filters.i_count )
111 filter_chain_DeleteFilterInternal( p_chain,
112 (filter_t*)p_chain->filters.pp_elems[0] );
115 es_format_Clean( &p_chain->fmt_in );
116 es_format_Copy( &p_chain->fmt_in, p_fmt_in );
120 es_format_Clean( &p_chain->fmt_out );
121 es_format_Copy( &p_chain->fmt_out, p_fmt_out );
127 * Modifying the filter chain
129 static filter_t *filter_chain_AppendFilterInternal( filter_chain_t *p_chain,
130 const char *psz_name,
131 config_chain_t *p_cfg,
132 const es_format_t *p_fmt_in,
133 const es_format_t *p_fmt_out )
135 static const char typename[] = "filter";
137 vlc_custom_create( p_chain->p_this, sizeof(filter_t),
138 VLC_OBJECT_GENERIC, typename );
139 if( !p_filter ) return NULL;
140 vlc_object_attach( p_filter, p_chain->p_this );
144 if( p_chain->filters.i_count )
145 p_fmt_in = &((filter_t*)p_chain->filters.pp_elems[p_chain->filters.i_count-1])->fmt_out;
147 p_fmt_in = &p_chain->fmt_in;
152 p_fmt_out = &p_chain->fmt_out;
155 es_format_Copy( &p_filter->fmt_in, p_fmt_in );
156 es_format_Copy( &p_filter->fmt_out, p_fmt_out );
157 p_filter->p_cfg = p_cfg;
158 p_filter->b_allow_fmt_out_change = p_chain->b_allow_fmt_out_change;
160 p_filter->p_module = module_Need( p_filter, p_chain->psz_capability,
161 psz_name, psz_name ? true : false );
163 if( !p_filter->p_module )
166 if( p_filter->b_allow_fmt_out_change )
168 es_format_Clean( &p_chain->fmt_out );
169 es_format_Copy( &p_chain->fmt_out, &p_filter->fmt_out );
172 if( p_chain->pf_buffer_allocation_init( p_filter,
173 p_chain->p_buffer_allocation_data ) != VLC_SUCCESS )
176 vlc_array_append( &p_chain->filters, p_filter );
178 msg_Dbg( p_chain->p_this, "Filter '%s' (%p) appended to chain",
179 psz_name?:p_filter->psz_object_name, p_filter );
185 msg_Err( p_chain->p_this, "Failed to create video filter '%s'",
188 msg_Err( p_chain->p_this, "Failed to create video filter" );
189 if( p_filter->p_module ) module_Unneed( p_filter,
190 p_filter->p_module );
191 es_format_Clean( &p_filter->fmt_in );
192 es_format_Clean( &p_filter->fmt_out );
193 vlc_object_detach( p_filter );
194 vlc_object_release( p_filter );
198 filter_t *filter_chain_AppendFilter( filter_chain_t *p_chain,
199 const char *psz_name,
200 config_chain_t *p_cfg,
201 const es_format_t *p_fmt_in,
202 const es_format_t *p_fmt_out )
204 filter_t *p_filter = filter_chain_AppendFilterInternal( p_chain, psz_name,
207 if( UpdateBufferFunctions( p_chain ) < 0 )
208 msg_Err( p_filter, "Woah! This doesn't look good." );
212 static int filter_chain_AppendFromStringInternal( filter_chain_t *p_chain,
213 const char *psz_string )
215 config_chain_t *p_cfg = NULL;
216 char *psz_name = NULL;
217 char* psz_new_string;
219 if( !psz_string || !*psz_string ) return 0;
221 psz_new_string = config_ChainCreate( &psz_name, &p_cfg, psz_string );
223 filter_t *p_filter = filter_chain_AppendFilterInternal( p_chain, psz_name,
227 msg_Err( p_chain->p_this, "Failed while trying to append '%s' "
228 "to filter chain", psz_name );
231 free( psz_new_string );
236 int ret = filter_chain_AppendFromStringInternal( p_chain, psz_new_string );
237 free( psz_new_string );
240 filter_chain_DeleteFilterInternal( p_chain, p_filter );
246 int filter_chain_AppendFromString( filter_chain_t *p_chain,
247 const char *psz_string )
249 int i_ret = filter_chain_AppendFromStringInternal( p_chain, psz_string );
250 if( i_ret < 0 ) return i_ret;
251 int i_ret2 = UpdateBufferFunctions( p_chain );
252 if( i_ret2 < 0 ) return i_ret2;
256 static int filter_chain_DeleteFilterInternal( filter_chain_t *p_chain,
260 /* Find the filter in the chain */
261 for( i = 0; i < p_chain->filters.i_count; i++ )
262 if( (filter_t*)p_chain->filters.pp_elems[i] == p_filter )
265 /* Oops, filter wasn't found */
266 if( i == p_chain->filters.i_count )
268 msg_Err( p_chain->p_this, "Couldn't find filter '%s' (%p) when trying "
269 "to remove it from chain", p_filter->psz_object_name,
274 /* Remove it from the chain */
275 vlc_array_remove( &p_chain->filters, i );
276 msg_Dbg( p_chain->p_this, "Filter '%s' (%p) removed from chain",
277 p_filter->psz_object_name, p_filter );
279 /* Destroy the filter object */
280 if( p_chain->pf_buffer_allocation_clear )
281 p_chain->pf_buffer_allocation_clear( p_filter );
282 vlc_object_detach( p_filter );
283 if( p_filter->p_module )
284 module_Unneed( p_filter, p_filter->p_module );
285 vlc_object_release( p_filter );
287 /* FIXME: check fmt_in/fmt_out consitency */
291 int filter_chain_DeleteFilter( filter_chain_t *p_chain, filter_t *p_filter )
293 int i_ret = filter_chain_DeleteFilterInternal( p_chain, p_filter );
294 if( i_ret < 0 ) return i_ret;
295 return UpdateBufferFunctions( p_chain );
299 * Reading from the filter chain
301 filter_t *filter_chain_GetFilter( filter_chain_t *p_chain, int i_position,
302 const char *psz_name )
305 filter_t **pp_filters = (filter_t **)p_chain->filters.pp_elems;
312 if( i_position >= p_chain->filters.i_count )
314 return pp_filters[i_position];
317 for( i = 0; i < p_chain->filters.i_count; i++ )
319 if( !strcmp( psz_name, pp_filters[i]->psz_object_name ) )
322 return pp_filters[i];
327 int filter_chain_GetLength( filter_chain_t *p_chain )
329 return p_chain->filters.i_count;
332 const es_format_t *filter_chain_GetFmtOut( filter_chain_t *p_chain )
335 if( p_chain->b_allow_fmt_out_change )
336 return &p_chain->fmt_out;
338 /* Unless filter_chain_Reset has been called we are doomed */
339 if( p_chain->filters.i_count <= 0 )
340 return &p_chain->fmt_out;
343 filter_t *p_last = (filter_t*)p_chain->filters.pp_elems[p_chain->filters.i_count-1];
345 return &p_last->fmt_out;
349 * Apply the filter chain
352 /* FIXME This include is needed by the Ugly hack */
353 #include <vlc_vout.h>
355 picture_t *filter_chain_VideoFilter( filter_chain_t *p_chain, picture_t *p_pic )
358 filter_t **pp_filter = (filter_t **)p_chain->filters.pp_elems;
359 for( i = 0; i < p_chain->filters.i_count; i++ )
361 filter_t *p_filter = pp_filter[i];
362 picture_t *p_newpic = p_filter->pf_video_filter( p_filter, p_pic );
364 /* FIXME Ugly hack to make it work in picture core.
365 * FIXME Remove this code when the picture release API has been
366 * FIXME cleaned up (a git revert of the commit should work) */
367 if( p_chain->p_this->i_object_type == VLC_OBJECT_VOUT )
369 vout_thread_t *p_vout = (vout_thread_t*)p_chain->p_this;
370 vlc_mutex_lock( &p_vout->picture_lock );
371 if( p_pic->i_refcount )
373 p_pic->i_status = DISPLAYED_PICTURE;
377 p_pic->i_status = DESTROYED_PICTURE;
378 p_vout->i_heap_size--;
380 vlc_mutex_unlock( &p_vout->picture_lock );
383 p_newpic->i_status = READY_PICTURE;
393 block_t *filter_chain_AudioFilter( filter_chain_t *p_chain, block_t *p_block )
396 filter_t **pp_filter = (filter_t **)p_chain->filters.pp_elems;
397 for( i = 0; i < p_chain->filters.i_count; i++ )
399 filter_t *p_filter = pp_filter[i];
400 p_block = p_filter->pf_audio_filter( p_filter, p_block );
409 void filter_chain_SubFilter( filter_chain_t *p_chain,
410 mtime_t display_date )
413 filter_t **pp_filter = (filter_t **)p_chain->filters.pp_elems;
414 for( i = 0; i < p_chain->filters.i_count; i++ )
416 filter_t *p_filter = pp_filter[i];
417 subpicture_t *p_subpic = p_filter->pf_sub_filter( p_filter,
420 spu_DisplaySubpicture( (spu_t*)p_chain->p_this, p_subpic );
425 * Internal chain buffer handling
429 * This function should be called after every filter chain change
431 static int UpdateBufferFunctions( filter_chain_t *p_chain )
433 if( !strcmp( p_chain->psz_capability, "video filter2" ) )
436 * Last filter uses the filter chain's parent buffer allocation
437 * functions. All the other filters use internal functions.
438 * This makes it possible to have format changes between each
439 * filter without having to worry about the parent's picture
443 filter_t **pp_filter = (filter_t **)p_chain->filters.pp_elems;
445 for( i = 0; i < p_chain->filters.i_count - 1; i++ )
447 p_filter = pp_filter[i];
448 if( p_filter->pf_vout_buffer_new != VideoBufferNew )
450 if( p_chain->pf_buffer_allocation_clear )
451 p_chain->pf_buffer_allocation_clear( p_filter );
452 p_filter->pf_vout_buffer_new = VideoBufferNew;
453 p_filter->pf_vout_buffer_del = NULL;
456 if( p_chain->filters.i_count >= 1 )
458 p_filter = pp_filter[i];
459 if( p_filter->pf_vout_buffer_new == VideoBufferNew )
461 p_filter->pf_vout_buffer_new = NULL;
462 if( p_chain->pf_buffer_allocation_init( p_filter,
463 p_chain->p_buffer_allocation_data ) != VLC_SUCCESS )
471 static picture_t *VideoBufferNew( filter_t *p_filter )
473 const video_format_t *p_fmt = &p_filter->fmt_out.video;
475 picture_t *p_picture = picture_New( p_fmt->i_chroma,
476 p_fmt->i_width, p_fmt->i_height,
479 msg_Err( p_filter, "Failed to allocate picture\n" );