C++ compatability
[melted] / src / framework / mlt_filter.h
1 /*
2 * mlt_filter.h -- abstraction for all filter services
3 * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
4 * Author: Charles Yates <charles.yates@pandora.be>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software Foundation,
18 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19 */
20
21 #ifndef _MLT_FILTER_H_
22 #define _MLT_FILTER_H_
23
24 #include "mlt_service.h"
25
26 /** The interface definition for all filters.
27 */
28
29 struct mlt_filter_s
30 {
31 // We're implementing service here
32 struct mlt_service_s parent;
33
34 // public virtual
35 void ( *close )( mlt_filter );
36
37 // protected filter method
38 mlt_frame ( *process )( mlt_filter, mlt_frame );
39
40 // track and in/out points
41 mlt_service producer;
42
43 // Protected
44 void *child;
45 };
46
47 /** Public final methods
48 */
49
50 extern int mlt_filter_init( mlt_filter self, void *child );
51 extern mlt_filter mlt_filter_new( );
52 extern mlt_service mlt_filter_service( mlt_filter self );
53 extern mlt_properties mlt_filter_properties( mlt_filter self );
54 extern mlt_frame mlt_filter_process( mlt_filter self, mlt_frame that );
55 extern int mlt_filter_connect( mlt_filter self, mlt_service producer, int index );
56 extern void mlt_filter_set_in_and_out( mlt_filter self, mlt_position in, mlt_position out );
57 extern int mlt_filter_get_track( mlt_filter self );
58 extern mlt_position mlt_filter_get_in( mlt_filter self );
59 extern mlt_position mlt_filter_get_out( mlt_filter self );
60 extern void mlt_filter_close( mlt_filter );
61
62 #endif