git.sesse.net Git - vlc/blob - include/vlc/libvlc_media.h

   1 /*****************************************************************************
   2  * libvlc.h:  libvlc external API
   3  *****************************************************************************
   4  * Copyright (C) 1998-2009 the VideoLAN team
   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
  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.
  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 General Public License for more details.
  20  *
  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  *****************************************************************************/
  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 VLC_PUBLIC_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 VLC_PUBLIC_API libvlc_media_t *libvlc_media_new_path(
 202                                    libvlc_instance_t *p_instance,
 203                                    const char *path );
 204
 205 /**
 206  * Create a media as an empty node with a given name.
 207  *
 208  * \see libvlc_media_release
 209  *
 210  * \param p_instance the instance
 211  * \param psz_name the name of the node
 212  * \return the new empty media or NULL on error
 213  */
 214 VLC_PUBLIC_API libvlc_media_t *libvlc_media_new_as_node(
 215                                    libvlc_instance_t *p_instance,
 216                                    const char * psz_name );
 217
 218 /**
 219  * Add an option to the media.
 220  *
 221  * This option will be used to determine how the media_player will
 222  * read the media. This allows to use VLC's advanced
 223  * reading/streaming options on a per-media basis.
 224  *
 225  * The options are detailed in vlc --long-help, for instance "--sout-all"
 226  *
 227  * \param p_md the media descriptor
 228  * \param ppsz_options the options (as a string)
 229  */
 230 VLC_PUBLIC_API void libvlc_media_add_option(
 231                                    libvlc_media_t *p_md,
 232                                    const char * ppsz_options );
 233
 234 /**
 235  * Add an option to the media with configurable flags.
 236  *
 237  * This option will be used to determine how the media_player will
 238  * read the media. This allows to use VLC's advanced
 239  * reading/streaming options on a per-media basis.
 240  *
 241  * The options are detailed in vlc --long-help, for instance "--sout-all"
 242  *
 243  * \param p_md the media descriptor
 244  * \param ppsz_options the options (as a string)
 245  * \param i_flags the flags for this option
 246  */
 247 VLC_PUBLIC_API void libvlc_media_add_option_flag(
 248                                    libvlc_media_t *p_md,
 249                                    const char * ppsz_options,
 250                                    unsigned i_flags );
 251
 252
 253 /**
 254  * Retain a reference to a media descriptor object (libvlc_media_t). Use
 255  * libvlc_media_release() to decrement the reference count of a
 256  * media descriptor object.
 257  *
 258  * \param p_md the media descriptor
 259  */
 260 VLC_PUBLIC_API void libvlc_media_retain( libvlc_media_t *p_md );
 261
 262 /**
 263  * Decrement the reference count of a media descriptor object. If the
 264  * reference count is 0, then libvlc_media_release() will release the
 265  * media descriptor object. It will send out an libvlc_MediaFreed event
 266  * to all listeners. If the media descriptor object has been released it
 267  * should not be used again.
 268  *
 269  * \param p_md the media descriptor
 270  */
 271 VLC_PUBLIC_API void libvlc_media_release( libvlc_media_t *p_md );
 272
 273
 274 /**
 275  * Get the media resource locator (mrl) from a media descriptor object
 276  *
 277  * \param p_md a media descriptor object
 278  * \return string with mrl of media descriptor object
 279  */
 280 VLC_PUBLIC_API char *libvlc_media_get_mrl( libvlc_media_t *p_md );
 281
 282 /**
 283  * Duplicate a media descriptor object.
 284  *
 285  * \param p_md a media descriptor object.
 286  */
 287 VLC_PUBLIC_API libvlc_media_t *libvlc_media_duplicate( libvlc_media_t *p_md );
 288
 289 /**
 290  * Read the meta of the media.
 291  *
 292  * If the media has not yet been parsed this will return NULL.
 293  *
 294  * This methods automatically calls libvlc_media_parse_async(), so after calling
 295  * it you may receive a libvlc_MediaMetaChanged event. If you prefer a synchronous
 296  * version ensure that you call libvlc_media_parse() before get_meta().
 297  *
 298  * \see libvlc_media_parse
 299  * \see libvlc_media_parse_async
 300  * \see libvlc_MediaMetaChanged
 301  *
 302  * \param p_md the media descriptor
 303  * \param e_meta the meta to read
 304  * \return the media's meta
 305  */
 306 VLC_PUBLIC_API char *libvlc_media_get_meta( libvlc_media_t *p_md,
 307                                              libvlc_meta_t e_meta );
 308
 309 /**
 310  * Set the meta of the media (this function will not save the meta, call
 311  * libvlc_media_save_meta in order to save the meta)
 312  *
 313  * \param p_md the media descriptor
 314  * \param e_meta the meta to write
 315  * \param psz_value the media's meta
 316  */
 317 VLC_PUBLIC_API void libvlc_media_set_meta( libvlc_media_t *p_md,
 318                                            libvlc_meta_t e_meta,
 319                                            const char *psz_value );
 320
 321
 322 /**
 323  * Save the meta previously set
 324  *
 325  * \param p_md the media desriptor
 326  * \return true if the write operation was successfull
 327  */
 328 VLC_PUBLIC_API int libvlc_media_save_meta( libvlc_media_t *p_md );
 329
 330
 331 /**
 332  * Get current state of media descriptor object. Possible media states
 333  * are defined in libvlc_structures.c ( libvlc_NothingSpecial=0,
 334  * libvlc_Opening, libvlc_Buffering, libvlc_Playing, libvlc_Paused,
 335  * libvlc_Stopped, libvlc_Ended,
 336  * libvlc_Error).
 337  *
 338  * \see libvlc_state_t
 339  * \param p_md a media descriptor object
 340  * \return state of media descriptor object
 341  */
 342 VLC_PUBLIC_API libvlc_state_t libvlc_media_get_state(
 343                                    libvlc_media_t *p_md );
 344
 345
 346 /**
 347  * Get the current statistics about the media
 348  * \param p_md: media descriptor object
 349  * \param p_stats: structure that contain the statistics about the media
 350  *                 (this structure must be allocated by the caller)
 351  * \return true if the statistics are available, false otherwise
 352  */
 353 VLC_PUBLIC_API int libvlc_media_get_stats( libvlc_media_t *p_md,
 354                                            libvlc_media_stats_t *p_stats );
 355
 356 /**
 357  * Get subitems of media descriptor object. This will increment
 358  * the reference count of supplied media descriptor object. Use
 359  * libvlc_media_list_release() to decrement the reference counting.
 360  *
 361  * \param p_md media descriptor object
 362  * \return list of media descriptor subitems or NULL
 363  */
 364
 365 /* This method uses libvlc_media_list_t, however, media_list usage is optionnal
 366  * and this is here for convenience */
 367 #define VLC_FORWARD_DECLARE_OBJECT(a) struct a
 368
 369 VLC_PUBLIC_API VLC_FORWARD_DECLARE_OBJECT(libvlc_media_list_t *)
 370 libvlc_media_subitems( libvlc_media_t *p_md );
 371
 372 /**
 373  * Get event manager from media descriptor object.
 374  * NOTE: this function doesn't increment reference counting.
 375  *
 376  * \param p_md a media descriptor object
 377  * \return event manager object
 378  */
 379 VLC_PUBLIC_API libvlc_event_manager_t *
 380     libvlc_media_event_manager( libvlc_media_t *p_md );
 381
 382 /**
 383  * Get duration (in ms) of media descriptor object item.
 384  *
 385  * \param p_md media descriptor object
 386  * \return duration of media item or -1 on error
 387  */
 388 VLC_PUBLIC_API libvlc_time_t
 389    libvlc_media_get_duration( libvlc_media_t *p_md );
 390
 391 /**
 392  * Parse a media.
 393  *
 394  * This fetches (local) meta data and tracks information.
 395  * The method is synchronous.
 396  *
 397  * \see libvlc_media_parse_async
 398  * \see libvlc_media_get_meta
 399  * \see libvlc_media_get_tracks_info
 400  *
 401  * \param p_md media descriptor object
 402  */
 403 VLC_PUBLIC_API void
 404 libvlc_media_parse( libvlc_media_t *p_md );
 405
 406 /**
 407  * Parse a media.
 408  *
 409  * This fetches (local) meta data and tracks information.
 410  * The method is the asynchronous of libvlc_media_parse().
 411  *
 412  * To track when this is over you can listen to libvlc_MediaParsedChanged
 413  * event. However if the media was already parsed you will not receive this
 414  * event.
 415  *
 416  * \see libvlc_media_parse
 417  * \see libvlc_MediaParsedChanged
 418  * \see libvlc_media_get_meta
 419  * \see libvlc_media_get_tracks_info
 420  *
 421  * \param p_md media descriptor object
 422  */
 423 VLC_PUBLIC_API void
 424 libvlc_media_parse_async( libvlc_media_t *p_md );
 425
 426 /**
 427  * Get Parsed status for media descriptor object.
 428  *
 429  * \see libvlc_MediaParsedChanged
 430  *
 431  * \param p_md media descriptor object
 432  * \return true if media object has been parsed otherwise it returns false
 433  */
 434 VLC_PUBLIC_API int
 435    libvlc_media_is_parsed( libvlc_media_t *p_md );
 436
 437 /**
 438  * Sets media descriptor's user_data. user_data is specialized data
 439  * accessed by the host application, VLC.framework uses it as a pointer to
 440  * an native object that references a libvlc_media_t pointer
 441  *
 442  * \param p_md media descriptor object
 443  * \param p_new_user_data pointer to user data
 444  */
 445 VLC_PUBLIC_API void
 446     libvlc_media_set_user_data( libvlc_media_t *p_md, void *p_new_user_data );
 447
 448 /**
 449  * Get media descriptor's user_data. user_data is specialized data
 450  * accessed by the host application, VLC.framework uses it as a pointer to
 451  * an native object that references a libvlc_media_t pointer
 452  *
 453  * \param p_md media descriptor object
 454  */
 455 VLC_PUBLIC_API void *libvlc_media_get_user_data( libvlc_media_t *p_md );
 456
 457 /**
 458  * Get media descriptor's elementary streams description
 459  *
 460  * Note, you need to play the media _one_ time with --sout="#description"
 461  * Not doing this will result in an empty array, and doing it more than once
 462  * will duplicate the entries in the array each time. Something like this:
 463  *
 464  * @begincode
 465  * libvlc_media_player_t *player = libvlc_media_player_new_from_media(media);
 466  * libvlc_media_add_option_flag(media, "sout=#description");
 467  * libvlc_media_player_play(player);
 468  * // ... wait until playing
 469  * libvlc_media_player_release(player);
 470  * @endcode
 471  *
 472  * This is very likely to change in next release, and be done at the parsing
 473  * phase.
 474  *
 475  * \param p_md media descriptor object
 476  * \param tracks address to store an allocated array of Elementary Streams
 477  * descriptions (must be freed by the caller)
 478  *
 479  * return the number of Elementary Streams
 480  */
 481 VLC_PUBLIC_API
 482 int libvlc_media_get_tracks_info( libvlc_media_t *p_md,
 483                                   libvlc_media_track_info_t **tracks );
 484
 485 /** @}*/
 486
 487 # ifdef __cplusplus
 488 }
 489 # endif
 490
 491 #endif /* VLC_LIBVLC_MEDIA_H */