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 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.
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.
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.
22 #include "mlt_service.h"
23 #include "mlt_filter.h"
24 #include "mlt_frame.h"
32 The base service implements a null frame producing service - as such,
33 it is functional without extension and will produce test cards frames
34 and PAL sized audio frames.
36 PLEASE DO NOT CHANGE THIS BEHAVIOUR!!! OVERRIDE THE METHODS THAT
37 CONTROL THIS IN EXTENDING CLASSES.
40 /** Private service definition.
52 pthread_mutex_t mutex
;
59 static void mlt_service_disconnect( mlt_service
this );
60 static void mlt_service_connect( mlt_service
this, mlt_service that
);
61 static int service_get_frame( mlt_service
this, mlt_frame_ptr frame
, int index
);
62 static void mlt_service_property_changed( mlt_listener
, mlt_properties owner
, mlt_service
this, void **args
);
67 int mlt_service_init( mlt_service
this, void *child
)
71 // Initialise everything to NULL
72 memset( this, 0, sizeof( struct mlt_service_s
) );
77 // Generate local space
78 this->local
= calloc( sizeof( mlt_service_base
), 1 );
80 // Associate the methods
81 this->get_frame
= service_get_frame
;
83 // Initialise the properties
84 error
= mlt_properties_init( &this->parent
, this );
87 this->parent
.close
= ( mlt_destructor
)mlt_service_close
;
88 this->parent
.close_object
= this;
90 mlt_events_init( &this->parent
);
91 mlt_events_register( &this->parent
, "service-changed", NULL
);
92 mlt_events_register( &this->parent
, "property-changed", ( mlt_transmitter
)mlt_service_property_changed
);
93 pthread_mutex_init( &( ( mlt_service_base
* )this->local
)->mutex
, NULL
);
99 static void mlt_service_property_changed( mlt_listener listener
, mlt_properties owner
, mlt_service
this, void **args
)
101 if ( listener
!= NULL
)
102 listener( owner
, this, ( char * )args
[ 0 ] );
105 void mlt_service_lock( mlt_service
this )
108 pthread_mutex_lock( &( ( mlt_service_base
* )this->local
)->mutex
);
111 void mlt_service_unlock( mlt_service
this )
114 pthread_mutex_unlock( &( ( mlt_service_base
* )this->local
)->mutex
);
117 mlt_service_type
mlt_service_identify( mlt_service
this )
119 mlt_service_type type
= invalid_type
;
122 mlt_properties properties
= MLT_SERVICE_PROPERTIES( this );
123 char *mlt_type
= mlt_properties_get( properties
, "mlt_type" );
124 char *resource
= mlt_properties_get( properties
, "resource" );
125 if ( mlt_type
== NULL
)
127 else if ( resource
== NULL
|| !strcmp( resource
, "<producer>" ) )
128 type
= producer_type
;
129 else if ( !strcmp( resource
, "<playlist>" ) )
130 type
= playlist_type
;
131 else if ( !strcmp( resource
, "<tractor>" ) )
133 else if ( !strcmp( resource
, "<multitrack>" ) )
134 type
= multitrack_type
;
135 else if ( !strcmp( mlt_type
, "producer" ) )
136 type
= producer_type
;
137 else if ( !strcmp( mlt_type
, "filter" ) )
139 else if ( !strcmp( mlt_type
, "transition" ) )
140 type
= transition_type
;
141 else if ( !strcmp( mlt_type
, "consumer" ) )
142 type
= consumer_type
;
149 /** Connect a producer service.
150 Returns: > 0 warning, == 0 success, < 0 serious error
151 1 = this service does not accept input
152 2 = the producer is invalid
153 3 = the producer is already registered with this consumer
156 int mlt_service_connect_producer( mlt_service
this, mlt_service producer
, int index
)
160 // Get the service base
161 mlt_service_base
*base
= this->local
;
163 // Special case 'track' index - only works for last filter(s) in a particular chain
164 // but allows a filter to apply to the output frame regardless of which track it comes from
168 // Check if the producer is already registered with this service
169 for ( i
= 0; i
< base
->count
; i
++ )
170 if ( base
->in
[ i
] == producer
)
174 if ( index
>= base
->size
)
176 int new_size
= base
->size
+ index
+ 10;
177 base
->in
= realloc( base
->in
, new_size
* sizeof( mlt_service
) );
178 if ( base
->in
!= NULL
)
180 for ( i
= base
->size
; i
< new_size
; i
++ )
181 base
->in
[ i
] = NULL
;
182 base
->size
= new_size
;
186 // If we have space, assign the input
187 if ( base
->in
!= NULL
&& index
>= 0 && index
< base
->size
)
189 // Get the current service
190 mlt_service current
= base
->in
[ index
];
192 // Increment the reference count on this producer
193 if ( producer
!= NULL
)
195 mlt_service_lock( producer
);
196 mlt_properties_inc_ref( MLT_SERVICE_PROPERTIES( producer
) );
197 mlt_service_unlock( producer
);
200 // Now we disconnect the producer service from its consumer
201 mlt_service_disconnect( producer
);
203 // Add the service to index specified
204 base
->in
[ index
] = producer
;
206 // Determine the number of active tracks
207 if ( index
>= base
->count
)
208 base
->count
= index
+ 1;
210 // Now we connect the producer to its connected consumer
211 mlt_service_connect( producer
, this );
213 // Close the current service
214 mlt_service_close( current
);
216 // Inform caller that all went well
225 /** Disconnect this service from its consumer.
228 static void mlt_service_disconnect( mlt_service
this )
232 // Get the service base
233 mlt_service_base
*base
= this->local
;
240 /** Obtain the consumer this service is connected to.
243 mlt_service
mlt_service_consumer( mlt_service
this )
245 // Get the service base
246 mlt_service_base
*base
= this->local
;
248 // Return the connected consumer
252 /** Obtain the producer this service is connected to.
255 mlt_service
mlt_service_producer( mlt_service
this )
257 // Get the service base
258 mlt_service_base
*base
= this->local
;
260 // Return the connected producer
261 return base
->count
> 0 ? base
->in
[ base
->count
- 1 ] : NULL
;
264 /** Associate this service to the consumer.
267 static void mlt_service_connect( mlt_service
this, mlt_service that
)
271 // Get the service base
272 mlt_service_base
*base
= this->local
;
274 // There's a bit more required here...
279 /** Get the first connected producer service.
282 mlt_service
mlt_service_get_producer( mlt_service
this )
284 mlt_service producer
= NULL
;
286 // Get the service base
287 mlt_service_base
*base
= this->local
;
289 if ( base
->in
!= NULL
)
290 producer
= base
->in
[ 0 ];
295 /** Default implementation of get_frame.
298 static int service_get_frame( mlt_service
this, mlt_frame_ptr frame
, int index
)
300 mlt_service_base
*base
= this->local
;
301 if ( index
< base
->count
)
303 mlt_service producer
= base
->in
[ index
];
304 if ( producer
!= NULL
)
305 return mlt_service_get_frame( producer
, frame
, index
);
307 *frame
= mlt_frame_init( );
311 /** Return the properties object.
314 mlt_properties
mlt_service_properties( mlt_service self
)
316 return self
!= NULL ?
&self
->parent
: NULL
;
319 /** Recursively apply attached filters
322 void mlt_service_apply_filters( mlt_service
this, mlt_frame frame
, int index
)
325 mlt_properties frame_properties
= MLT_FRAME_PROPERTIES( frame
);
326 mlt_properties service_properties
= MLT_SERVICE_PROPERTIES( this );
327 mlt_service_base
*base
= this->local
;
328 mlt_position position
= mlt_frame_get_position( frame
);
329 mlt_position this_in
= mlt_properties_get_position( service_properties
, "in" );
330 mlt_position this_out
= mlt_properties_get_position( service_properties
, "out" );
332 if ( index
== 0 || mlt_properties_get_int( service_properties
, "_filter_private" ) == 0 )
334 // Process the frame with the attached filters
335 for ( i
= 0; i
< base
->filter_count
; i
++ )
337 if ( base
->filters
[ i
] != NULL
)
339 mlt_position in
= mlt_filter_get_in( base
->filters
[ i
] );
340 mlt_position out
= mlt_filter_get_out( base
->filters
[ i
] );
341 if ( ( in
== 0 && out
== 0 ) || ( position
>= in
&& ( position
<= out
|| out
== 0 ) ) )
343 mlt_properties_set_position( frame_properties
, "in", in
== 0 ? this_in
: in
);
344 mlt_properties_set_position( frame_properties
, "out", out
== 0 ? this_out
: out
);
345 mlt_filter_process( base
->filters
[ i
], frame
);
346 mlt_service_apply_filters( MLT_FILTER_SERVICE( base
->filters
[ i
] ), frame
, index
+ 1 );
356 int mlt_service_get_frame( mlt_service
this, mlt_frame_ptr frame
, int index
)
361 mlt_service_lock( this );
363 // Ensure that the frame is NULL
366 // Only process if we have a valid service
367 if ( this != NULL
&& this->get_frame
!= NULL
)
369 mlt_properties properties
= MLT_SERVICE_PROPERTIES( this );
370 mlt_position in
= mlt_properties_get_position( properties
, "in" );
371 mlt_position out
= mlt_properties_get_position( properties
, "out" );
373 result
= this->get_frame( this, frame
, index
);
377 mlt_properties_inc_ref( properties
);
378 properties
= MLT_FRAME_PROPERTIES( *frame
);
379 if ( in
>=0 && out
> 0 )
381 mlt_properties_set_position( properties
, "in", in
);
382 mlt_properties_set_position( properties
, "out", out
);
384 mlt_service_apply_filters( this, *frame
, 1 );
385 mlt_deque_push_back( MLT_FRAME_SERVICE_STACK( *frame
), this );
389 // Make sure we return a frame
390 if ( *frame
== NULL
)
391 *frame
= mlt_frame_init( );
393 // Unlock the service
394 mlt_service_unlock( this );
399 static void mlt_service_filter_changed( mlt_service owner
, mlt_service
this )
401 mlt_events_fire( MLT_SERVICE_PROPERTIES( this ), "service-changed", NULL
);
407 int mlt_service_attach( mlt_service
this, mlt_filter filter
)
409 int error
= this == NULL
|| filter
== NULL
;
413 mlt_properties properties
= MLT_SERVICE_PROPERTIES( this );
414 mlt_service_base
*base
= this->local
;
416 for ( i
= 0; error
== 0 && i
< base
->filter_count
; i
++ )
417 if ( base
->filters
[ i
] == filter
)
422 if ( base
->filter_count
== base
->filter_size
)
424 base
->filter_size
+= 10;
425 base
->filters
= realloc( base
->filters
, base
->filter_size
* sizeof( mlt_filter
) );
428 if ( base
->filters
!= NULL
)
430 mlt_properties props
= MLT_FILTER_PROPERTIES( filter
);
431 mlt_properties_inc_ref( MLT_FILTER_PROPERTIES( filter
) );
432 base
->filters
[ base
->filter_count
++ ] = filter
;
433 mlt_events_fire( properties
, "service-changed", NULL
);
434 mlt_events_listen( props
, this, "service-changed", ( mlt_listener
)mlt_service_filter_changed
);
435 mlt_events_listen( props
, this, "property-changed", ( mlt_listener
)mlt_service_filter_changed
);
449 int mlt_service_detach( mlt_service
this, mlt_filter filter
)
451 int error
= this == NULL
|| filter
== NULL
;
455 mlt_service_base
*base
= this->local
;
456 mlt_properties properties
= MLT_SERVICE_PROPERTIES( this );
458 for ( i
= 0; i
< base
->filter_count
; i
++ )
459 if ( base
->filters
[ i
] == filter
)
462 if ( i
< base
->filter_count
)
464 base
->filters
[ i
] = NULL
;
465 for ( i
++ ; i
< base
->filter_count
; i
++ )
466 base
->filters
[ i
- 1 ] = base
->filters
[ i
];
467 base
->filter_count
--;
468 mlt_events_disconnect( MLT_FILTER_PROPERTIES( filter
), this );
469 mlt_filter_close( filter
);
470 mlt_events_fire( properties
, "service-changed", NULL
);
476 /** Retrieve a filter.
479 mlt_filter
mlt_service_filter( mlt_service
this, int index
)
481 mlt_filter filter
= NULL
;
484 mlt_service_base
*base
= this->local
;
485 if ( index
>= 0 && index
< base
->filter_count
)
486 filter
= base
->filters
[ index
];
491 /** Close the service.
494 void mlt_service_close( mlt_service
this )
496 mlt_service_lock( this );
497 if ( this != NULL
&& mlt_properties_dec_ref( MLT_SERVICE_PROPERTIES( this ) ) <= 0 )
499 mlt_service_unlock( this );
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 );