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>
35 int (*pf_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. */
36 void (* pf_clean)( filter_t * ); /* Callback called on filter removal from chain to clean up buffer allocation callbacks data (ie p_owner) */
37 void *p_data; /* Data for pf_buffer_allocation_init */
39 } filter_chain_allocator_t;
41 static int AllocatorInit( const filter_chain_allocator_t *, filter_t * );
42 static void AllocatorClean( const filter_chain_allocator_t *, filter_t * );
44 static bool IsInternalVideoAllocator( filter_t * );
46 static int InternalVideoInit( filter_t *, void * );
47 static void InternalVideoClean( filter_t * );
49 static const filter_chain_allocator_t internal_video_allocator = {
50 .pf_init = InternalVideoInit,
51 .pf_clean = InternalVideoClean,
64 /* Capability of all the filters in the chain */
67 /* Input format (read only) */
70 /* allow changing fmt_out if true */
71 bool b_allow_fmt_out_change;
73 /* Output format (writable depending on ... */
76 /* User provided allocator */
77 filter_chain_allocator_t allocator;
83 static filter_t *filter_chain_AppendFilterInternal( filter_chain_t *,
84 const char *, config_chain_t *,
85 const es_format_t *, const es_format_t * );
87 static int filter_chain_AppendFromStringInternal( filter_chain_t *, const char * );
89 static int filter_chain_DeleteFilterInternal( filter_chain_t *, filter_t * );
91 static int UpdateBufferFunctions( filter_chain_t * );
94 * Filter chain initialisation
96 filter_chain_t *__filter_chain_New( vlc_object_t *p_this,
97 const char *psz_capability,
98 bool b_allow_fmt_out_change,
99 int (*pf_buffer_allocation_init)( filter_t *, void * ),
100 void (*pf_buffer_allocation_clean)( filter_t * ),
101 void *p_buffer_allocation_data )
103 filter_chain_t *p_chain = malloc( sizeof( *p_chain ) );
107 p_chain->p_this = p_this;
108 vlc_array_init( &p_chain->filters );
109 p_chain->psz_capability = strdup( psz_capability );
110 if( !p_chain->psz_capability )
112 vlc_array_clear( &p_chain->filters );
116 es_format_Init( &p_chain->fmt_in, UNKNOWN_ES, 0 );
117 es_format_Init( &p_chain->fmt_out, UNKNOWN_ES, 0 );
118 p_chain->b_allow_fmt_out_change = b_allow_fmt_out_change;
120 p_chain->allocator.pf_init = pf_buffer_allocation_init;
121 p_chain->allocator.pf_clean = pf_buffer_allocation_clean;
122 p_chain->allocator.p_data = p_buffer_allocation_data;
128 * Filter chain destruction
130 void filter_chain_Delete( filter_chain_t *p_chain )
132 filter_chain_Reset( p_chain, NULL, NULL );
134 es_format_Clean( &p_chain->fmt_in );
135 es_format_Clean( &p_chain->fmt_out );
137 free( p_chain->psz_capability );
138 vlc_array_clear( &p_chain->filters );
142 * Filter chain reinitialisation
144 void filter_chain_Reset( filter_chain_t *p_chain, const es_format_t *p_fmt_in,
145 const es_format_t *p_fmt_out )
147 while( vlc_array_count( &p_chain->filters ) > 0 )
149 filter_t *p_filter = vlc_array_item_at_index( &p_chain->filters, 0 );
151 filter_chain_DeleteFilterInternal( p_chain, p_filter );
155 es_format_Clean( &p_chain->fmt_in );
156 es_format_Copy( &p_chain->fmt_in, p_fmt_in );
160 es_format_Clean( &p_chain->fmt_out );
161 es_format_Copy( &p_chain->fmt_out, p_fmt_out );
165 filter_t *filter_chain_AppendFilter( filter_chain_t *p_chain,
166 const char *psz_name,
167 config_chain_t *p_cfg,
168 const es_format_t *p_fmt_in,
169 const es_format_t *p_fmt_out )
171 filter_t *p_filter = filter_chain_AppendFilterInternal( p_chain, psz_name,
174 if( UpdateBufferFunctions( p_chain ) < 0 )
175 msg_Err( p_filter, "Woah! This doesn't look good." );
179 int filter_chain_AppendFromString( filter_chain_t *p_chain,
180 const char *psz_string )
182 const int i_ret = filter_chain_AppendFromStringInternal( p_chain, psz_string );
186 /* FIXME That one seems bad if a error is returned */
187 return UpdateBufferFunctions( p_chain );
190 int filter_chain_DeleteFilter( filter_chain_t *p_chain, filter_t *p_filter )
192 const int i_ret = filter_chain_DeleteFilterInternal( p_chain, p_filter );
196 /* FIXME That one seems bad if a error is returned */
197 return UpdateBufferFunctions( p_chain );
201 * Reading from the filter chain
203 filter_t *filter_chain_GetFilter( filter_chain_t *p_chain, int i_position,
204 const char *psz_name )
211 for( int i = 0; i < vlc_array_count( &p_chain->filters ); i++ )
213 filter_t *p_filter = vlc_array_item_at_index( &p_chain->filters, i );
214 if( !strcmp( p_filter->psz_object_name, psz_name ) )
216 if( i_position <= 0 )
225 if( i_position < 0 || i_position >= vlc_array_count( &p_chain->filters ) )
227 return vlc_array_item_at_index( &p_chain->filters, i_position );
231 int filter_chain_GetLength( filter_chain_t *p_chain )
233 return vlc_array_count( &p_chain->filters );
236 const es_format_t *filter_chain_GetFmtOut( filter_chain_t *p_chain )
239 if( p_chain->b_allow_fmt_out_change )
240 return &p_chain->fmt_out;
242 const int i_count = vlc_array_count( &p_chain->filters );
245 filter_t *p_last = vlc_array_item_at_index( &p_chain->filters, i_count - 1 );
246 return &p_last->fmt_out;
249 /* Unless filter_chain_Reset has been called we are doomed */
250 return &p_chain->fmt_out;
253 picture_t *filter_chain_VideoFilter( filter_chain_t *p_chain, picture_t *p_pic )
255 for( int i = 0; i < vlc_array_count( &p_chain->filters ); i++ )
257 filter_t *p_filter = vlc_array_item_at_index( &p_chain->filters, i );
259 p_pic = p_filter->pf_video_filter( p_filter, p_pic );
266 block_t *filter_chain_AudioFilter( filter_chain_t *p_chain, block_t *p_block )
268 for( int i = 0; i < vlc_array_count( &p_chain->filters ); i++ )
270 filter_t *p_filter = vlc_array_item_at_index( &p_chain->filters, i );
272 p_block = p_filter->pf_audio_filter( p_filter, p_block );
279 void filter_chain_SubFilter( filter_chain_t *p_chain,
280 mtime_t display_date )
282 for( int i = 0; i < vlc_array_count( &p_chain->filters ); i++ )
284 filter_t *p_filter = vlc_array_item_at_index( &p_chain->filters, i );
286 subpicture_t *p_subpic = p_filter->pf_sub_filter( p_filter, display_date );
287 /* XXX I find that spu_t cast ugly */
289 spu_DisplaySubpicture( (spu_t*)p_chain->p_this, p_subpic );
295 static filter_t *filter_chain_AppendFilterInternal( filter_chain_t *p_chain,
296 const char *psz_name,
297 config_chain_t *p_cfg,
298 const es_format_t *p_fmt_in,
299 const es_format_t *p_fmt_out )
301 filter_t *p_filter = vlc_custom_create( p_chain->p_this, sizeof(*p_filter),
302 VLC_OBJECT_GENERIC, "filter" );
305 vlc_object_attach( p_filter, p_chain->p_this );
309 p_fmt_in = &p_chain->fmt_in;
311 const int i_count = vlc_array_count( &p_chain->filters );
314 filter_t *p_last = vlc_array_item_at_index( &p_chain->filters, i_count - 1 );
315 p_fmt_in = &p_last->fmt_out;
321 p_fmt_out = &p_chain->fmt_out;
324 es_format_Copy( &p_filter->fmt_in, p_fmt_in );
325 es_format_Copy( &p_filter->fmt_out, p_fmt_out );
326 p_filter->p_cfg = p_cfg;
327 p_filter->b_allow_fmt_out_change = p_chain->b_allow_fmt_out_change;
329 p_filter->p_module = module_need( p_filter, p_chain->psz_capability,
330 psz_name, psz_name != NULL );
332 if( !p_filter->p_module )
335 if( p_filter->b_allow_fmt_out_change )
337 es_format_Clean( &p_chain->fmt_out );
338 es_format_Copy( &p_chain->fmt_out, &p_filter->fmt_out );
341 if( AllocatorInit( &p_chain->allocator, p_filter ) )
344 vlc_array_append( &p_chain->filters, p_filter );
346 msg_Dbg( p_chain->p_this, "Filter '%s' (%p) appended to chain",
347 psz_name ? psz_name : p_filter->psz_object_name, p_filter );
353 msg_Err( p_chain->p_this, "Failed to create %s '%s'",
354 p_chain->psz_capability, psz_name );
356 msg_Err( p_chain->p_this, "Failed to create %s",
357 p_chain->psz_capability );
358 if( p_filter->p_module )
359 module_unneed( p_filter, p_filter->p_module );
360 es_format_Clean( &p_filter->fmt_in );
361 es_format_Clean( &p_filter->fmt_out );
362 vlc_object_detach( p_filter );
363 vlc_object_release( p_filter );
368 static int filter_chain_AppendFromStringInternal( filter_chain_t *p_chain,
369 const char *psz_string )
371 config_chain_t *p_cfg = NULL;
372 char *psz_name = NULL;
373 char* psz_new_string;
375 if( !psz_string || !*psz_string )
378 psz_new_string = config_ChainCreate( &psz_name, &p_cfg, psz_string );
380 filter_t *p_filter = filter_chain_AppendFilterInternal( p_chain, psz_name,
384 msg_Err( p_chain->p_this, "Failed while trying to append '%s' "
385 "to filter chain", psz_name );
388 free( psz_new_string );
393 const int i_ret = filter_chain_AppendFromStringInternal( p_chain, psz_new_string );
394 free( psz_new_string );
397 filter_chain_DeleteFilterInternal( p_chain, p_filter );
403 static int filter_chain_DeleteFilterInternal( filter_chain_t *p_chain,
406 const int i_filter_idx = vlc_array_index_of_item( &p_chain->filters, p_filter );
407 if( i_filter_idx < 0 )
409 /* Oops, filter wasn't found
410 * FIXME shoulnd't it be an assert instead ? */
411 msg_Err( p_chain->p_this,
412 "Couldn't find filter '%s' (%p) when trying to remove it from chain",
413 p_filter->psz_object_name, p_filter );
417 /* Remove it from the chain */
418 vlc_array_remove( &p_chain->filters, i_filter_idx );
419 msg_Dbg( p_chain->p_this, "Filter '%s' (%p) removed from chain",
420 p_filter->psz_object_name, p_filter );
422 /* Destroy the filter object */
423 if( IsInternalVideoAllocator( p_filter ) )
424 AllocatorClean( &internal_video_allocator, p_filter );
426 AllocatorClean( &p_chain->allocator, p_filter );
428 vlc_object_detach( p_filter );
429 if( p_filter->p_module )
430 module_unneed( p_filter, p_filter->p_module );
431 vlc_object_release( p_filter );
433 /* FIXME: check fmt_in/fmt_out consitency */
438 * Internal chain buffer handling
441 static int UpdateVideoBufferFunctions( filter_chain_t *p_chain )
444 * Last filter uses the filter chain's parent buffer allocation
445 * functions. All the other filters use internal functions.
446 * This makes it possible to have format changes between each
447 * filter without having to worry about the parent's picture
450 const int i_count = vlc_array_count( &p_chain->filters );
451 for( int i = 0; i < i_count - 1; i++ )
453 filter_t *p_filter = vlc_array_item_at_index( &p_chain->filters, i );
455 if( !IsInternalVideoAllocator( p_filter ) )
457 AllocatorClean( &p_chain->allocator, p_filter );
459 AllocatorInit( &internal_video_allocator, p_filter );
464 filter_t * p_filter = vlc_array_item_at_index( &p_chain->filters, i_count - 1 );
465 if( IsInternalVideoAllocator( p_filter ) )
467 AllocatorClean( &internal_video_allocator, p_filter );
469 if( AllocatorInit( &p_chain->allocator, p_filter ) )
476 * This function should be called after every filter chain change
478 static int UpdateBufferFunctions( filter_chain_t *p_chain )
480 if( !strcmp( p_chain->psz_capability, "video filter2" ) )
481 return UpdateVideoBufferFunctions( p_chain );
486 /* Internal video allocator functions */
487 static picture_t *VideoBufferNew( filter_t *p_filter )
489 const video_format_t *p_fmt = &p_filter->fmt_out.video;
491 picture_t *p_picture = picture_New( p_fmt->i_chroma,
492 p_fmt->i_width, p_fmt->i_height,
495 msg_Err( p_filter, "Failed to allocate picture" );
498 static void VideoBufferDelete( filter_t *p_filter, picture_t *p_picture )
500 VLC_UNUSED( p_filter );
501 picture_Release( p_picture );
503 static int InternalVideoInit( filter_t *p_filter, void *p_data )
507 p_filter->pf_vout_buffer_new = VideoBufferNew;
508 p_filter->pf_vout_buffer_del = VideoBufferDelete;
512 static void InternalVideoClean( filter_t *p_filter )
514 p_filter->pf_vout_buffer_new = NULL;
515 p_filter->pf_vout_buffer_del = NULL;
517 static bool IsInternalVideoAllocator( filter_t *p_filter )
519 return p_filter->pf_vout_buffer_new == VideoBufferNew;
523 static int AllocatorInit( const filter_chain_allocator_t *p_alloc, filter_t *p_filter )
525 if( p_alloc->pf_init )
526 return p_alloc->pf_init( p_filter, p_alloc->p_data );
529 static void AllocatorClean( const filter_chain_allocator_t *p_alloc, filter_t *p_filter )
531 if( p_alloc->pf_clean )
532 p_alloc->pf_clean( p_filter );