LGPL
[vlc.git] / include / vlc / libvlc_media.h
1 /*****************************************************************************
2  * libvlc.h:  libvlc external API
3  *****************************************************************************
4  * Copyright (C) 1998-2009 VLC authors and VideoLAN
5  * $Id$
6  *
7  * Authors: ClĂ©ment Stenac <zorglub@videolan.org>
8  *          Jean-Paul Saman <jpsaman@videolan.org>
9  *          Pierre d'Herbemont <pdherbemont@videolan.org>
10  *
11  * This program is free software; you can redistribute it and/or modify it
12  * under the terms of the GNU Lesser General Public License as published by
13  * the Free Software Foundation; either version 2.1 of the License, or
14  * (at your option) any later version.
15  *
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 Lesser General Public License for more details.
20  *
21  * You should have received a copy of the GNU Lesser General Public License
22  * along with this program; if not, write to the Free Software Foundation,
23  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24  *****************************************************************************/
25
26 /**
27  * \file
28  * This file defines libvlc_media external API
29  */
30
31 #ifndef VLC_LIBVLC_MEDIA_H
32 #define VLC_LIBVLC_MEDIA_H 1
33
34 # ifdef __cplusplus
35 extern "C" {
36 # endif
37
38 /** \defgroup libvlc_media LibVLC media
39  * \ingroup libvlc
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.
42  * @{
43  */
44
45 typedef struct libvlc_media_t libvlc_media_t;
46
47 /** defgroup libvlc_meta LibVLC meta data
48  * \ingroup libvlc_media
49  * @{
50  */
51
52 /** Meta data types */
53 typedef enum libvlc_meta_t {
54     libvlc_meta_Title,
55     libvlc_meta_Artist,
56     libvlc_meta_Genre,
57     libvlc_meta_Copyright,
58     libvlc_meta_Album,
59     libvlc_meta_TrackNumber,
60     libvlc_meta_Description,
61     libvlc_meta_Rating,
62     libvlc_meta_Date,
63     libvlc_meta_Setting,
64     libvlc_meta_URL,
65     libvlc_meta_Language,
66     libvlc_meta_NowPlaying,
67     libvlc_meta_Publisher,
68     libvlc_meta_EncodedBy,
69     libvlc_meta_ArtworkURL,
70     libvlc_meta_TrackID
71     /* Add new meta types HERE */
72 } libvlc_meta_t;
73
74 /** @}*/
75
76 /**
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).
80  *
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
84  */
85 typedef enum libvlc_state_t
86 {
87     libvlc_NothingSpecial=0,
88     libvlc_Opening,
89     libvlc_Buffering,
90     libvlc_Playing,
91     libvlc_Paused,
92     libvlc_Stopped,
93     libvlc_Ended,
94     libvlc_Error
95 } libvlc_state_t;
96
97 enum
98 {
99     libvlc_media_option_trusted = 0x2,
100     libvlc_media_option_unique = 0x100
101 };
102
103 typedef enum libvlc_track_type_t
104 {
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;
110
111 /** defgroup libvlc_media_stats_t LibVLC media statistics
112  * \ingroup libvlc_media
113  * @{
114  */
115 typedef struct libvlc_media_stats_t
116 {
117     /* Input */
118     int         i_read_bytes;
119     float       f_input_bitrate;
120
121     /* Demux */
122     int         i_demux_read_bytes;
123     float       f_demux_bitrate;
124     int         i_demux_corrupted;
125     int         i_demux_discontinuity;
126
127     /* Decoders */
128     int         i_decoded_video;
129     int         i_decoded_audio;
130
131     /* Video Output */
132     int         i_displayed_pictures;
133     int         i_lost_pictures;
134
135     /* Audio output */
136     int         i_played_abuffers;
137     int         i_lost_abuffers;
138
139     /* Stream output */
140     int         i_sent_packets;
141     int         i_sent_bytes;
142     float       f_send_bitrate;
143 } libvlc_media_stats_t;
144 /** @}*/
145
146 typedef struct libvlc_media_track_info_t
147 {
148     /* Codec fourcc */
149     uint32_t    i_codec;
150     int         i_id;
151     libvlc_track_type_t i_type;
152
153     /* Codec specific */
154     int         i_profile;
155     int         i_level;
156
157     union {
158         struct {
159             /* Audio specific */
160             unsigned    i_channels;
161             unsigned    i_rate;
162         } audio;
163         struct {
164             /* Video specific */
165             unsigned    i_height;
166             unsigned    i_width;
167         } video;
168     } u;
169
170 } libvlc_media_track_info_t;
171
172
173 /**
174  * Create a media with a certain given media resource location,
175  * for instance a valid URL.
176  *
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
180  * local files.
181  *
182  * \see libvlc_media_release
183  *
184  * \param p_instance the instance
185  * \param psz_mrl the media location
186  * \return the newly created media or NULL on error
187  */
188 LIBVLC_API libvlc_media_t *libvlc_media_new_location(
189                                    libvlc_instance_t *p_instance,
190                                    const char * psz_mrl );
191
192 /**
193  * Create a media for a certain file path.
194  *
195  * \see libvlc_media_release
196  *
197  * \param p_instance the instance
198  * \param path local filesystem path
199  * \return the newly created media or NULL on error
200  */
201 LIBVLC_API libvlc_media_t *libvlc_media_new_path(
202                                    libvlc_instance_t *p_instance,
203                                    const char *path );
204
205 /**
206  * Create a media for an already open file descriptor.
207  * The file descriptor shall be open for reading (or reading and writing).
208  *
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.
215  *
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().
220  *
221  * \see libvlc_media_release
222  *
223  * \version LibVLC 1.1.5 and later.
224  *
225  * \param p_instance the instance
226  * \param fd open file descriptor
227  * \return the newly created media or NULL on error
228  */
229 LIBVLC_API libvlc_media_t *libvlc_media_new_fd(
230                                    libvlc_instance_t *p_instance,
231                                    int fd );
232
233
234 /**
235  * Create a media as an empty node with a given name.
236  *
237  * \see libvlc_media_release
238  *
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
242  */
243 LIBVLC_API libvlc_media_t *libvlc_media_new_as_node(
244                                    libvlc_instance_t *p_instance,
245                                    const char * psz_name );
246
247 /**
248  * Add an option to the media.
249  *
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.
253  *
254  * The options are detailed in vlc --long-help, for instance "--sout-all"
255  *
256  * \param p_md the media descriptor
257  * \param ppsz_options the options (as a string)
258  */
259 LIBVLC_API void libvlc_media_add_option(
260                                    libvlc_media_t *p_md,
261                                    const char * ppsz_options );
262
263 /**
264  * Add an option to the media with configurable flags.
265  *
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.
269  *
270  * The options are detailed in vlc --long-help, for instance "--sout-all"
271  *
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
275  */
276 LIBVLC_API void libvlc_media_add_option_flag(
277                                    libvlc_media_t *p_md,
278                                    const char * ppsz_options,
279                                    unsigned i_flags );
280
281
282 /**
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.
286  *
287  * \param p_md the media descriptor
288  */
289 LIBVLC_API void libvlc_media_retain( libvlc_media_t *p_md );
290
291 /**
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.
297  *
298  * \param p_md the media descriptor
299  */
300 LIBVLC_API void libvlc_media_release( libvlc_media_t *p_md );
301
302
303 /**
304  * Get the media resource locator (mrl) from a media descriptor object
305  *
306  * \param p_md a media descriptor object
307  * \return string with mrl of media descriptor object
308  */
309 LIBVLC_API char *libvlc_media_get_mrl( libvlc_media_t *p_md );
310
311 /**
312  * Duplicate a media descriptor object.
313  *
314  * \param p_md a media descriptor object.
315  */
316 LIBVLC_API libvlc_media_t *libvlc_media_duplicate( libvlc_media_t *p_md );
317
318 /**
319  * Read the meta of the media.
320  *
321  * If the media has not yet been parsed this will return NULL.
322  *
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().
326  *
327  * \see libvlc_media_parse
328  * \see libvlc_media_parse_async
329  * \see libvlc_MediaMetaChanged
330  *
331  * \param p_md the media descriptor
332  * \param e_meta the meta to read
333  * \return the media's meta
334  */
335 LIBVLC_API char *libvlc_media_get_meta( libvlc_media_t *p_md,
336                                              libvlc_meta_t e_meta );
337
338 /**
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)
341  *
342  * \param p_md the media descriptor
343  * \param e_meta the meta to write
344  * \param psz_value the media's meta
345  */
346 LIBVLC_API void libvlc_media_set_meta( libvlc_media_t *p_md,
347                                            libvlc_meta_t e_meta,
348                                            const char *psz_value );
349
350
351 /**
352  * Save the meta previously set
353  *
354  * \param p_md the media desriptor
355  * \return true if the write operation was successfull
356  */
357 LIBVLC_API int libvlc_media_save_meta( libvlc_media_t *p_md );
358
359
360 /**
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,
365  * libvlc_Error).
366  *
367  * \see libvlc_state_t
368  * \param p_md a media descriptor object
369  * \return state of media descriptor object
370  */
371 LIBVLC_API libvlc_state_t libvlc_media_get_state(
372                                    libvlc_media_t *p_md );
373
374
375 /**
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
381  *
382  * \libvlc_return_bool
383  */
384 LIBVLC_API int libvlc_media_get_stats( libvlc_media_t *p_md,
385                                            libvlc_media_stats_t *p_stats );
386
387 /**
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.
391  *
392  * \param p_md media descriptor object
393  * \return list of media descriptor subitems or NULL
394  */
395
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
399
400 LIBVLC_API VLC_FORWARD_DECLARE_OBJECT(libvlc_media_list_t *)
401 libvlc_media_subitems( libvlc_media_t *p_md );
402
403 /**
404  * Get event manager from media descriptor object.
405  * NOTE: this function doesn't increment reference counting.
406  *
407  * \param p_md a media descriptor object
408  * \return event manager object
409  */
410 LIBVLC_API libvlc_event_manager_t *
411     libvlc_media_event_manager( libvlc_media_t *p_md );
412
413 /**
414  * Get duration (in ms) of media descriptor object item.
415  *
416  * \param p_md media descriptor object
417  * \return duration of media item or -1 on error
418  */
419 LIBVLC_API libvlc_time_t
420    libvlc_media_get_duration( libvlc_media_t *p_md );
421
422 /**
423  * Parse a media.
424  *
425  * This fetches (local) meta data and tracks information.
426  * The method is synchronous.
427  *
428  * \see libvlc_media_parse_async
429  * \see libvlc_media_get_meta
430  * \see libvlc_media_get_tracks_info
431  *
432  * \param p_md media descriptor object
433  */
434 LIBVLC_API void
435 libvlc_media_parse( libvlc_media_t *p_md );
436
437 /**
438  * Parse a media.
439  *
440  * This fetches (local) meta data and tracks information.
441  * The method is the asynchronous of libvlc_media_parse().
442  *
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
445  * event.
446  *
447  * \see libvlc_media_parse
448  * \see libvlc_MediaParsedChanged
449  * \see libvlc_media_get_meta
450  * \see libvlc_media_get_tracks_info
451  *
452  * \param p_md media descriptor object
453  */
454 LIBVLC_API void
455 libvlc_media_parse_async( libvlc_media_t *p_md );
456
457 /**
458  * Get Parsed status for media descriptor object.
459  *
460  * \see libvlc_MediaParsedChanged
461  *
462  * \param p_md media descriptor object
463  * \return true if media object has been parsed otherwise it returns false
464  *
465  * \libvlc_return_bool
466  */
467 LIBVLC_API int
468    libvlc_media_is_parsed( libvlc_media_t *p_md );
469
470 /**
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
474  *
475  * \param p_md media descriptor object
476  * \param p_new_user_data pointer to user data
477  */
478 LIBVLC_API void
479     libvlc_media_set_user_data( libvlc_media_t *p_md, void *p_new_user_data );
480
481 /**
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
485  *
486  * \param p_md media descriptor object
487  */
488 LIBVLC_API void *libvlc_media_get_user_data( libvlc_media_t *p_md );
489
490 /**
491  * Get media descriptor's elementary streams description
492  *
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.
496  *
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)
500  *
501  * \return the number of Elementary Streams
502  */
503 LIBVLC_API
504 int libvlc_media_get_tracks_info( libvlc_media_t *p_md,
505                                   libvlc_media_track_info_t **tracks );
506
507 /** @}*/
508
509 # ifdef __cplusplus
510 }
511 # endif
512
513 #endif /* VLC_LIBVLC_MEDIA_H */