1 /*****************************************************************************
2 * libvlc.h: libvlc external API
3 *****************************************************************************
4 * Copyright (C) 1998-2009 the VideoLAN team
7 * Authors: Clément Stenac <zorglub@videolan.org>
8 * Jean-Paul Saman <jpsaman@videolan.org>
9 * Pierre d'Herbemont <pdherbemont@videolan.org>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24 *****************************************************************************/
28 * This file defines libvlc_media external API
31 #ifndef VLC_LIBVLC_MEDIA_H
32 #define VLC_LIBVLC_MEDIA_H 1
38 /** \defgroup libvlc_media LibVLC media
40 * @ref libvlc_media_t is an abstract representation of a playable media.
41 * It consists of a media location and various optional meta data.
45 typedef struct libvlc_media_t libvlc_media_t;
47 /** defgroup libvlc_meta LibVLC meta data
48 * \ingroup libvlc_media
52 /** Meta data types */
53 typedef enum libvlc_meta_t {
57 libvlc_meta_Copyright,
59 libvlc_meta_TrackNumber,
60 libvlc_meta_Description,
66 libvlc_meta_NowPlaying,
67 libvlc_meta_Publisher,
68 libvlc_meta_EncodedBy,
69 libvlc_meta_ArtworkURL,
71 /* Add new meta types HERE */
77 * Note the order of libvlc_state_t enum must match exactly the order of
78 * \see mediacontrol_PlayerStatus, \see input_state_e enums,
79 * and VideoLAN.LibVLC.State (at bindings/cil/src/media.cs).
81 * Expected states by web plugins are:
82 * IDLE/CLOSE=0, OPENING=1, BUFFERING=2, PLAYING=3, PAUSED=4,
83 * STOPPING=5, ENDED=6, ERROR=7
85 typedef enum libvlc_state_t
87 libvlc_NothingSpecial=0,
99 libvlc_media_option_trusted = 0x2,
100 libvlc_media_option_unique = 0x100
103 typedef enum libvlc_track_type_t
105 libvlc_track_unknown = -1,
106 libvlc_track_audio = 0,
107 libvlc_track_video = 1,
108 libvlc_track_text = 2,
109 } libvlc_track_type_t;
111 /** defgroup libvlc_media_stats_t LibVLC media statistics
112 * \ingroup libvlc_media
115 typedef struct libvlc_media_stats_t
119 float f_input_bitrate;
122 int i_demux_read_bytes;
123 float f_demux_bitrate;
124 int i_demux_corrupted;
125 int i_demux_discontinuity;
132 int i_displayed_pictures;
136 int i_played_abuffers;
142 float f_send_bitrate;
143 } libvlc_media_stats_t;
146 typedef struct libvlc_media_track_info_t
151 libvlc_track_type_t i_type;
170 } libvlc_media_track_info_t;
174 * Create a media with a certain given media resource location.
176 * \see libvlc_media_release
178 * \param p_instance the instance
179 * \param psz_mrl the MRL to read
180 * \return the newly created media or NULL on error
182 VLC_PUBLIC_API libvlc_media_t *libvlc_media_new_location(
183 libvlc_instance_t *p_instance,
184 const char * psz_mrl );
187 * Create a media with a certain file path.
189 * \see libvlc_media_release
191 * \param p_instance the instance
192 * \param path local filesystem path
193 * \return the newly created media or NULL on error
195 VLC_PUBLIC_API libvlc_media_t *libvlc_media_new_path(
196 libvlc_instance_t *p_instance,
200 * Create a media as an empty node with a given name.
202 * \see libvlc_media_release
204 * \param p_instance the instance
205 * \param psz_name the name of the node
206 * \return the new empty media or NULL on error
208 VLC_PUBLIC_API libvlc_media_t *libvlc_media_new_as_node(
209 libvlc_instance_t *p_instance,
210 const char * psz_name );
213 * Add an option to the media.
215 * This option will be used to determine how the media_player will
216 * read the media. This allows to use VLC's advanced
217 * reading/streaming options on a per-media basis.
219 * The options are detailed in vlc --long-help, for instance "--sout-all"
221 * \param p_md the media descriptor
222 * \param ppsz_options the options (as a string)
224 VLC_PUBLIC_API void libvlc_media_add_option(
225 libvlc_media_t *p_md,
226 const char * ppsz_options );
229 * Add an option to the media with configurable flags.
231 * This option will be used to determine how the media_player will
232 * read the media. This allows to use VLC's advanced
233 * reading/streaming options on a per-media basis.
235 * The options are detailed in vlc --long-help, for instance "--sout-all"
237 * \param p_md the media descriptor
238 * \param ppsz_options the options (as a string)
239 * \param i_flags the flags for this option
241 VLC_PUBLIC_API void libvlc_media_add_option_flag(
242 libvlc_media_t *p_md,
243 const char * ppsz_options,
248 * Retain a reference to a media descriptor object (libvlc_media_t). Use
249 * libvlc_media_release() to decrement the reference count of a
250 * media descriptor object.
252 * \param p_md the media descriptor
254 VLC_PUBLIC_API void libvlc_media_retain( libvlc_media_t *p_md );
257 * Decrement the reference count of a media descriptor object. If the
258 * reference count is 0, then libvlc_media_release() will release the
259 * media descriptor object. It will send out an libvlc_MediaFreed event
260 * to all listeners. If the media descriptor object has been released it
261 * should not be used again.
263 * \param p_md the media descriptor
265 VLC_PUBLIC_API void libvlc_media_release( libvlc_media_t *p_md );
269 * Get the media resource locator (mrl) from a media descriptor object
271 * \param p_md a media descriptor object
272 * \return string with mrl of media descriptor object
274 VLC_PUBLIC_API char *libvlc_media_get_mrl( libvlc_media_t *p_md );
277 * Duplicate a media descriptor object.
279 * \param p_md a media descriptor object.
281 VLC_PUBLIC_API libvlc_media_t *libvlc_media_duplicate( libvlc_media_t *p_md );
284 * Read the meta of the media.
286 * If the media has not yet been parsed this will return NULL.
288 * This methods automatically calls libvlc_media_parse_async(), so after calling
289 * it you may receive a libvlc_MediaMetaChanged event. If you prefer a synchronous
290 * version ensure that you call libvlc_media_parse() before get_meta().
292 * \see libvlc_media_parse
293 * \see libvlc_media_parse_async
294 * \see libvlc_MediaMetaChanged
296 * \param p_md the media descriptor
297 * \param e_meta the meta to read
298 * \return the media's meta
300 VLC_PUBLIC_API char *libvlc_media_get_meta( libvlc_media_t *p_md,
301 libvlc_meta_t e_meta );
304 * Set the meta of the media (this function will not save the meta, call
305 * libvlc_media_save_meta in order to save the meta)
307 * \param p_md the media descriptor
308 * \param e_meta the meta to write
309 * \param psz_value the media's meta
311 VLC_PUBLIC_API void libvlc_media_set_meta( libvlc_media_t *p_md,
312 libvlc_meta_t e_meta,
313 const char *psz_value );
317 * Save the meta previously set
319 * \param p_md the media desriptor
320 * \return true if the write operation was successfull
322 VLC_PUBLIC_API int libvlc_media_save_meta( libvlc_media_t *p_md );
326 * Get current state of media descriptor object. Possible media states
327 * are defined in libvlc_structures.c ( libvlc_NothingSpecial=0,
328 * libvlc_Opening, libvlc_Buffering, libvlc_Playing, libvlc_Paused,
329 * libvlc_Stopped, libvlc_Ended,
332 * \see libvlc_state_t
333 * \param p_md a media descriptor object
334 * \return state of media descriptor object
336 VLC_PUBLIC_API libvlc_state_t libvlc_media_get_state(
337 libvlc_media_t *p_md );
341 * Get the current statistics about the media
342 * \param p_md: media descriptor object
343 * \param p_stats: structure that contain the statistics about the media
344 * (this structure must be allocated by the caller)
345 * \return true if the statistics are available, false otherwise
347 VLC_PUBLIC_API int libvlc_media_get_stats( libvlc_media_t *p_md,
348 libvlc_media_stats_t *p_stats );
351 * Get subitems of media descriptor object. This will increment
352 * the reference count of supplied media descriptor object. Use
353 * libvlc_media_list_release() to decrement the reference counting.
355 * \param p_md media descriptor object
356 * \return list of media descriptor subitems or NULL
359 /* This method uses libvlc_media_list_t, however, media_list usage is optionnal
360 * and this is here for convenience */
361 #define VLC_FORWARD_DECLARE_OBJECT(a) struct a
363 VLC_PUBLIC_API VLC_FORWARD_DECLARE_OBJECT(libvlc_media_list_t *)
364 libvlc_media_subitems( libvlc_media_t *p_md );
367 * Get event manager from media descriptor object.
368 * NOTE: this function doesn't increment reference counting.
370 * \param p_md a media descriptor object
371 * \return event manager object
373 VLC_PUBLIC_API libvlc_event_manager_t *
374 libvlc_media_event_manager( libvlc_media_t *p_md );
377 * Get duration (in ms) of media descriptor object item.
379 * \param p_md media descriptor object
380 * \return duration of media item or -1 on error
382 VLC_PUBLIC_API libvlc_time_t
383 libvlc_media_get_duration( libvlc_media_t *p_md );
388 * This fetches (local) meta data and tracks information.
389 * The method is synchronous.
391 * \see libvlc_media_parse_async
392 * \see libvlc_media_get_meta
393 * \see libvlc_media_get_tracks_info
395 * \param p_md media descriptor object
398 libvlc_media_parse( libvlc_media_t *p_md );
403 * This fetches (local) meta data and tracks information.
404 * The method is the asynchronous of libvlc_media_parse().
406 * To track when this is over you can listen to libvlc_MediaParsedChanged
407 * event. However if the media was already parsed you will not receive this
410 * \see libvlc_media_parse
411 * \see libvlc_MediaParsedChanged
412 * \see libvlc_media_get_meta
413 * \see libvlc_media_get_tracks_info
415 * \param p_md media descriptor object
418 libvlc_media_parse_async( libvlc_media_t *p_md );
421 * Get Parsed status for media descriptor object.
423 * \see libvlc_MediaParsedChanged
425 * \param p_md media descriptor object
426 * \return true if media object has been parsed otherwise it returns false
429 libvlc_media_is_parsed( libvlc_media_t *p_md );
432 * Sets media descriptor's user_data. user_data is specialized data
433 * accessed by the host application, VLC.framework uses it as a pointer to
434 * an native object that references a libvlc_media_t pointer
436 * \param p_md media descriptor object
437 * \param p_new_user_data pointer to user data
440 libvlc_media_set_user_data( libvlc_media_t *p_md, void *p_new_user_data );
443 * Get media descriptor's user_data. user_data is specialized data
444 * accessed by the host application, VLC.framework uses it as a pointer to
445 * an native object that references a libvlc_media_t pointer
447 * \param p_md media descriptor object
449 VLC_PUBLIC_API void *libvlc_media_get_user_data( libvlc_media_t *p_md );
452 * Get media descriptor's elementary streams description
454 * Note, you need to play the media _one_ time with --sout="#description"
455 * Not doing this will result in an empty array, and doing it more than once
456 * will duplicate the entries in the array each time. Something like this:
459 * libvlc_media_player_t *player = libvlc_media_player_new_from_media(media);
460 * libvlc_media_add_option_flag(media, "sout=\"#description\"");
461 * libvlc_media_player_play(player);
462 * // ... wait until playing
463 * libvlc_media_player_release(player);
466 * This is very likely to change in next release, and be done at the parsing
469 * \param p_md media descriptor object
470 * \param tracks address to store an allocated array of Elementary Streams
471 * descriptions (must be freed by the caller)
473 * return the number of Elementary Streams
476 int libvlc_media_get_tracks_info( libvlc_media_t *p_md,
477 libvlc_media_track_info_t **tracks );
485 #endif /* VLC_LIBVLC_MEDIA_H */