Constness changes
[melted] / src / framework / mlt_tractor.h
1 /**
2 * \file mlt_tractor.h
3 * \brief tractor service class
4 * \see mlt_tractor_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_TRACTOR_H_
25 #define _MLT_TRACTOR_H_
26
27 #include "mlt_producer.h"
28
29 /** \brief Tractor class
30 *
31 * The tractor is a convenience class that works with the field class
32 * to manage a multitrack, track filters, and transitions.
33 *
34 * \extends mlt_producer_s
35 * \properties \em multitrack holds a reference to the mulitrack object that a tractor manages
36 * \properties \em field holds a reference to the field object that a tractor manages
37 * \properties \em producer holds a reference to an encapsulated producer
38 * \properties \em global_feed a flag to indicate whether this tractor feeds to the consumer or stops here
39 * \properties \em global_queue is something for the data_feed functionality in the core module
40 * \properties \em data_queue is something for the data_feed functionality in the core module
41 */
42
43 struct mlt_tractor_s
44 {
45 struct mlt_producer_s parent;
46 mlt_service producer;
47 };
48
49 #define MLT_TRACTOR_PRODUCER( tractor ) ( &( tractor )->parent )
50 #define MLT_TRACTOR_SERVICE( tractor ) MLT_PRODUCER_SERVICE( MLT_TRACTOR_PRODUCER( tractor ) )
51 #define MLT_TRACTOR_PROPERTIES( tractor ) MLT_SERVICE_PROPERTIES( MLT_TRACTOR_SERVICE( tractor ) )
52
53 extern mlt_tractor mlt_tractor_init( );
54 extern mlt_tractor mlt_tractor_new( );
55 extern mlt_service mlt_tractor_service( mlt_tractor self );
56 extern mlt_producer mlt_tractor_producer( mlt_tractor self );
57 extern mlt_properties mlt_tractor_properties( mlt_tractor self );
58 extern mlt_field mlt_tractor_field( mlt_tractor self );
59 extern mlt_multitrack mlt_tractor_multitrack( mlt_tractor self );
60 extern int mlt_tractor_connect( mlt_tractor self, mlt_service service );
61 extern void mlt_tractor_refresh( mlt_tractor self );
62 extern int mlt_tractor_set_track( mlt_tractor self, mlt_producer producer, int index );
63 extern mlt_producer mlt_tractor_get_track( mlt_tractor self, int index );
64 extern void mlt_tractor_close( mlt_tractor self );
65
66 #endif