git.sesse.net Git - vlc/blob - src/misc/filter_chain.c

   1 /*****************************************************************************
   2  * filter_chain.c : Handle chains of filter_t objects.
   3  *****************************************************************************
   4  * Copyright (C) 2008 the VideoLAN team
   5  * $Id$
   6  *
   7  * Author: Antoine Cellerier <dionoea at videolan dot org>
   8  *
   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.
  13  *
  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.
  18  *
  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  *****************************************************************************/
  23
  24 #ifdef HAVE_CONFIG_H
  25 # include "config.h"
  26 #endif
  27
  28 #include <vlc_filter.h>
  29 #include <vlc_arrays.h>
  30 #include <libvlc.h>
  31
  32 struct filter_chain_t
  33 {
  34     vlc_object_t *p_this; /* Parent object */
  35
  36     vlc_array_t filters; /* List of filters */
  37
  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 */
  42
  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 */
  46 };
  47
  48 /**
  49  * Local prototypes
  50  */
  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 * );
  54
  55 static int UpdateBufferFunctions( filter_chain_t * );
  56 static picture_t *VideoBufferNew( filter_t * );
  57
  58 /**
  59  * Filter chain initialisation
  60  */
  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 )
  67 {
  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 )
  75     {
  76         free( p_chain );
  77         return NULL;
  78     }
  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;
  82
  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;
  86
  87     return p_chain;
  88 }
  89
  90 /**
  91  * Filter chain destruction
  92  */
  93 void filter_chain_Delete( filter_chain_t *p_chain )
  94 {
  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 );
 102     free( p_chain );
 103 }
 104 /**
 105  * Filter chain reinitialisation
 106  */
 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 )
 109 {
 110     while( p_chain->filters.i_count )
 111         filter_chain_DeleteFilterInternal( p_chain,
 112                                    (filter_t*)p_chain->filters.pp_elems[0] );
 113     if( p_fmt_in )
 114     {
 115         es_format_Clean( &p_chain->fmt_in );
 116         es_format_Copy( &p_chain->fmt_in, p_fmt_in );
 117     }
 118     if( p_fmt_out )
 119     {
 120         es_format_Clean( &p_chain->fmt_out );
 121         es_format_Copy( &p_chain->fmt_out, p_fmt_out );
 122     }
 123 }
 124
 125
 126 /**
 127  * Modifying the filter chain
 128  */
 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 )
 134 {
 135     static const char typename[] = "filter";
 136     filter_t *p_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 );
 141
 142     if( !p_fmt_in )
 143     {
 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;
 146         else
 147             p_fmt_in = &p_chain->fmt_in;
 148     }
 149
 150     if( !p_fmt_out )
 151     {
 152         p_fmt_out = &p_chain->fmt_out;
 153     }
 154
 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;
 159
 160     p_filter->p_module = module_Need( p_filter, p_chain->psz_capability,
 161                                       psz_name, psz_name ? true : false );
 162
 163     if( !p_filter->p_module )
 164         goto error;
 165
 166     if( p_filter->b_allow_fmt_out_change )
 167     {
 168         es_format_Clean( &p_chain->fmt_out );
 169         es_format_Copy( &p_chain->fmt_out, &p_filter->fmt_out );
 170     }
 171
 172     if( p_chain->pf_buffer_allocation_init( p_filter,
 173             p_chain->p_buffer_allocation_data ) != VLC_SUCCESS )
 174         goto error;
 175
 176     vlc_array_append( &p_chain->filters, p_filter );
 177
 178     msg_Dbg( p_chain->p_this, "Filter '%s' (%p) appended to chain",
 179              psz_name?:p_filter->psz_object_name, p_filter );
 180
 181     return p_filter;
 182
 183     error:
 184         if( psz_name )
 185             msg_Err( p_chain->p_this, "Failed to create video filter '%s'",
 186                      psz_name );
 187         else
 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 );
 195         return NULL;
 196 }
 197
 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 )
 203 {
 204     filter_t *p_filter = filter_chain_AppendFilterInternal( p_chain, psz_name,
 205                                                             p_cfg, p_fmt_in,
 206                                                             p_fmt_out );
 207     if( UpdateBufferFunctions( p_chain ) < 0 )
 208         msg_Err( p_filter, "Woah! This doesn't look good." );
 209     return p_filter;
 210 }
 211
 212 static int filter_chain_AppendFromStringInternal( filter_chain_t *p_chain,
 213                                                   const char *psz_string )
 214 {
 215     config_chain_t *p_cfg = NULL;
 216     char *psz_name = NULL;
 217
 218     if( !psz_string || !*psz_string ) return 0;
 219
 220     psz_string = config_ChainCreate( &psz_name, &p_cfg, psz_string );
 221
 222     filter_t *p_filter = filter_chain_AppendFilterInternal( p_chain, psz_name,
 223                                                             p_cfg, NULL, NULL );
 224     if( !p_filter )
 225     {
 226         msg_Err( p_chain->p_this, "Failed while trying to append '%s' "
 227                  "to filter chain", psz_name );
 228         free( psz_name );
 229         free( p_cfg );
 230         return -1;
 231     }
 232     free( psz_name );
 233
 234     int ret = filter_chain_AppendFromStringInternal( p_chain, psz_string );
 235     if( ret < 0 )
 236     {
 237         filter_chain_DeleteFilterInternal( p_chain, p_filter );
 238         return ret;
 239     }
 240     return 1 + ret;
 241 }
 242
 243 int filter_chain_AppendFromString( filter_chain_t *p_chain,
 244                                    const char *psz_string )
 245 {
 246     int i_ret = filter_chain_AppendFromStringInternal( p_chain, psz_string );
 247     if( i_ret < 0 ) return i_ret;
 248     int i_ret2 = UpdateBufferFunctions( p_chain );
 249     if( i_ret2 < 0 ) return i_ret2;
 250     return i_ret;
 251 }
 252
 253 static int filter_chain_DeleteFilterInternal( filter_chain_t *p_chain,
 254                                               filter_t *p_filter )
 255 {
 256     int i;
 257     /* Find the filter in the chain */
 258     for( i = 0; i < p_chain->filters.i_count; i++ )
 259         if( (filter_t*)p_chain->filters.pp_elems[i] == p_filter )
 260             break;
 261
 262     /* Oops, filter wasn't found */
 263     if( i == p_chain->filters.i_count )
 264     {
 265         msg_Err( p_chain->p_this, "Couldn't find filter '%s' (%p) when trying "
 266                  "to remove it from chain", p_filter->psz_object_name,
 267                  p_filter );
 268         return VLC_EGENERIC;
 269     }
 270
 271     /* Remove it from the chain */
 272     vlc_array_remove( &p_chain->filters, i );
 273     msg_Dbg( p_chain->p_this, "Filter '%s' (%p) removed from chain",
 274              p_filter->psz_object_name, p_filter );
 275
 276     /* Destroy the filter object */
 277     if( p_chain->pf_buffer_allocation_clear )
 278         p_chain->pf_buffer_allocation_clear( p_filter );
 279     vlc_object_detach( p_filter );
 280     if( p_filter->p_module )
 281         module_Unneed( p_filter, p_filter->p_module );
 282     vlc_object_release( p_filter );
 283
 284     /* FIXME: check fmt_in/fmt_out consitency */
 285     return VLC_SUCCESS;
 286 }
 287
 288 int filter_chain_DeleteFilter( filter_chain_t *p_chain, filter_t *p_filter )
 289 {
 290     int i_ret = filter_chain_DeleteFilterInternal( p_chain, p_filter );
 291     if( i_ret < 0 ) return i_ret;
 292     return UpdateBufferFunctions( p_chain );
 293 }
 294
 295 /**
 296  * Reading from the filter chain
 297  */
 298 filter_t *filter_chain_GetFilter( filter_chain_t *p_chain, int i_position,
 299                                   const char *psz_name )
 300 {
 301     int i;
 302     filter_t **pp_filters = (filter_t **)p_chain->filters.pp_elems;
 303
 304     if( i_position < 0 )
 305         return NULL;
 306
 307     if( !psz_name )
 308     {
 309         if( i_position >= p_chain->filters.i_count )
 310             return NULL;
 311         return pp_filters[i_position];
 312     }
 313
 314     for( i = 0; i < p_chain->filters.i_count; i++ )
 315     {
 316         if( !strcmp( psz_name, pp_filters[i]->psz_object_name ) )
 317             i_position--;
 318         if( i_position < 0 )
 319             return pp_filters[i];
 320    }
 321    return NULL;
 322 }
 323
 324 int filter_chain_GetLength( filter_chain_t *p_chain )
 325 {
 326     return p_chain->filters.i_count;
 327 }
 328
 329 const es_format_t *filter_chain_GetFmtOut( filter_chain_t *p_chain )
 330 {
 331     return &p_chain->fmt_out;
 332 }
 333
 334 /**
 335  * Apply the filter chain
 336  */
 337
 338 /* FIXME This include is needed by the Ugly hack */
 339 #include <vlc_vout.h>
 340
 341 picture_t *filter_chain_VideoFilter( filter_chain_t *p_chain, picture_t *p_pic )
 342 {
 343     int i;
 344     filter_t **pp_filter = (filter_t **)p_chain->filters.pp_elems;
 345     for( i = 0; i < p_chain->filters.i_count; i++ )
 346     {
 347         filter_t *p_filter = pp_filter[i];
 348         picture_t *p_newpic = p_filter->pf_video_filter( p_filter, p_pic );
 349
 350         /* FIXME Ugly hack to make it work in picture core.
 351          * FIXME Remove this code when the picture release API has been
 352          * FIXME cleaned up (a git revert of the commit should work) */
 353         if( p_chain->p_this->i_object_type == VLC_OBJECT_VOUT )
 354         {
 355             vout_thread_t *p_vout = (vout_thread_t*)p_chain->p_this;
 356
 357             vlc_mutex_lock( &p_vout->picture_lock );
 358             if( p_pic->i_refcount )
 359             {
 360                 p_pic->i_status = DISPLAYED_PICTURE;
 361             }
 362             else
 363             {
 364                 p_pic->i_status = DESTROYED_PICTURE;
 365                 p_vout->i_heap_size--;
 366             }
 367             vlc_mutex_unlock( &p_vout->picture_lock );
 368
 369             if( p_newpic )
 370                 p_newpic->i_status = READY_PICTURE;
 371         }
 372         if( !p_newpic )
 373             return NULL;
 374
 375         p_pic = p_newpic;
 376     }
 377     return p_pic;
 378 }
 379
 380 block_t *filter_chain_AudioFilter( filter_chain_t *p_chain, block_t *p_block )
 381 {
 382     int i;
 383     filter_t **pp_filter = (filter_t **)p_chain->filters.pp_elems;
 384     for( i = 0; i < p_chain->filters.i_count; i++ )
 385     {
 386         filter_t *p_filter = pp_filter[i];
 387         p_block = p_filter->pf_audio_filter( p_filter, p_block );
 388         if( !p_block )
 389             return NULL;
 390     }
 391     return p_block;
 392 }
 393
 394 #include <vlc_osd.h>
 395
 396 void filter_chain_SubFilter( filter_chain_t *p_chain,
 397                              mtime_t display_date )
 398 {
 399     int i;
 400     filter_t **pp_filter = (filter_t **)p_chain->filters.pp_elems;
 401     for( i = 0; i < p_chain->filters.i_count; i++ )
 402     {
 403         filter_t *p_filter = pp_filter[i];
 404         subpicture_t *p_subpic = p_filter->pf_sub_filter( p_filter,
 405                                                           display_date );
 406         if( p_subpic )
 407             spu_DisplaySubpicture( (spu_t*)p_chain->p_this, p_subpic );
 408     }
 409 }
 410
 411 /**
 412  * Internal chain buffer handling
 413  */
 414
 415 /**
 416  * This function should be called after every filter chain change
 417  */
 418 static int UpdateBufferFunctions( filter_chain_t *p_chain )
 419 {
 420     if( !strcmp( p_chain->psz_capability, "video filter2" ) )
 421     {
 422         /**
 423          * Last filter uses the filter chain's parent buffer allocation
 424          * functions. All the other filters use internal functions.
 425          * This makes it possible to have format changes between each
 426          * filter without having to worry about the parent's picture
 427          * heap format.
 428          */
 429         int i;
 430         filter_t **pp_filter = (filter_t **)p_chain->filters.pp_elems;
 431         filter_t *p_filter;
 432         for( i = 0; i < p_chain->filters.i_count - 1; i++ )
 433         {
 434             p_filter = pp_filter[i];
 435             if( p_filter->pf_vout_buffer_new != VideoBufferNew )
 436             {
 437                 if( p_chain->pf_buffer_allocation_clear )
 438                     p_chain->pf_buffer_allocation_clear( p_filter );
 439                 p_filter->pf_vout_buffer_new = VideoBufferNew;
 440                 p_filter->pf_vout_buffer_del = NULL;
 441             }
 442         }
 443         if( p_chain->filters.i_count >= 1 )
 444         {
 445             p_filter = pp_filter[i];
 446             if( p_filter->pf_vout_buffer_new == VideoBufferNew )
 447             {
 448                 p_filter->pf_vout_buffer_new = NULL;
 449                 if( p_chain->pf_buffer_allocation_init( p_filter,
 450                         p_chain->p_buffer_allocation_data ) != VLC_SUCCESS )
 451                     return VLC_EGENERIC;
 452             }
 453         }
 454     }
 455     return VLC_SUCCESS;
 456 }
 457
 458 static picture_t *VideoBufferNew( filter_t *p_filter )
 459 {
 460     const video_format_t *p_fmt = &p_filter->fmt_out.video;
 461
 462     picture_t *p_picture = picture_New( p_fmt->i_chroma,
 463                                         p_fmt->i_width, p_fmt->i_height,
 464                                         p_fmt->i_aspect );
 465     if( !p_picture )
 466         msg_Err( p_filter, "Failed to allocate picture\n" );
 467     return p_picture;
 468 }
 469