git.sesse.net Git - vlc/blob - src/control/event.c

   1 /*****************************************************************************
   2  * event.c: New libvlc event control API
   3  *****************************************************************************
   4  * Copyright (C) 2007 the VideoLAN team
   5  * $Id $
   6  *
   7  * Authors: Filippo Carone <filippo@carone.org>
   8  *          Pierre d'Herbemont <pdherbemont # videolan.org>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 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 General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 #include "libvlc_internal.h"
  26 #include <vlc/libvlc.h>
  27 #include <vlc_playlist.h>
  28
  29
  30 /*
  31  * Private functions
  32  */
  33
  34
  35 /*
  36  * Internal libvlc functions
  37  */
  38
  39 /**************************************************************************
  40  *       libvlc_event_init (internal) :
  41  *
  42  * initialization function.
  43  **************************************************************************/
  44 void libvlc_event_init( libvlc_instance_t *p_instance, libvlc_exception_t *p_e )
  45 {
  46     /* Will certainly be used to install libvlc_instance event */
  47 }
  48
  49 /**************************************************************************
  50  *       libvlc_event_fini (internal) :
  51  *
  52  * finalization function.
  53  **************************************************************************/
  54 void libvlc_event_fini( libvlc_instance_t *p_instance, libvlc_exception_t *p_e )
  55 {
  56 }
  57
  58 /**************************************************************************
  59  *       libvlc_event_manager_init (internal) :
  60  *
  61  * Init an object's event manager.
  62  **************************************************************************/
  63 libvlc_event_manager_t *
  64 libvlc_event_manager_new( void * p_obj, libvlc_instance_t * p_libvlc_inst,
  65                            libvlc_exception_t *p_e )
  66 {
  67     libvlc_event_manager_t * p_em;
  68
  69     p_em = malloc(sizeof( libvlc_event_manager_t ));
  70     if( !p_em )
  71     {
  72         libvlc_exception_raise( p_e, "No Memory left" );
  73         return NULL;
  74     }
  75
  76     p_em->p_obj = p_obj;
  77     p_em->p_libvlc_instance = p_libvlc_inst;
  78     ARRAY_INIT( p_em->listeners_groups );
  79
  80     return p_em;
  81 }
  82
  83 /**************************************************************************
  84  *       libvlc_event_manager_release (internal) :
  85  *
  86  * Init an object's event manager.
  87  **************************************************************************/
  88 void libvlc_event_manager_release( libvlc_event_manager_t * p_em )
  89 {
  90     libvlc_event_listeners_group_t * listeners_group;
  91     libvlc_event_listener_t * listener;
  92
  93     FOREACH_ARRAY( listeners_group, p_em->listeners_groups )
  94         FOREACH_ARRAY( listener, listeners_group->listeners )
  95             free( listener );
  96         FOREACH_END()
  97         free( listeners_group );
  98     FOREACH_END()
  99     free( p_em );
 100 }
 101
 102 /**************************************************************************
 103  *       libvlc_event_manager_register_event_type (internal) :
 104  *
 105  * Init an object's event manager.
 106  **************************************************************************/
 107 void libvlc_event_manager_register_event_type(
 108         libvlc_event_manager_t * p_em,
 109         libvlc_event_type_t event_type,
 110         libvlc_exception_t * p_e )
 111 {
 112     libvlc_event_listeners_group_t * listeners_group;
 113     listeners_group = malloc(sizeof(libvlc_event_listeners_group_t));
 114     if( !listeners_group )
 115     {
 116         libvlc_exception_raise( p_e, "No Memory left" );
 117         return;
 118     }
 119
 120     listeners_group->event_type = event_type;
 121     ARRAY_INIT( listeners_group->listeners );
 122
 123     ARRAY_APPEND( p_em->listeners_groups, listeners_group );
 124 }
 125
 126 /**************************************************************************
 127  *       libvlc_event_send (internal) :
 128  *
 129  * Send a callback.
 130  **************************************************************************/
 131 void libvlc_event_send( libvlc_event_manager_t * p_em,
 132                         libvlc_event_t * p_event )
 133 {
 134     libvlc_event_listeners_group_t * listeners_group;
 135     libvlc_event_listener_t * listener;
 136     /* Fill event with the sending object now */
 137     p_event->p_obj = p_em->p_obj;
 138
 139     FOREACH_ARRAY( listeners_group, p_em->listeners_groups )
 140         if( listeners_group->event_type == p_event->type )
 141         {
 142             /* We found the group, now send every one the event */
 143             FOREACH_ARRAY( listener, listeners_group->listeners )
 144                 listener->pf_callback( p_event, listener->p_user_data );
 145             FOREACH_END()
 146             break;
 147         }
 148     FOREACH_END()
 149 }
 150
 151 /*
 152  * Public libvlc functions
 153  */
 154
 155 /**************************************************************************
 156  *       libvlc_event_attach (public) :
 157  *
 158  * Add a callback for an event.
 159  **************************************************************************/
 160 void libvlc_event_attach( libvlc_event_manager_t * p_event_manager,
 161                           libvlc_event_type_t event_type,
 162                           libvlc_callback_t pf_callback,
 163                           void *p_user_data,
 164                           libvlc_exception_t *p_e )
 165 {
 166     libvlc_event_listeners_group_t * listeners_group;
 167     libvlc_event_listener_t * listener;
 168     listener = malloc(sizeof(libvlc_event_listener_t));
 169     if( !listener )
 170     {
 171         libvlc_exception_raise( p_e, "No Memory left" );
 172         return;
 173     }
 174
 175     listener->event_type = event_type;
 176     listener->p_user_data = p_user_data;
 177     listener->pf_callback = pf_callback;
 178
 179     FOREACH_ARRAY( listeners_group, p_event_manager->listeners_groups )
 180         if( listeners_group->event_type == listener->event_type )
 181         {
 182             ARRAY_APPEND( listeners_group->listeners, listener );
 183             return;
 184         }
 185     FOREACH_END()
 186
 187     free(listener);
 188     libvlc_exception_raise( p_e,
 189             "This object event manager doesn't know about '%s' events",
 190             libvlc_event_type_name(a));
 191 }
 192
 193 /**************************************************************************
 194  *       libvlc_event_detach (public) :
 195  *
 196  * Remove a callback for an event.
 197  **************************************************************************/
 198 void libvlc_event_detach( libvlc_event_manager_t *p_event_manager,
 199                           libvlc_event_type_t event_type,
 200                           libvlc_callback_t pf_callback,
 201                           void *p_user_data,
 202                           libvlc_exception_t *p_e )
 203 {
 204     libvlc_event_listeners_group_t * listeners_group;
 205     libvlc_event_listener_t * listener;
 206     FOREACH_ARRAY( listeners_group, p_event_manager->listeners_groups )
 207         if( listeners_group->event_type == event_type )
 208         {
 209             FOREACH_ARRAY( listener, listeners_group->listeners )
 210                 if( listener->event_type == event_type &&
 211                     listener->pf_callback == pf_callback &&
 212                     listener->p_user_data == p_user_data )
 213                 {
 214                     /* that's our listener */
 215                     free( listener );
 216                     ARRAY_REMOVE( listeners_group->listeners,
 217                         fe_idx /* This comes from the macro (and that's why
 218                                   I hate macro) */ );
 219                     return;
 220                 }
 221             FOREACH_END()
 222         }
 223     FOREACH_END()
 224
 225     libvlc_exception_raise( p_e,
 226             "This object event manager doesn't know about '%i,%p,%p' event observer",
 227             event_type, pf_callback, p_user_data );
 228 }
 229