X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc%2Flibvlc_structures.h;h=49ddbbbb1924dc15a371c96ae8ab453b37bf6685;hb=b2efd10d19f7fb396eb8e9d5c30ee32b532a1694;hp=4334a2f43bc1108bce542809610df09547f0afa3;hpb=8239a93234c6d7a0cb74ddec81574d20f0e7a515;p=vlc diff --git a/include/vlc/libvlc_structures.h b/include/vlc/libvlc_structures.h index 4334a2f43b..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,8 +42,8 @@ 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 * @{ */ @@ -53,42 +58,58 @@ typedef struct libvlc_exception_t /**@} */ /***************************************************************************** - * Tag Query + * Time *****************************************************************************/ -/** defgroup libvlc_tag_query Tag Query - * \ingroup libvlc - * LibVLC Tag Query support in media descriptor +/** \defgroup libvlc_time libvlc_time + * \ingroup libvlc_core + * LibVLC Time support in libvlc * @{ */ -typedef struct libvlc_tag_query_t libvlc_tag_query_t; +typedef int64_t libvlc_time_t; /**@} */ /***************************************************************************** * Media Descriptor *****************************************************************************/ -/** defgroup libvlc_media_descriptor MediaDescriptor +/** \defgroup libvlc_media libvlc_media * \ingroup libvlc * LibVLC Media Descriptor handling * @{ */ /* Meta Handling */ -/** defgroup libvlc_meta Meta - * \ingroup libvlc_media_descriptor +/** defgroup libvlc_meta libvlc_meta + * \ingroup libvlc_media * LibVLC Media Meta * @{ */ typedef enum libvlc_meta_t { libvlc_meta_Title, - libvlc_meta_Artist + 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_descriptor_t libvlc_media_descriptor_t; +typedef struct libvlc_media_t libvlc_media_t; /**@} */ @@ -96,48 +117,84 @@ typedef struct libvlc_media_descriptor_t libvlc_media_descriptor_t; /***************************************************************************** * Media Instance *****************************************************************************/ -/** defgroup libvlc_media_instance MediaInstance +/** \defgroup libvlc_media_player libvlc_media_player * \ingroup libvlc * LibVLC Media Instance handling * @{ */ -typedef struct libvlc_media_instance_t libvlc_media_instance_t; +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 MediaList +/** \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 MediaListPlayer - * \ingroup libvlc +/** \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 * @{ */ @@ -151,16 +208,63 @@ typedef struct libvlc_playlist_item_t /**@} */ +/***************************************************************************** + * 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, @@ -182,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 * @{ */ @@ -210,75 +327,6 @@ typedef struct libvlc_log_message_t /**@} */ -/***************************************************************************** - * Callbacks handling - *****************************************************************************/ - -/** defgroup libvlc_callbacks Callbacks - * \ingroup libvlc - * LibVLC Event Callbacks - * @{ - */ - -/** - * Available events: (XXX: being reworked) - * - libvlc_MediaInstanceReachedEnd - */ - -typedef enum libvlc_event_type_t { - libvlc_MediaInstanceReachedEnd, - libvlc_MediaListItemAdded, - libvlc_MediaListItemDeleted, - libvlc_MediaListItemChanged, -} libvlc_event_type_t; - -/** - * An Event - * \param type the even type - * \param p_obj the sender object - * \param u Event dependent content - */ - -typedef struct libvlc_event_t -{ - libvlc_event_type_t type; - void * p_obj; - union event_type_specific - { - struct - { - libvlc_media_descriptor_t * item; - int index; - } media_list_item_added; - struct - { - libvlc_media_descriptor_t * item; - int index; - } media_list_item_deleted; - struct - { - libvlc_media_descriptor_t * item; - int index; - } media_list_item_changed; - } u; -} libvlc_event_t; - -/** - * Event manager that belongs to a libvlc object, and from whom events can - * be received. - */ - -typedef struct libvlc_event_manager_t libvlc_event_manager_t; - -/** - * Callback function notification - * \param p_event the event triggering the callback - */ - -typedef void ( *libvlc_callback_t )( const libvlc_event_t *, void * ); - -/**@} */ - # ifdef __cplusplus } # endif