include/vlc_filter.h

   1 /*****************************************************************************
   2  * vlc_filter.h: filter related structures and functions
   3  *****************************************************************************
   4  * Copyright (C) 1999-2008 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Gildas Bazin <gbazin@videolan.org>
   8  *          Antoine Cellerier <dionoea at videolan dot org>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 #ifndef VLC_FILTER_H
  26 #define VLC_FILTER_H 1
  27
  28 #include <vlc_es.h>
  29 #include <vlc_picture.h>
  30 #include <vlc_subpicture.h>
  31 #include <vlc_mouse.h>
  32
  33 /**
  34  * \file
  35  * This file defines the structure and types used by video and audio filters
  36  */
  37
  38 typedef struct filter_owner_sys_t filter_owner_sys_t;
  39
  40 /** Structure describing a filter
  41  * @warning BIG FAT WARNING : the code relies on the first 4 members of
  42  * filter_t and decoder_t to be the same, so if you have anything to add,
  43  * do it at the end of the structure.
  44  */
  45 struct filter_t
  46 {
  47     VLC_COMMON_MEMBERS
  48
  49     /* Module properties */
  50     module_t *          p_module;
  51     filter_sys_t *      p_sys;
  52
  53     /* Input format */
  54     es_format_t         fmt_in;
  55
  56     /* Output format of filter */
  57     es_format_t         fmt_out;
  58     bool                b_allow_fmt_out_change;
  59
  60     /* Filter configuration */
  61     config_chain_t *    p_cfg;
  62
  63     union
  64     {
  65         struct
  66         {
  67             picture_t * (*pf_filter) ( filter_t *, picture_t * );
  68             void        (*pf_flush)( filter_t * );
  69             picture_t * (*pf_buffer_new) ( filter_t * );
  70             void        (*pf_buffer_del) ( filter_t *, picture_t * );
  71             /* Filter mouse state.
  72              *
  73              * If non-NULL, you must convert from output to input formats:
  74              * - If VLC_SUCCESS is returned, the mouse state is propagated.
  75              * - Otherwise, the mouse change is not propagated.
  76              * If NULL, the mouse state is considered unchanged and will be
  77              * propagated.
  78              */
  79             int         (*pf_mouse)( filter_t *, vlc_mouse_t *,
  80                                      const vlc_mouse_t *p_old,
  81                                      const vlc_mouse_t *p_new );
  82         } video;
  83 #define pf_video_filter     u.video.pf_filter
  84 #define pf_video_flush      u.video.pf_flush
  85 #define pf_video_mouse      u.video.pf_mouse
  86 #define pf_video_buffer_new u.video.pf_buffer_new
  87 #define pf_video_buffer_del u.video.pf_buffer_del
  88
  89         struct
  90         {
  91             block_t *   (*pf_filter) ( filter_t *, block_t * );
  92             block_t *   (*pf_buffer_new) ( filter_t *, int );
  93         } audio;
  94 #define pf_audio_filter     u.audio.pf_filter
  95 #define pf_audio_buffer_new u.audio.pf_buffer_new
  96
  97         struct
  98         {
  99             void        (*pf_blend) ( filter_t *,  picture_t *,
 100                                       const picture_t *, int, int, int );
 101         } blend;
 102 #define pf_video_blend     u.blend.pf_blend
 103
 104         struct
 105         {
 106             subpicture_t * (*pf_source)    ( filter_t *, mtime_t );
 107             subpicture_t * (*pf_buffer_new)( filter_t * );
 108             void           (*pf_buffer_del)( filter_t *, subpicture_t * );
 109             int            (*pf_mouse)     ( filter_t *,
 110                                              const vlc_mouse_t *p_old,
 111                                              const vlc_mouse_t *p_new,
 112                                              const video_format_t * );
 113         } sub;
 114 #define pf_sub_source      u.sub.pf_source
 115 #define pf_sub_buffer_new  u.sub.pf_buffer_new
 116 #define pf_sub_buffer_del  u.sub.pf_buffer_del
 117 #define pf_sub_mouse       u.sub.pf_mouse
 118
 119         struct
 120         {
 121             subpicture_t * (*pf_filter) ( filter_t *, subpicture_t * );
 122         } subf;
 123 #define pf_sub_filter      u.subf.pf_filter
 124
 125         struct
 126         {
 127             int         (*pf_text) ( filter_t *, subpicture_region_t *,
 128                                      subpicture_region_t * );
 129             int         (*pf_html) ( filter_t *, subpicture_region_t *,
 130                                      subpicture_region_t * );
 131         } render;
 132 #define pf_render_text     u.render.pf_text
 133 #define pf_render_html     u.render.pf_html
 134
 135     } u;
 136
 137     /* Input attachments
 138      * XXX use filter_GetInputAttachments */
 139     int (*pf_get_attachments)( filter_t *, input_attachment_t ***, int * );
 140
 141     /* Private structure for the owner of the decoder */
 142     filter_owner_sys_t *p_owner;
 143 };
 144
 145 /**
 146  * This function will return a new picture usable by p_filter as an output
 147  * buffer. You have to release it using filter_DeletePicture or by returning
 148  * it to the caller as a pf_video_filter return value.
 149  * Provided for convenience.
 150  *
 151  * \param p_filter filter_t object
 152  * \return new picture on success or NULL on failure
 153  */
 154 static inline picture_t *filter_NewPicture( filter_t *p_filter )
 155 {
 156     picture_t *p_picture = p_filter->pf_video_buffer_new( p_filter );
 157     if( !p_picture )
 158         msg_Warn( p_filter, "can't get output picture" );
 159     return p_picture;
 160 }
 161
 162 /**
 163  * This function will release a picture create by filter_NewPicture.
 164  * Provided for convenience.
 165  *
 166  * \param p_filter filter_t object
 167  * \param p_picture picture to be deleted
 168  */
 169 static inline void filter_DeletePicture( filter_t *p_filter, picture_t *p_picture )
 170 {
 171     p_filter->pf_video_buffer_del( p_filter, p_picture );
 172 }
 173
 174 /**
 175  * This function will flush the state of a video filter.
 176  */
 177 static inline void filter_FlushPictures( filter_t *p_filter )
 178 {
 179     if( p_filter->pf_video_flush )
 180         p_filter->pf_video_flush( p_filter );
 181 }
 182
 183 /**
 184  * This function will return a new subpicture usable by p_filter as an output
 185  * buffer. You have to release it using filter_DeleteSubpicture or by returning
 186  * it to the caller as a pf_sub_source return value.
 187  * Provided for convenience.
 188  *
 189  * \param p_filter filter_t object
 190  * \return new subpicture
 191  */
 192 static inline subpicture_t *filter_NewSubpicture( filter_t *p_filter )
 193 {
 194     subpicture_t *p_subpicture = p_filter->pf_sub_buffer_new( p_filter );
 195     if( !p_subpicture )
 196         msg_Warn( p_filter, "can't get output subpicture" );
 197     return p_subpicture;
 198 }
 199
 200 /**
 201  * This function will release a subpicture create by filter_NewSubicture.
 202  * Provided for convenience.
 203  *
 204  * \param p_filter filter_t object
 205  * \param p_subpicture to be released
 206  */
 207 static inline void filter_DeleteSubpicture( filter_t *p_filter, subpicture_t *p_subpicture )
 208 {
 209     p_filter->pf_sub_buffer_del( p_filter, p_subpicture );
 210 }
 211
 212 /**
 213  * This function will return a new audio buffer usable by p_filter as an
 214  * output buffer. You have to release it using block_Release or by returning
 215  * it to the caller as a pf_audio_filter return value.
 216  * Provided for convenience.
 217  *
 218  * \param p_filter filter_t object
 219  * \param i_size size of audio buffer requested
 220  * \return block to be used as audio output buffer
 221  */
 222 static inline block_t *filter_NewAudioBuffer( filter_t *p_filter, int i_size )
 223 {
 224     block_t *p_block = p_filter->pf_audio_buffer_new( p_filter, i_size );
 225     if( !p_block )
 226         msg_Warn( p_filter, "can't get output block" );
 227     return p_block;
 228 }
 229
 230 /**
 231  * This function gives all input attachments at once.
 232  *
 233  * You MUST release the returned values
 234  */
 235 static inline int filter_GetInputAttachments( filter_t *p_filter,
 236                                               input_attachment_t ***ppp_attachment,
 237                                               int *pi_attachment )
 238 {
 239     if( !p_filter->pf_get_attachments )
 240         return VLC_EGENERIC;
 241     return p_filter->pf_get_attachments( p_filter,
 242                                          ppp_attachment, pi_attachment );
 243 }
 244
 245 /**
 246  * It creates a blend filter.
 247  *
 248  * Only the chroma properties of the dest format is used (chroma
 249  * type, rgb masks and shifts)
 250  */
 251 VLC_API filter_t * filter_NewBlend( vlc_object_t *, const video_format_t *p_dst_chroma ) VLC_USED;
 252
 253 /**
 254  * It configures blend filter parameters that are allowed to changed
 255  * after the creation.
 256  */
 257 VLC_API int filter_ConfigureBlend( filter_t *, int i_dst_width, int i_dst_height, const video_format_t *p_src );
 258
 259 /**
 260  * It blends a picture into another one.
 261  *
 262  * The input picture is not modified and not released.
 263  */
 264 VLC_API int filter_Blend( filter_t *, picture_t *p_dst, int i_dst_x, int i_dst_y, const picture_t *p_src, int i_alpha );
 265
 266 /**
 267  * It destroys a blend filter created by filter_NewBlend.
 268  */
 269 VLC_API void filter_DeleteBlend( filter_t * );
 270
 271 /**
 272  * Create a picture_t *(*)( filter_t *, picture_t * ) compatible wrapper
 273  * using a void (*)( filter_t *, picture_t *, picture_t * ) function
 274  *
 275  * Currently used by the chroma video filters
 276  */
 277 #define VIDEO_FILTER_WRAPPER( name )                                    \
 278     static picture_t *name ## _Filter ( filter_t *p_filter,             \
 279                                         picture_t *p_pic )              \
 280     {                                                                   \
 281         picture_t *p_outpic = filter_NewPicture( p_filter );            \
 282         if( p_outpic )                                                  \
 283         {                                                               \
 284             name( p_filter, p_pic, p_outpic );                          \
 285             picture_CopyProperties( p_outpic, p_pic );                  \
 286         }                                                               \
 287         picture_Release( p_pic );                                       \
 288         return p_outpic;                                                \
 289     }
 290
 291 /**
 292  * Filter chain management API
 293  * The filter chain management API is used to dynamically construct filters
 294  * and add them in a chain.
 295  */
 296
 297 typedef struct filter_chain_t filter_chain_t;
 298
 299 /**
 300  * Create new filter chain
 301  *
 302  * \param p_object pointer to a vlc object
 303  * \param psz_capability vlc capability of filters in filter chain
 304  * \param b_allow_format_fmt_change allow changing of fmt
 305  * \param pf_buffer_allocation_init callback function to initialize buffer allocations
 306  * \param pf_buffer_allocation_clear callback function to clear buffer allocation initialization
 307  * \param p_buffer_allocation_data pointer to private allocation data
 308  * \return pointer to a filter chain
 309  */
 310 VLC_API filter_chain_t * filter_chain_New( vlc_object_t *, const char *, bool, int (*)( filter_t *, void * ), void (*)( filter_t * ), void *  ) VLC_USED;
 311 #define filter_chain_New( a, b, c, d, e, f ) filter_chain_New( VLC_OBJECT( a ), b, c, d, e, f )
 312
 313 /**
 314  * Delete filter chain will delete all filters in the chain and free all
 315  * allocated data. The pointer to the filter chain is then no longer valid.
 316  *
 317  * \param p_chain pointer to filter chain
 318  */
 319 VLC_API void filter_chain_Delete( filter_chain_t * );
 320
 321 /**
 322  * Reset filter chain will delete all filters in the chain and
 323  * reset p_fmt_in and p_fmt_out to the new values.
 324  *
 325  * \param p_chain pointer to filter chain
 326  * \param p_fmt_in new fmt_in params
 327  * \param p_fmt_out new fmt_out params
 328  */
 329 VLC_API void filter_chain_Reset( filter_chain_t *, const es_format_t *, const es_format_t * );
 330
 331 /**
 332  * Append filter to the end of the chain.
 333  *
 334  * \param p_chain pointer to filter chain
 335  * \param psz_name name of filter
 336  * \param p_cfg
 337  * \param p_fmt_in input es_format_t
 338  * \param p_fmt_out output es_format_t
 339  * \return pointer to filter chain
 340  */
 341 VLC_API filter_t * filter_chain_AppendFilter( filter_chain_t *, const char *, config_chain_t *, const es_format_t *, const es_format_t * );
 342
 343 /**
 344  * Append new filter to filter chain from string.
 345  *
 346  * \param p_chain pointer to filter chain
 347  * \param psz_string string of filters
 348  * \return 0 for success
 349  */
 350 VLC_API int filter_chain_AppendFromString( filter_chain_t *, const char * );
 351
 352 /**
 353  * Delete filter from filter chain. This function also releases the filter
 354  * object and unloads the filter modules. The pointer to p_filter is no
 355  * longer valid after this function successfully returns.
 356  *
 357  * \param p_chain pointer to filter chain
 358  * \param p_filter pointer to filter object
 359  * \return VLC_SUCCESS on succes, else VLC_EGENERIC
 360  */
 361 VLC_API int filter_chain_DeleteFilter( filter_chain_t *, filter_t * );
 362
 363 /**
 364  * Get the number of filters in the filter chain.
 365  *
 366  * \param p_chain pointer to filter chain
 367  * \return number of filters in this filter chain
 368  */
 369 VLC_API int filter_chain_GetLength( filter_chain_t * );
 370
 371 /**
 372  * Get last p_fmt_out in the chain.
 373  *
 374  * \param p_chain pointer to filter chain
 375  * \return last p_fmt (es_format_t) of this filter chain
 376  */
 377 VLC_API const es_format_t * filter_chain_GetFmtOut( filter_chain_t * );
 378
 379 /**
 380  * Apply the filter chain to a video picture.
 381  *
 382  * \param p_chain pointer to filter chain
 383  * \param p_picture picture to apply filters on
 384  * \return modified picture after applying all video filters
 385  */
 386 VLC_API picture_t * filter_chain_VideoFilter( filter_chain_t *, picture_t * );
 387
 388 /**
 389  * Flush a video filter chain.
 390  */
 391 VLC_API void filter_chain_VideoFlush( filter_chain_t * );
 392
 393 /**
 394  * Apply the filter chain to a audio block.
 395  *
 396  * \param p_chain pointer to filter chain
 397  * \param p_block audio frame to apply filters on
 398  * \return modified audio frame after applying all audio filters
 399  */
 400 VLC_API block_t * filter_chain_AudioFilter( filter_chain_t *, block_t * );
 401
 402 /**
 403  * Apply filter chain to subpictures.
 404  *
 405  * \param p_chain pointer to filter chain
 406  * \param display_date of subpictures
 407  */
 408 VLC_API void filter_chain_SubSource( filter_chain_t *, mtime_t );
 409
 410 /**
 411  * Apply filter chain to subpictures.
 412  *
 413  * \param p_chain pointer to filter chain
 414  * \param p_subpicture subpicture to apply filters on
 415  * \return modified subpicture after applying all subpicture filters
 416  */
 417 VLC_API subpicture_t * filter_chain_SubFilter( filter_chain_t *, subpicture_t * );
 418
 419 /**
 420  * Apply the filter chain to a mouse state.
 421  *
 422  * It will be applied from the output to the input. It makes sense only
 423  * for a video filter chain.
 424  *
 425  * The vlc_mouse_t* pointers may be the same.
 426  */
 427 VLC_API int filter_chain_MouseFilter( filter_chain_t *, vlc_mouse_t *, const vlc_mouse_t * );
 428
 429 /**
 430  * Inform the filter chain of mouse state.
 431  *
 432  * It makes sense only for a sub source chain.
 433  */
 434 VLC_API int filter_chain_MouseEvent( filter_chain_t *, const vlc_mouse_t *, const video_format_t * );
 435
 436 #endif /* _VLC_FILTER_H */
 437