events: Rework event subsystem (add_event, send_event) to be more versatile.

add_event_ex is added that takes an extra user_data pointer. This pointer is
passed to the callback (add_event and add_event_ex have slightly different
callbacks types). All callbacks also get the event id passed. Events added
with add_event_ex must be removed with remove_event_ex because the user_data
pointer must match in addition to the callback pointer.

On the other add_event is simplified to omit the oneshort parameter which
was almost always false (still there with add_event_ex).

As a side effect the ata_idle_notify callbacks are changed as well, they
do not take a data parameter anymore which was always NULL anyway.

This commit also adds some documentation to events.h

Change-Id: I13e29a0f88ef908f175b376d83550f9e0231f772

5 files changed, 40 insertions, 47 deletions

diff --git a/apps/gui/list.c b/apps/gui/list.c
index c393340..8663abe 100644
--- a/apps/gui/list.c
+++ b/apps/gui/list.c
@@ -66,16 +66,17 @@ static bool list_is_dirty(struct gui_synclist *list)
     return TIME_BEFORE(list->dirty_tick, last_dirty_tick);
 }
 
-static void list_force_reinit(void *param)
+static void list_force_reinit(unsigned short id, void *param, void *last_dirty_tick)
 {
+    (void)id;
     (void)param;
-    last_dirty_tick = current_tick;
+    *(int *)last_dirty_tick = current_tick;
 }
 
 void list_init(void)
 {
     last_dirty_tick = current_tick;
-    add_event(GUI_EVENT_THEME_CHANGED, false, list_force_reinit);
+    add_event_ex(GUI_EVENT_THEME_CHANGED, false, list_force_reinit, &last_dirty_tick);
 }
 
 static void list_init_viewports(struct gui_synclist *list)
@@ -611,8 +612,9 @@ bool gui_synclist_keyclick_callback(int action, void* data)
  */
 static struct gui_synclist *current_lists;
 static bool ui_update_event_registered = false;
-static void _lists_uiviewport_update_callback(void *data)
+static void _lists_uiviewport_update_callback(unsigned short id, void *data)
 {
+    (void)id;
     (void)data;
     if (current_lists)
         gui_synclist_draw(current_lists);
@@ -801,8 +803,7 @@ int list_do_action_timeout(struct gui_synclist *lists, int timeout)
     {
         if (!ui_update_event_registered)
             ui_update_event_registered = 
-                    add_event(GUI_EVENT_NEED_UI_UPDATE, false,
-                            _lists_uiviewport_update_callback);
+                    add_event(GUI_EVENT_NEED_UI_UPDATE, _lists_uiviewport_update_callback);
         current_lists = lists;
     }
     if(lists->scheduled_talk_tick)
diff --git a/apps/gui/statusbar-skinned.c b/apps/gui/statusbar-skinned.c
index c991d8e..c4cc37d 100644
--- a/apps/gui/statusbar-skinned.c
+++ b/apps/gui/statusbar-skinned.c
@@ -178,8 +178,9 @@ void sb_skin_update(enum screen_type screen, bool force)
     }
 }
 
-void do_sbs_update_callback(void *param)
+void do_sbs_update_callback(unsigned short id, void *param)
 {
+    (void)id;
     (void)param;
     /* the WPS handles changing the actual id3 data in the id3 pointers
      * we imported, we just want a full update */
diff --git a/apps/gui/statusbar-skinned.h b/apps/gui/statusbar-skinned.h
index ac12dfa..237ec45 100644
--- a/apps/gui/statusbar-skinned.h
+++ b/apps/gui/statusbar-skinned.h
@@ -66,5 +66,5 @@ int sb_postproccess(enum screen_type screen, struct wps_data *data);
 #define sb_preproccess NULL
 #define sb_postproccess NULL
 #endif
-void do_sbs_update_callback(void *param);
+void do_sbs_update_callback(unsigned short id, void *param);
 #endif /* __STATUSBAR_SKINNED_H__ */
diff --git a/apps/gui/viewport.c b/apps/gui/viewport.c
index aeb884a..194954c 100644
--- a/apps/gui/viewport.c
+++ b/apps/gui/viewport.c
@@ -69,7 +69,7 @@ struct viewport_stack_item
 };
 
 #ifdef HAVE_LCD_BITMAP
-static void viewportmanager_redraw(void* data);
+static void viewportmanager_redraw(unsigned short id, void* data);
 
 static int theme_stack_top[NB_SCREENS]; /* the last item added */
 static struct viewport_stack_item theme_stack[NB_SCREENS][VPSTACK_DEPTH];
@@ -80,14 +80,12 @@ static void toggle_events(bool enable)
 {
     if (enable)
     {
-        add_event(GUI_EVENT_ACTIONUPDATE, false, viewportmanager_redraw);
+        add_event(GUI_EVENT_ACTIONUPDATE, viewportmanager_redraw);
 #if defined(HAVE_LCD_ENABLE) || defined(HAVE_LCD_SLEEP)
-        add_event(LCD_EVENT_ACTIVATION, false, do_sbs_update_callback);
+        add_event(LCD_EVENT_ACTIVATION, do_sbs_update_callback);
 #endif
-        add_event(PLAYBACK_EVENT_TRACK_CHANGE, false,
-                                                do_sbs_update_callback);
-        add_event(PLAYBACK_EVENT_NEXTTRACKID3_AVAILABLE, false,
-                                                do_sbs_update_callback);
+        add_event(PLAYBACK_EVENT_TRACK_CHANGE, do_sbs_update_callback);
+        add_event(PLAYBACK_EVENT_NEXTTRACKID3_AVAILABLE, do_sbs_update_callback);
     }
     else
     {
@@ -232,8 +230,9 @@ int viewport_get_nb_lines(const struct viewport *vp)
 #endif
 }
 
-static void viewportmanager_redraw(void* data)
+static void viewportmanager_redraw(unsigned short id, void* data)
 {
+    (void)id;
     FOR_NB_SCREENS(i)
     {
 #ifdef HAVE_LCD_BITMAP
@@ -256,7 +255,7 @@ void viewportmanager_init()
         viewportmanager_theme_enable(i, true, NULL);
     }
 #else
-    add_event(GUI_EVENT_ACTIONUPDATE, false, viewportmanager_redraw);
+    add_event(GUI_EVENT_ACTIONUPDATE, viewportmanager_redraw);
 #endif
 }
 
diff --git a/apps/gui/wps.c b/apps/gui/wps.c
index b4c3f40..d1161ea7 100644
--- a/apps/gui/wps.c
+++ b/apps/gui/wps.c
@@ -74,8 +74,7 @@
 
 /* initial setup of wps_data  */
 static void wps_state_init(void);
-static void track_changed_callback(void *param);
-static void nextid3available_callback(void* param);
+static void track_info_callback(unsigned short id, void *param);
 
 #define WPS_DEFAULTCFG WPS_DIR "/rockbox_default.wps"
 #ifdef HAVE_REMOTE_LCD
@@ -626,8 +625,9 @@ static void play_hop(int direction)
  * we suppress updates until the wps is activated again (the lcd driver will
  * call this hook to issue an instant update)
  * */
-static void wps_lcd_activation_hook(void *param)
+static void wps_lcd_activation_hook(unsigned short id, void *param)
 {
+    (void)id;
     (void)param;
     skin_request_full_update(WPS);
     /* force timeout in wps main loop, so that the update is instantly */
@@ -1119,7 +1119,7 @@ long gui_wps_show(void)
             restore = false;
             restoretimer = RESTORE_WPS_INSTANTLY;
 #if defined(HAVE_LCD_ENABLE) || defined(HAVE_LCD_SLEEP)
-            add_event(LCD_EVENT_ACTIVATION, false, wps_lcd_activation_hook);
+            add_event(LCD_EVENT_ACTIVATION, wps_lcd_activation_hook);
 #endif
         /* we remove the update delay since it's not very usable in the wps,
          * e.g. during volume changing or ffwd/rewind */
@@ -1187,35 +1187,27 @@ long gui_wps_show(void)
 }
 
 /* this is called from the playback thread so NO DRAWING! */
-static void track_changed_callback(void *param)
+static void track_info_callback(unsigned short id, void *param)
 {
     struct wps_state *state = skin_get_global_state();
-    state->id3 = ((struct track_event *)param)->id3;
-    state->nid3 = audio_next_track();
-    if (state->id3->cuesheet)
+
+    if (id == PLAYBACK_EVENT_TRACK_CHANGE || id == PLAYBACK_EVENT_CUR_TRACK_READY)
     {
-        cue_find_current_track(state->id3->cuesheet, state->id3->elapsed);
+        state->id3 = ((struct track_event *)param)->id3;
+        if (state->id3->cuesheet)
+        {
+            cue_find_current_track(state->id3->cuesheet, state->id3->elapsed);
+        }
     }
-    skin_request_full_update(WPS);
-}
-static void nextid3available_callback(void* param)
-{
-    (void)param;
-    skin_get_global_state()->nid3 = audio_next_track();
-    skin_request_full_update(WPS);
-}
-
 #ifdef AUDIO_FAST_SKIP_PREVIEW
-/* this is called on the audio_skip caller thread */
-static void track_skip_callback(void *param)
-{
-    struct wps_state *state = skin_get_global_state();
-    state->id3 = audio_current_track();
-    state->nid3 = audio_next_track();
+    else if (id == PLAYBACK_EVENT_TRACK_SKIP)
+    {
+        state->id3 = audio_current_track();
+    }
+#endif
+    skin_get_global_state()->nid3 = audio_next_track();
     skin_request_full_update(WPS);
-    (void)param;
 }
-#endif /* AUDIO_FAST_SKIP_PREVIEW */
 
 static void wps_state_init(void)
 {
@@ -1235,15 +1227,15 @@ static void wps_state_init(void)
     /* We'll be updating due to restore initialized with true */
     skin_request_full_update(WPS);
     /* add the WPS track event callbacks */
-    add_event(PLAYBACK_EVENT_TRACK_CHANGE, false, track_changed_callback);
-    add_event(PLAYBACK_EVENT_NEXTTRACKID3_AVAILABLE, false, nextid3available_callback);
+    add_event(PLAYBACK_EVENT_TRACK_CHANGE, track_info_callback);
+    add_event(PLAYBACK_EVENT_NEXTTRACKID3_AVAILABLE, track_info_callback);
 #if CONFIG_CODEC == SWCODEC
     /* Use the same callback as ..._TRACK_CHANGE for when remaining handles have
        finished */
-    add_event(PLAYBACK_EVENT_CUR_TRACK_READY, false, track_changed_callback);
+    add_event(PLAYBACK_EVENT_CUR_TRACK_READY, track_info_callback);
 #endif
 #ifdef AUDIO_FAST_SKIP_PREVIEW
-    add_event(PLAYBACK_EVENT_TRACK_SKIP, false, track_skip_callback);
+    add_event(PLAYBACK_EVENT_TRACK_SKIP, track_info_callback);
 #endif
 }