1 /*****************************************************************************
2 * libvlc.h: libvlc_* new external API structures
3 *****************************************************************************
4 * Copyright (C) 1998-2007 the VideoLAN team
7 * Authors: Filippo Carone <littlejohn@videolan.org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 #ifndef _LIBVLC_STRUCTURES_H
25 #define _LIBVLC_STRUCTURES_H 1
33 /** This structure is opaque. It represents a libvlc instance */
34 typedef struct libvlc_instance_t libvlc_instance_t;
36 /*****************************************************************************
38 *****************************************************************************/
40 /** defgroup libvlc_exception Exceptions
42 * LibVLC Exceptions handling
55 /*****************************************************************************
57 *****************************************************************************/
58 /** defgroup libvlc_playlist Playlist
60 * LibVLC Playlist handling
69 } libvlc_playlist_item_t;
74 /*****************************************************************************
76 *****************************************************************************/
77 /** defgroup libvlc_video Video
79 * LibVLC Video handling
84 * Downcast to this general type as placeholder for a platform specific one, such as:
86 * CGrafPort on MacOSX,
89 typedef int libvlc_drawable_t;
92 * Rectangle type for video geometry
104 /*****************************************************************************
105 * Message log handling
106 *****************************************************************************/
108 /** defgroup libvlc_log Log
110 * LibVLC Message Logging
114 /** This structure is opaque. It represents a libvlc log instance */
115 typedef struct libvlc_log_t libvlc_log_t;
117 /** This structure is opaque. It represents a libvlc log iterator */
118 typedef struct libvlc_log_iterator_t libvlc_log_iterator_t;
120 typedef struct libvlc_log_message_t
122 unsigned sizeof_msg; /* sizeof() of message structure, must be filled in by user */
123 int i_severity; /* 0=INFO, 1=ERR, 2=WARN, 3=DBG */
124 const char *psz_type; /* module type */
125 const char *psz_name; /* module name */
126 const char *psz_header; /* optional header */
127 const char *psz_message; /* message */
128 } libvlc_log_message_t;
132 /*****************************************************************************
134 *****************************************************************************/
136 /** defgroup libvlc_callbacks Callbacks
138 * LibVLC Event Callbacks
145 * - INPUT_POSITION_CHANGED
150 INPUT_POSITION_CHANGED,
151 } libvlc_event_type_t;
163 } libvlc_event_value_type_t;
167 libvlc_event_type_t type;
168 libvlc_event_value_type_t value_type;
169 vlc_value_t old_value;
170 vlc_value_t new_value;
171 char reserved[8]; /* For future use */
175 * Callback function notification
176 * \param p_instance the libvlc instance
177 * \param p_event the event triggering the callback
178 * \param p_user_data user provided data
181 typedef void ( *libvlc_callback_t )( struct libvlc_instance_t *, libvlc_event_t *, void * );