/*****************************************************************************
- * libvlc.h: libvlc external API
+ * libvlc_media.h: libvlc external API
*****************************************************************************
- * Copyright (C) 1998-2009 the VideoLAN team
+ * Copyright (C) 1998-2009 VLC authors and VideoLAN
* $Id$
*
* Authors: Clément Stenac <zorglub@videolan.org>
* Jean-Paul Saman <jpsaman@videolan.org>
* Pierre d'Herbemont <pdherbemont@videolan.org>
*
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2.1 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
*
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
*****************************************************************************/
/**
libvlc_meta_EncodedBy,
libvlc_meta_ArtworkURL,
libvlc_meta_TrackID,
+ libvlc_meta_TrackTotal,
+ libvlc_meta_Director,
+ libvlc_meta_Season,
+ libvlc_meta_Episode,
+ libvlc_meta_ShowName,
+ libvlc_meta_Actors,
+ libvlc_meta_AlbumArtist,
+ libvlc_meta_DiscNumber
/* Add new meta types HERE */
} 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:
libvlc_track_unknown = -1,
libvlc_track_audio = 0,
libvlc_track_video = 1,
- libvlc_track_text = 2,
+ libvlc_track_text = 2
} libvlc_track_type_t;
/** defgroup libvlc_media_stats_t LibVLC media statistics
int i_profile;
int i_level;
- /* Audio specific */
+ 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;
+
+
+typedef struct libvlc_audio_track_t
+{
unsigned i_channels;
unsigned i_rate;
+} libvlc_audio_track_t;
- /* Video specific */
+typedef struct libvlc_video_track_t
+{
unsigned i_height;
unsigned i_width;
+ unsigned i_sar_num;
+ unsigned i_sar_den;
+ unsigned i_frame_rate_num;
+ unsigned i_frame_rate_den;
+} libvlc_video_track_t;
-} libvlc_media_track_info_t;
+typedef struct libvlc_subtitle_track_t
+{
+ char *psz_encoding;
+} libvlc_subtitle_track_t;
+
+typedef struct libvlc_media_track_t
+{
+ /* Codec fourcc */
+ uint32_t i_codec;
+ uint32_t i_original_fourcc;
+ int i_id;
+ libvlc_track_type_t i_type;
+
+ /* Codec specific */
+ int i_profile;
+ int i_level;
+
+ union {
+ libvlc_audio_track_t *audio;
+ libvlc_video_track_t *video;
+ libvlc_subtitle_track_t *subtitle;
+ };
+
+ unsigned int i_bitrate;
+ char *psz_language;
+ char *psz_description;
+
+} libvlc_media_track_t;
+
+/** defgroup libvlc_media_type LibVLC media type
+ * \ingroup libvlc_media
+ * @{
+ */
+
+/**
+ * Media type
+ *
+ * \see libvlc_media_get_type
+ */
+typedef enum libvlc_media_type_t {
+ libvlc_media_type_unknown,
+ libvlc_media_type_file,
+ libvlc_media_type_directory,
+ libvlc_media_type_disc,
+ libvlc_media_type_stream,
+ libvlc_media_type_playlist,
+} libvlc_media_type_t;
+/** @}*/
/**
- * Create a media with a certain given media resource location.
+ * Parse flags used by libvlc_media_parse_with_options()
+ *
+ * \see libvlc_media_parse_with_options
+ */
+typedef enum libvlc_media_parse_flag_t
+{
+ /**
+ * Parse media if it's a local file
+ */
+ libvlc_media_parse_local = 0x00,
+ /**
+ * Parse media even if it's a network file
+ */
+ libvlc_media_parse_network = 0x01,
+ /**
+ * Fetch meta and covert art using local resources
+ */
+ libvlc_media_fetch_local = 0x02,
+ /**
+ * Fetch meta and covert art using network resources
+ */
+ libvlc_media_fetch_network = 0x04,
+} libvlc_media_parse_flag_t;
+
+/**
+ * Create a media with a certain given media resource location,
+ * for instance a valid URL.
+ *
+ * \note To refer to a local file with this function,
+ * the file://... URI syntax <b>must</b> be used (see IETF RFC3986).
+ * We recommend using libvlc_media_new_path() instead when dealing with
+ * local files.
*
* \see libvlc_media_release
*
* \param p_instance the instance
- * \param psz_mrl the MRL to read
+ * \param psz_mrl the media location
* \return the newly created media or NULL on error
*/
-VLC_PUBLIC_API libvlc_media_t *libvlc_media_new_location(
+LIBVLC_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.
+ * Create a media for a certain file path.
*
* \see libvlc_media_release
*
* \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_API libvlc_media_t *libvlc_media_new_path(
libvlc_instance_t *p_instance,
const char *path );
+/**
+ * Create a media for an already open file descriptor.
+ * The file descriptor shall be open for reading (or reading and writing).
+ *
+ * Regular file descriptors, pipe read descriptors and character device
+ * descriptors (including TTYs) are supported on all platforms.
+ * Block device descriptors are supported where available.
+ * Directory descriptors are supported on systems that provide fdopendir().
+ * Sockets are supported on all platforms where they are file descriptors,
+ * i.e. all except Windows.
+ *
+ * \note This library will <b>not</b> automatically close the file descriptor
+ * under any circumstance. Nevertheless, a file descriptor can usually only be
+ * rendered once in a media player. To render it a second time, the file
+ * descriptor should probably be rewound to the beginning with lseek().
+ *
+ * \see libvlc_media_release
+ *
+ * \version LibVLC 1.1.5 and later.
+ *
+ * \param p_instance the instance
+ * \param fd open file descriptor
+ * \return the newly created media or NULL on error
+ */
+LIBVLC_API libvlc_media_t *libvlc_media_new_fd(
+ libvlc_instance_t *p_instance,
+ int fd );
+
+
/**
* Create a media as an empty node with a given name.
*
* \param psz_name the name of the node
* \return the new empty media or NULL on error
*/
-VLC_PUBLIC_API libvlc_media_t * libvlc_media_new_as_node(
+LIBVLC_API libvlc_media_t *libvlc_media_new_as_node(
libvlc_instance_t *p_instance,
const char * psz_name );
* read the media. This allows to use VLC's advanced
* reading/streaming options on a per-media basis.
*
- * The options are detailed in vlc --long-help, for instance "--sout-all"
+ * \note The options are listed in 'vlc --long-help' from the command line,
+ * e.g. "-sout-all". Keep in mind that available options and their semantics
+ * vary across LibVLC versions and builds.
+ * \warning Not all options affects libvlc_media_t objects:
+ * Specifically, due to architectural issues most audio and video options,
+ * such as text renderer options, have no effects on an individual media.
+ * These options must be set through libvlc_new() instead.
*
* \param p_md the media descriptor
- * \param ppsz_options the options (as a string)
+ * \param psz_options the options (as a string)
*/
-VLC_PUBLIC_API void libvlc_media_add_option(
- libvlc_media_t * p_md,
- const char * ppsz_options );
+LIBVLC_API void libvlc_media_add_option(
+ libvlc_media_t *p_md,
+ const char * psz_options );
/**
* Add an option to the media with configurable flags.
* read the media. This allows to use VLC's advanced
* reading/streaming options on a per-media basis.
*
- * The options are detailed in vlc --long-help, for instance "--sout-all"
+ * The options are detailed in vlc --long-help, for instance
+ * "--sout-all". Note that all options are not usable on medias:
+ * specifically, due to architectural issues, video-related options
+ * such as text renderer options cannot be set on a single media. They
+ * must be set on the whole libvlc instance instead.
*
* \param p_md the media descriptor
- * \param ppsz_options the options (as a string)
+ * \param psz_options the options (as a string)
* \param i_flags the flags for this option
*/
-VLC_PUBLIC_API void libvlc_media_add_option_flag(
- libvlc_media_t * p_md,
- const char * ppsz_options,
+LIBVLC_API void libvlc_media_add_option_flag(
+ libvlc_media_t *p_md,
+ const char * psz_options,
unsigned i_flags );
*
* \param p_md the media descriptor
*/
-VLC_PUBLIC_API void libvlc_media_retain( libvlc_media_t *p_md );
+LIBVLC_API void libvlc_media_retain( libvlc_media_t *p_md );
/**
* Decrement the reference count of a media descriptor object. If the
*
* \param p_md the media descriptor
*/
-VLC_PUBLIC_API void libvlc_media_release( libvlc_media_t *p_md );
+LIBVLC_API void libvlc_media_release( libvlc_media_t *p_md );
/**
* \param p_md a media descriptor object
* \return string with mrl of media descriptor object
*/
-VLC_PUBLIC_API char * libvlc_media_get_mrl( libvlc_media_t * p_md );
+LIBVLC_API char *libvlc_media_get_mrl( libvlc_media_t *p_md );
/**
* Duplicate 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 );
+LIBVLC_API libvlc_media_t *libvlc_media_duplicate( libvlc_media_t *p_md );
/**
* Read the meta of the media.
* \param e_meta the meta to read
* \return the media's meta
*/
-VLC_PUBLIC_API char * libvlc_media_get_meta( libvlc_media_t *p_md,
+LIBVLC_API char *libvlc_media_get_meta( libvlc_media_t *p_md,
libvlc_meta_t e_meta );
/**
* \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_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
+ * \return true if the write operation was successful
*/
-VLC_PUBLIC_API int libvlc_media_save_meta( libvlc_media_t *p_md );
+LIBVLC_API int libvlc_media_save_meta( libvlc_media_t *p_md );
/**
* libvlc_Stopped, libvlc_Ended,
* libvlc_Error).
*
- * @see libvlc_state_t
- * \param p_meta_desc a media descriptor 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_API libvlc_state_t libvlc_media_get_state(
+ 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
+ * 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
+ * \return true if the statistics are available, false otherwise
+ *
+ * \libvlc_return_bool
*/
-VLC_PUBLIC_API int libvlc_media_get_stats( libvlc_media_t *p_md,
+LIBVLC_API int libvlc_media_get_stats( libvlc_media_t *p_md,
libvlc_media_stats_t *p_stats );
+/* The following method uses libvlc_media_list_t, however, media_list usage is optionnal
+ * and this is here for convenience */
+#define VLC_FORWARD_DECLARE_OBJECT(a) struct a
+
/**
* Get subitems of media descriptor object. This will increment
* the reference count of supplied media descriptor object. Use
* \param p_md media descriptor object
* \return list of media descriptor subitems or NULL
*/
-
-/* This method uses libvlc_media_list_t, however, media_list usage is optionnal
- * and this is here for convenience */
-#define VLC_FORWARD_DECLARE_OBJECT(a) struct a
-
-VLC_PUBLIC_API VLC_FORWARD_DECLARE_OBJECT(libvlc_media_list_t *)
+LIBVLC_API VLC_FORWARD_DECLARE_OBJECT(libvlc_media_list_t *)
libvlc_media_subitems( libvlc_media_t *p_md );
/**
* \param p_md a media descriptor object
* \return event manager object
*/
-VLC_PUBLIC_API libvlc_event_manager_t *
- libvlc_media_event_manager( libvlc_media_t * p_md );
+LIBVLC_API libvlc_event_manager_t *
+ libvlc_media_event_manager( libvlc_media_t *p_md );
/**
* Get duration (in ms) of media descriptor object item.
* \param p_md media descriptor object
* \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_API libvlc_time_t
+ libvlc_media_get_duration( libvlc_media_t *p_md );
/**
* Parse a media.
*
- * This fetches (local) meta data and tracks information.
+ * This fetches (local) art, 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
+ * \param p_md media descriptor object
*/
-VLC_PUBLIC_API void
-libvlc_media_parse(libvlc_media_t *media);
+LIBVLC_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_async().
+ * This fetches (local) art, 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_MediaPreparsedChanged
- * event. However if the media was already preparsed you will not receive this
+ * 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_MediaPreparsedChanged
+ * \see libvlc_MediaParsedChanged
* \see libvlc_media_get_meta
* \see libvlc_media_get_tracks_info
*
- * \param media media descriptor object
+ * \param p_md media descriptor object
+ */
+LIBVLC_API void
+libvlc_media_parse_async( libvlc_media_t *p_md );
+
+/**
+ * Parse the media asynchronously with options.
+ *
+ * This fetches (local or network) art, meta data and/or tracks information.
+ * This method is the extended version of libvlc_media_parse_async().
+ *
+ * To track when this is over you can listen to libvlc_MediaParsedChanged
+ * event. However if this functions returns an error, you will not receive this
+ * event.
+ *
+ * It uses a flag to specify parse options (see libvlc_media_parse_flag_t). All
+ * these flags can be combined. By default, media is parsed if it's a local
+ * file.
+ *
+ * \see libvlc_MediaParsedChanged
+ * \see libvlc_media_get_meta
+ * \see libvlc_media_tracks_get
+ * \see libvlc_media_parse_flag_t
+ *
+ * \param p_md media descriptor object
+ * \param parse_flag parse options:
+ * \return -1 in case of error, 0 otherwise
+ * \version LibVLC 3.0.0 or later
*/
-VLC_PUBLIC_API void
-libvlc_media_parse_async(libvlc_media_t *media);
+LIBVLC_API int
+libvlc_media_parse_with_options( libvlc_media_t *p_md,
+ libvlc_media_parse_flag_t parse_flag );
/**
- * Get preparsed status for media descriptor object.
+ * 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
+ *
+ * \libvlc_return_bool
*/
-VLC_PUBLIC_API int
- libvlc_media_is_preparsed( libvlc_media_t * p_md );
+LIBVLC_API int
+ libvlc_media_is_parsed( libvlc_media_t *p_md );
/**
* Sets media descriptor's user_data. user_data is specialized data
* \param p_md media descriptor object
* \param p_new_user_data pointer to user data
*/
-VLC_PUBLIC_API void
- libvlc_media_set_user_data( libvlc_media_t * p_md,
- void * p_new_user_data );
+LIBVLC_API void
+ 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
*
* \param p_md media descriptor object
*/
-VLC_PUBLIC_API void *
- libvlc_media_get_user_data( libvlc_media_t * p_md );
+LIBVLC_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:
+ * Note, you need to call libvlc_media_parse() or play the media at least once
+ * before calling this function.
+ * Not doing this will result in an empty array.
*
- * @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
+ * \deprecated Use libvlc_media_tracks_get instead
*
- * 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) [OUT]
*
- * \param media media descriptor object
+ * \return the number of Elementary Streams
+ */
+LIBVLC_DEPRECATED LIBVLC_API
+int libvlc_media_get_tracks_info( libvlc_media_t *p_md,
+ libvlc_media_track_info_t **tracks );
+
+/**
+ * Get media descriptor's elementary streams description
+ *
+ * Note, you need to call libvlc_media_parse() or play the media at least once
+ * before calling this function.
+ * Not doing this will result in an empty array.
+ *
+ * \version LibVLC 2.1.0 and later.
+ *
+ * \param p_md media descriptor object
* \param tracks address to store an allocated array of Elementary Streams
- * descriptions (must be freed by the caller)
+ * descriptions (must be freed with libvlc_media_tracks_release
+ by the caller) [OUT]
+ *
+ * \return the number of Elementary Streams (zero on error)
+ */
+LIBVLC_API
+unsigned libvlc_media_tracks_get( libvlc_media_t *p_md,
+ libvlc_media_track_t ***tracks );
+
+/**
+ * Get codec description from media elementary stream
+ *
+ * \version LibVLC 3.0.0 and later.
+ *
+ * \see libvlc_media_track_t
+ *
+ * \param i_type i_type from libvlc_media_track_t
+ * \param i_codec i_codec or i_original_fourcc from libvlc_media_track_t
+ *
+ * \return codec description
+ */
+LIBVLC_API
+const char *libvlc_media_get_codec_description( libvlc_track_type_t i_type,
+ uint32_t i_codec );
+
+/**
+ * Release media descriptor's elementary streams description array
+ *
+ * \version LibVLC 2.1.0 and later.
+ *
+ * \param p_tracks tracks info array to release
+ * \param i_count number of elements in the array
+ */
+LIBVLC_API
+void libvlc_media_tracks_release( libvlc_media_track_t **p_tracks,
+ unsigned i_count );
+
+/**
+ * Get the media type of the media descriptor object
+ *
+ * \version LibVLC 3.0.0 and later.
+ *
+ * \see libvlc_media_type_t
+ *
+ * \param p_md media descriptor object
*
- * return the number of Elementary Streams
+ * \return media type
*/
-VLC_PUBLIC_API
-int libvlc_media_get_tracks_info(libvlc_media_t *media,
- libvlc_media_track_info_t **tracks );
+LIBVLC_API
+libvlc_media_type_t libvlc_media_get_type( libvlc_media_t *p_md );
/** @}*/
projects / vlc / blobdiff