X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc%2Flibvlc_media.h;h=b64ec7f127244dbe8834dbbe304a16d7b6737102;hb=c60652e38ac6afd74bd8225e9dae5406f13aaa4f;hp=18fcd216d4e5e2bc0319f7082848d18d456b468a;hpb=66bd92014e5d721d8fe74bfd69f601bfd228012a;p=vlc diff --git a/include/vlc/libvlc_media.h b/include/vlc/libvlc_media.h index 18fcd216d4..b64ec7f127 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, @@ -74,7 +75,7 @@ typedef enum libvlc_meta_t { /** * Note the order of libvlc_state_t enum must match exactly the order of - * @see mediacontrol_PlayerStatus, @see input_state_e enums, + * \see mediacontrol_PlayerStatus, \see input_state_e enums, * and VideoLAN.LibVLC.State (at bindings/cil/src/media.cs). * * Expected states by web plugins are: @@ -93,31 +94,120 @@ typedef enum libvlc_state_t libvlc_Error } libvlc_state_t; +enum +{ + libvlc_media_option_trusted = 0x2, + libvlc_media_option_unique = 0x100 +}; + +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 statistics + * \ingroup libvlc_media + * @{ + */ +typedef struct libvlc_media_stats_t +{ + /* Input */ + int i_read_bytes; + float f_input_bitrate; + + /* Demux */ + int i_demux_read_bytes; + float f_demux_bitrate; + int i_demux_corrupted; + int i_demux_discontinuity; + + /* Decoders */ + int i_decoded_video; + int i_decoded_audio; + + /* Video Output */ + int i_displayed_pictures; + int i_lost_pictures; + + /* Audio output */ + int i_played_abuffers; + int i_lost_abuffers; + + /* Stream output */ + int i_sent_packets; + int i_sent_bytes; + float f_send_bitrate; +} 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( +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. + * + * \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_path( + libvlc_instance_t *p_instance, + const char *path ); + +/** + * 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( +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. @@ -128,16 +218,15 @@ VLC_PUBLIC_API libvlc_media_t * libvlc_media_new_as_node( * * The options are detailed in vlc --long-help, for instance "--sout-all" * - * \param p_instance the instance + * \param p_md the media descriptor * \param ppsz_options the options (as a string) - * \param p_e an initialized exception pointer */ VLC_PUBLIC_API void libvlc_media_add_option( - libvlc_media_t * p_md, - const char * ppsz_options, - libvlc_exception_t * p_e ); + libvlc_media_t *p_md, + const char * ppsz_options ); + /** - * Add an option to the media from an untrusted source. + * Add an option to the media with configurable flags. * * This option will be used to determine how the media_player will * read the media. This allows to use VLC's advanced @@ -145,14 +234,14 @@ VLC_PUBLIC_API void libvlc_media_add_option( * * The options are detailed in vlc --long-help, for instance "--sout-all" * - * \param p_instance the instance + * \param p_md the media descriptor * \param ppsz_options the options (as a string) - * \param p_e an initialized exception pointer + * \param i_flags the flags for this option */ -VLC_PUBLIC_API void libvlc_media_add_option_untrusted( - libvlc_media_t * p_md, +VLC_PUBLIC_API void libvlc_media_add_option_flag( + libvlc_media_t *p_md, const char * ppsz_options, - libvlc_exception_t * p_e ); + unsigned i_flags ); /** @@ -160,10 +249,9 @@ VLC_PUBLIC_API void libvlc_media_add_option_untrusted( * libvlc_media_release() to decrement the reference count of a * media descriptor object. * - * \param p_meta_desc a media descriptor object. + * \param p_md the media descriptor */ -VLC_PUBLIC_API void libvlc_media_retain( - libvlc_media_t *p_meta_desc ); +VLC_PUBLIC_API void libvlc_media_retain( libvlc_media_t *p_md ); /** * Decrement the reference count of a media descriptor object. If the @@ -172,41 +260,68 @@ VLC_PUBLIC_API void libvlc_media_retain( * to all listeners. If the media descriptor object has been released it * should not be used again. * - * \param p_meta_desc a media descriptor object. + * \param p_md the media descriptor */ -VLC_PUBLIC_API void libvlc_media_release( - libvlc_media_t *p_meta_desc ); +VLC_PUBLIC_API void libvlc_media_release( libvlc_media_t *p_md ); /** * Get the media resource locator (mrl) from a media descriptor object * * \param p_md a media descriptor object - * \param p_e an initialized exception object * \return string with mrl of media descriptor object */ -VLC_PUBLIC_API char * libvlc_media_get_mrl( libvlc_media_t * p_md, - libvlc_exception_t * p_e ); +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 * ); +VLC_PUBLIC_API libvlc_media_t *libvlc_media_duplicate( libvlc_media_t *p_md ); /** * Read the meta of the media. * - * \param p_meta_desc the media to read - * \param e_meta_desc the meta to read - * \param p_e an initialized exception pointer + * 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 */ -VLC_PUBLIC_API char * libvlc_media_get_meta( - libvlc_media_t *p_meta_desc, - libvlc_meta_t e_meta, - libvlc_exception_t *p_e ); +VLC_PUBLIC_API char *libvlc_media_get_meta( libvlc_media_t *p_md, + libvlc_meta_t e_meta ); + +/** + * Set the meta of the media (this function will not save the meta, call + * libvlc_media_save_meta in order to save the meta) + * + * \param p_md the media descriptor + * \param e_meta the meta to write + * \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, + const char *psz_value ); + + +/** + * Save the meta previously set + * + * \param p_md the media desriptor + * \return true if the write operation was successfull + */ +VLC_PUBLIC_API int libvlc_media_save_meta( libvlc_media_t *p_md ); + + /** * Get current state of media descriptor object. Possible media states * are defined in libvlc_structures.c ( libvlc_NothingSpecial=0, @@ -214,23 +329,30 @@ VLC_PUBLIC_API char * libvlc_media_get_meta( * libvlc_Stopped, libvlc_Ended, * libvlc_Error). * - * @see libvlc_state_t - * \param p_meta_desc a media descriptor object - * \param p_e an initialized exception object + * \see libvlc_state_t + * \param p_md a media descriptor object * \return state of media descriptor object */ VLC_PUBLIC_API libvlc_state_t libvlc_media_get_state( - libvlc_media_t *p_meta_desc, - libvlc_exception_t *p_e ); + libvlc_media_t *p_md ); +/** + * Get the current statistics about the media + * \param p_md: media descriptor object + * \param p_stats: structure that contain the statistics about the media + * (this structure must be allocated by the caller) + * \return true if the statistics are available, false otherwise + */ +VLC_PUBLIC_API int libvlc_media_get_stats( libvlc_media_t *p_md, + libvlc_media_stats_t *p_stats ); + /** * Get subitems of media descriptor object. This will increment * the reference count of supplied media descriptor object. Use * libvlc_media_list_release() to decrement the reference counting. * * \param p_md media descriptor object - * \param p_e initalized exception object * \return list of media descriptor subitems or NULL */ @@ -239,42 +361,72 @@ VLC_PUBLIC_API libvlc_state_t libvlc_media_get_state( #define VLC_FORWARD_DECLARE_OBJECT(a) struct a VLC_PUBLIC_API VLC_FORWARD_DECLARE_OBJECT(libvlc_media_list_t *) -libvlc_media_subitems( libvlc_media_t *p_md, - libvlc_exception_t *p_e ); +libvlc_media_subitems( libvlc_media_t *p_md ); /** * Get event manager from media descriptor object. * NOTE: this function doesn't increment reference counting. * * \param p_md a media descriptor object - * \param p_e an initialized exception object * \return event manager object */ VLC_PUBLIC_API libvlc_event_manager_t * - libvlc_media_event_manager( libvlc_media_t * p_md, - libvlc_exception_t * p_e ); + libvlc_media_event_manager( libvlc_media_t *p_md ); /** - * Get duration of media descriptor object item. + * 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 p_md media descriptor object - * \param p_e an initialized exception object - * \return true if media object has been preparsed otherwise it returns false + */ +VLC_PUBLIC_API void +libvlc_media_parse( libvlc_media_t *p_md ); + +/** + * Parse a media. + * + * This fetches (local) meta data and tracks information. + * The method is the asynchronous of libvlc_media_parse(). + * + * 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 p_md media descriptor object + */ +VLC_PUBLIC_API void +libvlc_media_parse_async( libvlc_media_t *p_md ); + +/** + * Get Parsed status for media descriptor object. + * + * \see libvlc_MediaParsedChanged + * + * \param p_md media descriptor object + * \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_exception_t * p_e ); + libvlc_media_is_parsed( libvlc_media_t *p_md ); /** * Sets media descriptor's user_data. user_data is specialized data @@ -283,12 +435,9 @@ VLC_PUBLIC_API int * * \param p_md media descriptor object * \param p_new_user_data pointer to user data - * \param p_e an initialized exception object */ VLC_PUBLIC_API void - libvlc_media_set_user_data( libvlc_media_t * p_md, - void * p_new_user_data, - libvlc_exception_t * p_e); + libvlc_media_set_user_data( libvlc_media_t *p_md, void *p_new_user_data ); /** * Get media descriptor's user_data. user_data is specialized data @@ -296,12 +445,41 @@ VLC_PUBLIC_API void * an native object that references a libvlc_media_t pointer * * \param p_md media descriptor object - * \param p_e an initialized exception object */ -VLC_PUBLIC_API void * - libvlc_media_get_user_data( libvlc_media_t * p_md, - libvlc_exception_t * p_e); +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 p_md 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 *p_md, + libvlc_media_track_info_t **tracks ); /** @}*/ +# ifdef __cplusplus +} +# endif + #endif /* VLC_LIBVLC_MEDIA_H */