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>
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 typedef struct chained_filter_t
43 /* Public part of the filter structure */
45 /* Private filter chain data (shhhh!) */
46 struct chained_filter_t *prev, *next;
50 /* Only use this with filter objects from _this_ C module */
51 static inline chained_filter_t *chained (filter_t *filter)
53 return (chained_filter_t *)filter;
56 static int AllocatorInit( const filter_chain_allocator_t *,
58 static void AllocatorClean( const filter_chain_allocator_t *,
61 static bool IsInternalVideoAllocator( chained_filter_t * );
63 static int InternalVideoInit( filter_t *, void * );
64 static void InternalVideoClean( filter_t * );
66 static const filter_chain_allocator_t internal_video_allocator = {
67 .pf_init = InternalVideoInit,
68 .pf_clean = InternalVideoClean,
75 vlc_object_t *p_this; /**< Owner object */
76 filter_chain_allocator_t allocator; /**< Owner allocation callbacks */
78 chained_filter_t *first, *last; /**< List of filters */
80 es_format_t fmt_in; /**< Chain input format (constant) */
81 es_format_t fmt_out; /**< Chain current output format */
82 unsigned length; /**< Number of filters */
83 bool b_allow_fmt_out_change; /**< Can the output format be changed? */
84 char psz_capability[1]; /**< Module capability for all chained filters */
90 static filter_t *filter_chain_AppendFilterInternal( filter_chain_t *,
91 const char *, config_chain_t *,
92 const es_format_t *, const es_format_t * );
94 static int filter_chain_AppendFromStringInternal( filter_chain_t *, const char * );
96 static int filter_chain_DeleteFilterInternal( filter_chain_t *, filter_t * );
98 static int UpdateBufferFunctions( filter_chain_t * );
100 #undef filter_chain_New
102 * Filter chain initialisation
104 filter_chain_t *filter_chain_New( vlc_object_t *p_this,
105 const char *psz_capability,
106 bool b_allow_fmt_out_change,
107 int (*pf_buffer_allocation_init)( filter_t *, void * ),
108 void (*pf_buffer_allocation_clean)( filter_t * ),
109 void *p_buffer_allocation_data )
112 assert( psz_capability );
114 size_t size = sizeof(filter_chain_t) + strlen(psz_capability);
115 filter_chain_t *p_chain = malloc( size );
119 p_chain->p_this = p_this;
120 p_chain->last = p_chain->first = NULL;
122 strcpy( p_chain->psz_capability, psz_capability );
124 es_format_Init( &p_chain->fmt_in, UNKNOWN_ES, 0 );
125 es_format_Init( &p_chain->fmt_out, UNKNOWN_ES, 0 );
126 p_chain->b_allow_fmt_out_change = b_allow_fmt_out_change;
128 p_chain->allocator.pf_init = pf_buffer_allocation_init;
129 p_chain->allocator.pf_clean = pf_buffer_allocation_clean;
130 p_chain->allocator.p_data = p_buffer_allocation_data;
136 * Filter chain destruction
138 void filter_chain_Delete( filter_chain_t *p_chain )
140 filter_chain_Reset( p_chain, NULL, NULL );
142 es_format_Clean( &p_chain->fmt_in );
143 es_format_Clean( &p_chain->fmt_out );
148 * Filter chain reinitialisation
150 void filter_chain_Reset( filter_chain_t *p_chain, const es_format_t *p_fmt_in,
151 const es_format_t *p_fmt_out )
155 while( (p_filter = &p_chain->first->filter) != NULL )
156 filter_chain_DeleteFilterInternal( p_chain, p_filter );
160 es_format_Clean( &p_chain->fmt_in );
161 es_format_Copy( &p_chain->fmt_in, p_fmt_in );
165 es_format_Clean( &p_chain->fmt_out );
166 es_format_Copy( &p_chain->fmt_out, p_fmt_out );
170 filter_t *filter_chain_AppendFilter( filter_chain_t *p_chain,
171 const char *psz_name,
172 config_chain_t *p_cfg,
173 const es_format_t *p_fmt_in,
174 const es_format_t *p_fmt_out )
176 filter_t *p_filter = filter_chain_AppendFilterInternal( p_chain, psz_name,
179 if( UpdateBufferFunctions( p_chain ) < 0 )
180 msg_Err( p_filter, "Woah! This doesn't look good." );
184 int filter_chain_AppendFromString( filter_chain_t *p_chain,
185 const char *psz_string )
187 const int i_ret = filter_chain_AppendFromStringInternal( p_chain, psz_string );
191 /* FIXME That one seems bad if a error is returned */
192 return UpdateBufferFunctions( p_chain );
195 int filter_chain_DeleteFilter( filter_chain_t *p_chain, filter_t *p_filter )
197 const int i_ret = filter_chain_DeleteFilterInternal( p_chain, p_filter );
201 /* FIXME That one seems bad if a error is returned */
202 return UpdateBufferFunctions( p_chain );
205 int filter_chain_GetLength( filter_chain_t *p_chain )
207 return p_chain->length;
210 const es_format_t *filter_chain_GetFmtOut( filter_chain_t *p_chain )
213 if( p_chain->b_allow_fmt_out_change )
214 return &p_chain->fmt_out;
216 if( p_chain->last != NULL )
217 return &p_chain->last->filter.fmt_out;
219 /* Unless filter_chain_Reset has been called we are doomed */
220 return &p_chain->fmt_out;
223 picture_t *filter_chain_VideoFilter( filter_chain_t *p_chain, picture_t *p_pic )
225 for( chained_filter_t *f = p_chain->first; f != NULL; f = f->next )
227 filter_t *p_filter = &f->filter;
229 p_pic = p_filter->pf_video_filter( p_filter, p_pic );
236 block_t *filter_chain_AudioFilter( filter_chain_t *p_chain, block_t *p_block )
238 for( chained_filter_t *f = p_chain->first; f != NULL; f = f->next )
240 filter_t *p_filter = &f->filter;
242 p_block = p_filter->pf_audio_filter( p_filter, p_block );
249 void filter_chain_SubFilter( filter_chain_t *p_chain,
250 mtime_t display_date )
252 for( chained_filter_t *f = p_chain->first; f != NULL; f = f->next )
254 filter_t *p_filter = &f->filter;
255 subpicture_t *p_subpic = p_filter->pf_sub_filter( p_filter, display_date );
256 /* XXX I find that spu_t cast ugly */
258 spu_DisplaySubpicture( (spu_t*)p_chain->p_this, p_subpic );
262 int filter_chain_MouseFilter( filter_chain_t *p_chain, vlc_mouse_t *p_dst, const vlc_mouse_t *p_src )
264 vlc_mouse_t current = *p_src;
266 for( chained_filter_t *f = p_chain->first; f != NULL; f = f->next )
268 filter_t *p_filter = &f->filter;
269 vlc_mouse_t *p_mouse = f->mouse;
271 if( p_filter->pf_video_mouse && p_mouse )
273 vlc_mouse_t old = *p_mouse;
274 vlc_mouse_t filtered;
277 if( p_filter->pf_video_mouse( p_filter, &filtered, &old, ¤t ) )
289 static filter_t *filter_chain_AppendFilterInternal( filter_chain_t *p_chain,
290 const char *psz_name,
291 config_chain_t *p_cfg,
292 const es_format_t *p_fmt_in,
293 const es_format_t *p_fmt_out )
295 chained_filter_t *p_chained =
296 vlc_custom_create( p_chain->p_this, sizeof(*p_chained),
297 VLC_OBJECT_GENERIC, "filter" );
298 filter_t *p_filter = &p_chained->filter;
301 vlc_object_attach( p_filter, p_chain->p_this );
305 if( p_chain->last != NULL )
306 p_fmt_in = &p_chain->last->filter.fmt_out;
308 p_fmt_in = &p_chain->fmt_in;
313 p_fmt_out = &p_chain->fmt_out;
316 es_format_Copy( &p_filter->fmt_in, p_fmt_in );
317 es_format_Copy( &p_filter->fmt_out, p_fmt_out );
318 p_filter->p_cfg = p_cfg;
319 p_filter->b_allow_fmt_out_change = p_chain->b_allow_fmt_out_change;
321 p_filter->p_module = module_need( p_filter, p_chain->psz_capability,
322 psz_name, psz_name != NULL );
324 if( !p_filter->p_module )
327 if( p_filter->b_allow_fmt_out_change )
329 es_format_Clean( &p_chain->fmt_out );
330 es_format_Copy( &p_chain->fmt_out, &p_filter->fmt_out );
333 if( AllocatorInit( &p_chain->allocator, p_chained ) )
336 if( p_chain->last == NULL )
338 assert( p_chain->first == NULL );
339 p_chain->first = p_chained;
342 p_chain->last->next = p_chained;
343 p_chained->prev = p_chain->last;
344 p_chain->last = p_chained;
345 p_chained->next = NULL;
348 vlc_mouse_t *p_mouse = malloc( sizeof(*p_mouse) );
350 vlc_mouse_Init( p_mouse );
351 p_chained->mouse = p_mouse;
353 msg_Dbg( p_chain->p_this, "Filter '%s' (%p) appended to chain",
354 psz_name ? psz_name : module_get_name(p_filter->p_module, false),
361 msg_Err( p_chain->p_this, "Failed to create %s '%s'",
362 p_chain->psz_capability, psz_name );
364 msg_Err( p_chain->p_this, "Failed to create %s",
365 p_chain->psz_capability );
366 if( p_filter->p_module )
367 module_unneed( p_filter, p_filter->p_module );
368 es_format_Clean( &p_filter->fmt_in );
369 es_format_Clean( &p_filter->fmt_out );
370 vlc_object_release( p_filter );
375 static int filter_chain_AppendFromStringInternal( filter_chain_t *p_chain,
376 const char *psz_string )
378 config_chain_t *p_cfg = NULL;
379 char *psz_name = NULL;
380 char* psz_new_string;
382 if( !psz_string || !*psz_string )
385 psz_new_string = config_ChainCreate( &psz_name, &p_cfg, psz_string );
387 filter_t *p_filter = filter_chain_AppendFilterInternal( p_chain, psz_name,
391 msg_Err( p_chain->p_this, "Failed while trying to append '%s' "
392 "to filter chain", psz_name );
395 free( psz_new_string );
400 const int i_ret = filter_chain_AppendFromStringInternal( p_chain, psz_new_string );
401 free( psz_new_string );
404 filter_chain_DeleteFilterInternal( p_chain, p_filter );
410 static int filter_chain_DeleteFilterInternal( filter_chain_t *p_chain,
413 chained_filter_t *p_chained = chained( p_filter );
415 /* Remove it from the chain */
416 if( p_chained->prev != NULL )
417 p_chained->prev->next = p_chained->next;
420 assert( p_chained == p_chain->first );
421 p_chain->first = p_chained->next;
424 if( p_chained->next != NULL )
425 p_chained->next->prev = p_chained->prev;
428 assert( p_chained == p_chain->last );
429 p_chain->last = p_chained->prev;
433 msg_Dbg( p_chain->p_this, "Filter %p removed from chain", p_filter );
435 /* Destroy the filter object */
436 if( IsInternalVideoAllocator( p_chained ) )
437 AllocatorClean( &internal_video_allocator, p_chained );
439 AllocatorClean( &p_chain->allocator, p_chained );
441 if( p_filter->p_module )
442 module_unneed( p_filter, p_filter->p_module );
443 free( p_chained->mouse );
444 vlc_object_release( p_filter );
447 /* FIXME: check fmt_in/fmt_out consitency */
452 * Internal chain buffer handling
455 static int UpdateVideoBufferFunctions( filter_chain_t *p_chain )
458 * Last filter uses the filter chain's parent buffer allocation
459 * functions. All the other filters use internal functions.
460 * This makes it possible to have format changes between each
461 * filter without having to worry about the parent's picture
464 /* FIXME: we should only update the last and penultimate filters */
467 for( f = p_chain->first; f != p_chain->last; f = f->next )
469 if( !IsInternalVideoAllocator( f ) )
471 AllocatorClean( &p_chain->allocator, f );
473 AllocatorInit( &internal_video_allocator, f );
479 if( IsInternalVideoAllocator( f ) )
481 AllocatorClean( &internal_video_allocator, f );
483 if( AllocatorInit( &p_chain->allocator, f ) )
491 * This function should be called after every filter chain change
493 static int UpdateBufferFunctions( filter_chain_t *p_chain )
495 if( !strcmp( p_chain->psz_capability, "video filter2" ) )
496 return UpdateVideoBufferFunctions( p_chain );
501 /* Internal video allocator functions */
502 static picture_t *VideoBufferNew( filter_t *p_filter )
504 const video_format_t *p_fmt = &p_filter->fmt_out.video;
506 picture_t *p_picture = picture_NewFromFormat( p_fmt );
508 msg_Err( p_filter, "Failed to allocate picture" );
511 static void VideoBufferDelete( filter_t *p_filter, picture_t *p_picture )
513 VLC_UNUSED( p_filter );
514 picture_Release( p_picture );
516 static int InternalVideoInit( filter_t *p_filter, void *p_data )
520 p_filter->pf_video_buffer_new = VideoBufferNew;
521 p_filter->pf_video_buffer_del = VideoBufferDelete;
525 static void InternalVideoClean( filter_t *p_filter )
527 p_filter->pf_video_buffer_new = NULL;
528 p_filter->pf_video_buffer_del = NULL;
531 static bool IsInternalVideoAllocator( chained_filter_t *p_filter )
533 return p_filter->filter.pf_video_buffer_new == VideoBufferNew;
537 static int AllocatorInit( const filter_chain_allocator_t *p_alloc,
538 chained_filter_t *p_filter )
540 if( p_alloc->pf_init )
541 return p_alloc->pf_init( &p_filter->filter, p_alloc->p_data );
545 static void AllocatorClean( const filter_chain_allocator_t *p_alloc,
546 chained_filter_t *p_filter )
548 if( p_alloc->pf_clean )
549 p_alloc->pf_clean( &p_filter->filter );