VLC  3.0.21
vlc_events.h
Go to the documentation of this file.
1 /*****************************************************************************
2  * vlc_events.h: events definitions
3  * Interface used to send events.
4  *****************************************************************************
5  * Copyright (C) 2007 VLC authors and VideoLAN
6  * $Id$
7  *
8  * Authors: Pierre d'Herbemont
9  *
10  * This program is free software; you can redistribute it and/or modify it
11  * under the terms of the GNU Lesser General Public License as published by
12  * the Free Software Foundation; either version 2.1 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU Lesser General Public License for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public License
21  * along with this program; if not, write to the Free Software Foundation,
22  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23  *****************************************************************************/
24 
25 #ifndef VLC_EVENTS_H
26 # define VLC_EVENTS_H
27 
28 #include <vlc_arrays.h>
29 #include <vlc_meta.h>
30 
31 /**
32  * \file
33  * This file is the interface definition for events
34  * (implementation in src/misc/events.c)
35  */
36 
37 /*****************************************************************************
38  * Documentation
39  *****************************************************************************/
40 /*
41  **** Background
42  *
43  * This implements a way to send and receive event for an object (which can be
44  * a simple C struct or less).
45  *
46  * This is in direct concurrency with the Variable based Callback
47  * (see src/misc/variables.c).
48  *
49  * It has the following advantages over Variable based Callback:
50  * - No need to implement the whole VLC_COMMON_MEMBERS in the object,
51  * thus it reduce it size. This is especially true for input_item_t which
52  * doesn't have VLC_COMMON_MEMBERS. This is the first reason of existence of
53  * this implementation.
54  * - Libvlc can easily be based upon that.
55  * - Existing event are clearly declared (in include/vlc_events.h)
56  *
57  *
58  **** Example usage
59  *
60  * (vlc_cool_object_t doesn't need to have the VLC_COMMON_MEMBERS.)
61  *
62  * struct vlc_cool_object_t
63  * {
64  * ...
65  * vlc_event_manager_t p_event_manager;
66  * ...
67  * }
68  *
69  * vlc_my_cool_object_new()
70  * {
71  * ...
72  * vlc_event_manager_init( &p_self->p_event_manager, p_self, p_a_libvlc_object );
73  * ...
74  * }
75  *
76  * vlc_my_cool_object_release()
77  * {
78  * ...
79  * vlc_event_manager_fini( &p_self->p_event_manager );
80  * ...
81  * }
82  *
83  * vlc_my_cool_object_do_something()
84  * {
85  * ...
86  * vlc_event_t event;
87  * event.type = vlc_MyCoolObjectDidSomething;
88  * event.u.my_cool_object_did_something.what_it_did = kSomething;
89  * vlc_event_send( &p_self->p_event_manager, &event );
90  * }
91  * */
92 
93  /*****************************************************************************
94  * Event Type
95  *****************************************************************************/
96 
97 /* List of event */
98 typedef enum vlc_event_type_t {
99  /* Input item events */
109 
111 {
114 
115 /* Event manager type */
116 typedef struct vlc_event_manager_t
117 {
118  void * p_obj;
122 
123 /* Event definition */
124 typedef struct vlc_event_t
125 {
127  void * p_obj; /* Sender object, automatically filled by vlc_event_send() */
129  {
130  /* Input item events */
132  {
136  {
140  {
144  {
148  {
152  {
153  const char * new_name;
156  {
157  void * unused;
160  {
161  bool new_value;
164  {
165  int new_status;
167  } u;
168 } vlc_event_t;
169 
170 /* Event callback type */
171 typedef void ( *vlc_event_callback_t )( const vlc_event_t *, void * );
172 
173  /*****************************************************************************
174  * Event manager
175  *****************************************************************************/
176 
177 /*
178  * p_obj points to the object that owns the event manager, and from
179  * which events are sent
180  */
181 void vlc_event_manager_init( vlc_event_manager_t * p_em, void * p_obj );
182 
183 /*
184  * Destroy
185  */
187 
188 /*
189  * Send an event to the listener attached to this p_em.
190  */
192 
193 /*
194  * Add a callback for an event.
195  */
196 VLC_API int vlc_event_attach( vlc_event_manager_t * p_event_manager,
197  vlc_event_type_t event_type,
198  vlc_event_callback_t pf_callback,
199  void *p_user_data );
200 
201 /*
202  * Remove a callback for an event.
203  */
204 VLC_API void vlc_event_detach( vlc_event_manager_t *p_event_manager,
205  vlc_event_type_t event_type,
206  vlc_event_callback_t pf_callback,
207  void *p_user_data );
208 
209 #endif /* VLC_EVENTS_H */
vlc_event_t::vlc_event_type_specific::input_item_error_when_reading_changed
Definition: vlc_events.h:157
VLC_API
#define VLC_API
Definition: fourcc_gen.c:30
vlc_event_manager_t
struct vlc_event_manager_t vlc_event_manager_t
vlc_event_t::vlc_event_type_specific::input_item_preparse_ended
struct vlc_event_t::vlc_event_type_specific::input_item_preparse_ended input_item_preparse_ended
vlc_event_t::vlc_event_type_specific::input_item_preparse_ended::new_status
int new_status
Definition: vlc_events.h:163
vlc_InputItemPreparsedChanged
Definition: vlc_events.h:103
vlc_event_listeners_group_t
Definition: vlc_events.h:108
vlc_InputItemMetaChanged
Definition: vlc_events.h:100
vlc_event_t::p_obj
void * p_obj
Definition: vlc_events.h:125
vlc_event_t::vlc_event_type_specific::input_item_info_changed
struct vlc_event_t::vlc_event_type_specific::vlc_input_item_info_changed input_item_info_changed
vlc_InputItemDurationChanged
Definition: vlc_events.h:102
vlc_event_manager_t::p_obj
void * p_obj
Definition: vlc_events.h:116
vlc_common.h
input_item_t
Describes an input and is used to spawn input_thread_t objects.
Definition: vlc_input_item.h:58
vlc_tick_t
int64_t vlc_tick_t
High precision date or time interval.
Definition: vlc_common.h:150
vlc_event_listeners_group_t::listeners
struct vlc_event_listeners_group_t::@162 listeners
vlc_event_callback_t
void(* vlc_event_callback_t)(const vlc_event_t *, void *)
Definition: vlc_events.h:169
vlc_InputItemNameChanged
Definition: vlc_events.h:104
vlc_InputItemSubItemTreeAdded
Definition: vlc_events.h:101
vlc_event_t::vlc_event_type_specific::input_item_preparse_ended
Definition: vlc_events.h:161
vlc_event_manager_init
void vlc_event_manager_init(vlc_event_manager_t *p_em, void *p_obj)
Initialize event manager object p_obj is the object that contains the event manager.
Definition: events.c:61
vlc_event_t::vlc_event_type_specific::input_item_subitem_added
struct vlc_event_t::vlc_event_type_specific::vlc_input_item_subitem_added input_item_subitem_added
vlc_event_t::u
union vlc_event_t::vlc_event_type_specific u
vlc_event_t::vlc_event_type_specific
Definition: vlc_events.h:126
vlc_event_t
Definition: vlc_events.h:122
vlc_event_t::vlc_event_type_specific::vlc_input_item_name_changed
Definition: vlc_events.h:149
vlc_event_t::vlc_event_type_specific::vlc_input_item_info_changed::unused
void * unused
Definition: vlc_events.h:155
vlc_event_t::vlc_event_type_specific::vlc_input_item_subitem_added::p_new_child
input_item_t * p_new_child
Definition: vlc_events.h:135
vlc_event_manager_t::events
vlc_event_listeners_group_t events[vlc_InputItemPreparseEnded+1]
Definition: vlc_events.h:118
vlc_event_t::vlc_event_type_specific::vlc_input_item_subitem_tree_added::p_root
input_item_node_t * p_root
Definition: vlc_events.h:139
vlc_event_t::vlc_event_type_specific::input_item_error_when_reading_changed::new_value
bool new_value
Definition: vlc_events.h:159
vlc_event_t::vlc_event_type_specific::vlc_input_item_meta_changed::meta_type
vlc_meta_type_t meta_type
Definition: vlc_events.h:131
vlc_event_listener_t
Definition: events.c:45
vlc_event_attach
int vlc_event_attach(vlc_event_manager_t *p_event_manager, vlc_event_type_t event_type, vlc_event_callback_t pf_callback, void *p_user_data)
Add a callback for an event.
Definition: events.c:117
vlc_event_t::vlc_event_type_specific::vlc_input_item_name_changed::new_name
const char * new_name
Definition: vlc_events.h:151
vlc_InputItemErrorWhenReadingChanged
Definition: vlc_events.h:106
vlc_event_manager_t::lock
vlc_mutex_t lock
Definition: vlc_events.h:117
vlc_InputItemPreparseEnded
Definition: vlc_events.h:107
vlc_event_detach
void vlc_event_detach(vlc_event_manager_t *p_event_manager, vlc_event_type_t event_type, vlc_event_callback_t pf_callback, void *p_user_data)
Remove a callback for an event.
Definition: events.c:142
vlc_event_manager_t
Definition: vlc_events.h:114
DECL_ARRAY
#define DECL_ARRAY(type)
Definition: vlc_arrays.h:165
vlc_event_manager_fini
void vlc_event_manager_fini(vlc_event_manager_t *p_em)
Destroy the event manager.
Definition: events.c:75
vlc_event_t::vlc_event_type_specific::vlc_input_item_meta_changed
Definition: vlc_events.h:129
vlc_mutex_t
pthread_mutex_t vlc_mutex_t
Mutex.
Definition: vlc_threads.h:267
vlc_event_t::vlc_event_type_specific::input_item_duration_changed
struct vlc_event_t::vlc_event_type_specific::vlc_input_item_duration_changed input_item_duration_changed
vlc_event_t::vlc_event_type_specific::vlc_input_item_subitem_added
Definition: vlc_events.h:133
vlc_event_type_t
vlc_event_type_t
Definition: vlc_events.h:96
vlc_event_t::vlc_event_type_specific::vlc_input_item_duration_changed::new_duration
vlc_tick_t new_duration
Definition: vlc_events.h:143
vlc_event_t::vlc_event_type_specific::input_item_preparsed_changed
struct vlc_event_t::vlc_event_type_specific::vlc_input_item_preparsed_changed input_item_preparsed_changed
vlc_InputItemInfoChanged
Definition: vlc_events.h:105
vlc_event_t::vlc_event_type_specific::vlc_input_item_info_changed
Definition: vlc_events.h:153
vlc_event_t::vlc_event_type_specific::input_item_subitem_tree_added
struct vlc_event_t::vlc_event_type_specific::vlc_input_item_subitem_tree_added input_item_subitem_tree_added
vlc_event_t::vlc_event_type_specific::input_item_name_changed
struct vlc_event_t::vlc_event_type_specific::vlc_input_item_name_changed input_item_name_changed
vlc_event_t::vlc_event_type_specific::input_item_meta_changed
struct vlc_event_t::vlc_event_type_specific::vlc_input_item_meta_changed input_item_meta_changed
vlc_arrays.h
vlc_event_t::vlc_event_type_specific::vlc_input_item_duration_changed
Definition: vlc_events.h:141
vlc_meta_type_t
vlc_meta_type_t
Definition: vlc_meta.h:33
input_item_node_t
Definition: vlc_input_item.h:180
vlc_event_t::vlc_event_type_specific::vlc_input_item_preparsed_changed::new_status
int new_status
Definition: vlc_events.h:147
vlc_meta.h
vlc_event_listeners_group_t
struct vlc_event_listeners_group_t vlc_event_listeners_group_t
vlc_event_t::vlc_event_type_specific::input_item_error_when_reading_changed
struct vlc_event_t::vlc_event_type_specific::input_item_error_when_reading_changed input_item_error_when_reading_changed
vlc_event_t::vlc_event_type_specific::vlc_input_item_subitem_tree_added
Definition: vlc_events.h:137
vlc_event_t::type
vlc_event_type_t type
Definition: vlc_events.h:124
vlc_event_t
struct vlc_event_t vlc_event_t
vlc_event_t::vlc_event_type_specific::vlc_input_item_preparsed_changed
Definition: vlc_events.h:145
vlc_event_send
void vlc_event_send(vlc_event_manager_t *p_em, vlc_event_t *)
Send an event to the listener attached to this p_em.
Definition: events.c:95