MLT  7.24.0
mlt_events.h
Go to the documentation of this file.
1 
23 #ifndef MLT_EVENTS_H
24 #define MLT_EVENTS_H
25 
26 #include "mlt_types.h"
27 
29 typedef struct
30 {
31  union {
32  int i;
33  void *p;
34  } u;
35 } mlt_event_data;
36 
38 typedef struct
39 {
40  void **thread;
41  int *priority;
42  mlt_thread_function_t function;
43  void *data;
44 } mlt_event_data_thread;
45 
51 typedef void (*mlt_listener)(mlt_properties, void *, mlt_event_data);
52 
53 extern void mlt_events_init(mlt_properties self);
54 extern int mlt_events_register(mlt_properties self, const char *id);
55 extern int mlt_events_fire(mlt_properties self, const char *id, mlt_event_data);
56 extern mlt_event mlt_events_listen(mlt_properties self,
57  void *listener_data,
58  const char *id,
59  mlt_listener listener);
60 extern void mlt_events_block(mlt_properties self, void *listener_data);
61 extern void mlt_events_unblock(mlt_properties self, void *listener_data);
62 extern void mlt_events_disconnect(mlt_properties self, void *listener_data);
63 
64 extern mlt_event mlt_events_setup_wait_for(mlt_properties self, const char *id);
65 extern void mlt_events_wait_for(mlt_properties self, mlt_event event);
66 extern void mlt_events_close_wait_for(mlt_properties self, mlt_event event);
67 
68 extern void mlt_event_inc_ref(mlt_event self);
69 extern void mlt_event_block(mlt_event self);
70 extern void mlt_event_unblock(mlt_event self);
71 extern void mlt_event_close(mlt_event self);
72 
73 extern mlt_event_data mlt_event_data_none();
74 extern mlt_event_data mlt_event_data_from_int(int value);
75 extern int mlt_event_data_to_int(mlt_event_data);
76 extern mlt_event_data mlt_event_data_from_string(const char *value);
77 extern const char *mlt_event_data_to_string(mlt_event_data);
78 extern mlt_event_data mlt_event_data_from_frame(mlt_frame);
79 extern mlt_frame mlt_event_data_to_frame(mlt_event_data);
80 extern mlt_event_data mlt_event_data_from_object(void *);
81 extern void *mlt_event_data_to_object(mlt_event_data);
82 
83 #endif
mlt_listener
void(* mlt_listener)(mlt_properties, void *, mlt_event_data)
event handler when receiving an event message
Definition: mlt_events.h:51
mlt_types.h
Provides forward definitions of all public types.
mlt_thread_function_t
void *(* mlt_thread_function_t)(void *)
generic thread function pointer
Definition: mlt_types.h:271
mlt_properties
struct mlt_properties_s * mlt_properties
pointer to Properties object
Definition: mlt_types.h:245
mlt_event_data_thread
An event data structure to convey thread parameters.
Definition: mlt_events.h:39
mlt_event_data_thread::priority
int * priority
a priority level for the thread
Definition: mlt_events.h:41
mlt_event_data_thread::thread
void ** thread
a pointer to a thread object or handle as determined by you
Definition: mlt_events.h:40
mlt_event_data_thread::data
void * data
an opaque data pointer to pass along
Definition: mlt_events.h:43
mlt_event_data
A container for data that may be supplied with an event.
Definition: mlt_events.h:30
mlt_event_data::mlt_event_data_to_int
int mlt_event_data_to_int(mlt_event_data event_data)
Get an integer from the event data.
Definition: mlt_events.c:502
mlt_event_data::i
int i
Definition: mlt_events.h:32
mlt_event_data::p
void * p
Definition: mlt_events.h:33
mlt_event_data::mlt_event_data_from_object
mlt_event_data mlt_event_data_from_object(void *value)
Initialize event data with opaque data.
Definition: mlt_events.c:566
mlt_event_data::mlt_event_data_to_object
void * mlt_event_data_to_object(mlt_event_data event_data)
Get a pointer from the event data.
Definition: mlt_events.c:580
mlt_event_data::mlt_event_data_from_string
mlt_event_data mlt_event_data_from_string(const char *value)
Initialize event data with a string.
Definition: mlt_events.c:514
mlt_event_data::mlt_event_data_from_int
mlt_event_data mlt_event_data_from_int(int value)
Initialize event data with an integer.
Definition: mlt_events.c:488
mlt_event_data::mlt_event_data_to_string
const char * mlt_event_data_to_string(mlt_event_data event_data)
Get a string from the event data.
Definition: mlt_events.c:528
mlt_event_data::mlt_event_data_to_frame
mlt_frame mlt_event_data_to_frame(mlt_event_data event_data)
Get a frame from the event data.
Definition: mlt_events.c:554
mlt_event_data::mlt_event_data_from_frame
mlt_event_data mlt_event_data_from_frame(mlt_frame frame)
Initialize event data with a frame.
Definition: mlt_events.c:540
mlt_event_data::mlt_event_data_none
mlt_event_data mlt_event_data_none()
Initialize an empty event data.
Definition: mlt_events.c:474
mlt_event_struct
Event class.
Definition: mlt_events.c:62
mlt_event_struct::mlt_event_unblock
void mlt_event_unblock(mlt_event self)
Decrement the block count on self event.
Definition: mlt_events.c:100
mlt_event_struct::mlt_event_inc_ref
void mlt_event_inc_ref(mlt_event self)
Increment the reference count on self event.
Definition: mlt_events.c:76
mlt_event_struct::mlt_event_block
void mlt_event_block(mlt_event self)
Increment the block count on self event.
Definition: mlt_events.c:88
mlt_event_struct::mlt_event_close
void mlt_event_close(mlt_event self)
Close self event.
Definition: mlt_events.c:112
mlt_events_struct::mlt_events_init
void mlt_events_init(mlt_properties self)
Initialise the events structure.
Definition: mlt_events.c:142
mlt_events_struct::mlt_events_fire
int mlt_events_fire(mlt_properties self, const char *id, mlt_event_data event_data)
Fire an event.
Definition: mlt_events.c:196
mlt_events_struct::mlt_events_listen
mlt_event mlt_events_listen(mlt_properties self, void *listener_data, const char *id, mlt_listener listener)
Register a listener.
Definition: mlt_events.c:230
mlt_events_struct::mlt_events_wait_for
void mlt_events_wait_for(mlt_properties self, mlt_event event)
Wait for an event.
Definition: mlt_events.c:412
mlt_events_struct::mlt_events_register
int mlt_events_register(mlt_properties self, const char *id)
Register an event.
Definition: mlt_events.c:168
mlt_events_struct::mlt_events_setup_wait_for
mlt_event mlt_events_setup_wait_for(mlt_properties self, const char *id)
Prepare to wait for an event.
Definition: mlt_events.c:396
mlt_events_struct::mlt_events_disconnect
void mlt_events_disconnect(mlt_properties self, void *listener_data)
Disconnect all events for a given listener_data.
Definition: mlt_events.c:345
mlt_events_struct::mlt_events_close_wait_for
void mlt_events_close_wait_for(mlt_properties self, mlt_event event)
Cleanup after waiting for an event.
Definition: mlt_events.c:427
mlt_events_struct::mlt_events_block
void mlt_events_block(mlt_properties self, void *listener_data)
Block all events for a given listener_data.
Definition: mlt_events.c:291
mlt_events_struct::mlt_events_unblock
void mlt_events_unblock(mlt_properties self, void *listener_data)
Unblock all events for a given listener_data.
Definition: mlt_events.c:318
mlt_frame_s
Frame class.
Definition: mlt_frame.h:90
mlt_properties_s
Properties class.
Definition: mlt_properties.h:40
Generated by doxygen 1.9.1