]> git.sesse.net Git - mlt/blob - src/framework/mlt_parser.h
src/framework/*: improve the doxygen documentation (work in progress). This also...
[mlt] / src / framework / mlt_parser.h
1 /**
2  * \file mlt_parser.h
3  * \brief service parsing functionality
4  *
5  * Copyright (C) 2003-2008 Ushodaya Enterprises Limited
6  * \author Charles Yates <charles.yates@pandora.be>
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with this library; if not, write to the Free Software
20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21  */
22
23 #ifndef _MLT_PARSER_H_
24 #define _MLT_PARSER_H_
25
26 #include "mlt_types.h"
27
28 /** \brief Parser class
29  *
30  * \extends mlt_properties_s
31  */
32
33 struct mlt_parser_s
34 {
35         struct mlt_properties_s parent;
36         int ( *on_invalid )( mlt_parser self, mlt_service object );
37         int ( *on_unknown )( mlt_parser self, mlt_service object );
38         int ( *on_start_producer )( mlt_parser self, mlt_producer object );
39         int ( *on_end_producer )( mlt_parser self, mlt_producer object );
40         int ( *on_start_playlist )( mlt_parser self, mlt_playlist object );
41         int ( *on_end_playlist )( mlt_parser self, mlt_playlist object );
42         int ( *on_start_tractor )( mlt_parser self, mlt_tractor object );
43         int ( *on_end_tractor )( mlt_parser self, mlt_tractor object );
44         int ( *on_start_multitrack )( mlt_parser self, mlt_multitrack object );
45         int ( *on_end_multitrack )( mlt_parser self, mlt_multitrack object );
46         int ( *on_start_track )( mlt_parser self );
47         int ( *on_end_track )( mlt_parser self );
48         int ( *on_start_filter )( mlt_parser self, mlt_filter object );
49         int ( *on_end_filter )( mlt_parser self, mlt_filter object );
50         int ( *on_start_transition )( mlt_parser self, mlt_transition object );
51         int ( *on_end_transition )( mlt_parser self, mlt_transition object );
52 };
53
54 extern mlt_parser mlt_parser_new( );
55 extern mlt_properties mlt_parser_properties( mlt_parser self );
56 extern int mlt_parser_start( mlt_parser self, mlt_service object );
57 extern void mlt_parser_close( mlt_parser self );
58
59 #endif