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
  30 /**
  31  * \file
  32  * This file defines the structure and types used by video and audio filters
  33  */
  34
  35 typedef struct filter_owner_sys_t filter_owner_sys_t;
  36
  37 /** Structure describing a filter
  38  * @warning BIG FAT WARNING : the code relies on the first 4 members of
  39  * filter_t and decoder_t to be the same, so if you have anything to add,
  40  * do it at the end of the structure.
  41  */
  42 struct filter_t
  43 {
  44     VLC_COMMON_MEMBERS
  45
  46     /* Module properties */
  47     module_t *          p_module;
  48     filter_sys_t *      p_sys;
  49
  50     /* Input format */
  51     es_format_t         fmt_in;
  52
  53     /* Output format of filter */
  54     es_format_t         fmt_out;
  55     bool                b_allow_fmt_out_change;
  56
  57     /* Filter configuration */
  58     config_chain_t *    p_cfg;
  59
  60     picture_t *         ( * pf_video_filter ) ( filter_t *, picture_t * );
  61     block_t *           ( * pf_audio_filter ) ( filter_t *, block_t * );
  62     void                ( * pf_video_blend )  ( filter_t *,
  63                                                 picture_t *, picture_t *,
  64                                                 int, int, int );
  65
  66     subpicture_t *      ( *pf_sub_filter ) ( filter_t *, mtime_t );
  67     int                 ( *pf_render_text ) ( filter_t *, subpicture_region_t *,
  68                                               subpicture_region_t * );
  69     int                 ( *pf_render_html ) ( filter_t *, subpicture_region_t *,
  70                                               subpicture_region_t * );
  71
  72     /*
  73      * Buffers allocation
  74      */
  75
  76     /* Audio output callbacks */
  77     block_t *       ( * pf_audio_buffer_new) ( filter_t *, int );
  78
  79     /* Video output callbacks */
  80     picture_t     * ( * pf_vout_buffer_new) ( filter_t * );
  81     void            ( * pf_vout_buffer_del) ( filter_t *, picture_t * );
  82     /* void            ( * pf_picture_link)    ( picture_t * );
  83     void            ( * pf_picture_unlink)  ( picture_t * ); */
  84
  85     /* SPU output callbacks */
  86     subpicture_t *  ( * pf_sub_buffer_new) ( filter_t * );
  87     void            ( * pf_sub_buffer_del) ( filter_t *, subpicture_t * );
  88
  89     /* Private structure for the owner of the decoder */
  90     filter_owner_sys_t *p_owner;
  91 };
  92
  93 /**
  94  * This function will return a new picture usable by p_filter as an output
  95  * buffer. You have to release it using filter_DeletePicture or by returning
  96  * it to the caller as a pf_video_filter return value.
  97  * Provided for convenience.
  98  *
  99  * \param p_filter filter_t object
 100  * \return new picture on success or NULL on failure
 101  */
 102 static inline picture_t *filter_NewPicture( filter_t *p_filter )
 103 {
 104     picture_t *p_picture = p_filter->pf_vout_buffer_new( p_filter );
 105     if( !p_picture )
 106         msg_Warn( p_filter, "can't get output picture" );
 107     return p_picture;
 108 }
 109
 110 /**
 111  * This function will release a picture create by filter_NewPicture.
 112  * Provided for convenience.
 113  *
 114  * \param p_filter filter_t object
 115  * \param p_picture picture to be deleted
 116  */
 117 static inline void filter_DeletePicture( filter_t *p_filter, picture_t *p_picture )
 118 {
 119     p_filter->pf_vout_buffer_del( p_filter, p_picture );
 120 }
 121
 122 /**
 123  * This function will return a new subpicture usable by p_filter as an output
 124  * buffer. You have to release it using filter_DeleteSubpicture or by returning
 125  * it to the caller as a pf_sub_filter return value.
 126  * Provided for convenience.
 127  *
 128  * \param p_filter filter_t object
 129  * \return new subpicture
 130  */
 131 static inline subpicture_t *filter_NewSubpicture( filter_t *p_filter )
 132 {
 133     subpicture_t *p_subpicture = p_filter->pf_sub_buffer_new( p_filter );
 134     if( !p_subpicture )
 135         msg_Warn( p_filter, "can't get output subpicture" );
 136     return p_subpicture;
 137 }
 138
 139 /**
 140  * This function will release a subpicture create by filter_NewSubicture.
 141  * Provided for convenience.
 142  *
 143  * \param p_filter filter_t object
 144  * \param p_subpicture to be released
 145  */
 146 static inline void filter_DeleteSubpicture( filter_t *p_filter, subpicture_t *p_subpicture )
 147 {
 148     p_filter->pf_sub_buffer_del( p_filter, p_subpicture );
 149 }
 150
 151 /**
 152  * This function will return a new audio buffer usable by p_filter as an
 153  * output buffer. You have to release it using block_Release or by returning
 154  * it to the caller as a pf_audio_filter return value.
 155  * Provided for convenience.
 156  *
 157  * \param p_filter filter_t object
 158  * \param i_size size of audio buffer requested
 159  * \return block to be used as audio output buffer
 160  */
 161 static inline block_t *filter_NewAudioBuffer( filter_t *p_filter, int i_size )
 162 {
 163     block_t *p_block = p_filter->pf_audio_buffer_new( p_filter, i_size );
 164     if( !p_block )
 165         msg_Warn( p_filter, "can't get output block" );
 166     return p_block;
 167 }
 168
 169 /**
 170  * Create a picture_t *(*)( filter_t *, picture_t * ) compatible wrapper
 171  * using a void (*)( filter_t *, picture_t *, picture_t * ) function
 172  *
 173  * Currently used by the chroma video filters
 174  */
 175 #define VIDEO_FILTER_WRAPPER( name )                                    \
 176     static picture_t *name ## _Filter ( filter_t *p_filter,             \
 177                                         picture_t *p_pic )              \
 178     {                                                                   \
 179         picture_t *p_outpic = filter_NewPicture( p_filter );            \
 180         if( p_outpic )                                                  \
 181         {                                                               \
 182             name( p_filter, p_pic, p_outpic );                          \
 183             picture_CopyProperties( p_outpic, p_pic );                  \
 184         }                                                               \
 185         picture_Release( p_pic );                                       \
 186         return p_outpic;                                                \
 187     }
 188
 189 /**
 190  * Filter chain management API
 191  * The filter chain management API is used to dynamically construct filters
 192  * and add them in a chain.
 193  */
 194
 195 typedef struct filter_chain_t filter_chain_t;
 196
 197 /**
 198  * Create new filter chain
 199  *
 200  * \param p_object pointer to a vlc object
 201  * \param psz_capability vlc capability of filters in filter chain
 202  * \param b_allow_format_fmt_change allow changing of fmt
 203  * \param pf_buffer_allocation_init callback function to initialize buffer allocations
 204  * \param pf_buffer_allocation_clear callback function to clear buffer allocation initialization
 205  * \param p_buffer_allocation_data pointer to private allocation data
 206  * \return pointer to a filter chain
 207  */
 208 VLC_EXPORT( filter_chain_t *, __filter_chain_New, ( vlc_object_t *, const char *, bool, int (*)( filter_t *, void * ), void (*)( filter_t * ), void *  ) );
 209 #define filter_chain_New( a, b, c, d, e, f ) __filter_chain_New( VLC_OBJECT( a ), b, c, d, e, f )
 210
 211 /**
 212  * Delete filter chain will delete all filters in the chain and free all
 213  * allocated data. The pointer to the filter chain is then no longer valid.
 214  *
 215  * \param p_chain pointer to filter chain
 216  */
 217 VLC_EXPORT( void, filter_chain_Delete, ( filter_chain_t * ) );
 218
 219 /**
 220  * Reset filter chain will delete all filters in the chain and
 221  * reset p_fmt_in and p_fmt_out to the new values.
 222  *
 223  * \param p_chain pointer to filter chain
 224  * \param p_fmt_in new fmt_in params
 225  * \param p_fmt_out new fmt_out params
 226  */
 227 VLC_EXPORT( void, filter_chain_Reset, ( filter_chain_t *, const es_format_t *, const es_format_t * ) );
 228
 229 /**
 230  * Append filter to the end of the chain.
 231  *
 232  * \param p_chain pointer to filter chain
 233  * \param psz_name name of filter
 234  * \param p_cfg
 235  * \param p_fmt_in input es_format_t
 236  * \param p_fmt_out output es_format_t
 237  * \return pointer to filter chain
 238  */
 239 VLC_EXPORT( filter_t *, filter_chain_AppendFilter, ( filter_chain_t *, const char *, config_chain_t *, const es_format_t *, const es_format_t * ) );
 240
 241 /**
 242  * Append new filter to filter chain from string.
 243  *
 244  * \param p_chain pointer to filter chain
 245  * \param psz_string string of filters
 246  * \return 0 for success
 247  */
 248 VLC_EXPORT( int, filter_chain_AppendFromString, ( filter_chain_t *, const char * ) );
 249
 250 /**
 251  * Delete filter from filter chain. This function also releases the filter
 252  * object and unloads the filter modules. The pointer to p_filter is no
 253  * longer valid after this function successfully returns.
 254  *
 255  * \param p_chain pointer to filter chain
 256  * \param p_filter pointer to filter object
 257  * \return VLC_SUCCESS on succes, else VLC_EGENERIC
 258  */
 259 VLC_EXPORT( int, filter_chain_DeleteFilter, ( filter_chain_t *, filter_t * ) );
 260
 261 /**
 262  * Get filter by name of position in the filter chain.
 263  *
 264  * \param p_chain pointer to filter chain
 265  * \param i_position position of filter in filter chain
 266  * \param psz_name name of filter to get
 267  * \return filter object based on position or name provided
 268  */
 269 VLC_EXPORT( filter_t *, filter_chain_GetFilter, ( filter_chain_t *, int, const char * ) );
 270
 271 /**
 272  * Get the number of filters in the filter chain.
 273  *
 274  * \param p_chain pointer to filter chain
 275  * \return number of filters in this filter chain
 276  */
 277 VLC_EXPORT( int, filter_chain_GetLength, ( filter_chain_t * ) );
 278
 279 /**
 280  * Get last p_fmt_out in the chain.
 281  *
 282  * \param p_chain pointer to filter chain
 283  * \return last p_fmt (es_format_t) of this filter chain
 284  */
 285 VLC_EXPORT( const es_format_t *, filter_chain_GetFmtOut, ( filter_chain_t * ) );
 286
 287 /**
 288  * Apply the filter chain to a video picture.
 289  *
 290  * \param p_chain pointer to filter chain
 291  * \param p_picture picture to apply filters on
 292  * \return modified picture after applying all video filters
 293  */
 294 VLC_EXPORT( picture_t *, filter_chain_VideoFilter, ( filter_chain_t *, picture_t * ) );
 295
 296 /**
 297  * Apply the filter chain to a audio block.
 298  *
 299  * \param p_chain pointer to filter chain
 300  * \param p_block audio frame to apply filters on
 301  * \return modified audio frame after applying all audio filters
 302  */
 303 VLC_EXPORT( block_t *, filter_chain_AudioFilter, ( filter_chain_t *, block_t * ) );
 304
 305 /**
 306  * Apply filter chain to subpictures.
 307  *
 308  * \param p_chain pointer to filter chain
 309  * \param display_date of subpictures
 310  */
 311 VLC_EXPORT( void, filter_chain_SubFilter, ( filter_chain_t *, mtime_t ) );
 312
 313 #endif /* _VLC_FILTER_H */
 314