mlt_tractor.[ch], mlt_multitrack.[ch]: improve doxygen documentation for the tractor...
[melted] / src / framework / mlt_multitrack.h
1 /**
2 * \file mlt_multitrack.h
3 * \brief multitrack 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_MULITRACK_H_
24 #define _MLT_MULITRACK_H_
25
26 #include "mlt_producer.h"
27
28 /** \brief Track class
29 */
30
31 struct mlt_track_s
32 {
33 mlt_producer producer;
34 mlt_event event;
35 };
36
37 typedef struct mlt_track_s *mlt_track;
38
39 /** \brief Multitrack class
40 *
41 * A multitrack is a parallel container of producers that acts a single producer.
42 *
43 * \extends mlt_producer_s
44 * \properties \em log_id not currently used, but sets it to "mulitrack"
45 */
46
47 struct mlt_multitrack_s
48 {
49 /** We're extending producer here */
50 struct mlt_producer_s parent;
51 mlt_track *list;
52 int size;
53 int count;
54 };
55
56 #define MLT_MULTITRACK_PRODUCER( multitrack ) ( &( multitrack )->parent )
57 #define MLT_MULTITRACK_SERVICE( multitrack ) MLT_PRODUCER_SERVICE( MLT_MULTITRACK_PRODUCER( multitrack ) )
58 #define MLT_MULTITRACK_PROPERTIES( multitrack ) MLT_SERVICE_PROPERTIES( MLT_MULTITRACK_SERVICE( multitrack ) )
59
60 extern mlt_multitrack mlt_multitrack_init( );
61 extern mlt_producer mlt_multitrack_producer( mlt_multitrack self );
62 extern mlt_service mlt_multitrack_service( mlt_multitrack self );
63 extern mlt_properties mlt_multitrack_properties( mlt_multitrack self );
64 extern int mlt_multitrack_connect( mlt_multitrack self, mlt_producer producer, int track );
65 extern mlt_position mlt_multitrack_clip( mlt_multitrack self, mlt_whence whence, int index );
66 extern void mlt_multitrack_close( mlt_multitrack self );
67 extern int mlt_multitrack_count( mlt_multitrack self );
68 extern void mlt_multitrack_refresh( mlt_multitrack self );
69 extern mlt_producer mlt_multitrack_track( mlt_multitrack self, int track );
70
71 #endif
72