doxygen/mlt__service_8h_source.html

 #ifndef MLT_SERVICE_H

 #define MLT_SERVICE_H


 #include "mlt_properties.h"

 #include "mlt_types.h"


 struct mlt_service_s

 {

     struct mlt_properties_s parent;

     int (*get_frame)(mlt_service self, mlt_frame_ptr frame, int index);


     mlt_destructor close;

     void *close_object;

     void *local;

     void *child;

 };


 #define MLT_SERVICE_PROPERTIES(service) (&(service)->parent)


 extern int mlt_service_init(mlt_service self, void *child);

 extern void mlt_service_lock(mlt_service self);

 extern void mlt_service_unlock(mlt_service self);

 extern mlt_service_type mlt_service_identify(mlt_service self);

 extern int mlt_service_connect_producer(mlt_service self, mlt_service producer, int index);

 extern int mlt_service_insert_producer(mlt_service self, mlt_service producer, int index);

 extern int mlt_service_disconnect_producer(mlt_service self, int index);

 extern int mlt_service_disconnect_all_producers(mlt_service self);

 extern mlt_service mlt_service_get_producer(mlt_service self);

 extern int mlt_service_get_frame(mlt_service self, mlt_frame_ptr frame, int index);

 extern mlt_properties mlt_service_properties(mlt_service self);

 extern mlt_service mlt_service_consumer(mlt_service self);

 extern mlt_service mlt_service_producer(mlt_service self);

 extern int mlt_service_attach(mlt_service self, mlt_filter filter);

 extern int mlt_service_detach(mlt_service self, mlt_filter filter);

 extern void mlt_service_apply_filters(mlt_service self, mlt_frame frame, int index);

 extern int mlt_service_filter_count(mlt_service self);

 extern int mlt_service_move_filter(mlt_service self, int from, int to);

 extern mlt_filter mlt_service_filter(mlt_service self, int index);

 extern mlt_profile mlt_service_profile(mlt_service self);

 extern void mlt_service_set_profile(mlt_service self, mlt_profile profile);

 extern void mlt_service_close(mlt_service self);


 extern void mlt_service_cache_put(

     mlt_service self, const char *name, void *data, int size, mlt_destructor destructor);

 extern mlt_cache_item mlt_service_cache_get(mlt_service self, const char *name);

 extern void mlt_service_cache_set_size(mlt_service self, const char *name, int size);

 extern int mlt_service_cache_get_size(mlt_service self, const char *name);

 extern void mlt_service_cache_purge(mlt_service self);


 #endif

mlt_properties.h
Properties class declaration.

mlt_types.h
Provides forward definitions of all public types.

mlt_destructor
void(* mlt_destructor)(void *)
pointer to destructor function
Definition: mlt_types.h:269

mlt_service_type
mlt_service_type
The recognized subclasses of mlt_service.
Definition: mlt_types.h:194

mlt_cache_item_s
Cache item class.
Definition: mlt_cache.c:50

mlt_filter_s
Filter abstract service class.
Definition: mlt_filter.h:40

mlt_frame_s
Frame class.
Definition: mlt_frame.h:90

mlt_profile_s
Profile class.
Definition: mlt_profile.h:35

mlt_properties_s
Properties class.
Definition: mlt_properties.h:40

mlt_properties_s::child
void * child
the object of a subclass
Definition: mlt_properties.h:41

mlt_service_s
Service abstract base class.
Definition: mlt_service.h:58

mlt_service_s::mlt_service_filter
mlt_filter mlt_service_filter(mlt_service self, int index)
Retrieve an attached filter.
Definition: mlt_service.c:808

mlt_service_s::mlt_service_get_frame
int mlt_service_get_frame(mlt_service self, mlt_frame_ptr frame, int index)
Obtain a frame.
Definition: mlt_service.c:549

mlt_service_s::mlt_service_cache_get_size
int mlt_service_cache_get_size(mlt_service self, const char *name)
Get the current maximum size of the named cache.
Definition: mlt_service.c:995

mlt_service_s::get_frame
int(* get_frame)(mlt_service self, mlt_frame_ptr frame, int index)
Get a frame of data (virtual function).
Definition: mlt_service.h:68

mlt_service_s::mlt_service_insert_producer
int mlt_service_insert_producer(mlt_service self, mlt_service producer, int index)
Insert a producer connected to the service.
Definition: mlt_service.c:253

mlt_service_s::mlt_service_unlock
void mlt_service_unlock(mlt_service self)
Release a mutual exclusion lock on this service.
Definition: mlt_service.c:124

mlt_service_s::mlt_service_get_producer
mlt_service mlt_service_get_producer(mlt_service self)
Get the first connected producer.
Definition: mlt_service.c:450

mlt_service_s::mlt_service_properties
mlt_properties mlt_service_properties(mlt_service self)
Return the properties object.
Definition: mlt_service.c:491

mlt_service_s::mlt_service_attach
int mlt_service_attach(mlt_service self, mlt_filter filter)
Attach a filter.
Definition: mlt_service.c:664

mlt_service_s::mlt_service_cache_purge
void mlt_service_cache_purge(mlt_service self)
Release a service's cache items.
Definition: mlt_service.c:880

mlt_service_s::mlt_service_set_profile
void mlt_service_set_profile(mlt_service self, mlt_profile profile)
Set the profile for a service.
Definition: mlt_service.c:838

mlt_service_s::mlt_service_consumer
mlt_service mlt_service_consumer(mlt_service self)
Obtain the consumer a service is connected to.
Definition: mlt_service.c:393

mlt_service_s::mlt_service_detach
int mlt_service_detach(mlt_service self, mlt_filter filter)
Detach a filter.
Definition: mlt_service.c:718

mlt_service_s::mlt_service_cache_put
void mlt_service_cache_put(mlt_service self, const char *name, void *data, int size, mlt_destructor destructor)
Put an object into a service's cache.
Definition: mlt_service.c:941

mlt_service_s::child
void * child
the object of a subclass
Definition: mlt_service.h:75

mlt_service_s::mlt_service_cache_set_size
void mlt_service_cache_set_size(mlt_service self, const char *name, int size)
Set the number of items to cache for the named cache.
Definition: mlt_service.c:980

mlt_service_s::mlt_service_close
void mlt_service_close(mlt_service self)
Destroy a service.
Definition: mlt_service.c:849

mlt_service_s::mlt_service_move_filter
int mlt_service_move_filter(mlt_service self, int from, int to)
Reorder the attached filters.
Definition: mlt_service.c:769

mlt_service_s::local
void * local
instance object
Definition: mlt_service.h:74

mlt_service_s::mlt_service_producer
mlt_service mlt_service_producer(mlt_service self)
Obtain the producer a service is connected to.
Definition: mlt_service.c:412

mlt_service_s::close
mlt_destructor close
the destructor virtual function
Definition: mlt_service.h:71

mlt_service_s::mlt_service_filter_count
int mlt_service_filter_count(mlt_service self)
Get the number of filters attached.
Definition: mlt_service.c:750

mlt_service_s::mlt_service_disconnect_producer
int mlt_service_disconnect_producer(mlt_service self, int index)
Remove the N-th producer.
Definition: mlt_service.c:319

mlt_service_s::mlt_service_cache_get
mlt_cache_item mlt_service_cache_get(mlt_service self, const char *name)
Get an object from a service's cache.
Definition: mlt_service.c:960

mlt_service_s::mlt_service_connect_producer
int mlt_service_connect_producer(mlt_service self, mlt_service producer, int index)
Connect a producer to the service.
Definition: mlt_service.c:181

mlt_service_s::close_object
void * close_object
the object supplied to the close virtual function
Definition: mlt_service.h:72

mlt_service_s::mlt_service_identify
mlt_service_type mlt_service_identify(mlt_service self)
Identify the subclass of the service.
Definition: mlt_service.c:137

mlt_service_s::mlt_service_profile
mlt_profile mlt_service_profile(mlt_service self)
Retrieve the profile.
Definition: mlt_service.c:826

mlt_service_s::mlt_service_lock
void mlt_service_lock(mlt_service self)
Acquire a mutual exclusion lock on this service.
Definition: mlt_service.c:112

mlt_service_s::mlt_service_apply_filters
void mlt_service_apply_filters(mlt_service self, mlt_frame frame, int index)
Recursively apply attached filters.
Definition: mlt_service.c:504

mlt_service_s::mlt_service_disconnect_all_producers
int mlt_service_disconnect_all_producers(mlt_service self)
Remove the all the attached producers.
Definition: mlt_service.c:349

mlt_service_s::mlt_service_init
int mlt_service_init(mlt_service self, void *child)
Initialize a service.
Definition: mlt_service.c:75

mlt_service_s::parent
struct mlt_properties_s parent
A service extends properties.
Definition: mlt_service.h:59