provisional framework docs and corrections
[melted] / src / framework / mlt_factory.c
1 /*
2 * mlt_factory.c -- the factory method interfaces
3 * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
4 * Author: Charles Yates <charles.yates@pandora.be>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software Foundation,
18 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19 */
20
21 #include "config.h"
22 #include "mlt.h"
23 #include "mlt_repository.h"
24
25 #include <stdio.h>
26 #include <stdlib.h>
27 #include <string.h>
28
29 /** Singleton repositories
30 */
31
32 static char *mlt_prefix = NULL;
33 static mlt_properties global_properties = NULL;
34 static mlt_properties object_list = NULL;
35 static mlt_repository producers = NULL;
36 static mlt_repository filters = NULL;
37 static mlt_repository transitions = NULL;
38 static mlt_repository consumers = NULL;
39 static int unique_id = 0;
40
41 /** Construct the factories.
42 */
43
44 int mlt_factory_init( char *prefix )
45 {
46 // Only initialise once
47 if ( mlt_prefix == NULL )
48 {
49 // Allow user over rides
50 if ( prefix == NULL )
51 prefix = getenv( "MLT_REPOSITORY" );
52
53 // If no directory is specified, default to install directory
54 if ( prefix == NULL )
55 prefix = PREFIX_DATA;
56
57 // Store the prefix for later retrieval
58 mlt_prefix = strdup( prefix );
59
60 // Initialise the pool
61 mlt_pool_init( );
62
63 // Create the global properties
64 global_properties = mlt_properties_new( );
65 mlt_properties_set_or_default( global_properties, "MLT_NORMALISATION", getenv( "MLT_NORMALISATION" ), "PAL" );
66 mlt_properties_set_or_default( global_properties, "MLT_PRODUCER", getenv( "MLT_PRODUCER" ), "fezzik" );
67 mlt_properties_set_or_default( global_properties, "MLT_CONSUMER", getenv( "MLT_CONSUMER" ), "sdl" );
68
69 // Create the object list.
70 object_list = mlt_properties_new( );
71
72 // Create a repository for each service type
73 producers = mlt_repository_init( object_list, prefix, "producers.dat", "mlt_create_producer" );
74 filters = mlt_repository_init( object_list, prefix, "filters.dat", "mlt_create_filter" );
75 transitions = mlt_repository_init( object_list, prefix, "transitions.dat", "mlt_create_transition" );
76 consumers = mlt_repository_init( object_list, prefix, "consumers.dat", "mlt_create_consumer" );
77 }
78
79 return 0;
80 }
81
82 /** Fetch the prefix used in this instance.
83 */
84
85 const char *mlt_factory_prefix( )
86 {
87 return mlt_prefix;
88 }
89
90 /** Get a value from the environment.
91 */
92
93 char *mlt_environment( char *name )
94 {
95 return mlt_properties_get( global_properties, name );
96 }
97
98 /** Fetch a producer from the repository.
99 */
100
101 mlt_producer mlt_factory_producer( char *service, void *input )
102 {
103 mlt_producer obj = NULL;
104
105 // Pick up the default normalising producer if necessary
106 if ( service == NULL )
107 service = mlt_environment( "MLT_PRODUCER" );
108
109 // Try to instantiate via the specified service
110 obj = mlt_repository_fetch( producers, service, input );
111
112 if ( obj != NULL )
113 {
114 mlt_properties properties = mlt_producer_properties( obj );
115 mlt_properties_set_int( properties, "_unique_id", ++ unique_id );
116 mlt_properties_set( properties, "mlt_type", "producer" );
117 if ( mlt_properties_get_int( properties, "_mlt_service_hidden" ) == 0 )
118 mlt_properties_set( properties, "mlt_service", service );
119 }
120 return obj;
121 }
122
123 /** Fetch a filter from the repository.
124 */
125
126 mlt_filter mlt_factory_filter( char *service, void *input )
127 {
128 mlt_filter obj = mlt_repository_fetch( filters, service, input );
129 if ( obj != NULL )
130 {
131 mlt_properties properties = mlt_filter_properties( obj );
132 mlt_properties_set_int( properties, "_unique_id", ++ unique_id );
133 mlt_properties_set( properties, "mlt_type", "filter" );
134 mlt_properties_set( properties, "mlt_service", service );
135 }
136 return obj;
137 }
138
139 /** Fetch a transition from the repository.
140 */
141
142 mlt_transition mlt_factory_transition( char *service, void *input )
143 {
144 mlt_transition obj = mlt_repository_fetch( transitions, service, input );
145 if ( obj != NULL )
146 {
147 mlt_properties properties = mlt_transition_properties( obj );
148 mlt_properties_set_int( properties, "_unique_id", ++ unique_id );
149 mlt_properties_set( properties, "mlt_type", "transition" );
150 mlt_properties_set( properties, "mlt_service", service );
151 }
152 return obj;
153 }
154
155 /** Fetch a consumer from the repository
156 */
157
158 mlt_consumer mlt_factory_consumer( char *service, void *input )
159 {
160 mlt_consumer obj = NULL;
161
162 if ( service == NULL )
163 service = mlt_environment( "MLT_CONSUMER" );
164
165 obj = mlt_repository_fetch( consumers, service, input );
166
167 if ( obj != NULL )
168 {
169 mlt_properties properties = mlt_consumer_properties( obj );
170 mlt_properties_set_int( properties, "_unique_id", ++ unique_id );
171 mlt_properties_set( properties, "mlt_type", "consumer" );
172 mlt_properties_set( properties, "mlt_service", service );
173 }
174 return obj;
175 }
176
177 /** Close the factory.
178 */
179
180 void mlt_factory_close( )
181 {
182 if ( mlt_prefix != NULL )
183 {
184 mlt_repository_close( producers );
185 mlt_repository_close( filters );
186 mlt_repository_close( transitions );
187 mlt_repository_close( consumers );
188 mlt_properties_close( object_list );
189 mlt_properties_close( global_properties );
190 free( mlt_prefix );
191 mlt_prefix = NULL;
192 mlt_pool_close( );
193 }
194 }
195