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,
175 * for instance a valid URL.
177 * \note To refer to a local file with this function,
178 * the file://... URI syntax <b>must</b> be used (see IETF RFC3986).
179 * We recommend using libvlc_media_new_path() instead when dealing with
182 * \see libvlc_media_release
184 * \param p_instance the instance
185 * \param psz_mrl the media location
186 * \return the newly created media or NULL on error
188 LIBVLC_API libvlc_media_t *libvlc_media_new_location(
189 libvlc_instance_t *p_instance,
190 const char * psz_mrl );
193 * Create a media for a certain file path.
195 * \see libvlc_media_release
197 * \param p_instance the instance
198 * \param path local filesystem path
199 * \return the newly created media or NULL on error
201 LIBVLC_API libvlc_media_t *libvlc_media_new_path(
202 libvlc_instance_t *p_instance,
206 * Create a media for an already open file descriptor.
207 * The file descriptor shall be open for reading (or reading and writing).
209 * Regular file descriptors, pipe read descriptors and character device
210 * descriptors (including TTYs) are supported on all platforms.
211 * Block device descriptors are supported where available.
212 * Directory descriptors are supported on systems that provide fdopendir().
213 * Sockets are supported on all platforms where they are file descriptors,
214 * i.e. all except Windows.
216 * \note This library will <b>not</b> automatically close the file descriptor
217 * under any circumstance. Nevertheless, a file descriptor can usually only be
218 * rendered once in a media player. To render it a second time, the file
219 * descriptor should probably be rewound to the beginning with lseek().
221 * \see libvlc_media_release
223 * \version LibVLC 1.1.5 and later.
225 * \param p_instance the instance
226 * \param fd open file descriptor
227 * \return the newly created media or NULL on error
229 LIBVLC_API libvlc_media_t *libvlc_media_new_fd(
230 libvlc_instance_t *p_instance,
235 * Create a media as an empty node with a given name.
237 * \see libvlc_media_release
239 * \param p_instance the instance
240 * \param psz_name the name of the node
241 * \return the new empty media or NULL on error
243 LIBVLC_API libvlc_media_t *libvlc_media_new_as_node(
244 libvlc_instance_t *p_instance,
245 const char * psz_name );
248 * Add an option to the media.
250 * This option will be used to determine how the media_player will
251 * read the media. This allows to use VLC's advanced
252 * reading/streaming options on a per-media basis.
254 * The options are detailed in vlc --long-help, for instance "--sout-all"
256 * \param p_md the media descriptor
257 * \param ppsz_options the options (as a string)
259 LIBVLC_API void libvlc_media_add_option(
260 libvlc_media_t *p_md,
261 const char * ppsz_options );
264 * Add an option to the media with configurable flags.
266 * This option will be used to determine how the media_player will
267 * read the media. This allows to use VLC's advanced
268 * reading/streaming options on a per-media basis.
270 * The options are detailed in vlc --long-help, for instance "--sout-all"
272 * \param p_md the media descriptor
273 * \param ppsz_options the options (as a string)
274 * \param i_flags the flags for this option
276 LIBVLC_API void libvlc_media_add_option_flag(
277 libvlc_media_t *p_md,
278 const char * ppsz_options,
283 * Retain a reference to a media descriptor object (libvlc_media_t). Use
284 * libvlc_media_release() to decrement the reference count of a
285 * media descriptor object.
287 * \param p_md the media descriptor
289 LIBVLC_API void libvlc_media_retain( libvlc_media_t *p_md );
292 * Decrement the reference count of a media descriptor object. If the
293 * reference count is 0, then libvlc_media_release() will release the
294 * media descriptor object. It will send out an libvlc_MediaFreed event
295 * to all listeners. If the media descriptor object has been released it
296 * should not be used again.
298 * \param p_md the media descriptor
300 LIBVLC_API void libvlc_media_release( libvlc_media_t *p_md );
304 * Get the media resource locator (mrl) from a media descriptor object
306 * \param p_md a media descriptor object
307 * \return string with mrl of media descriptor object
309 LIBVLC_API char *libvlc_media_get_mrl( libvlc_media_t *p_md );
312 * Duplicate a media descriptor object.
314 * \param p_md a media descriptor object.
316 LIBVLC_API libvlc_media_t *libvlc_media_duplicate( libvlc_media_t *p_md );
319 * Read the meta of the media.
321 * If the media has not yet been parsed this will return NULL.
323 * This methods automatically calls libvlc_media_parse_async(), so after calling
324 * it you may receive a libvlc_MediaMetaChanged event. If you prefer a synchronous
325 * version ensure that you call libvlc_media_parse() before get_meta().
327 * \see libvlc_media_parse
328 * \see libvlc_media_parse_async
329 * \see libvlc_MediaMetaChanged
331 * \param p_md the media descriptor
332 * \param e_meta the meta to read
333 * \return the media's meta
335 LIBVLC_API char *libvlc_media_get_meta( libvlc_media_t *p_md,
336 libvlc_meta_t e_meta );
339 * Set the meta of the media (this function will not save the meta, call
340 * libvlc_media_save_meta in order to save the meta)
342 * \param p_md the media descriptor
343 * \param e_meta the meta to write
344 * \param psz_value the media's meta
346 LIBVLC_API void libvlc_media_set_meta( libvlc_media_t *p_md,
347 libvlc_meta_t e_meta,
348 const char *psz_value );
352 * Save the meta previously set
354 * \param p_md the media desriptor
355 * \return true if the write operation was successfull
357 LIBVLC_API int libvlc_media_save_meta( libvlc_media_t *p_md );
361 * Get current state of media descriptor object. Possible media states
362 * are defined in libvlc_structures.c ( libvlc_NothingSpecial=0,
363 * libvlc_Opening, libvlc_Buffering, libvlc_Playing, libvlc_Paused,
364 * libvlc_Stopped, libvlc_Ended,
367 * \see libvlc_state_t
368 * \param p_md a media descriptor object
369 * \return state of media descriptor object
371 LIBVLC_API libvlc_state_t libvlc_media_get_state(
372 libvlc_media_t *p_md );
376 * Get the current statistics about the media
377 * \param p_md: media descriptor object
378 * \param p_stats: structure that contain the statistics about the media
379 * (this structure must be allocated by the caller)
380 * \return true if the statistics are available, false otherwise
382 * \libvlc_return_bool
384 LIBVLC_API int libvlc_media_get_stats( libvlc_media_t *p_md,
385 libvlc_media_stats_t *p_stats );
388 * Get subitems of media descriptor object. This will increment
389 * the reference count of supplied media descriptor object. Use
390 * libvlc_media_list_release() to decrement the reference counting.
392 * \param p_md media descriptor object
393 * \return list of media descriptor subitems or NULL
396 /* This method uses libvlc_media_list_t, however, media_list usage is optionnal
397 * and this is here for convenience */
398 #define VLC_FORWARD_DECLARE_OBJECT(a) struct a
400 LIBVLC_API VLC_FORWARD_DECLARE_OBJECT(libvlc_media_list_t *)
401 libvlc_media_subitems( libvlc_media_t *p_md );
404 * Get event manager from media descriptor object.
405 * NOTE: this function doesn't increment reference counting.
407 * \param p_md a media descriptor object
408 * \return event manager object
410 LIBVLC_API libvlc_event_manager_t *
411 libvlc_media_event_manager( libvlc_media_t *p_md );
414 * Get duration (in ms) of media descriptor object item.
416 * \param p_md media descriptor object
417 * \return duration of media item or -1 on error
419 LIBVLC_API libvlc_time_t
420 libvlc_media_get_duration( libvlc_media_t *p_md );
425 * This fetches (local) meta data and tracks information.
426 * The method is synchronous.
428 * \see libvlc_media_parse_async
429 * \see libvlc_media_get_meta
430 * \see libvlc_media_get_tracks_info
432 * \param p_md media descriptor object
435 libvlc_media_parse( libvlc_media_t *p_md );
440 * This fetches (local) meta data and tracks information.
441 * The method is the asynchronous of libvlc_media_parse().
443 * To track when this is over you can listen to libvlc_MediaParsedChanged
444 * event. However if the media was already parsed you will not receive this
447 * \see libvlc_media_parse
448 * \see libvlc_MediaParsedChanged
449 * \see libvlc_media_get_meta
450 * \see libvlc_media_get_tracks_info
452 * \param p_md media descriptor object
455 libvlc_media_parse_async( libvlc_media_t *p_md );
458 * Get Parsed status for media descriptor object.
460 * \see libvlc_MediaParsedChanged
462 * \param p_md media descriptor object
463 * \return true if media object has been parsed otherwise it returns false
465 * \libvlc_return_bool
468 libvlc_media_is_parsed( libvlc_media_t *p_md );
471 * Sets media descriptor's user_data. user_data is specialized data
472 * accessed by the host application, VLC.framework uses it as a pointer to
473 * an native object that references a libvlc_media_t pointer
475 * \param p_md media descriptor object
476 * \param p_new_user_data pointer to user data
479 libvlc_media_set_user_data( libvlc_media_t *p_md, void *p_new_user_data );
482 * Get media descriptor's user_data. user_data is specialized data
483 * accessed by the host application, VLC.framework uses it as a pointer to
484 * an native object that references a libvlc_media_t pointer
486 * \param p_md media descriptor object
488 LIBVLC_API void *libvlc_media_get_user_data( libvlc_media_t *p_md );
491 * Get media descriptor's elementary streams description
493 * Note, you need to call libvlc_media_parse() or play the media at least once
494 * before calling this function.
495 * Not doing this will result in an empty array.
497 * \param p_md media descriptor object
498 * \param tracks address to store an allocated array of Elementary Streams
499 * descriptions (must be freed by the caller)
501 * \return the number of Elementary Streams
504 int libvlc_media_get_tracks_info( libvlc_media_t *p_md,
505 libvlc_media_track_info_t **tracks );
513 #endif /* VLC_LIBVLC_MEDIA_H */