]> git.sesse.net Git - mlt/blob - src/framework/mlt_tractor.h
src/framework/*: improve the doxygen documentation (work in progress). This also...
[mlt] / src / framework / mlt_tractor.h
1 /**
2  * \file mlt_tractor.h
3  * \brief tractor service class
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_TRACTOR_H_
24 #define _MLT_TRACTOR_H_
25
26 #include "mlt_producer.h"
27
28 /** \brief Tractor class
29  *
30  * \extends mlt_producer_s
31  */
32
33 struct mlt_tractor_s
34 {
35         struct mlt_producer_s parent;
36         mlt_service producer;
37 };
38
39 #define MLT_TRACTOR_PRODUCER( tractor )         ( &( tractor )->parent )
40 #define MLT_TRACTOR_SERVICE( tractor )          MLT_PRODUCER_SERVICE( MLT_TRACTOR_PRODUCER( tractor ) )
41 #define MLT_TRACTOR_PROPERTIES( tractor )       MLT_SERVICE_PROPERTIES( MLT_TRACTOR_SERVICE( tractor ) )
42
43 extern mlt_tractor mlt_tractor_init( );
44 extern mlt_tractor mlt_tractor_new( );
45 extern mlt_service mlt_tractor_service( mlt_tractor self );
46 extern mlt_producer mlt_tractor_producer( mlt_tractor self );
47 extern mlt_properties mlt_tractor_properties( mlt_tractor self );
48 extern mlt_field mlt_tractor_field( mlt_tractor self );
49 extern mlt_multitrack mlt_tractor_multitrack( mlt_tractor self );
50 extern int mlt_tractor_connect( mlt_tractor self, mlt_service service );
51 extern void mlt_tractor_refresh( mlt_tractor self );
52 extern int mlt_tractor_set_track( mlt_tractor self, mlt_producer producer, int index );
53 extern mlt_producer mlt_tractor_get_track( mlt_tractor self, int index );
54 extern void mlt_tractor_close( mlt_tractor self );
55
56 #endif