include/vlc_filter.h

   1 /*****************************************************************************
   2  * vlc_filter.h: filter related structures and functions
   3  *****************************************************************************
   4  * Copyright (C) 1999-2008 VLC authors and VideoLAN
   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 it
  11  * under the terms of the GNU Lesser General Public License as published by
  12  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public License
  21  * along with this program; if not, write to the Free Software Foundation,
  22  * 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         } audio;
  93 #define pf_audio_filter     u.audio.pf_filter
  94
  95         struct
  96         {
  97             void        (*pf_blend) ( filter_t *,  picture_t *,
  98                                       const picture_t *, int, int, int );
  99         } blend;
 100 #define pf_video_blend     u.blend.pf_blend
 101
 102         struct
 103         {
 104             subpicture_t * (*pf_source)    ( filter_t *, mtime_t );
 105             subpicture_t * (*pf_buffer_new)( filter_t * );
 106             void           (*pf_buffer_del)( filter_t *, subpicture_t * );
 107             int            (*pf_mouse)     ( filter_t *,
 108                                              const vlc_mouse_t *p_old,
 109                                              const vlc_mouse_t *p_new,
 110                                              const video_format_t * );
 111         } sub;
 112 #define pf_sub_source      u.sub.pf_source
 113 #define pf_sub_buffer_new  u.sub.pf_buffer_new
 114 #define pf_sub_buffer_del  u.sub.pf_buffer_del
 115 #define pf_sub_mouse       u.sub.pf_mouse
 116
 117         struct
 118         {
 119             subpicture_t * (*pf_filter) ( filter_t *, subpicture_t * );
 120         } subf;
 121 #define pf_sub_filter      u.subf.pf_filter
 122
 123         struct
 124         {
 125             int         (*pf_text) ( filter_t *, subpicture_region_t *,
 126                                      subpicture_region_t *,
 127                                      const vlc_fourcc_t * );
 128             int         (*pf_html) ( filter_t *, subpicture_region_t *,
 129                                      subpicture_region_t *,
 130                                      const vlc_fourcc_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 gives all input attachments at once.
 214  *
 215  * You MUST release the returned values
 216  */
 217 static inline int filter_GetInputAttachments( filter_t *p_filter,
 218                                               input_attachment_t ***ppp_attachment,
 219                                               int *pi_attachment )
 220 {
 221     if( !p_filter->pf_get_attachments )
 222         return VLC_EGENERIC;
 223     return p_filter->pf_get_attachments( p_filter,
 224                                          ppp_attachment, pi_attachment );
 225 }
 226
 227 /**
 228  * It creates a blend filter.
 229  *
 230  * Only the chroma properties of the dest format is used (chroma
 231  * type, rgb masks and shifts)
 232  */
 233 VLC_API filter_t * filter_NewBlend( vlc_object_t *, const video_format_t *p_dst_chroma ) VLC_USED;
 234
 235 /**
 236  * It configures blend filter parameters that are allowed to changed
 237  * after the creation.
 238  */
 239 VLC_API int filter_ConfigureBlend( filter_t *, int i_dst_width, int i_dst_height, const video_format_t *p_src );
 240
 241 /**
 242  * It blends a picture into another one.
 243  *
 244  * The input picture is not modified and not released.
 245  */
 246 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 );
 247
 248 /**
 249  * It destroys a blend filter created by filter_NewBlend.
 250  */
 251 VLC_API void filter_DeleteBlend( filter_t * );
 252
 253 /**
 254  * Create a picture_t *(*)( filter_t *, picture_t * ) compatible wrapper
 255  * using a void (*)( filter_t *, picture_t *, picture_t * ) function
 256  *
 257  * Currently used by the chroma video filters
 258  */
 259 #define VIDEO_FILTER_WRAPPER( name )                                    \
 260     static picture_t *name ## _Filter ( filter_t *p_filter,             \
 261                                         picture_t *p_pic )              \
 262     {                                                                   \
 263         picture_t *p_outpic = filter_NewPicture( p_filter );            \
 264         if( p_outpic )                                                  \
 265         {                                                               \
 266             name( p_filter, p_pic, p_outpic );                          \
 267             picture_CopyProperties( p_outpic, p_pic );                  \
 268         }                                                               \
 269         picture_Release( p_pic );                                       \
 270         return p_outpic;                                                \
 271     }
 272
 273 /**
 274  * Filter chain management API
 275  * The filter chain management API is used to dynamically construct filters
 276  * and add them in a chain.
 277  */
 278
 279 typedef struct filter_chain_t filter_chain_t;
 280
 281 /**
 282  * Create new filter chain
 283  *
 284  * \param p_object pointer to a vlc object
 285  * \param psz_capability vlc capability of filters in filter chain
 286  * \param b_allow_format_fmt_change allow changing of fmt
 287  * \param pf_buffer_allocation_init callback function to initialize buffer allocations
 288  * \param pf_buffer_allocation_clear callback function to clear buffer allocation initialization
 289  * \param p_buffer_allocation_data pointer to private allocation data
 290  * \return pointer to a filter chain
 291  */
 292 VLC_API filter_chain_t * filter_chain_New( vlc_object_t *, const char *, bool, int (*)( filter_t *, void * ), void (*)( filter_t * ), void *  ) VLC_USED;
 293 #define filter_chain_New( a, b, c, d, e, f ) filter_chain_New( VLC_OBJECT( a ), b, c, d, e, f )
 294
 295 /**
 296  * Delete filter chain will delete all filters in the chain and free all
 297  * allocated data. The pointer to the filter chain is then no longer valid.
 298  *
 299  * \param p_chain pointer to filter chain
 300  */
 301 VLC_API void filter_chain_Delete( filter_chain_t * );
 302
 303 /**
 304  * Reset filter chain will delete all filters in the chain and
 305  * reset p_fmt_in and p_fmt_out to the new values.
 306  *
 307  * \param p_chain pointer to filter chain
 308  * \param p_fmt_in new fmt_in params
 309  * \param p_fmt_out new fmt_out params
 310  */
 311 VLC_API void filter_chain_Reset( filter_chain_t *, const es_format_t *, const es_format_t * );
 312
 313 /**
 314  * Append filter to the end of the chain.
 315  *
 316  * \param p_chain pointer to filter chain
 317  * \param psz_name name of filter
 318  * \param p_cfg
 319  * \param p_fmt_in input es_format_t
 320  * \param p_fmt_out output es_format_t
 321  * \return pointer to filter chain
 322  */
 323 VLC_API filter_t * filter_chain_AppendFilter( filter_chain_t *, const char *, config_chain_t *, const es_format_t *, const es_format_t * );
 324
 325 /**
 326  * Append new filter to filter chain from string.
 327  *
 328  * \param p_chain pointer to filter chain
 329  * \param psz_string string of filters
 330  * \return 0 for success
 331  */
 332 VLC_API int filter_chain_AppendFromString( filter_chain_t *, const char * );
 333
 334 /**
 335  * Delete filter from filter chain. This function also releases the filter
 336  * object and unloads the filter modules. The pointer to p_filter is no
 337  * longer valid after this function successfully returns.
 338  *
 339  * \param p_chain pointer to filter chain
 340  * \param p_filter pointer to filter object
 341  * \return VLC_SUCCESS on succes, else VLC_EGENERIC
 342  */
 343 VLC_API int filter_chain_DeleteFilter( filter_chain_t *, filter_t * );
 344
 345 /**
 346  * Get the number of filters in the filter chain.
 347  *
 348  * \param p_chain pointer to filter chain
 349  * \return number of filters in this filter chain
 350  */
 351 VLC_API int filter_chain_GetLength( filter_chain_t * );
 352
 353 /**
 354  * Get last p_fmt_out in the chain.
 355  *
 356  * \param p_chain pointer to filter chain
 357  * \return last p_fmt (es_format_t) of this filter chain
 358  */
 359 VLC_API const es_format_t * filter_chain_GetFmtOut( filter_chain_t * );
 360
 361 /**
 362  * Apply the filter chain to a video picture.
 363  *
 364  * \param p_chain pointer to filter chain
 365  * \param p_picture picture to apply filters on
 366  * \return modified picture after applying all video filters
 367  */
 368 VLC_API picture_t * filter_chain_VideoFilter( filter_chain_t *, picture_t * );
 369
 370 /**
 371  * Flush a video filter chain.
 372  */
 373 VLC_API void filter_chain_VideoFlush( filter_chain_t * );
 374
 375 /**
 376  * Apply the filter chain to a audio block.
 377  *
 378  * \param p_chain pointer to filter chain
 379  * \param p_block audio frame to apply filters on
 380  * \return modified audio frame after applying all audio filters
 381  */
 382 VLC_API block_t * filter_chain_AudioFilter( filter_chain_t *, block_t * );
 383
 384 /**
 385  * Apply filter chain to subpictures.
 386  *
 387  * \param p_chain pointer to filter chain
 388  * \param display_date of subpictures
 389  */
 390 VLC_API void filter_chain_SubSource( filter_chain_t *, mtime_t );
 391
 392 /**
 393  * Apply filter chain to subpictures.
 394  *
 395  * \param p_chain pointer to filter chain
 396  * \param p_subpicture subpicture to apply filters on
 397  * \return modified subpicture after applying all subpicture filters
 398  */
 399 VLC_API subpicture_t * filter_chain_SubFilter( filter_chain_t *, subpicture_t * );
 400
 401 /**
 402  * Apply the filter chain to a mouse state.
 403  *
 404  * It will be applied from the output to the input. It makes sense only
 405  * for a video filter chain.
 406  *
 407  * The vlc_mouse_t* pointers may be the same.
 408  */
 409 VLC_API int filter_chain_MouseFilter( filter_chain_t *, vlc_mouse_t *, const vlc_mouse_t * );
 410
 411 /**
 412  * Inform the filter chain of mouse state.
 413  *
 414  * It makes sense only for a sub source chain.
 415  */
 416 VLC_API int filter_chain_MouseEvent( filter_chain_t *, const vlc_mouse_t *, const video_format_t * );
 417
 418 #endif /* _VLC_FILTER_H */
 419