include/vlc_events.h

   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  *        vlc_event_manager_register_event_type(p_self->p_event_manager,
  74  *                vlc_MyCoolObjectDidSomething, p_e)
  75  *        ...
  76  * }
  77  *
  78  * vlc_my_cool_object_release()
  79  * {
  80  *         ...
  81  *         vlc_event_manager_fini( &p_self->p_event_manager );
  82  *         ...
  83  * }
  84  *
  85  * vlc_my_cool_object_do_something()
  86  * {
  87  *        ...
  88  *        vlc_event_t event;
  89  *        event.type = vlc_MyCoolObjectDidSomething;
  90  *        event.u.my_cool_object_did_something.what_it_did = kSomething;
  91  *        vlc_event_send( &p_self->p_event_manager, &event );
  92  * }
  93  * */
  94
  95   /*****************************************************************************
  96  * Event Type
  97  *****************************************************************************/
  98
  99 /* Private structure defined in misc/events.c */
 100 struct vlc_event_listeners_group_t;
 101
 102 /* Event manager type */
 103 typedef struct vlc_event_manager_t
 104 {
 105     void * p_obj;
 106     vlc_mutex_t object_lock;
 107     vlc_mutex_t event_sending_lock;
 108     DECL_ARRAY(struct vlc_event_listeners_group_t *) listeners_groups;
 109 } vlc_event_manager_t;
 110
 111 /* List of event */
 112 typedef enum vlc_event_type_t {
 113     /* Input item events */
 114     vlc_InputItemMetaChanged,
 115     vlc_InputItemSubItemAdded,
 116     vlc_InputItemSubItemTreeAdded,
 117     vlc_InputItemDurationChanged,
 118     vlc_InputItemPreparsedChanged,
 119     vlc_InputItemNameChanged,
 120     vlc_InputItemInfoChanged,
 121     vlc_InputItemErrorWhenReadingChanged,
 122     vlc_InputItemPreparseEnded,
 123
 124     /* Renderer Discovery events */
 125     vlc_RendererDiscoveryItemAdded=vlc_InputItemPreparseEnded+6,
 126     vlc_RendererDiscoveryItemRemoved,
 127
 128     /* Addons Manager events */
 129     vlc_AddonFound,
 130     vlc_AddonsDiscoveryEnded,
 131     vlc_AddonChanged
 132 } vlc_event_type_t;
 133
 134 /* Event definition */
 135 typedef struct vlc_event_t
 136 {
 137     vlc_event_type_t type;
 138     void * p_obj; /* Sender object, automatically filled by vlc_event_send() */
 139     union vlc_event_type_specific
 140     {
 141         /* Input item events */
 142         struct vlc_input_item_meta_changed
 143         {
 144             vlc_meta_type_t meta_type;
 145         } input_item_meta_changed;
 146         struct vlc_input_item_subitem_added
 147         {
 148             input_item_t * p_new_child;
 149         } input_item_subitem_added;
 150         struct vlc_input_item_subitem_tree_added
 151         {
 152             input_item_node_t * p_root;
 153         } input_item_subitem_tree_added;
 154         struct vlc_input_item_duration_changed
 155         {
 156             mtime_t new_duration;
 157         } input_item_duration_changed;
 158         struct vlc_input_item_preparsed_changed
 159         {
 160             int new_status;
 161         } input_item_preparsed_changed;
 162         struct vlc_input_item_name_changed
 163         {
 164             const char * new_name;
 165         } input_item_name_changed;
 166         struct vlc_input_item_info_changed
 167         {
 168             void * unused;
 169         } input_item_info_changed;
 170         struct input_item_error_when_reading_changed
 171         {
 172             bool new_value;
 173         } input_item_error_when_reading_changed;
 174         struct input_item_preparse_ended
 175         {
 176             int new_status;
 177         } input_item_preparse_ended;
 178
 179         /* Renderer discovery events */
 180         struct vlc_renderer_discovery_item_added
 181         {
 182             vlc_renderer_item_t * p_new_item;
 183         } renderer_discovery_item_added;
 184         struct vlc_renderer_discovery_item_removed
 185         {
 186             vlc_renderer_item_t * p_item;
 187         } renderer_discovery_item_removed;
 188
 189         /* Addons */
 190         struct vlc_addon_generic_event
 191         {
 192             addon_entry_t * p_entry;
 193         } addon_generic_event;
 194     } u;
 195 } vlc_event_t;
 196
 197 /* Event callback type */
 198 typedef void ( *vlc_event_callback_t )( const vlc_event_t *, void * );
 199
 200  /*****************************************************************************
 201  * Event manager
 202  *****************************************************************************/
 203
 204 /*
 205  * p_obj points to the object that owns the event manager, and from
 206  * which events are sent
 207  */
 208 VLC_API int vlc_event_manager_init( vlc_event_manager_t * p_em, void * p_obj );
 209
 210 /*
 211  * Destroy
 212  */
 213 VLC_API void vlc_event_manager_fini( vlc_event_manager_t * p_em );
 214
 215 /*
 216  * Tells a specific event manager that it will handle event_type object
 217  */
 218 VLC_API int vlc_event_manager_register_event_type( vlc_event_manager_t * p_em,
 219                                                    vlc_event_type_t );
 220
 221 /*
 222  * Send an event to the listener attached to this p_em.
 223  */
 224 VLC_API void vlc_event_send( vlc_event_manager_t * p_em, vlc_event_t * );
 225
 226 /*
 227  * Add a callback for an event.
 228  */
 229 VLC_API int vlc_event_attach( vlc_event_manager_t * p_event_manager,
 230                               vlc_event_type_t event_type,
 231                               vlc_event_callback_t pf_callback,
 232                               void *p_user_data );
 233
 234 /*
 235  * Remove a callback for an event.
 236  */
 237 VLC_API void vlc_event_detach( vlc_event_manager_t *p_event_manager,
 238                                vlc_event_type_t event_type,
 239                                vlc_event_callback_t pf_callback,
 240                                void *p_user_data );
 241
 242 #endif /* VLC_EVENTS_H */