include/vlc_image.h

   1 /*****************************************************************************
   2  * vlc_image.h : wrapper for image reading/writing facilities
   3  *****************************************************************************
   4  * Copyright (C) 2004 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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #ifndef VLC_IMAGE_H
  25 #define VLC_IMAGE_H 1
  26
  27 /**
  28  * \file
  29  * This file defines functions and structures for image conversions in vlc
  30  */
  31
  32 #include <vlc_vout.h>
  33
  34 # ifdef __cplusplus
  35 extern "C" {
  36 # endif
  37
  38 struct image_handler_t
  39 {
  40     picture_t * (*pf_read)      ( image_handler_t *, block_t *,
  41                                   video_format_t *, video_format_t * );
  42     picture_t * (*pf_read_url)  ( image_handler_t *, const char *,
  43                                   video_format_t *, video_format_t * );
  44     block_t * (*pf_write)       ( image_handler_t *, picture_t *,
  45                                   video_format_t *, video_format_t * );
  46     int (*pf_write_url)         ( image_handler_t *, picture_t *,
  47                                   video_format_t *, video_format_t *,
  48                                   const char * );
  49
  50     picture_t * (*pf_convert)   ( image_handler_t *, picture_t *,
  51                                   video_format_t *, video_format_t * );
  52     picture_t * (*pf_filter)    ( image_handler_t *, picture_t *,
  53                                   video_format_t *, const char * );
  54
  55     /* Private properties */
  56     vlc_object_t *p_parent;
  57     decoder_t *p_dec;
  58     encoder_t *p_enc;
  59     filter_t  *p_filter;
  60 };
  61
  62 VLC_EXPORT( image_handler_t *, image_HandlerCreate, ( vlc_object_t * ) LIBVLC_USED );
  63 #define image_HandlerCreate( a ) image_HandlerCreate( VLC_OBJECT(a) )
  64 VLC_EXPORT( void, image_HandlerDelete, ( image_handler_t * ) );
  65
  66 #define image_Read( a, b, c, d ) a->pf_read( a, b, c, d )
  67 #define image_ReadUrl( a, b, c, d ) a->pf_read_url( a, b, c, d )
  68 #define image_Write( a, b, c, d ) a->pf_write( a, b, c, d )
  69 #define image_WriteUrl( a, b, c, d, e ) a->pf_write_url( a, b, c, d, e )
  70 #define image_Convert( a, b, c, d ) a->pf_convert( a, b, c, d )
  71 #define image_Filter( a, b, c, d ) a->pf_filter( a, b, c, d )
  72
  73 VLC_EXPORT( vlc_fourcc_t, image_Type2Fourcc, ( const char *psz_name ) );
  74 VLC_EXPORT( vlc_fourcc_t, image_Ext2Fourcc, ( const char *psz_name ) );
  75 VLC_EXPORT( vlc_fourcc_t, image_Mime2Fourcc, ( const char *psz_mime ) );
  76
  77 # ifdef __cplusplus
  78 }
  79 # endif
  80
  81 #endif /* _VLC_IMAGE_H */