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