X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc%2Flibvlc_media.h;h=52de810d2b0fffd2dfa54bef089fe6474b76ddd4;hb=917555567e3bb1f160ec732f495aef0e618e706a;hp=d300722256a04f0f8daaf00f912dcd1bdd52f796;hpb=8c5a6af9a851269280791b0cd7ceca0cbf047fd2;p=vlc diff --git a/include/vlc/libvlc_media.h b/include/vlc/libvlc_media.h index d300722256..52de810d2b 100644 --- a/include/vlc/libvlc_media.h +++ b/include/vlc/libvlc_media.h @@ -31,24 +31,25 @@ #ifndef VLC_LIBVLC_MEDIA_H #define VLC_LIBVLC_MEDIA_H 1 -/***************************************************************************** - * media - *****************************************************************************/ -/** \defgroup libvlc_media libvlc_media +# ifdef __cplusplus +extern "C" { +# endif + +/** \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, @@ -93,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_track_type_t +{ + libvlc_track_unknown = -1, + libvlc_track_audio = 0, + libvlc_track_video = 1, + libvlc_track_text = 2, +} libvlc_track_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 @@ -136,32 +143,71 @@ typedef struct libvlc_media_stats_t } libvlc_media_stats_t; /** @}*/ +typedef struct libvlc_media_track_info_t +{ + /* Codec fourcc */ + uint32_t i_codec; + int i_id; + libvlc_track_type_t i_type; + + /* Codec specific */ + int i_profile; + int i_level; + + union { + struct { + /* Audio specific */ + unsigned i_channels; + unsigned i_rate; + } audio; + struct { + /* Video specific */ + unsigned i_height; + unsigned i_width; + } video; + } u; + +} libvlc_media_track_info_t; + /** - * Create a media with the given MRL. + * Create a media with a certain given media resource location. + * + * \see libvlc_media_release * * \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_location( + libvlc_instance_t *p_instance, + const char * psz_mrl ); + +/** + * Create a media with a certain file path. + * + * \see libvlc_media_release + * + * \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( +VLC_PUBLIC_API libvlc_media_t *libvlc_media_new_path( libvlc_instance_t *p_instance, - const char * psz_mrl, - libvlc_exception_t *p_e ); + const char *path ); /** - * Create a media as an empty node with the passed name. + * Create a media as an empty node with a given name. + * + * \see libvlc_media_release * * \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. @@ -195,7 +241,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 ); /** @@ -230,13 +276,23 @@ 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 ); /** * Read the meta of the media. * + * If the media has not yet been parsed this will return NULL. + * + * This methods automatically calls libvlc_media_parse_async(), so after calling + * it you may receive a libvlc_MediaMetaChanged event. If you prefer a synchronous + * version ensure that you call libvlc_media_parse() before get_meta(). + * + * \see libvlc_media_parse + * \see libvlc_media_parse_async + * \see libvlc_MediaMetaChanged + * * \param p_md the media descriptor * \param e_meta the meta to read * \return the media's meta @@ -250,7 +306,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, @@ -321,21 +377,56 @@ 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. + * Parse a media. + * + * This fetches (local) meta data and tracks information. + * The method is synchronous. + * + * \see libvlc_media_parse_async + * \see libvlc_media_get_meta + * \see libvlc_media_get_tracks_info + * + * \param media media descriptor object + */ +VLC_PUBLIC_API void +libvlc_media_parse(libvlc_media_t *media); + +/** + * Parse a media. + * + * This fetches (local) meta data and tracks information. + * The method is the asynchronous of libvlc_media_parse_async(). + * + * To track when this is over you can listen to libvlc_MediaParsedChanged + * event. However if the media was already parsed you will not receive this + * event. + * + * \see libvlc_media_parse + * \see libvlc_MediaParsedChanged + * \see libvlc_media_get_meta + * \see libvlc_media_get_tracks_info + * + * \param media media descriptor object + */ +VLC_PUBLIC_API void +libvlc_media_parse_async(libvlc_media_t *media); + +/** + * Get Parsed status for media descriptor object. + * + * \see libvlc_MediaParsedChanged * * \param p_md media descriptor object - * \return true if media object has been preparsed otherwise it returns false + * \return true if media object has been parsed otherwise it returns false */ VLC_PUBLIC_API int - libvlc_media_is_preparsed( libvlc_media_t * p_md ); + libvlc_media_is_parsed( libvlc_media_t * p_md ); /** * Sets media descriptor's user_data. user_data is specialized data @@ -359,6 +450,38 @@ 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. Something like this: + * + * @begincode + * libvlc_media_player_t *player = libvlc_media_player_new_from_media(media); + * libvlc_media_add_option_flag(media, "sout=\"#description\""); + * libvlc_media_player_play(player); + * // ... wait until playing + * libvlc_media_player_release(player); + * @endcode + * + * This is very likely to change in next release, and be done at the parsing + * phase. + * + * \param media media descriptor object + * \param tracks 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_tracks_info(libvlc_media_t *media, + libvlc_media_track_info_t **tracks ); + /** @}*/ +# ifdef __cplusplus +} +# endif + #endif /* VLC_LIBVLC_MEDIA_H */