git.sesse.net Git - vlc/blob - include/vlc/libvlc_events.h

   1 /*****************************************************************************
   2  * libvlc_events.h:  libvlc_events external API structure
   3  *****************************************************************************
   4  * Copyright (C) 1998-2008 the VideoLAN team
   5  * $Id $
   6  *
   7  * Authors: Filippo Carone <littlejohn@videolan.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 along
  21  * with this program; if not, write to the Free Software Foundation, Inc.,
  22  * 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 #ifndef LIBVLC_EVENTS_H
  26 #define LIBVLC_EVENTS_H 1
  27
  28 /**
  29  * \file
  30  * This file defines libvlc_event external API
  31  */
  32
  33 # ifdef __cplusplus
  34 extern "C" {
  35 # endif
  36
  37 /*****************************************************************************
  38  * Events handling
  39  *****************************************************************************/
  40
  41 /** \defgroup libvlc_event libvlc_event
  42  * \ingroup libvlc_core
  43  * LibVLC Available Events
  44  * @{
  45  */
  46
  47     /* Append new event types at the end. Do not remove, insert or
  48      * re-order any entry. The cpp will prepend libvlc_ to the symbols. */
  49 #define DEFINE_LIBVLC_EVENT_TYPES \
  50     DEF( MediaMetaChanged ), \
  51     DEF( MediaSubItemAdded ), \
  52     DEF( MediaDurationChanged ), \
  53     DEF( MediaPreparsedChanged ), \
  54     DEF( MediaFreed ), \
  55     DEF( MediaStateChanged ), \
  56     \
  57     DEF( MediaPlayerNothingSpecial ), \
  58     DEF( MediaPlayerOpening ), \
  59     DEF( MediaPlayerBuffering ), \
  60     DEF( MediaPlayerPlaying ), \
  61     DEF( MediaPlayerPaused ), \
  62     DEF( MediaPlayerStopped ), \
  63     DEF( MediaPlayerForward ), \
  64     DEF( MediaPlayerBackward ), \
  65     DEF( MediaPlayerEndReached ), \
  66     DEF( MediaPlayerEncounteredError ), \
  67     DEF( MediaPlayerTimeChanged ), \
  68     DEF( MediaPlayerPositionChanged ), \
  69     DEF( MediaPlayerSeekableChanged ), \
  70     DEF( MediaPlayerPausableChanged ), \
  71     \
  72     DEF( MediaListItemAdded ), \
  73     DEF( MediaListWillAddItem ), \
  74     DEF( MediaListItemDeleted ), \
  75     DEF( MediaListWillDeleteItem ), \
  76     \
  77     DEF( MediaListViewItemAdded ), \
  78     DEF( MediaListViewWillAddItem ), \
  79     DEF( MediaListViewItemDeleted ), \
  80     DEF( MediaListViewWillDeleteItem ), \
  81     \
  82     DEF( MediaListPlayerPlayed ), \
  83     DEF( MediaListPlayerNextItemSet ), \
  84     DEF( MediaListPlayerStopped ), \
  85     \
  86     DEF( MediaDiscovererStarted ), \
  87     DEF( MediaDiscovererEnded ), \
  88     \
  89     DEF( MediaPlayerTitleChanged ), \
  90     DEF( MediaPlayerSnapshotTaken ), \
  91     DEF( MediaPlayerLengthChanged ), \
  92     \
  93     DEF( VlmMediaAdded ), \
  94     DEF( VlmMediaRemoved ), \
  95     DEF( VlmMediaChanged ), \
  96     DEF( VlmMediaInstanceStarted ), \
  97     DEF( VlmMediaInstanceStopped ), \
  98     DEF( VlmMediaInstanceStatusInit ), \
  99     DEF( VlmMediaInstanceStatusOpening ), \
 100     DEF( VlmMediaInstanceStatusPlaying ), \
 101     DEF( VlmMediaInstanceStatusPause ), \
 102     DEF( VlmMediaInstanceStatusEnd ), \
 103     DEF( VlmMediaInstanceStatusError ), \
 104     /* New event types HERE */
 105
 106 #ifdef __cplusplus
 107 enum libvlc_event_type_e {
 108 #else
 109 enum libvlc_event_type_t {
 110 #endif
 111 #define DEF(a) libvlc_##a
 112     DEFINE_LIBVLC_EVENT_TYPES
 113     libvlc_num_event_types
 114 #undef  DEF
 115 };
 116
 117 /* Implementing libvlc_event_type_name() needs the definition too. */
 118 #ifndef LIBVLC_EVENT_TYPES_KEEP_DEFINE
 119 #undef  DEFINE_LIBVLC_EVENT_TYPES
 120 #endif
 121
 122 /**
 123  * An Event
 124  * \param type the even type
 125  * \param p_obj the sender object
 126  * \param u Event dependent content
 127  */
 128
 129 struct libvlc_event_t
 130 {
 131     libvlc_event_type_t type;
 132     void * p_obj;
 133     union event_type_specific
 134     {
 135         /* media descriptor */
 136         struct
 137         {
 138             libvlc_meta_t meta_type;
 139         } media_meta_changed;
 140         struct
 141         {
 142             libvlc_media_t * new_child;
 143         } media_subitem_added;
 144         struct
 145         {
 146             int64_t new_duration;
 147         } media_duration_changed;
 148         struct
 149         {
 150             int new_status;
 151         } media_preparsed_changed;
 152         struct
 153         {
 154             libvlc_media_t * md;
 155         } media_freed;
 156         struct
 157         {
 158             libvlc_state_t new_state;
 159         } media_state_changed;
 160
 161         /* media instance */
 162         struct
 163         {
 164             float new_position;
 165         } media_player_position_changed;
 166         struct
 167         {
 168             libvlc_time_t new_time;
 169         } media_player_time_changed;
 170         struct
 171         {
 172             int new_title;
 173         } media_player_title_changed;
 174         struct
 175         {
 176             int new_seekable;
 177         } media_player_seekable_changed;
 178         struct
 179         {
 180             int new_pausable;
 181         } media_player_pausable_changed;
 182
 183         /* media list */
 184         struct
 185         {
 186             libvlc_media_t * item;
 187             int index;
 188         } media_list_item_added;
 189         struct
 190         {
 191             libvlc_media_t * item;
 192             int index;
 193         } media_list_will_add_item;
 194         struct
 195         {
 196             libvlc_media_t * item;
 197             int index;
 198         } media_list_item_deleted;
 199         struct
 200         {
 201             libvlc_media_t * item;
 202             int index;
 203         } media_list_will_delete_item;
 204
 205         /* media list view */
 206         struct
 207         {
 208             libvlc_media_t * item;
 209             int index;
 210         } media_list_view_item_added;
 211         struct
 212         {
 213             libvlc_media_t * item;
 214             int index;
 215         } media_list_view_will_add_item;
 216         struct
 217         {
 218             libvlc_media_t * item;
 219             int index;
 220         } media_list_view_item_deleted;
 221         struct
 222         {
 223             libvlc_media_t * item;
 224             int index;
 225         } media_list_view_will_delete_item;
 226
 227         /* media list player */
 228         struct
 229         {
 230             libvlc_media_t * item;
 231         } media_list_player_next_item_set;
 232
 233         /* snapshot taken */
 234         struct
 235         {
 236              char* psz_filename ;
 237         } media_player_snapshot_taken ;
 238
 239         /* Length changed */
 240         struct
 241         {
 242             libvlc_time_t   new_length;
 243         } media_player_length_changed;
 244
 245         /* VLM media */
 246         struct
 247         {
 248             const char * psz_media_name;
 249             const char * psz_instance_name;
 250         } vlm_media_event;
 251     } u;
 252 };
 253
 254
 255 /**@} */
 256
 257 # ifdef __cplusplus
 258 }
 259 # endif
 260
 261 #endif /* _LIBVLC_EVENTS_H */