git.sesse.net Git - vlc/blob - include/vlc_filter.h

   1 /*****************************************************************************
   2  * vlc_filter.h: filter related structures
   3  *****************************************************************************
   4  * Copyright (C) 1999-2003 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Gildas Bazin <gbazin@videolan.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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  22  *****************************************************************************/
  23 #ifndef _VLC_FILTER_H
  24 #define _VLC_FILTER_H 1
  25
  26 /**
  27  * \file
  28  * This file defines the structure and types used by video and audio filters
  29  */
  30
  31 typedef struct filter_owner_sys_t filter_owner_sys_t;
  32
  33 /**
  34  * \defgroup filter Filter
  35  *
  36  * The structure describing a filter
  37  *
  38  * @{
  39  */
  40
  41 /*
  42  * BIG FAT WARNING : the code relies in the first 4 members of filter_t
  43  * and decoder_t to be the same, so if you have anything to add, do it
  44  * at the end of the structure.
  45  */
  46 struct filter_t
  47 {
  48     VLC_COMMON_MEMBERS
  49
  50     /* Module properties */
  51     module_t *          p_module;
  52     filter_sys_t *      p_sys;
  53
  54     /* Input format */
  55     es_format_t         fmt_in;
  56
  57     /* Output format of filter */
  58     es_format_t         fmt_out;
  59
  60     /* Filter configuration */
  61     sout_cfg_t *        p_cfg;
  62
  63     picture_t *         ( * pf_video_filter ) ( filter_t *, picture_t * );
  64     block_t *           ( * pf_audio_filter ) ( filter_t *, block_t * );
  65     void                ( * pf_video_blend )  ( filter_t *, picture_t *,
  66                                                 picture_t *, picture_t *,
  67                                                 int, int, int );
  68
  69     subpicture_t *      ( *pf_sub_filter ) ( filter_t *, mtime_t );
  70     int                 ( *pf_render_text ) ( filter_t *, subpicture_region_t *, 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)    ( filter_t *, picture_t * );
  83     void            ( * pf_picture_unlink)  ( filter_t *, 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  * @}
  95  */
  96
  97 #endif /* _VLC_FILTER_H */