2 * mlt_service.c -- interface for all service classes
3 * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
4 * Author: Charles Yates <charles.yates@pandora.be>
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library 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 GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 #include "mlt_service.h"
22 #include "mlt_filter.h"
23 #include "mlt_frame.h"
31 The base service implements a null frame producing service - as such,
32 it is functional without extension and will produce test cards frames
33 and PAL sized audio frames.
35 PLEASE DO NOT CHANGE THIS BEHAVIOUR!!! OVERRIDE THE METHODS THAT
36 CONTROL THIS IN EXTENDING CLASSES.
39 /** Private service definition.
51 pthread_mutex_t mutex
;
58 static void mlt_service_disconnect( mlt_service
this );
59 static void mlt_service_connect( mlt_service
this, mlt_service that
);
60 static int service_get_frame( mlt_service
this, mlt_frame_ptr frame
, int index
);
61 static void mlt_service_property_changed( mlt_listener
, mlt_properties owner
, mlt_service
this, void **args
);
66 int mlt_service_init( mlt_service
this, void *child
)
70 // Initialise everything to NULL
71 memset( this, 0, sizeof( struct mlt_service_s
) );
76 // Generate local space
77 this->local
= calloc( sizeof( mlt_service_base
), 1 );
79 // Associate the methods
80 this->get_frame
= service_get_frame
;
82 // Initialise the properties
83 error
= mlt_properties_init( &this->parent
, this );
86 this->parent
.close
= ( mlt_destructor
)mlt_service_close
;
87 this->parent
.close_object
= this;
89 mlt_events_init( &this->parent
);
90 mlt_events_register( &this->parent
, "service-changed", NULL
);
91 mlt_events_register( &this->parent
, "property-changed", ( mlt_transmitter
)mlt_service_property_changed
);
92 pthread_mutex_init( &( ( mlt_service_base
* )this->local
)->mutex
, NULL
);
98 static void mlt_service_property_changed( mlt_listener listener
, mlt_properties owner
, mlt_service
this, void **args
)
100 if ( listener
!= NULL
)
101 listener( owner
, this, ( char * )args
[ 0 ] );
104 void mlt_service_lock( mlt_service
this )
107 pthread_mutex_lock( &( ( mlt_service_base
* )this->local
)->mutex
);
110 void mlt_service_unlock( mlt_service
this )
113 pthread_mutex_unlock( &( ( mlt_service_base
* )this->local
)->mutex
);
116 mlt_service_type
mlt_service_identify( mlt_service
this )
118 mlt_service_type type
= invalid_type
;
121 mlt_properties properties
= MLT_SERVICE_PROPERTIES( this );
122 char *mlt_type
= mlt_properties_get( properties
, "mlt_type" );
123 char *resource
= mlt_properties_get( properties
, "resource" );
124 if ( mlt_type
== NULL
)
126 else if (resource
!= NULL
&& !strcmp( resource
, "<playlist>" ) )
127 type
= playlist_type
;
128 else if (resource
!= NULL
&& !strcmp( resource
, "<tractor>" ) )
130 else if (resource
!= NULL
&& !strcmp( resource
, "<multitrack>" ) )
131 type
= multitrack_type
;
132 else if ( !strcmp( mlt_type
, "producer" ) )
133 type
= producer_type
;
134 else if ( !strcmp( mlt_type
, "filter" ) )
136 else if ( !strcmp( mlt_type
, "transition" ) )
137 type
= transition_type
;
138 else if ( !strcmp( mlt_type
, "consumer" ) )
139 type
= consumer_type
;
146 /** Connect a producer service.
147 Returns: > 0 warning, == 0 success, < 0 serious error
148 1 = this service does not accept input
149 2 = the producer is invalid
150 3 = the producer is already registered with this consumer
153 int mlt_service_connect_producer( mlt_service
this, mlt_service producer
, int index
)
157 // Get the service base
158 mlt_service_base
*base
= this->local
;
160 // Special case 'track' index - only works for last filter(s) in a particular chain
161 // but allows a filter to apply to the output frame regardless of which track it comes from
165 // Check if the producer is already registered with this service
166 for ( i
= 0; i
< base
->count
; i
++ )
167 if ( base
->in
[ i
] == producer
)
171 if ( index
>= base
->size
)
173 int new_size
= base
->size
+ index
+ 10;
174 base
->in
= realloc( base
->in
, new_size
* sizeof( mlt_service
) );
175 if ( base
->in
!= NULL
)
177 for ( i
= base
->size
; i
< new_size
; i
++ )
178 base
->in
[ i
] = NULL
;
179 base
->size
= new_size
;
183 // If we have space, assign the input
184 if ( base
->in
!= NULL
&& index
>= 0 && index
< base
->size
)
186 // Get the current service
187 mlt_service current
= base
->in
[ index
];
189 // Increment the reference count on this producer
190 if ( producer
!= NULL
)
191 mlt_properties_inc_ref( MLT_SERVICE_PROPERTIES( producer
) );
193 // Now we disconnect the producer service from its consumer
194 mlt_service_disconnect( producer
);
196 // Add the service to index specified
197 base
->in
[ index
] = producer
;
199 // Determine the number of active tracks
200 if ( index
>= base
->count
)
201 base
->count
= index
+ 1;
203 // Now we connect the producer to its connected consumer
204 mlt_service_connect( producer
, this );
206 // Close the current service
207 mlt_service_close( current
);
209 // Inform caller that all went well
218 /** Disconnect this service from its consumer.
221 static void mlt_service_disconnect( mlt_service
this )
225 // Get the service base
226 mlt_service_base
*base
= this->local
;
233 /** Obtain the consumer this service is connected to.
236 mlt_service
mlt_service_consumer( mlt_service
this )
238 // Get the service base
239 mlt_service_base
*base
= this->local
;
241 // Return the connected consumer
245 /** Obtain the producer this service is connected to.
248 mlt_service
mlt_service_producer( mlt_service
this )
250 // Get the service base
251 mlt_service_base
*base
= this->local
;
253 // Return the connected producer
254 return base
->count
> 0 ? base
->in
[ base
->count
- 1 ] : NULL
;
257 /** Associate this service to the consumer.
260 static void mlt_service_connect( mlt_service
this, mlt_service that
)
264 // Get the service base
265 mlt_service_base
*base
= this->local
;
267 // There's a bit more required here...
272 /** Get the first connected producer service.
275 mlt_service
mlt_service_get_producer( mlt_service
this )
277 mlt_service producer
= NULL
;
279 // Get the service base
280 mlt_service_base
*base
= this->local
;
282 if ( base
->in
!= NULL
)
283 producer
= base
->in
[ 0 ];
288 /** Default implementation of get_frame.
291 static int service_get_frame( mlt_service
this, mlt_frame_ptr frame
, int index
)
293 mlt_service_base
*base
= this->local
;
294 if ( index
< base
->count
)
296 mlt_service producer
= base
->in
[ index
];
297 if ( producer
!= NULL
)
298 return mlt_service_get_frame( producer
, frame
, index
);
300 *frame
= mlt_frame_init( this );
304 /** Return the properties object.
307 mlt_properties
mlt_service_properties( mlt_service self
)
309 return self
!= NULL ?
&self
->parent
: NULL
;
312 /** Recursively apply attached filters
315 void mlt_service_apply_filters( mlt_service
this, mlt_frame frame
, int index
)
318 mlt_properties frame_properties
= MLT_FRAME_PROPERTIES( frame
);
319 mlt_properties service_properties
= MLT_SERVICE_PROPERTIES( this );
320 mlt_service_base
*base
= this->local
;
321 mlt_position position
= mlt_frame_get_position( frame
);
322 mlt_position this_in
= mlt_properties_get_position( service_properties
, "in" );
323 mlt_position this_out
= mlt_properties_get_position( service_properties
, "out" );
325 if ( index
== 0 || mlt_properties_get_int( service_properties
, "_filter_private" ) == 0 )
327 // Process the frame with the attached filters
328 for ( i
= 0; i
< base
->filter_count
; i
++ )
330 if ( base
->filters
[ i
] != NULL
)
332 mlt_position in
= mlt_filter_get_in( base
->filters
[ i
] );
333 mlt_position out
= mlt_filter_get_out( base
->filters
[ i
] );
334 int disable
= mlt_properties_get_int( MLT_FILTER_PROPERTIES( base
->filters
[ i
] ), "disable" );
335 if ( !disable
&& ( ( in
== 0 && out
== 0 ) || ( position
>= in
&& ( position
<= out
|| out
== 0 ) ) ) )
337 mlt_properties_set_position( frame_properties
, "in", in
== 0 ? this_in
: in
);
338 mlt_properties_set_position( frame_properties
, "out", out
== 0 ? this_out
: out
);
339 mlt_filter_process( base
->filters
[ i
], frame
);
340 mlt_service_apply_filters( MLT_FILTER_SERVICE( base
->filters
[ i
] ), frame
, index
+ 1 );
350 int mlt_service_get_frame( mlt_service
this, mlt_frame_ptr frame
, int index
)
355 mlt_service_lock( this );
357 // Ensure that the frame is NULL
360 // Only process if we have a valid service
361 if ( this != NULL
&& this->get_frame
!= NULL
)
363 mlt_properties properties
= MLT_SERVICE_PROPERTIES( this );
364 mlt_position in
= mlt_properties_get_position( properties
, "in" );
365 mlt_position out
= mlt_properties_get_position( properties
, "out" );
367 result
= this->get_frame( this, frame
, index
);
371 mlt_properties_inc_ref( properties
);
372 properties
= MLT_FRAME_PROPERTIES( *frame
);
373 if ( in
>=0 && out
> 0 )
375 mlt_properties_set_position( properties
, "in", in
);
376 mlt_properties_set_position( properties
, "out", out
);
378 mlt_service_apply_filters( this, *frame
, 1 );
379 mlt_deque_push_back( MLT_FRAME_SERVICE_STACK( *frame
), this );
383 // Make sure we return a frame
384 if ( *frame
== NULL
)
385 *frame
= mlt_frame_init( this );
387 // Unlock the service
388 mlt_service_unlock( this );
393 static void mlt_service_filter_changed( mlt_service owner
, mlt_service
this )
395 mlt_events_fire( MLT_SERVICE_PROPERTIES( this ), "service-changed", NULL
);
401 int mlt_service_attach( mlt_service
this, mlt_filter filter
)
403 int error
= this == NULL
|| filter
== NULL
;
407 mlt_properties properties
= MLT_SERVICE_PROPERTIES( this );
408 mlt_service_base
*base
= this->local
;
410 for ( i
= 0; error
== 0 && i
< base
->filter_count
; i
++ )
411 if ( base
->filters
[ i
] == filter
)
416 if ( base
->filter_count
== base
->filter_size
)
418 base
->filter_size
+= 10;
419 base
->filters
= realloc( base
->filters
, base
->filter_size
* sizeof( mlt_filter
) );
422 if ( base
->filters
!= NULL
)
424 mlt_properties props
= MLT_FILTER_PROPERTIES( filter
);
425 mlt_properties_inc_ref( MLT_FILTER_PROPERTIES( filter
) );
426 base
->filters
[ base
->filter_count
++ ] = filter
;
427 mlt_events_fire( properties
, "service-changed", NULL
);
428 mlt_events_listen( props
, this, "service-changed", ( mlt_listener
)mlt_service_filter_changed
);
429 mlt_events_listen( props
, this, "property-changed", ( mlt_listener
)mlt_service_filter_changed
);
443 int mlt_service_detach( mlt_service
this, mlt_filter filter
)
445 int error
= this == NULL
|| filter
== NULL
;
449 mlt_service_base
*base
= this->local
;
450 mlt_properties properties
= MLT_SERVICE_PROPERTIES( this );
452 for ( i
= 0; i
< base
->filter_count
; i
++ )
453 if ( base
->filters
[ i
] == filter
)
456 if ( i
< base
->filter_count
)
458 base
->filters
[ i
] = NULL
;
459 for ( i
++ ; i
< base
->filter_count
; i
++ )
460 base
->filters
[ i
- 1 ] = base
->filters
[ i
];
461 base
->filter_count
--;
462 mlt_events_disconnect( MLT_FILTER_PROPERTIES( filter
), this );
463 mlt_filter_close( filter
);
464 mlt_events_fire( properties
, "service-changed", NULL
);
470 /** Retrieve a filter.
473 mlt_filter
mlt_service_filter( mlt_service
this, int index
)
475 mlt_filter filter
= NULL
;
478 mlt_service_base
*base
= this->local
;
479 if ( index
>= 0 && index
< base
->filter_count
)
480 filter
= base
->filters
[ index
];
485 /** Retrieve the profile.
488 mlt_profile
mlt_service_profile( mlt_service
this )
490 return mlt_properties_get_data( MLT_SERVICE_PROPERTIES( this ), "_profile", NULL
);
493 /** Close the service.
496 void mlt_service_close( mlt_service
this )
498 if ( this != NULL
&& mlt_properties_dec_ref( MLT_SERVICE_PROPERTIES( this ) ) <= 0 )
500 if ( this->close
!= NULL
)
502 this->close( this->close_object
);
506 mlt_service_base
*base
= this->local
;
508 int count
= base
->filter_count
;
509 mlt_events_block( MLT_SERVICE_PROPERTIES( this ), this );
511 mlt_service_detach( this, base
->filters
[ 0 ] );
512 free( base
->filters
);
513 for ( i
= 0; i
< base
->count
; i
++ )
514 if ( base
->in
[ i
] != NULL
)
515 mlt_service_close( base
->in
[ i
] );
516 this->parent
.close
= NULL
;
518 pthread_mutex_destroy( &base
->mutex
);
520 mlt_properties_close( &this->parent
);
525 mlt_service_unlock( this );