X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc%2Flibvlc_media.h;h=075a1c670f32db3c7bcd16080a1f0b7a37eb1cb5;hb=2d7c19fd30f7562eb8477852991a5ea955a1c691;hp=637d115bb079b5539572c2421316d97aa90510a0;hpb=3c4fac1eecf58f2d15ebd728ac1f01e0799cb204;p=vlc diff --git a/include/vlc/libvlc_media.h b/include/vlc/libvlc_media.h index 637d115bb0..075a1c670f 100644 --- a/include/vlc/libvlc_media.h +++ b/include/vlc/libvlc_media.h @@ -35,24 +35,21 @@ extern "C" { # endif -/***************************************************************************** - * media - *****************************************************************************/ -/** \defgroup libvlc_media libvlc_media +/** \defgroup libvlc_media LibVLC media * \ingroup libvlc - * LibVLC Media + * @ref libvlc_media_t is an abstract representation of a playable media. + * It consists of a media location and various optional meta data. * @{ */ typedef struct libvlc_media_t libvlc_media_t; -/* Meta Handling */ -/** defgroup libvlc_meta libvlc_meta +/** defgroup libvlc_meta LibVLC meta data * \ingroup libvlc_media - * LibVLC Media Meta * @{ */ +/** Meta data types */ typedef enum libvlc_meta_t { libvlc_meta_Title, libvlc_meta_Artist, @@ -97,16 +94,22 @@ typedef enum libvlc_state_t libvlc_Error } libvlc_state_t; -typedef enum libvlc_media_option_t +enum { libvlc_media_option_trusted = 0x2, libvlc_media_option_unique = 0x100 -} libvlc_media_option_t; +}; +typedef enum libvlc_es_type_t +{ + libvlc_es_unknown = -1, + libvlc_es_audio = 0, + libvlc_es_video = 1, + libvlc_es_text = 2, +} libvlc_es_type_t; -/** defgroup libvlc_media_stats_t libvlc_media_stats_t +/** defgroup libvlc_media_stats_t LibVLC media statistics * \ingroup libvlc_media - * LibVLC Media statistics * @{ */ typedef struct libvlc_media_stats_t @@ -140,32 +143,60 @@ typedef struct libvlc_media_stats_t } libvlc_media_stats_t; /** @}*/ +typedef struct libvlc_media_es_t +{ + /* Codec fourcc */ + uint32_t i_codec; + int i_id; + libvlc_es_type_t i_type; + + /* Codec specific */ + int i_profile; + int i_level; + + /* Audio specific */ + unsigned i_channels; + unsigned i_rate; + + /* Video specific */ + unsigned i_height; + unsigned i_width; + +} libvlc_media_es_t; + /** - * Create a media with the given MRL. + * Create a media with a certain given media resource location. * * \param p_instance the instance * \param psz_mrl the MRL to read - * \param p_e an initialized exception pointer - * \return the newly created media + * \return the newly created media or NULL on error */ -VLC_PUBLIC_API libvlc_media_t * libvlc_media_new( +VLC_PUBLIC_API libvlc_media_t *libvlc_media_new_location( libvlc_instance_t *p_instance, - const char * psz_mrl, - libvlc_exception_t *p_e ); + const char * psz_mrl ); /** - * Create a media as an empty node with the passed name. + * Create a media with a certain file path. + * + * \param p_instance the instance + * \param path local filesystem path + * \return the newly created media or NULL on error + */ +VLC_PUBLIC_API libvlc_media_t *libvlc_media_new_path( + libvlc_instance_t *p_instance, + const char *path ); + +/** + * Create a media as an empty node with a given name. * * \param p_instance the instance * \param psz_name the name of the node - * \param p_e an initialized exception pointer - * \return the new empty media + * \return the new empty media or NULL on error */ VLC_PUBLIC_API libvlc_media_t * libvlc_media_new_as_node( libvlc_instance_t *p_instance, - const char * psz_name, - libvlc_exception_t *p_e ); + const char * psz_name ); /** * Add an option to the media. @@ -199,7 +230,7 @@ VLC_PUBLIC_API void libvlc_media_add_option( VLC_PUBLIC_API void libvlc_media_add_option_flag( libvlc_media_t * p_md, const char * ppsz_options, - libvlc_media_option_t i_flags ); + unsigned i_flags ); /** @@ -234,7 +265,7 @@ VLC_PUBLIC_API char * libvlc_media_get_mrl( libvlc_media_t * p_md ); /** * Duplicate a media descriptor object. * - * \param p_meta_desc a media descriptor object. + * \param p_md a media descriptor object. */ VLC_PUBLIC_API libvlc_media_t * libvlc_media_duplicate( libvlc_media_t *p_md ); @@ -254,7 +285,7 @@ VLC_PUBLIC_API char * libvlc_media_get_meta( libvlc_media_t *p_md, * * \param p_md the media descriptor * \param e_meta the meta to write - * \param the media's meta + * \param psz_value the media's meta */ VLC_PUBLIC_API void libvlc_media_set_meta( libvlc_media_t *p_md, libvlc_meta_t e_meta, @@ -325,12 +356,10 @@ VLC_PUBLIC_API libvlc_event_manager_t * * Get duration (in ms) of media descriptor object item. * * \param p_md media descriptor object - * \param p_e an initialized exception object - * \return duration of media item + * \return duration of media item or -1 on error */ VLC_PUBLIC_API libvlc_time_t - libvlc_media_get_duration( libvlc_media_t * p_md, - libvlc_exception_t * p_e ); + libvlc_media_get_duration( libvlc_media_t * p_md ); /** * Get preparsed status for media descriptor object. @@ -363,6 +392,21 @@ VLC_PUBLIC_API void VLC_PUBLIC_API void * libvlc_media_get_user_data( libvlc_media_t * p_md ); +/** + * Get media descriptor's elementary streams description + * + * Note, you need to play the media _one_ time with --sout="#description" + * Not doing this will result in an empty array, and doing it more than once + * will duplicate the entries in the array each time. + * + * \param p_md media descriptor object + * \param pp_es address to store an allocated array of Elementary Streams descriptions (must be freed by the caller) + * + * return the number of Elementary Streams + */ +VLC_PUBLIC_API int + libvlc_media_get_es( libvlc_media_t * p_md, libvlc_media_es_t ** pp_es ); + /** @}*/ # ifdef __cplusplus