]> git.sesse.net Git - mlt/blob - src/framework/mlt_types.h
34c5a2131da55e369da047aa53ac873cac5f5e28
[mlt] / src / framework / mlt_types.h
1 /**
2  * \file mlt_types.h
3  * \brief Provides forward definitions of all public types
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_TYPES_H_
24 #define _MLT_TYPES_H_
25
26 #ifndef GCC_VERSION
27 #define GCC_VERSION (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + __GNUC_PATCHLEVEL__)
28 #endif
29
30 #include <stdint.h>
31
32 #include "mlt_pool.h"
33
34 /** The set of supported image formats */
35
36 typedef enum
37 {
38         mlt_image_none = 0,/**< image not available */
39         mlt_image_rgb24,   /**< 8-bit RGB */
40         mlt_image_rgb24a,  /**< 8-bit RGB with alpha channel */
41         mlt_image_yuv422,  /**< 8-bit YUV 4:2:2 packed */
42         mlt_image_yuv420p, /**< 8-bit YUV 4:2:0 planar */
43         mlt_image_opengl   /**< suitable for OpenGL texture */
44 }
45 mlt_image_format;
46
47 /** The set of supported audio formats */
48
49 typedef enum
50 {
51         mlt_audio_none = 0,/**< audio not available */
52         mlt_audio_pcm      /**< signed 16-bit interleaved PCM */
53 }
54 mlt_audio_format;
55
56 /** The relative time qualifiers */
57
58 typedef enum
59 {
60         mlt_whence_relative_start,  /**< relative to the beginning */
61         mlt_whence_relative_current,/**< relative to the current position */
62         mlt_whence_relative_end     /**< relative to the end */
63 }
64 mlt_whence;
65
66 /** The recognized subclasses of mlt_service */
67
68 typedef enum
69 {
70         invalid_type,               /**< invalid service */
71         unknown_type,               /**< unknown class */
72         producer_type,              /**< Producer class */
73         tractor_type,               /**< Tractor class */
74         playlist_type,              /**< Playlist class */
75         multitrack_type,            /**< Multitrack class */
76         filter_type,                /**< Filter class */
77         transition_type,            /**< Transition class */
78         consumer_type,              /**< Consumer class */
79         field_type                  /**< Field class */
80 }
81 mlt_service_type;
82
83 /* I don't want to break anyone's applications without warning. -Zach */
84 #undef DOUBLE_MLT_POSITION
85 #ifdef DOUBLE_MLT_POSITION
86 typedef double mlt_position;
87 #else
88 typedef int32_t mlt_position;
89 #endif
90
91 typedef struct mlt_frame_s *mlt_frame, **mlt_frame_ptr; /**< pointer to Frame object */
92 typedef struct mlt_property_s *mlt_property;            /**< pointer to Property object */
93 typedef struct mlt_properties_s *mlt_properties;        /**< pointer to Properties object */
94 typedef struct mlt_event_struct *mlt_event;             /**< pointer to Event object */
95 typedef struct mlt_service_s *mlt_service;              /**< pointer to Service object */
96 typedef struct mlt_producer_s *mlt_producer;            /**< pointer to Producer object */
97 typedef struct mlt_playlist_s *mlt_playlist;            /**< pointer to Playlist object */
98 typedef struct mlt_multitrack_s *mlt_multitrack;        /**< pointer to Multitrack object */
99 typedef struct mlt_filter_s *mlt_filter;                /**< pointer to Filter object */
100 typedef struct mlt_transition_s *mlt_transition;        /**< pointer to Transition object */
101 typedef struct mlt_tractor_s *mlt_tractor;              /**< pointer to Tractor object */
102 typedef struct mlt_field_s *mlt_field;                  /**< pointer to Field object */
103 typedef struct mlt_consumer_s *mlt_consumer;            /**< pointer to Consumer object */
104 typedef struct mlt_parser_s *mlt_parser;                /**< pointer to Properties object */
105 typedef struct mlt_deque_s *mlt_deque;                  /**< pointer to Deque object */
106 typedef struct mlt_geometry_s *mlt_geometry;            /**< pointer to Geometry object */
107 typedef struct mlt_geometry_item_s *mlt_geometry_item;  /**< pointer to Geometry Item object */
108 typedef struct mlt_profile_s *mlt_profile;              /**< pointer to Profile object */
109
110 typedef void ( *mlt_destructor )( void * );             /**< pointer to destructor function */
111 typedef char *( *mlt_serialiser )( void *, int length );/**< pointer to serialization function */
112
113 #define MLT_SERVICE(x) ( ( mlt_service )( x ) )         /**< Cast to a Service pointer */
114 #define MLT_PRODUCER(x) ( ( mlt_producer )( x ) )       /**< Cast to a Producer pointer */
115 #define MLT_MULTITRACK(x) ( ( mlt_multitrack )( x ) )   /**< Cast to a Multitrack pointer */
116 #define MLT_PLAYLIST(x) ( ( mlt_playlist )( x ) )       /**< Cast to a Playlist pointer */
117 #define MLT_TRACTOR(x) ( ( mlt_tractor )( x ) )         /**< Cast to a Tractor pointer */
118 #define MLT_FILTER(x) ( ( mlt_filter )( x ) )           /**< Cast to a Filter pointer */
119 #define MLT_TRANSITION(x) ( ( mlt_transition )( x ) )   /**< Cast to a Transition pointer */
120
121 #endif