vlc_events.h 6.97 KB
Newer Older
1
/*****************************************************************************
Pere Orga's avatar
Pere Orga committed
2
 * vlc_events.h: events definitions
3 4
 * Interface used to send events.
 *****************************************************************************
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
5
 * Copyright (C) 2007 VLC authors and VideoLAN
6 7 8 9
 * $Id$
 *
 * Authors: Pierre d'Herbemont
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
10 11 12
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
13 14 15 16
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
17 18
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
19
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
20 21 22
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 24 25 26 27 28
 *****************************************************************************/

#ifndef VLC_EVENTS_H
# define VLC_EVENTS_H

#include <vlc_arrays.h>
29
#include <vlc_meta.h>
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44

/**
 * \file
 * This file is the interface definition for events
 * (implementation in src/misc/events.c)
 */

/*****************************************************************************
 * Documentation
 *****************************************************************************/
/*
 **** Background
 *
 * This implements a way to send and receive event for an object (which can be
 * a simple C struct or less).
45
 *
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
 * This is in direct concurrency with the Variable based Callback
 * (see src/misc/variables.c).
 *
 * It has the following advantages over Variable based Callback:
 * - No need to implement the whole VLC_COMMON_MEMBERS in the object,
 * thus it reduce it size. This is especially true for input_item_t which
 * doesn't have VLC_COMMON_MEMBERS. This is the first reason of existence of
 * this implementation.
 * - Libvlc can easily be based upon that.
 * - Existing event are clearly declared (in include/vlc_events.h)
 *
 *
 **** Example usage
 *
 * (vlc_cool_object_t doesn't need to have the VLC_COMMON_MEMBERS.)
 *
62
 * struct vlc_cool_object_t
63 64 65 66 67 68 69 70 71
 * {
 *        ...
 *        vlc_event_manager_t p_event_manager;
 *        ...
 * }
 *
 * vlc_my_cool_object_new()
 * {
 *        ...
Pierre d'Herbemont's avatar
Pierre d'Herbemont committed
72
 *        vlc_event_manager_init( &p_self->p_event_manager, p_self, p_a_libvlc_object );
73 74 75 76 77 78 79 80
 *        vlc_event_manager_register_event_type(p_self->p_event_manager,
 *                vlc_MyCoolObjectDidSomething, p_e)
 *        ...
 * }
 *
 * vlc_my_cool_object_release()
 * {
 *         ...
Pierre d'Herbemont's avatar
Pierre d'Herbemont committed
81
 *         vlc_event_manager_fini( &p_self->p_event_manager );
82 83 84 85 86 87 88 89 90
 *         ...
 * }
 *
 * vlc_my_cool_object_do_something()
 * {
 *        ...
 *        vlc_event_t event;
 *        event.type = vlc_MyCoolObjectDidSomething;
 *        event.u.my_cool_object_did_something.what_it_did = kSomething;
Pierre d'Herbemont's avatar
Pierre d'Herbemont committed
91
 *        vlc_event_send( &p_self->p_event_manager, &event );
92 93
 * }
 * */
94

95 96 97 98 99 100
  /*****************************************************************************
 * Event Type
 *****************************************************************************/

/* List of event */
typedef enum vlc_event_type_t {
101
    /* Input item events */
102
    vlc_InputItemMetaChanged,
103
    vlc_InputItemSubItemAdded,
104
    vlc_InputItemSubItemTreeAdded,
105 106
    vlc_InputItemDurationChanged,
    vlc_InputItemPreparsedChanged,
107 108
    vlc_InputItemNameChanged,
    vlc_InputItemInfoChanged,
109
    vlc_InputItemErrorWhenReadingChanged,
110
    vlc_InputItemPreparseEnded,
111 112
} vlc_event_type_t;

113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132
typedef struct vlc_event_listeners_group_t
{
    DECL_ARRAY(struct vlc_event_listener_t *) listeners;

   /* Used in vlc_event_send() to make sure to behave
      Correctly when vlc_event_detach was called during
      a callback */
    bool          b_sublistener_removed;

} vlc_event_listeners_group_t;

/* Event manager type */
typedef struct vlc_event_manager_t
{
    void * p_obj;
    vlc_mutex_t object_lock;
    vlc_mutex_t event_sending_lock;
    vlc_event_listeners_group_t events[vlc_InputItemPreparseEnded + 1];
} vlc_event_manager_t;

133 134 135 136
/* Event definition */
typedef struct vlc_event_t
{
    vlc_event_type_t type;
137
    void * p_obj; /* Sender object, automatically filled by vlc_event_send() */
138
    union vlc_event_type_specific
139
    {
140
        /* Input item events */
141
        struct vlc_input_item_meta_changed
142
        {
143
            vlc_meta_type_t meta_type;
144
        } input_item_meta_changed;
145 146 147 148
        struct vlc_input_item_subitem_added
        {
            input_item_t * p_new_child;
        } input_item_subitem_added;
149 150 151 152
        struct vlc_input_item_subitem_tree_added
        {
            input_item_node_t * p_root;
        } input_item_subitem_tree_added;
153 154 155 156 157 158 159 160
        struct vlc_input_item_duration_changed
        {
            mtime_t new_duration;
        } input_item_duration_changed;
        struct vlc_input_item_preparsed_changed
        {
            int new_status;
        } input_item_preparsed_changed;
161 162 163 164 165 166 167 168
        struct vlc_input_item_name_changed
        {
            const char * new_name;
        } input_item_name_changed;
        struct vlc_input_item_info_changed
        {
            void * unused;
        } input_item_info_changed;
169 170 171 172
        struct input_item_error_when_reading_changed
        {
            bool new_value;
        } input_item_error_when_reading_changed;
173 174 175 176
        struct input_item_preparse_ended
        {
            int new_status;
        } input_item_preparse_ended;
177 178 179 180 181 182 183 184 185 186 187 188 189 190
    } u;
} vlc_event_t;

/* Event callback type */
typedef void ( *vlc_event_callback_t )( const vlc_event_t *, void * );

 /*****************************************************************************
 * Event manager
 *****************************************************************************/

/*
 * p_obj points to the object that owns the event manager, and from
 * which events are sent
 */
191
VLC_API int vlc_event_manager_init( vlc_event_manager_t * p_em, void * p_obj );
192 193 194 195

/*
 * Destroy
 */
196
VLC_API void vlc_event_manager_fini( vlc_event_manager_t * p_em );
197 198 199 200

/*
 * Tells a specific event manager that it will handle event_type object
 */
201 202
VLC_API int vlc_event_manager_register_event_type( vlc_event_manager_t * p_em,
                                                   vlc_event_type_t );
203 204 205 206

/*
 * Send an event to the listener attached to this p_em.
 */
207
VLC_API void vlc_event_send( vlc_event_manager_t * p_em, vlc_event_t * );
208 209 210 211

/*
 * Add a callback for an event.
 */
212 213 214
VLC_API int vlc_event_attach( vlc_event_manager_t * p_event_manager,
                              vlc_event_type_t event_type,
                              vlc_event_callback_t pf_callback,
215
                              void *p_user_data );
216 217 218 219

/*
 * Remove a callback for an event.
 */
220 221 222 223
VLC_API 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 );
224 225

#endif /* VLC_EVENTS_H */