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             picture_t * (*pf_buffer_new) ( filter_t * );
  69             void        (*pf_buffer_del) ( filter_t *, picture_t * );
  70             /* Filter mouse state.
  71              *
  72              * If non-NULL, you must convert from output to input formats:
  73              * - If VLC_SUCCESS is returned, the mouse state is propagated.
  74              * - Otherwise, the mouse change is not propagated.
  75              * If NULL, the mouse state is considered unchanged and will be
  76              * propagated.
  77              */
  78             int         (*pf_mouse)( filter_t *, vlc_mouse_t *,
  79                                      const vlc_mouse_t *p_old,
  80                                      const vlc_mouse_t *p_new );
  81         } video;
  82 #define pf_video_filter     u.video.pf_filter
  83 #define pf_video_mouse      u.video.pf_mouse
  84 #define pf_video_buffer_new u.video.pf_buffer_new
  85 #define pf_video_buffer_del u.video.pf_buffer_del
  86
  87         struct
  88         {
  89             block_t *   (*pf_filter) ( filter_t *, block_t * );
  90             block_t *   (*pf_buffer_new) ( filter_t *, int );
  91         } audio;
  92 #define pf_audio_filter     u.audio.pf_filter
  93 #define pf_audio_buffer_new u.audio.pf_buffer_new
  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_filter) ( filter_t *, mtime_t );
 105             subpicture_t * (*pf_buffer_new) ( filter_t * );
 106             void        (*pf_buffer_del) ( filter_t *, subpicture_t * );
 107         } sub;
 108 #define pf_sub_filter      u.sub.pf_filter
 109 #define pf_sub_buffer_new  u.sub.pf_buffer_new
 110 #define pf_sub_buffer_del  u.sub.pf_buffer_del
 111
 112         struct
 113         {
 114             int         (*pf_text) ( filter_t *, subpicture_region_t *,
 115                                      subpicture_region_t * );
 116             int         (*pf_html) ( filter_t *, subpicture_region_t *,
 117                                      subpicture_region_t * );
 118         } render;
 119 #define pf_render_text     u.render.pf_text
 120 #define pf_render_html     u.render.pf_html
 121
 122     } u;
 123     /* Private structure for the owner of the decoder */
 124     filter_owner_sys_t *p_owner;
 125 };
 126
 127 /**
 128  * This function will return a new picture usable by p_filter as an output
 129  * buffer. You have to release it using filter_DeletePicture or by returning
 130  * it to the caller as a pf_video_filter return value.
 131  * Provided for convenience.
 132  *
 133  * \param p_filter filter_t object
 134  * \return new picture on success or NULL on failure
 135  */
 136 static inline picture_t *filter_NewPicture( filter_t *p_filter )
 137 {
 138     picture_t *p_picture = p_filter->pf_video_buffer_new( p_filter );
 139     if( !p_picture )
 140         msg_Warn( p_filter, "can't get output picture" );
 141     return p_picture;
 142 }
 143
 144 /**
 145  * This function will release a picture create by filter_NewPicture.
 146  * Provided for convenience.
 147  *
 148  * \param p_filter filter_t object
 149  * \param p_picture picture to be deleted
 150  */
 151 static inline void filter_DeletePicture( filter_t *p_filter, picture_t *p_picture )
 152 {
 153     p_filter->pf_video_buffer_del( p_filter, p_picture );
 154 }
 155
 156 /**
 157  * This function will return a new subpicture usable by p_filter as an output
 158  * buffer. You have to release it using filter_DeleteSubpicture or by returning
 159  * it to the caller as a pf_sub_filter return value.
 160  * Provided for convenience.
 161  *
 162  * \param p_filter filter_t object
 163  * \return new subpicture
 164  */
 165 static inline subpicture_t *filter_NewSubpicture( filter_t *p_filter )
 166 {
 167     subpicture_t *p_subpicture = p_filter->pf_sub_buffer_new( p_filter );
 168     if( !p_subpicture )
 169         msg_Warn( p_filter, "can't get output subpicture" );
 170     return p_subpicture;
 171 }
 172
 173 /**
 174  * This function will release a subpicture create by filter_NewSubicture.
 175  * Provided for convenience.
 176  *
 177  * \param p_filter filter_t object
 178  * \param p_subpicture to be released
 179  */
 180 static inline void filter_DeleteSubpicture( filter_t *p_filter, subpicture_t *p_subpicture )
 181 {
 182     p_filter->pf_sub_buffer_del( p_filter, p_subpicture );
 183 }
 184
 185 /**
 186  * This function will return a new audio buffer usable by p_filter as an
 187  * output buffer. You have to release it using block_Release or by returning
 188  * it to the caller as a pf_audio_filter return value.
 189  * Provided for convenience.
 190  *
 191  * \param p_filter filter_t object
 192  * \param i_size size of audio buffer requested
 193  * \return block to be used as audio output buffer
 194  */
 195 static inline block_t *filter_NewAudioBuffer( filter_t *p_filter, int i_size )
 196 {
 197     block_t *p_block = p_filter->pf_audio_buffer_new( p_filter, i_size );
 198     if( !p_block )
 199         msg_Warn( p_filter, "can't get output block" );
 200     return p_block;
 201 }
 202
 203 /**
 204  * It creates a blend filter.
 205  *
 206  * Only the chroma properties of the dest format is used (chroma
 207  * type, rgb masks and shifts)
 208  */
 209 VLC_EXPORT( filter_t *, filter_NewBlend, ( vlc_object_t *, const video_format_t *p_dst_chroma ) );
 210
 211 /**
 212  * It configures blend filter parameters that are allowed to changed
 213  * after the creation.
 214  */
 215 VLC_EXPORT( int, filter_ConfigureBlend, ( filter_t *, int i_dst_width, int i_dst_height, const video_format_t *p_src ) );
 216
 217 /**
 218  * It blends a picture into another one.
 219  *
 220  * The input picture is not modified and not released.
 221  */
 222 VLC_EXPORT( 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 ) );
 223
 224 /**
 225  * It destroys a blend filter created by filter_NewBlend.
 226  */
 227 VLC_EXPORT( void, filter_DeleteBlend, ( filter_t * ) );
 228
 229 /**
 230  * Create a picture_t *(*)( filter_t *, picture_t * ) compatible wrapper
 231  * using a void (*)( filter_t *, picture_t *, picture_t * ) function
 232  *
 233  * Currently used by the chroma video filters
 234  */
 235 #define VIDEO_FILTER_WRAPPER( name )                                    \
 236     static picture_t *name ## _Filter ( filter_t *p_filter,             \
 237                                         picture_t *p_pic )              \
 238     {                                                                   \
 239         picture_t *p_outpic = filter_NewPicture( p_filter );            \
 240         if( p_outpic )                                                  \
 241         {                                                               \
 242             name( p_filter, p_pic, p_outpic );                          \
 243             picture_CopyProperties( p_outpic, p_pic );                  \
 244         }                                                               \
 245         picture_Release( p_pic );                                       \
 246         return p_outpic;                                                \
 247     }
 248
 249 /**
 250  * Filter chain management API
 251  * The filter chain management API is used to dynamically construct filters
 252  * and add them in a chain.
 253  */
 254
 255 typedef struct filter_chain_t filter_chain_t;
 256
 257 /**
 258  * Create new filter chain
 259  *
 260  * \param p_object pointer to a vlc object
 261  * \param psz_capability vlc capability of filters in filter chain
 262  * \param b_allow_format_fmt_change allow changing of fmt
 263  * \param pf_buffer_allocation_init callback function to initialize buffer allocations
 264  * \param pf_buffer_allocation_clear callback function to clear buffer allocation initialization
 265  * \param p_buffer_allocation_data pointer to private allocation data
 266  * \return pointer to a filter chain
 267  */
 268 VLC_EXPORT( filter_chain_t *, filter_chain_New, ( vlc_object_t *, const char *, bool, int (*)( filter_t *, void * ), void (*)( filter_t * ), void *  ) );
 269 #define filter_chain_New( a, b, c, d, e, f ) filter_chain_New( VLC_OBJECT( a ), b, c, d, e, f )
 270
 271 /**
 272  * Delete filter chain will delete all filters in the chain and free all
 273  * allocated data. The pointer to the filter chain is then no longer valid.
 274  *
 275  * \param p_chain pointer to filter chain
 276  */
 277 VLC_EXPORT( void, filter_chain_Delete, ( filter_chain_t * ) );
 278
 279 /**
 280  * Reset filter chain will delete all filters in the chain and
 281  * reset p_fmt_in and p_fmt_out to the new values.
 282  *
 283  * \param p_chain pointer to filter chain
 284  * \param p_fmt_in new fmt_in params
 285  * \param p_fmt_out new fmt_out params
 286  */
 287 VLC_EXPORT( void, filter_chain_Reset, ( filter_chain_t *, const es_format_t *, const es_format_t * ) );
 288
 289 /**
 290  * Append filter to the end of the chain.
 291  *
 292  * \param p_chain pointer to filter chain
 293  * \param psz_name name of filter
 294  * \param p_cfg
 295  * \param p_fmt_in input es_format_t
 296  * \param p_fmt_out output es_format_t
 297  * \return pointer to filter chain
 298  */
 299 VLC_EXPORT( filter_t *, filter_chain_AppendFilter, ( filter_chain_t *, const char *, config_chain_t *, const es_format_t *, const es_format_t * ) );
 300
 301 /**
 302  * Append new filter to filter chain from string.
 303  *
 304  * \param p_chain pointer to filter chain
 305  * \param psz_string string of filters
 306  * \return 0 for success
 307  */
 308 VLC_EXPORT( int, filter_chain_AppendFromString, ( filter_chain_t *, const char * ) );
 309
 310 /**
 311  * Delete filter from filter chain. This function also releases the filter
 312  * object and unloads the filter modules. The pointer to p_filter is no
 313  * longer valid after this function successfully returns.
 314  *
 315  * \param p_chain pointer to filter chain
 316  * \param p_filter pointer to filter object
 317  * \return VLC_SUCCESS on succes, else VLC_EGENERIC
 318  */
 319 VLC_EXPORT( int, filter_chain_DeleteFilter, ( filter_chain_t *, filter_t * ) );
 320
 321 /**
 322  * Get the number of filters in the filter chain.
 323  *
 324  * \param p_chain pointer to filter chain
 325  * \return number of filters in this filter chain
 326  */
 327 VLC_EXPORT( int, filter_chain_GetLength, ( filter_chain_t * ) );
 328
 329 /**
 330  * Get last p_fmt_out in the chain.
 331  *
 332  * \param p_chain pointer to filter chain
 333  * \return last p_fmt (es_format_t) of this filter chain
 334  */
 335 VLC_EXPORT( const es_format_t *, filter_chain_GetFmtOut, ( filter_chain_t * ) );
 336
 337 /**
 338  * Apply the filter chain to a video picture.
 339  *
 340  * \param p_chain pointer to filter chain
 341  * \param p_picture picture to apply filters on
 342  * \return modified picture after applying all video filters
 343  */
 344 VLC_EXPORT( picture_t *, filter_chain_VideoFilter, ( filter_chain_t *, picture_t * ) );
 345
 346 /**
 347  * Apply the filter chain to a audio block.
 348  *
 349  * \param p_chain pointer to filter chain
 350  * \param p_block audio frame to apply filters on
 351  * \return modified audio frame after applying all audio filters
 352  */
 353 VLC_EXPORT( block_t *, filter_chain_AudioFilter, ( filter_chain_t *, block_t * ) );
 354
 355 /**
 356  * Apply filter chain to subpictures.
 357  *
 358  * \param p_chain pointer to filter chain
 359  * \param display_date of subpictures
 360  */
 361 VLC_EXPORT( void, filter_chain_SubFilter, ( filter_chain_t *, mtime_t ) );
 362
 363 /**
 364  * Apply the filter chain to a mouse state.
 365  *
 366  * It will be applied from the output to the input. It makes sense only
 367  * for a video filter chain.
 368  *
 369  * The vlc_mouse_t* pointers may be the same.
 370  */
 371 VLC_EXPORT( int, filter_chain_MouseFilter, ( filter_chain_t *, vlc_mouse_t *, const vlc_mouse_t * ) );
 372
 373 #endif /* _VLC_FILTER_H */
 374