Skip to content

V
vlc
Commit 3adef752 authored by Pierre d'Herbemont's avatar Pierre d'Herbemont
Browse files
Options

libvlc: Introduce VLC_DEPRECATED_API. And mark the libvlc_playlist_* and VLC_* API as deprecated.

parent 6c52c72b
Show whitespace changes
Inline Side-by-side
Showing with 78 additions and 67 deletions
include/vlc/libvlc.h
View file @ 3adef752
......@@ -293,7 +293,7 @@ VLC_PUBLIC_API void *
* \param loop the loop attribute. 1 sets looping, 0 disables it
* \param p_e an initialized exception pointer
*/
VLC_PUBLIC_API void libvlc_playlist_loop( libvlc_instance_t* , int,
VLC_DEPRECATED_API void libvlc_playlist_loop( libvlc_instance_t* , int,
libvlc_exception_t * );
/**
......@@ -310,7 +310,7 @@ VLC_PUBLIC_API void libvlc_playlist_loop( libvlc_instance_t* , int,
* \param ppsz_options the options to add to the item
* \param p_e an initialized exception pointer
*/
VLC_PUBLIC_API void libvlc_playlist_play( libvlc_instance_t*, int, int,
VLC_DEPRECATED_API void libvlc_playlist_play( libvlc_instance_t*, int, int,
char **, libvlc_exception_t * );
/**
......@@ -321,7 +321,7 @@ VLC_PUBLIC_API void libvlc_playlist_play( libvlc_instance_t*, int, int,
* \param p_instance the playlist instance to pause
* \param p_e an initialized exception pointer
*/
VLC_PUBLIC_API void libvlc_playlist_pause( libvlc_instance_t *,
VLC_DEPRECATED_API void libvlc_playlist_pause( libvlc_instance_t *,
libvlc_exception_t * );
/**
......@@ -331,7 +331,7 @@ VLC_PUBLIC_API void libvlc_playlist_pause( libvlc_instance_t *,
* \param p_e an initialized exception pointer
* \return 0 if the playlist is stopped or paused, 1 if it is running
*/
VLC_PUBLIC_API int libvlc_playlist_isplaying( libvlc_instance_t *,
VLC_DEPRECATED_API int libvlc_playlist_isplaying( libvlc_instance_t *,
libvlc_exception_t * );
/**
......@@ -341,7 +341,7 @@ VLC_PUBLIC_API int libvlc_playlist_isplaying( libvlc_instance_t *,
* \param p_e an initialized exception pointer
* \return the number of items
*/
VLC_PUBLIC_API int libvlc_playlist_items_count( libvlc_instance_t *,
VLC_DEPRECATED_API int libvlc_playlist_items_count( libvlc_instance_t *,
libvlc_exception_t * );
/**
......@@ -349,14 +349,14 @@ VLC_PUBLIC_API int libvlc_playlist_items_count( libvlc_instance_t *,
*
* \param p_instance the playlist instance
*/
VLC_PUBLIC_API void libvlc_playlist_lock( libvlc_instance_t * );
VLC_DEPRECATED_API void libvlc_playlist_lock( libvlc_instance_t * );
/**
* Unlock the playlist.
*
* \param p_instance the playlist instance
*/
VLC_PUBLIC_API void libvlc_playlist_unlock( libvlc_instance_t * );
VLC_DEPRECATED_API void libvlc_playlist_unlock( libvlc_instance_t * );
/**
* Stop playing.
......@@ -364,7 +364,7 @@ VLC_PUBLIC_API void libvlc_playlist_unlock( libvlc_instance_t * );
* \param p_instance the playlist instance to stop
* \param p_e an initialized exception pointer
*/
VLC_PUBLIC_API void libvlc_playlist_stop( libvlc_instance_t *,
VLC_DEPRECATED_API void libvlc_playlist_stop( libvlc_instance_t *,
libvlc_exception_t * );
/**
......@@ -374,7 +374,7 @@ VLC_PUBLIC_API void libvlc_playlist_stop( libvlc_instance_t *,
* \param p_instance the playlist instance
* \param p_e an initialized exception pointer
*/
VLC_PUBLIC_API void libvlc_playlist_next( libvlc_instance_t *,
VLC_DEPRECATED_API void libvlc_playlist_next( libvlc_instance_t *,
libvlc_exception_t * );
/**
......@@ -384,7 +384,7 @@ VLC_PUBLIC_API void libvlc_playlist_next( libvlc_instance_t *,
* \param p_instance the playlist instance
* \param p_e an initialized exception pointer
*/
VLC_PUBLIC_API void libvlc_playlist_prev( libvlc_instance_t *,
VLC_DEPRECATED_API void libvlc_playlist_prev( libvlc_instance_t *,
libvlc_exception_t * );
/**
......@@ -393,7 +393,7 @@ VLC_PUBLIC_API void libvlc_playlist_prev( libvlc_instance_t *,
* \param p_instance the playlist instance
* \param p_e an initialized exception pointer
*/
VLC_PUBLIC_API void libvlc_playlist_clear( libvlc_instance_t *,
VLC_DEPRECATED_API void libvlc_playlist_clear( libvlc_instance_t *,
libvlc_exception_t * );
/**
......@@ -406,7 +406,7 @@ VLC_PUBLIC_API void libvlc_playlist_clear( libvlc_instance_t *,
* \param p_e an initialized exception pointer
* \return the identifier of the new item
*/
VLC_PUBLIC_API int libvlc_playlist_add( libvlc_instance_t *, const char *,
VLC_DEPRECATED_API int libvlc_playlist_add( libvlc_instance_t *, const char *,
const char *, libvlc_exception_t * );
/**
......@@ -421,7 +421,7 @@ VLC_PUBLIC_API int libvlc_playlist_add( libvlc_instance_t *, const char *,
* \param p_e an initialized exception pointer
* \return the identifier of the new item
*/
VLC_PUBLIC_API int libvlc_playlist_add_extended( libvlc_instance_t *, const char *,
VLC_DEPRECATED_API int libvlc_playlist_add_extended( libvlc_instance_t *, const char *,
const char *, int, const char **,
libvlc_exception_t * );
......@@ -433,7 +433,7 @@ VLC_PUBLIC_API int libvlc_playlist_add_extended( libvlc_instance_t *, const char
* \param p_e an initialized exception pointer
* \return 0 in case of success, a non-zero value otherwise
*/
VLC_PUBLIC_API int libvlc_playlist_delete_item( libvlc_instance_t *, int,
VLC_DEPRECATED_API int libvlc_playlist_delete_item( libvlc_instance_t *, int,
libvlc_exception_t * );
/** Get the input that is currently being played by the playlist.
......@@ -442,17 +442,9 @@ VLC_PUBLIC_API int libvlc_playlist_delete_item( libvlc_instance_t *, int,
* \param p_e an initialized exception pointern
* \return a media instance object
*/
VLC_PUBLIC_API libvlc_media_instance_t * libvlc_playlist_get_media_instance(
VLC_DEPRECATED_API libvlc_media_instance_t * libvlc_playlist_get_media_instance(
libvlc_instance_t *, libvlc_exception_t * );
VLC_PUBLIC_API int libvlc_media_instance_is_seekable(
libvlc_media_instance_t *p_mi,
libvlc_exception_t *p_e );
VLC_PUBLIC_API int libvlc_media_instance_can_pause(
libvlc_media_instance_t *p_mi,
libvlc_exception_t *p_e );
/** @}*/
/*****************************************************************************
......@@ -541,6 +533,13 @@ VLC_PUBLIC_API libvlc_state_t libvlc_media_instance_get_state ( libvlc_media_i
VLC_PUBLIC_API int libvlc_media_instance_has_vout( libvlc_media_instance_t *, libvlc_exception_t *);
VLC_PUBLIC_API float libvlc_media_instance_get_fps( libvlc_media_instance_t *, libvlc_exception_t *);
VLC_PUBLIC_API int libvlc_media_instance_is_seekable(
libvlc_media_instance_t *p_mi,
libvlc_exception_t *p_e );
VLC_PUBLIC_API int libvlc_media_instance_can_pause(
libvlc_media_instance_t *p_mi,
libvlc_exception_t *p_e );
/** @} */
......@@ -728,18 +727,18 @@ VLC_PUBLIC_API libvlc_media_list_t *
* LibVLC Media List
* @{ */
VLC_PUBLIC_API libvlc_dynamic_media_list_t *
VLC_DEPRECATED_API libvlc_dynamic_media_list_t *
libvlc_dynamic_media_list_new( libvlc_media_list_t * p_mlist,
libvlc_tag_query_t * p_query,
libvlc_tag_t tag,
libvlc_exception_t * p_e );
VLC_PUBLIC_API void
VLC_DEPRECATED_API void
libvlc_dynamic_media_list_release( libvlc_dynamic_media_list_t * p_dmlist );
VLC_PUBLIC_API void
VLC_DEPRECATED_API void
libvlc_dynamic_media_list_retain( libvlc_dynamic_media_list_t * p_dmlist );
libvlc_media_list_t *
VLC_DEPRECATED_API libvlc_media_list_t *
libvlc_dynamic_media_list_media_list( libvlc_dynamic_media_list_t * p_dmlist,
libvlc_exception_t * p_e );
......
include/vlc/vlc.h
View file @ 3adef752
......@@ -160,8 +160,20 @@ struct vlc_list_t
/*****************************************************************************
* Shared library Export macros
*****************************************************************************/
#ifndef VLC_PUBLIC_API
# define VLC_PUBLIC_API extern
#ifndef VLC_DEPRECATED_API
# define VLC_DEPRECATED_API extern
#endif
/*****************************************************************************
* Compiler specific
*****************************************************************************/
#ifndef VLC_DEPRECATED_API
#if defined(__GNUC__) && (__GNUC__ > 3 || __GNUC__ == 3 && __GNUC_MINOR__ > 0)
# define VLC_DEPRECATED_API VLC_PUBLIC_API __attribute__((deprecated))
#else
# define VLC_DEPRECATED_API VLC_PUBLIC_API
#endif
#endif
/*****************************************************************************
......@@ -174,49 +186,49 @@ struct vlc_list_t
*
* \return a string containing the libvlc version
*/
VLC_PUBLIC_API char const * VLC_Version ( void );
VLC_DEPRECATED_API char const * VLC_Version ( void );
/**
* Retrieve libvlc compile time
*
* \return a string containing the libvlc compile time
*/
VLC_PUBLIC_API char const * VLC_CompileTime ( void );
VLC_DEPRECATED_API char const * VLC_CompileTime ( void );
/**
* Retrieve the username of the libvlc builder
*
* \return a string containing the username of the libvlc builder
*/
VLC_PUBLIC_API char const * VLC_CompileBy ( void );
VLC_DEPRECATED_API char const * VLC_CompileBy ( void );
/**
* Retrieve the host of the libvlc builder
*
* \return a string containing the host of the libvlc builder
*/
VLC_PUBLIC_API char const * VLC_CompileHost ( void );
VLC_DEPRECATED_API char const * VLC_CompileHost ( void );
/**
* Retrieve the domain name of the host of the libvlc builder
*
* \return a string containing the domain name of the host of the libvlc builder
*/
VLC_PUBLIC_API char const * VLC_CompileDomain ( void );
VLC_DEPRECATED_API char const * VLC_CompileDomain ( void );
/**
* Retrieve libvlc compiler version
*
* \return a string containing the libvlc compiler version
*/
VLC_PUBLIC_API char const * VLC_Compiler ( void );
VLC_DEPRECATED_API char const * VLC_Compiler ( void );
/**
* Retrieve libvlc changeset
*
* \return a string containing the libvlc subversion changeset
*/
VLC_PUBLIC_API char const * VLC_Changeset ( void );
VLC_DEPRECATED_API char const * VLC_Changeset ( void );
/**
* Return an error string
......@@ -224,7 +236,7 @@ VLC_PUBLIC_API char const * VLC_Changeset ( void );
* \param i_err an error code
* \return an error string
*/
VLC_PUBLIC_API char const * VLC_Error ( int i_err );
VLC_DEPRECATED_API char const * VLC_Error ( int i_err );
#endif /* __LIBVLC__ */
......@@ -236,7 +248,7 @@ VLC_PUBLIC_API char const * VLC_Error ( int i_err );
*
* \return vlc object id or an error code
*/
VLC_PUBLIC_API int VLC_Create( void );
VLC_DEPRECATED_API int VLC_Create( void );
/**
* Initialize a vlc_t structure
......@@ -252,7 +264,7 @@ VLC_PUBLIC_API int VLC_Create( void );
* \param ppsz_argv an array of arguments
* \return VLC_SUCCESS on success
*/
VLC_PUBLIC_API int VLC_Init( int, int, const char *[] );
VLC_DEPRECATED_API int VLC_Init( int, int, const char *[] );
/**
* Add an interface
......@@ -268,7 +280,7 @@ VLC_PUBLIC_API int VLC_Init( int, int, const char *[] );
* \param b_play start playing when the interface is done loading
* \return VLC_SUCCESS on success
*/
VLC_PUBLIC_API int VLC_AddIntf( int, char const *, vlc_bool_t, vlc_bool_t );
VLC_DEPRECATED_API int VLC_AddIntf( int, char const *, vlc_bool_t, vlc_bool_t );
/**
* Ask vlc to die
......@@ -279,7 +291,7 @@ VLC_PUBLIC_API int VLC_AddIntf( int, char const *, vlc_bool_t, vlc_bool_t );
* \param i_object a vlc object id
* \return VLC_SUCCESS on success
*/
VLC_PUBLIC_API int VLC_Die( int );
VLC_DEPRECATED_API int VLC_Die( int );
/**
* Clean up all the intf, playlist, vout and aout
......@@ -292,7 +304,7 @@ VLC_PUBLIC_API int VLC_Die( int );
* \param i_object a vlc object id
* \return VLC_SUCCESS on success
*/
VLC_PUBLIC_API int VLC_CleanUp( int );
VLC_DEPRECATED_API int VLC_CleanUp( int );
/**
* Destroy all threads and the VLC object
......@@ -304,7 +316,7 @@ VLC_PUBLIC_API int VLC_CleanUp( int );
* \param i_object a vlc object id
* \return VLC_SUCCESS on success
*/
VLC_PUBLIC_API int VLC_Destroy( int );
VLC_DEPRECATED_API int VLC_Destroy( int );
/**
* Set a VLC variable
......@@ -318,7 +330,7 @@ VLC_PUBLIC_API int VLC_Destroy( int );
* \param value a vlc_value_t structure
* \return VLC_SUCCESS on success
*/
VLC_PUBLIC_API int VLC_VariableSet( int, char const *, vlc_value_t );
VLC_DEPRECATED_API int VLC_VariableSet( int, char const *, vlc_value_t );
/**
* Get a VLC variable
......@@ -333,7 +345,7 @@ VLC_PUBLIC_API int VLC_VariableSet( int, char const *, vlc_value_t );
* \param p_value a pointer to a vlc_value_t structure
* \return VLC_SUCCESS on success
*/
VLC_PUBLIC_API int VLC_VariableGet( int, char const *, vlc_value_t * );
VLC_DEPRECATED_API int VLC_VariableGet( int, char const *, vlc_value_t * );
/**
* Get a VLC variable type
......@@ -346,7 +358,7 @@ VLC_PUBLIC_API int VLC_VariableGet( int, char const *, vlc_value_t * );
* \param pi_type a pointer to an integer
* \return VLC_SUCCESS on success
*/
VLC_PUBLIC_API int VLC_VariableType( int, char const *, int * );
VLC_DEPRECATED_API int VLC_VariableType( int, char const *, int * );
/**
* Add a target to the current playlist
......@@ -362,7 +374,7 @@ VLC_PUBLIC_API int VLC_VariableType( int, char const *, int * );
* \param i_pos the position at which to add the new target (PLAYLIST_END for end)
* \return the item id on success and -1 on error
*/
VLC_PUBLIC_API int VLC_AddTarget( int, char const *, const char **, int, int, int );
VLC_DEPRECATED_API int VLC_AddTarget( int, char const *, const char **, int, int, int );
/**
* Start the playlist and play the currently selected playlist item
......@@ -374,7 +386,7 @@ VLC_PUBLIC_API int VLC_AddTarget( int, char const *, const char **, int, int
* \param i_object a vlc object id
* \return VLC_SUCCESS on success
*/
VLC_PUBLIC_API int VLC_Play( int );
VLC_DEPRECATED_API int VLC_Play( int );
/**
* Pause the currently playing item. Resume it if already paused
......@@ -385,7 +397,7 @@ VLC_PUBLIC_API int VLC_Play( int );
* \param i_object a vlc object id
* \return VLC_SUCCESS on success
*/
VLC_PUBLIC_API int VLC_Pause( int );
VLC_DEPRECATED_API int VLC_Pause( int );
/**
* Stop the playlist
......@@ -398,7 +410,7 @@ VLC_PUBLIC_API int VLC_Pause( int );
* \param i_object a vlc object id
* \return VLC_SUCCESS on success
*/
VLC_PUBLIC_API int VLC_Stop( int );
VLC_DEPRECATED_API int VLC_Stop( int );
/**
* Tell if VLC is playing
......@@ -409,7 +421,7 @@ VLC_PUBLIC_API int VLC_Stop( int );
* \param i_object a vlc object id
* \return VLC_TRUE or VLC_FALSE
*/
VLC_PUBLIC_API vlc_bool_t VLC_IsPlaying( int );
VLC_DEPRECATED_API vlc_bool_t VLC_IsPlaying( int );
/**
* Get the current position in a input
......@@ -421,7 +433,7 @@ VLC_PUBLIC_API vlc_bool_t VLC_IsPlaying( int );
* \param i_object a vlc object id
* \return a float in the range of 0.0 - 1.0
*/
VLC_PUBLIC_API float VLC_PositionGet( int );
VLC_DEPRECATED_API float VLC_PositionGet( int );
/**
* Set the current position in a input
......@@ -434,7 +446,7 @@ VLC_PUBLIC_API float VLC_PositionGet( int );
* \param i_position a float in the range of 0.0 - 1.0
* \return a float in the range of 0.0 - 1.0
*/
VLC_PUBLIC_API float VLC_PositionSet( int, float );
VLC_DEPRECATED_API float VLC_PositionSet( int, float );
/**
* Get the current position in a input
......@@ -445,7 +457,7 @@ VLC_PUBLIC_API float VLC_PositionSet( int, float );
* \param i_object a vlc object id
* \return the offset from 0:00 in seconds
*/
VLC_PUBLIC_API int VLC_TimeGet( int );
VLC_DEPRECATED_API int VLC_TimeGet( int );
/**
* Seek to a position in the current input
......@@ -460,7 +472,7 @@ VLC_PUBLIC_API int VLC_TimeGet( int );
* \param b_relative seek relative from current position
* \return VLC_SUCCESS on success
*/
VLC_PUBLIC_API int VLC_TimeSet( int, int, vlc_bool_t );
VLC_DEPRECATED_API int VLC_TimeSet( int, int, vlc_bool_t );
/**
* Get the total length of a input
......@@ -471,7 +483,7 @@ VLC_PUBLIC_API int VLC_TimeSet( int, int, vlc_bool_t );
* \param i_object a vlc object id
* \return the length in seconds
*/
VLC_PUBLIC_API int VLC_LengthGet( int );
VLC_DEPRECATED_API int VLC_LengthGet( int );
/**
* Play the input faster than realtime
......@@ -482,7 +494,7 @@ VLC_PUBLIC_API int VLC_LengthGet( int );
* \param i_object a vlc object id
* \return the current speedrate
*/
VLC_PUBLIC_API float VLC_SpeedFaster( int );
VLC_DEPRECATED_API float VLC_SpeedFaster( int );
/**
* Play the input slower than realtime
......@@ -493,7 +505,7 @@ VLC_PUBLIC_API float VLC_SpeedFaster( int );
* \param i_object a vlc object id
* \return the current speedrate
*/
VLC_PUBLIC_API float VLC_SpeedSlower( int );
VLC_DEPRECATED_API float VLC_SpeedSlower( int );
/**
* Return the current playlist item
......@@ -501,7 +513,7 @@ VLC_PUBLIC_API float VLC_SpeedSlower( int );
* \param i_object a vlc object id
* \return the index of the playlistitem that is currently selected for play
*/
VLC_PUBLIC_API int VLC_PlaylistIndex( int );
VLC_DEPRECATED_API int VLC_PlaylistIndex( int );
/**
* Total amount of items in the playlist
......@@ -509,7 +521,7 @@ VLC_PUBLIC_API int VLC_PlaylistIndex( int );
* \param i_object a vlc object id
* \return amount of playlist items
*/
VLC_PUBLIC_API int VLC_PlaylistNumberOfItems( int );
VLC_DEPRECATED_API int VLC_PlaylistNumberOfItems( int );
/**
* Next playlist item
......@@ -519,7 +531,7 @@ VLC_PUBLIC_API int VLC_PlaylistNumberOfItems( int );
* \param i_object a vlc object id
* \return VLC_SUCCESS on success
*/
VLC_PUBLIC_API int VLC_PlaylistNext( int );
VLC_DEPRECATED_API int VLC_PlaylistNext( int );
/**
* Previous playlist item
......@@ -529,7 +541,7 @@ VLC_PUBLIC_API int VLC_PlaylistNext( int );
* \param i_object a vlc object id
* \return VLC_SUCCESS on success
*/
VLC_PUBLIC_API int VLC_PlaylistPrev( int );
VLC_DEPRECATED_API int VLC_PlaylistPrev( int );
/**
* Clear the contents of the playlist
......@@ -541,7 +553,7 @@ VLC_PUBLIC_API int VLC_PlaylistPrev( int );
* \param i_object a vlc object id
* \return VLC_SUCCESS on success
*/
VLC_PUBLIC_API int VLC_PlaylistClear( int );
VLC_DEPRECATED_API int VLC_PlaylistClear( int );
/**
* Change the volume
......@@ -550,7 +562,7 @@ VLC_PUBLIC_API int VLC_PlaylistClear( int );
* \param i_volume something in a range from 0-200
* \return the new volume (range 0-200 %)
*/
VLC_PUBLIC_API int VLC_VolumeSet( int, int );
VLC_DEPRECATED_API int VLC_VolumeSet( int, int );
/**
* Get the current volume
......@@ -560,7 +572,7 @@ VLC_PUBLIC_API int VLC_VolumeSet( int, int );
* \param i_object a vlc object id
* \return the current volume (range 0-200 %)
*/
VLC_PUBLIC_API int VLC_VolumeGet( int );
VLC_DEPRECATED_API int VLC_VolumeGet( int );
/**
* Mute/Unmute the volume
......@@ -568,7 +580,7 @@ VLC_PUBLIC_API int VLC_VolumeGet( int );
* \param i_object a vlc object id
* \return VLC_SUCCESS on success
*/
VLC_PUBLIC_API int VLC_VolumeMute( int );
VLC_DEPRECATED_API int VLC_VolumeMute( int );
/**
* Toggle Fullscreen mode
......@@ -578,7 +590,7 @@ VLC_PUBLIC_API int VLC_VolumeMute( int );
* \param i_object a vlc object id
* \return VLC_SUCCESS on success
*/
VLC_PUBLIC_API int VLC_FullScreen( int );
VLC_DEPRECATED_API int VLC_FullScreen( int );
# ifdef __cplusplus
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment