X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc%2Flibvlc_structures.h;h=49ddbbbb1924dc15a371c96ae8ab453b37bf6685;hb=b2efd10d19f7fb396eb8e9d5c30ee32b532a1694;hp=e9708112a2e3a68e3f83a5b6d4ae2bad14668828;hpb=3c5ed2fe48048d3047634ca3da2f1d97db70d9f4;p=vlc diff --git a/include/vlc/libvlc_structures.h b/include/vlc/libvlc_structures.h index e9708112a2..49ddbbbb19 100644 --- a/include/vlc/libvlc_structures.h +++ b/include/vlc/libvlc_structures.h @@ -1,7 +1,7 @@ /***************************************************************************** * libvlc.h: libvlc_* new external API structures ***************************************************************************** - * Copyright (C) 1998-2007 the VideoLAN team + * Copyright (C) 1998-2008 the VideoLAN team * $Id $ * * Authors: Filippo Carone @@ -21,10 +21,15 @@ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. *****************************************************************************/ -#ifndef _LIBVLC_STRUCTURES_H -#define _LIBVLC_STRUCTURES_H 1 +#ifndef LIBVLC_STRUCTURES_H +#define LIBVLC_STRUCTURES_H 1 -#include +/** + * \file + * This file defines libvlc_* new external API structures + */ + +#include # ifdef __cplusplus extern "C" { @@ -37,13 +42,13 @@ typedef struct libvlc_instance_t libvlc_instance_t; * Exceptions *****************************************************************************/ -/** defgroup libvlc_exception Exceptions - * \ingroup libvlc +/** \defgroup libvlc_exception libvlc_exception + * \ingroup libvlc_core * LibVLC Exceptions handling * @{ */ -typedef struct +typedef struct libvlc_exception_t { int b_raised; int i_code; @@ -52,16 +57,149 @@ typedef struct /**@} */ +/***************************************************************************** + * Time + *****************************************************************************/ +/** \defgroup libvlc_time libvlc_time + * \ingroup libvlc_core + * LibVLC Time support in libvlc + * @{ + */ + +typedef int64_t libvlc_time_t; + +/**@} */ + +/***************************************************************************** + * Media Descriptor + *****************************************************************************/ +/** \defgroup libvlc_media libvlc_media + * \ingroup libvlc + * LibVLC Media Descriptor handling + * @{ + */ + +/* Meta Handling */ +/** defgroup libvlc_meta libvlc_meta + * \ingroup libvlc_media + * LibVLC Media Meta + * @{ + */ + +typedef enum libvlc_meta_t { + libvlc_meta_Title, + libvlc_meta_Artist, + libvlc_meta_Genre, + libvlc_meta_Copyright, + libvlc_meta_Album, + libvlc_meta_TrackNumber, + libvlc_meta_Description, + libvlc_meta_Rating, + libvlc_meta_Date, + libvlc_meta_Setting, + libvlc_meta_URL, + libvlc_meta_Language, + libvlc_meta_NowPlaying, + libvlc_meta_Publisher, + libvlc_meta_EncodedBy, + libvlc_meta_ArtworkURL, + libvlc_meta_TrackID, + /* Add new meta types HERE */ +} libvlc_meta_t; + +/**@} */ + +typedef struct libvlc_media_t libvlc_media_t; + +/**@} */ + + +/***************************************************************************** + * Media Instance + *****************************************************************************/ +/** \defgroup libvlc_media_player libvlc_media_player + * \ingroup libvlc + * LibVLC Media Instance handling + * @{ + */ + +typedef struct libvlc_media_player_t libvlc_media_player_t; + +/** + * Note the order of libvlc_state_t enum must match exactly the order of + * @see mediacontrol_PlayerStatus and @see input_state_e enums. + * + * Expected states by web plugins are: + * IDLE/CLOSE=0, OPENING=1, BUFFERING=2, PLAYING=3, PAUSED=4, + * STOPPING=5, ENDED=6, ERROR=7 + */ +typedef enum libvlc_state_t +{ + libvlc_NothingSpecial=0, + libvlc_Opening, + libvlc_Buffering, + libvlc_Playing, + libvlc_Paused, + libvlc_Stopped, + libvlc_Ended, + libvlc_Error +} libvlc_state_t; + +/**@} */ + +/***************************************************************************** + * Media List + *****************************************************************************/ +/** \defgroup libvlc_media_list libvlc_media_list + * \ingroup libvlc + * LibVLC Media List handling + * @{ + */ + +typedef struct libvlc_media_list_t libvlc_media_list_t; +typedef struct libvlc_media_list_view_t libvlc_media_list_view_t; + + +/***************************************************************************** + * Media List Player + *****************************************************************************/ +/** \defgroup libvlc_media_list_player libvlc_media_list_player + * \ingroup libvlc_media_list + * LibVLC Media List Player handling + * @{ + */ + +typedef struct libvlc_media_list_player_t libvlc_media_list_player_t; + +/**@} libvlc_media_list_player */ + +/**@} libvlc_media_list */ + +/***************************************************************************** + * Media Library + *****************************************************************************/ +/** \defgroup libvlc_media_library libvlc_media_library + * \ingroup libvlc + * LibVLC Media Library + * @{ + */ + +typedef struct libvlc_media_library_t libvlc_media_library_t; + +/**@} */ + /***************************************************************************** * Playlist *****************************************************************************/ -/** defgroup libvlc_playlist Playlist +/** \defgroup libvlc_playlist libvlc_playlist (Deprecated) * \ingroup libvlc - * LibVLC Playlist handling + * LibVLC Playlist handling (Deprecated) + * @deprecated Use media_list * @{ */ -typedef struct { +typedef struct libvlc_playlist_item_t +{ int i_id; char * psz_uri; char * psz_name; @@ -70,16 +208,63 @@ typedef struct { /**@} */ +/***************************************************************************** + * Media Player + *****************************************************************************/ +/** \defgroup libvlc_media_player libvlc_media_player + * \ingroup libvlc + * LibVLC Media Player, object that let you play a media + * in a libvlc_drawable_t + * @{ + */ + +/** + * Description for video, audio tracks and subtitles. It contains + * id, name (description string) and pointer to next record. + */ +typedef struct libvlc_track_description_t +{ + int i_id; + char *psz_name; + struct libvlc_track_description_t *p_next; + +} libvlc_track_description_t; + +/**@} */ + +/***************************************************************************** + * Audio + *****************************************************************************/ +/** \defgroup libvlc_audio libvlc_audio + * \ingroup libvlc_media_player + * LibVLC Audio handling + * @{ + */ + +/** + * Description for audio output. It contains + * name, description and pointer to next record. + */ +typedef struct libvlc_audio_output_t +{ + char *psz_name; + char *psz_description; + struct libvlc_audio_output_t *p_next; + +} libvlc_audio_output_t; + +/**@} */ + /***************************************************************************** * Video *****************************************************************************/ -/** defgroup libvlc_video Video - * \ingroup libvlc +/** \defgroup libvlc_video libvlc_video + * \ingroup libvlc_media_player * LibVLC Video handling * @{ */ - + /** * Downcast to this general type as placeholder for a platform specific one, such as: * Drawable on X11, @@ -91,7 +276,7 @@ typedef int libvlc_drawable_t; /** * Rectangle type for video geometry */ -typedef struct +typedef struct libvlc_rectangle_t { int top, left; int bottom, right; @@ -101,12 +286,25 @@ libvlc_rectangle_t; /**@} */ +/***************************************************************************** + * Services/Media Discovery + *****************************************************************************/ +/** \defgroup libvlc_media_discoverer libvlc_media_discoverer + * \ingroup libvlc + * LibVLC Media Discoverer + * @{ + */ + +typedef struct libvlc_media_discoverer_t libvlc_media_discoverer_t; + +/**@} */ + /***************************************************************************** * Message log handling *****************************************************************************/ -/** defgroup libvlc_log Log - * \ingroup libvlc +/** \defgroup libvlc_log libvlc_log + * \ingroup libvlc_core * LibVLC Message Logging * @{ */ @@ -129,36 +327,6 @@ typedef struct libvlc_log_message_t /**@} */ -/***************************************************************************** - * Callbacks handling - *****************************************************************************/ - -/** defgroup libvlc_callbacks Callbacks - * \ingroup libvlc - * LibVLC Event Callbacks - * @{ - */ - -/** - * Available events: - * - VOLUME_CHANGED - * - INPUT_POSITION_CHANGED - */ -typedef enum { - VOLUME_CHANGED, - INPUT_POSITION_CHANGED, -} libvlc_event_type_t; - -typedef struct -{ - libvlc_event_type_t type; - char reserved[8]; /* For future use */ -} libvlc_event_t; - -typedef void ( *libvlc_callback_t )( struct libvlc_instance_t *, libvlc_event_t * ); - -/**@} */ - # ifdef __cplusplus } # endif