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>
30 #include <vlc_modules.h>
36 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. */
37 void (* pf_clean)( filter_t * ); /* Callback called on filter removal from chain to clean up buffer allocation callbacks data (ie p_owner) */
38 void *p_data; /* Data for pf_buffer_allocation_init */
40 } filter_chain_allocator_t;
42 typedef struct chained_filter_t
44 /* Public part of the filter structure */
46 /* Private filter chain data (shhhh!) */
47 struct chained_filter_t *prev, *next;
51 /* Only use this with filter objects from _this_ C module */
52 static inline chained_filter_t *chained (filter_t *filter)
54 return (chained_filter_t *)filter;
57 static int AllocatorInit( const filter_chain_allocator_t *,
59 static void AllocatorClean( const filter_chain_allocator_t *,
62 static bool IsInternalVideoAllocator( chained_filter_t * );
64 static int InternalVideoInit( filter_t *, void * );
65 static void InternalVideoClean( filter_t * );
67 static const filter_chain_allocator_t internal_video_allocator = {
68 .pf_init = InternalVideoInit,
69 .pf_clean = InternalVideoClean,
76 vlc_object_t *p_this; /**< Owner object */
77 filter_chain_allocator_t allocator; /**< Owner allocation callbacks */
79 chained_filter_t *first, *last; /**< List of filters */
81 es_format_t fmt_in; /**< Chain input format (constant) */
82 es_format_t fmt_out; /**< Chain current output format */
83 unsigned length; /**< Number of filters */
84 bool b_allow_fmt_out_change; /**< Can the output format be changed? */
85 char psz_capability[1]; /**< Module capability for all chained filters */
91 static filter_t *filter_chain_AppendFilterInternal( filter_chain_t *,
92 const char *, config_chain_t *,
93 const es_format_t *, const es_format_t * );
95 static int filter_chain_AppendFromStringInternal( filter_chain_t *, const char * );
97 static int filter_chain_DeleteFilterInternal( filter_chain_t *, filter_t * );
99 static int UpdateBufferFunctions( filter_chain_t * );
101 #undef filter_chain_New
103 * Filter chain initialisation
105 filter_chain_t *filter_chain_New( vlc_object_t *p_this,
106 const char *psz_capability,
107 bool b_allow_fmt_out_change,
108 int (*pf_buffer_allocation_init)( filter_t *, void * ),
109 void (*pf_buffer_allocation_clean)( filter_t * ),
110 void *p_buffer_allocation_data )
113 assert( psz_capability );
115 size_t size = sizeof(filter_chain_t) + strlen(psz_capability);
116 filter_chain_t *p_chain = malloc( size );
120 p_chain->p_this = p_this;
121 p_chain->last = p_chain->first = NULL;
123 strcpy( p_chain->psz_capability, psz_capability );
125 es_format_Init( &p_chain->fmt_in, UNKNOWN_ES, 0 );
126 es_format_Init( &p_chain->fmt_out, UNKNOWN_ES, 0 );
127 p_chain->b_allow_fmt_out_change = b_allow_fmt_out_change;
129 p_chain->allocator.pf_init = pf_buffer_allocation_init;
130 p_chain->allocator.pf_clean = pf_buffer_allocation_clean;
131 p_chain->allocator.p_data = p_buffer_allocation_data;
137 * Filter chain destruction
139 void filter_chain_Delete( filter_chain_t *p_chain )
141 filter_chain_Reset( p_chain, NULL, NULL );
143 es_format_Clean( &p_chain->fmt_in );
144 es_format_Clean( &p_chain->fmt_out );
149 * Filter chain reinitialisation
151 void filter_chain_Reset( filter_chain_t *p_chain, const es_format_t *p_fmt_in,
152 const es_format_t *p_fmt_out )
156 while( (p_filter = &p_chain->first->filter) != NULL )
157 filter_chain_DeleteFilterInternal( p_chain, p_filter );
161 es_format_Clean( &p_chain->fmt_in );
162 es_format_Copy( &p_chain->fmt_in, p_fmt_in );
166 es_format_Clean( &p_chain->fmt_out );
167 es_format_Copy( &p_chain->fmt_out, p_fmt_out );
171 filter_t *filter_chain_AppendFilter( filter_chain_t *p_chain,
172 const char *psz_name,
173 config_chain_t *p_cfg,
174 const es_format_t *p_fmt_in,
175 const es_format_t *p_fmt_out )
177 filter_t *p_filter = filter_chain_AppendFilterInternal( p_chain, psz_name,
180 if( UpdateBufferFunctions( p_chain ) < 0 )
181 msg_Err( p_filter, "Woah! This doesn't look good." );
185 int filter_chain_AppendFromString( filter_chain_t *p_chain,
186 const char *psz_string )
188 const int i_ret = filter_chain_AppendFromStringInternal( p_chain, psz_string );
192 /* FIXME That one seems bad if a error is returned */
193 return UpdateBufferFunctions( p_chain );
196 int filter_chain_DeleteFilter( filter_chain_t *p_chain, filter_t *p_filter )
198 const int i_ret = filter_chain_DeleteFilterInternal( p_chain, p_filter );
202 /* FIXME That one seems bad if a error is returned */
203 return UpdateBufferFunctions( p_chain );
206 int filter_chain_GetLength( filter_chain_t *p_chain )
208 return p_chain->length;
211 const es_format_t *filter_chain_GetFmtOut( filter_chain_t *p_chain )
214 if( p_chain->b_allow_fmt_out_change )
215 return &p_chain->fmt_out;
217 if( p_chain->last != NULL )
218 return &p_chain->last->filter.fmt_out;
220 /* Unless filter_chain_Reset has been called we are doomed */
221 return &p_chain->fmt_out;
224 picture_t *filter_chain_VideoFilter( filter_chain_t *p_chain, picture_t *p_pic )
226 for( chained_filter_t *f = p_chain->first; f != NULL; f = f->next )
228 filter_t *p_filter = &f->filter;
230 p_pic = p_filter->pf_video_filter( p_filter, p_pic );
237 void filter_chain_VideoFlush( filter_chain_t *p_chain )
239 for( chained_filter_t *f = p_chain->first; f != NULL; f = f->next )
241 filter_t *p_filter = &f->filter;
243 filter_FlushPictures( p_filter );
248 block_t *filter_chain_AudioFilter( filter_chain_t *p_chain, block_t *p_block )
250 for( chained_filter_t *f = p_chain->first; f != NULL; f = f->next )
252 filter_t *p_filter = &f->filter;
254 p_block = p_filter->pf_audio_filter( p_filter, p_block );
261 void filter_chain_SubFilter( filter_chain_t *p_chain,
262 mtime_t display_date )
264 for( chained_filter_t *f = p_chain->first; f != NULL; f = f->next )
266 filter_t *p_filter = &f->filter;
267 subpicture_t *p_subpic = p_filter->pf_sub_filter( p_filter, display_date );
268 /* XXX I find that spu_t cast ugly */
270 spu_DisplaySubpicture( (spu_t*)p_chain->p_this, p_subpic );
274 int filter_chain_MouseFilter( filter_chain_t *p_chain, vlc_mouse_t *p_dst, const vlc_mouse_t *p_src )
276 vlc_mouse_t current = *p_src;
278 for( chained_filter_t *f = p_chain->first; f != NULL; f = f->next )
280 filter_t *p_filter = &f->filter;
281 vlc_mouse_t *p_mouse = f->mouse;
283 if( p_filter->pf_video_mouse && p_mouse )
285 vlc_mouse_t old = *p_mouse;
286 vlc_mouse_t filtered;
289 if( p_filter->pf_video_mouse( p_filter, &filtered, &old, ¤t ) )
299 int filter_chain_MouseEvent( filter_chain_t *p_chain,
300 const vlc_mouse_t *p_mouse,
301 const video_format_t *p_fmt )
303 for( chained_filter_t *f = p_chain->first; f != NULL; f = f->next )
305 filter_t *p_filter = &f->filter;
307 if( p_filter->pf_sub_mouse )
309 vlc_mouse_t old = *f->mouse;
310 *f->mouse = *p_mouse;
311 if( p_filter->pf_sub_mouse( p_filter, &old, p_mouse, p_fmt ) )
320 static filter_t *filter_chain_AppendFilterInternal( filter_chain_t *p_chain,
321 const char *psz_name,
322 config_chain_t *p_cfg,
323 const es_format_t *p_fmt_in,
324 const es_format_t *p_fmt_out )
326 chained_filter_t *p_chained =
327 vlc_custom_create( p_chain->p_this, sizeof(*p_chained),
328 VLC_OBJECT_GENERIC, "filter" );
329 filter_t *p_filter = &p_chained->filter;
332 vlc_object_attach( p_filter, p_chain->p_this );
336 if( p_chain->last != NULL )
337 p_fmt_in = &p_chain->last->filter.fmt_out;
339 p_fmt_in = &p_chain->fmt_in;
344 p_fmt_out = &p_chain->fmt_out;
347 es_format_Copy( &p_filter->fmt_in, p_fmt_in );
348 es_format_Copy( &p_filter->fmt_out, p_fmt_out );
349 p_filter->p_cfg = p_cfg;
350 p_filter->b_allow_fmt_out_change = p_chain->b_allow_fmt_out_change;
352 p_filter->p_module = module_need( p_filter, p_chain->psz_capability,
353 psz_name, psz_name != NULL );
355 if( !p_filter->p_module )
358 if( p_filter->b_allow_fmt_out_change )
360 es_format_Clean( &p_chain->fmt_out );
361 es_format_Copy( &p_chain->fmt_out, &p_filter->fmt_out );
364 if( AllocatorInit( &p_chain->allocator, p_chained ) )
367 if( p_chain->last == NULL )
369 assert( p_chain->first == NULL );
370 p_chain->first = p_chained;
373 p_chain->last->next = p_chained;
374 p_chained->prev = p_chain->last;
375 p_chain->last = p_chained;
376 p_chained->next = NULL;
379 vlc_mouse_t *p_mouse = malloc( sizeof(*p_mouse) );
381 vlc_mouse_Init( p_mouse );
382 p_chained->mouse = p_mouse;
384 msg_Dbg( p_chain->p_this, "Filter '%s' (%p) appended to chain",
385 psz_name ? psz_name : module_get_name(p_filter->p_module, false),
392 msg_Err( p_chain->p_this, "Failed to create %s '%s'",
393 p_chain->psz_capability, psz_name );
395 msg_Err( p_chain->p_this, "Failed to create %s",
396 p_chain->psz_capability );
397 if( p_filter->p_module )
398 module_unneed( p_filter, p_filter->p_module );
399 es_format_Clean( &p_filter->fmt_in );
400 es_format_Clean( &p_filter->fmt_out );
401 vlc_object_release( p_filter );
406 static int filter_chain_AppendFromStringInternal( filter_chain_t *p_chain,
407 const char *psz_string )
409 config_chain_t *p_cfg = NULL;
410 char *psz_name = NULL;
411 char* psz_new_string;
413 if( !psz_string || !*psz_string )
416 psz_new_string = config_ChainCreate( &psz_name, &p_cfg, psz_string );
418 filter_t *p_filter = filter_chain_AppendFilterInternal( p_chain, psz_name,
422 msg_Err( p_chain->p_this, "Failed while trying to append '%s' "
423 "to filter chain", psz_name );
426 free( psz_new_string );
431 const int i_ret = filter_chain_AppendFromStringInternal( p_chain, psz_new_string );
432 free( psz_new_string );
435 filter_chain_DeleteFilterInternal( p_chain, p_filter );
441 static int filter_chain_DeleteFilterInternal( filter_chain_t *p_chain,
444 chained_filter_t *p_chained = chained( p_filter );
446 /* Remove it from the chain */
447 if( p_chained->prev != NULL )
448 p_chained->prev->next = p_chained->next;
451 assert( p_chained == p_chain->first );
452 p_chain->first = p_chained->next;
455 if( p_chained->next != NULL )
456 p_chained->next->prev = p_chained->prev;
459 assert( p_chained == p_chain->last );
460 p_chain->last = p_chained->prev;
464 msg_Dbg( p_chain->p_this, "Filter %p removed from chain", p_filter );
466 /* Destroy the filter object */
467 if( IsInternalVideoAllocator( p_chained ) )
468 AllocatorClean( &internal_video_allocator, p_chained );
470 AllocatorClean( &p_chain->allocator, p_chained );
472 if( p_filter->p_module )
473 module_unneed( p_filter, p_filter->p_module );
474 free( p_chained->mouse );
475 vlc_object_release( p_filter );
478 /* FIXME: check fmt_in/fmt_out consitency */
483 * Internal chain buffer handling
486 static int UpdateVideoBufferFunctions( filter_chain_t *p_chain )
489 * Last filter uses the filter chain's parent buffer allocation
490 * functions. All the other filters use internal functions.
491 * This makes it possible to have format changes between each
492 * filter without having to worry about the parent's picture
495 /* FIXME: we should only update the last and penultimate filters */
498 for( f = p_chain->first; f != p_chain->last; f = f->next )
500 if( !IsInternalVideoAllocator( f ) )
502 AllocatorClean( &p_chain->allocator, f );
504 AllocatorInit( &internal_video_allocator, f );
510 if( IsInternalVideoAllocator( f ) )
512 AllocatorClean( &internal_video_allocator, f );
514 if( AllocatorInit( &p_chain->allocator, f ) )
522 * This function should be called after every filter chain change
524 static int UpdateBufferFunctions( filter_chain_t *p_chain )
526 if( !strcmp( p_chain->psz_capability, "video filter2" ) )
527 return UpdateVideoBufferFunctions( p_chain );
532 /* Internal video allocator functions */
533 static picture_t *VideoBufferNew( filter_t *p_filter )
535 const video_format_t *p_fmt = &p_filter->fmt_out.video;
537 picture_t *p_picture = picture_NewFromFormat( p_fmt );
539 msg_Err( p_filter, "Failed to allocate picture" );
542 static void VideoBufferDelete( filter_t *p_filter, picture_t *p_picture )
544 VLC_UNUSED( p_filter );
545 picture_Release( p_picture );
547 static int InternalVideoInit( filter_t *p_filter, void *p_data )
551 p_filter->pf_video_buffer_new = VideoBufferNew;
552 p_filter->pf_video_buffer_del = VideoBufferDelete;
556 static void InternalVideoClean( filter_t *p_filter )
558 p_filter->pf_video_buffer_new = NULL;
559 p_filter->pf_video_buffer_del = NULL;
562 static bool IsInternalVideoAllocator( chained_filter_t *p_filter )
564 return p_filter->filter.pf_video_buffer_new == VideoBufferNew;
568 static int AllocatorInit( const filter_chain_allocator_t *p_alloc,
569 chained_filter_t *p_filter )
571 if( p_alloc->pf_init )
572 return p_alloc->pf_init( &p_filter->filter, p_alloc->p_data );
576 static void AllocatorClean( const filter_chain_allocator_t *p_alloc,
577 chained_filter_t *p_filter )
579 if( p_alloc->pf_clean )
580 p_alloc->pf_clean( &p_filter->filter );