nice is a phony target
[vlc.git] / 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 #if !defined( __LIBVLC__ )
25   #error You are not libvlc or one of its plugins. You cannot include this file
26 #endif
27
28 #ifndef _VLC_IMAGE_H
29 #define _VLC_IMAGE_H 1
30
31 #include <vlc_vout.h>
32
33 # ifdef __cplusplus
34 extern "C" {
35 # endif
36
37 struct image_handler_t
38 {
39     picture_t * (*pf_read)      ( image_handler_t *, block_t *,
40                                   video_format_t *, video_format_t * );
41     picture_t * (*pf_read_url)  ( image_handler_t *, const char *,
42                                   video_format_t *, video_format_t * );
43     block_t * (*pf_write)       ( image_handler_t *, picture_t *,
44                                   video_format_t *, video_format_t * );
45     int (*pf_write_url)         ( image_handler_t *, picture_t *,
46                                   video_format_t *, video_format_t *,
47                                   const char * );
48
49     picture_t * (*pf_convert)   ( image_handler_t *, picture_t *,
50                                   video_format_t *, video_format_t * );
51     picture_t * (*pf_filter)    ( image_handler_t *, picture_t *,
52                                   video_format_t *, const char * );
53
54     /* Private properties */
55     vlc_object_t *p_parent;
56     decoder_t *p_dec;
57     encoder_t *p_enc;
58     filter_t  *p_filter;
59 };
60
61 VLC_EXPORT( image_handler_t *, __image_HandlerCreate, ( vlc_object_t * ) );
62 #define image_HandlerCreate( a ) __image_HandlerCreate( VLC_OBJECT(a) )
63 VLC_EXPORT( void, image_HandlerDelete, ( image_handler_t * ) );
64
65 #define image_Read( a, b, c, d ) a->pf_read( a, b, c, d )
66 #define image_ReadUrl( a, b, c, d ) a->pf_read_url( a, b, c, d )
67 #define image_Write( a, b, c, d ) a->pf_write( a, b, c, d )
68 #define image_WriteUrl( a, b, c, d, e ) a->pf_write_url( a, b, c, d, e )
69 #define image_Convert( a, b, c, d ) a->pf_convert( a, b, c, d )
70 #define image_Filter( a, b, c, d ) a->pf_filter( a, b, c, d )
71
72 # ifdef __cplusplus
73 }
74 # endif
75
76 #endif /* _VLC_IMAGE_H */