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  *
 176  * \see libvlc_media_release
 177  *
 178  * \param p_instance the instance
 179  * \param psz_mrl the MRL to read
 180  * \return the newly created media or NULL on error
 181  */
 182 VLC_PUBLIC_API libvlc_media_t *libvlc_media_new_location(
 183                                    libvlc_instance_t *p_instance,
 184                                    const char * psz_mrl );
 185
 186 /**
 187  * Create a media with a certain file path.
 188  *
 189  * \see libvlc_media_release
 190  *
 191  * \param p_instance the instance
 192  * \param path local filesystem path
 193  * \return the newly created media or NULL on error
 194  */
 195 VLC_PUBLIC_API libvlc_media_t *libvlc_media_new_path(
 196                                    libvlc_instance_t *p_instance,
 197                                    const char *path );
 198
 199 /**
 200  * Create a media as an empty node with a given name.
 201  *
 202  * \see libvlc_media_release
 203  *
 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
 207  */
 208 VLC_PUBLIC_API libvlc_media_t *libvlc_media_new_as_node(
 209                                    libvlc_instance_t *p_instance,
 210                                    const char * psz_name );
 211
 212 /**
 213  * Add an option to the media.
 214  *
 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.
 218  *
 219  * The options are detailed in vlc --long-help, for instance "--sout-all"
 220  *
 221  * \param p_md the media descriptor
 222  * \param ppsz_options the options (as a string)
 223  */
 224 VLC_PUBLIC_API void libvlc_media_add_option(
 225                                    libvlc_media_t *p_md,
 226                                    const char * ppsz_options );
 227
 228 /**
 229  * Add an option to the media with configurable flags.
 230  *
 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.
 234  *
 235  * The options are detailed in vlc --long-help, for instance "--sout-all"
 236  *
 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
 240  */
 241 VLC_PUBLIC_API void libvlc_media_add_option_flag(
 242                                    libvlc_media_t *p_md,
 243                                    const char * ppsz_options,
 244                                    unsigned i_flags );
 245
 246
 247 /**
 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.
 251  *
 252  * \param p_md the media descriptor
 253  */
 254 VLC_PUBLIC_API void libvlc_media_retain( libvlc_media_t *p_md );
 255
 256 /**
 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.
 262  *
 263  * \param p_md the media descriptor
 264  */
 265 VLC_PUBLIC_API void libvlc_media_release( libvlc_media_t *p_md );
 266
 267
 268 /**
 269  * Get the media resource locator (mrl) from a media descriptor object
 270  *
 271  * \param p_md a media descriptor object
 272  * \return string with mrl of media descriptor object
 273  */
 274 VLC_PUBLIC_API char *libvlc_media_get_mrl( libvlc_media_t *p_md );
 275
 276 /**
 277  * Duplicate a media descriptor object.
 278  *
 279  * \param p_md a media descriptor object.
 280  */
 281 VLC_PUBLIC_API libvlc_media_t *libvlc_media_duplicate( libvlc_media_t *p_md );
 282
 283 /**
 284  * Read the meta of the media.
 285  *
 286  * If the media has not yet been parsed this will return NULL.
 287  *
 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().
 291  *
 292  * \see libvlc_media_parse
 293  * \see libvlc_media_parse_async
 294  * \see libvlc_MediaMetaChanged
 295  *
 296  * \param p_md the media descriptor
 297  * \param e_meta the meta to read
 298  * \return the media's meta
 299  */
 300 VLC_PUBLIC_API char *libvlc_media_get_meta( libvlc_media_t *p_md,
 301                                              libvlc_meta_t e_meta );
 302
 303 /**
 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)
 306  *
 307  * \param p_md the media descriptor
 308  * \param e_meta the meta to write
 309  * \param psz_value the media's meta
 310  */
 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 );
 314
 315
 316 /**
 317  * Save the meta previously set
 318  *
 319  * \param p_md the media desriptor
 320  * \return true if the write operation was successfull
 321  */
 322 VLC_PUBLIC_API int libvlc_media_save_meta( libvlc_media_t *p_md );
 323
 324
 325 /**
 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,
 330  * libvlc_Error).
 331  *
 332  * \see libvlc_state_t
 333  * \param p_md a media descriptor object
 334  * \return state of media descriptor object
 335  */
 336 VLC_PUBLIC_API libvlc_state_t libvlc_media_get_state(
 337                                    libvlc_media_t *p_md );
 338
 339
 340 /**
 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
 346  */
 347 VLC_PUBLIC_API int libvlc_media_get_stats( libvlc_media_t *p_md,
 348                                            libvlc_media_stats_t *p_stats );
 349
 350 /**
 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.
 354  *
 355  * \param p_md media descriptor object
 356  * \return list of media descriptor subitems or NULL
 357  */
 358
 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
 362
 363 VLC_PUBLIC_API VLC_FORWARD_DECLARE_OBJECT(libvlc_media_list_t *)
 364 libvlc_media_subitems( libvlc_media_t *p_md );
 365
 366 /**
 367  * Get event manager from media descriptor object.
 368  * NOTE: this function doesn't increment reference counting.
 369  *
 370  * \param p_md a media descriptor object
 371  * \return event manager object
 372  */
 373 VLC_PUBLIC_API libvlc_event_manager_t *
 374     libvlc_media_event_manager( libvlc_media_t *p_md );
 375
 376 /**
 377  * Get duration (in ms) of media descriptor object item.
 378  *
 379  * \param p_md media descriptor object
 380  * \return duration of media item or -1 on error
 381  */
 382 VLC_PUBLIC_API libvlc_time_t
 383    libvlc_media_get_duration( libvlc_media_t *p_md );
 384
 385 /**
 386  * Parse a media.
 387  *
 388  * This fetches (local) meta data and tracks information.
 389  * The method is synchronous.
 390  *
 391  * \see libvlc_media_parse_async
 392  * \see libvlc_media_get_meta
 393  * \see libvlc_media_get_tracks_info
 394  *
 395  * \param p_md media descriptor object
 396  */
 397 VLC_PUBLIC_API void
 398 libvlc_media_parse( libvlc_media_t *p_md );
 399
 400 /**
 401  * Parse a media.
 402  *
 403  * This fetches (local) meta data and tracks information.
 404  * The method is the asynchronous of libvlc_media_parse().
 405  *
 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
 408  * event.
 409  *
 410  * \see libvlc_media_parse
 411  * \see libvlc_MediaParsedChanged
 412  * \see libvlc_media_get_meta
 413  * \see libvlc_media_get_tracks_info
 414  *
 415  * \param p_md media descriptor object
 416  */
 417 VLC_PUBLIC_API void
 418 libvlc_media_parse_async( libvlc_media_t *p_md );
 419
 420 /**
 421  * Get Parsed status for media descriptor object.
 422  *
 423  * \see libvlc_MediaParsedChanged
 424  *
 425  * \param p_md media descriptor object
 426  * \return true if media object has been parsed otherwise it returns false
 427  */
 428 VLC_PUBLIC_API int
 429    libvlc_media_is_parsed( libvlc_media_t *p_md );
 430
 431 /**
 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
 435  *
 436  * \param p_md media descriptor object
 437  * \param p_new_user_data pointer to user data
 438  */
 439 VLC_PUBLIC_API void
 440     libvlc_media_set_user_data( libvlc_media_t *p_md, void *p_new_user_data );
 441
 442 /**
 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
 446  *
 447  * \param p_md media descriptor object
 448  */
 449 VLC_PUBLIC_API void *libvlc_media_get_user_data( libvlc_media_t *p_md );
 450
 451 /**
 452  * Get media descriptor's elementary streams description
 453  *
 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:
 457  *
 458  * @begincode
 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);
 464  * @endcode
 465  *
 466  * This is very likely to change in next release, and be done at the parsing
 467  * phase.
 468  *
 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)
 472  *
 473  * return the number of Elementary Streams
 474  */
 475 VLC_PUBLIC_API
 476 int libvlc_media_get_tracks_info( libvlc_media_t *p_md,
 477                                   libvlc_media_track_info_t **tracks );
 478
 479 /** @}*/
 480
 481 # ifdef __cplusplus
 482 }
 483 # endif
 484
 485 #endif /* VLC_LIBVLC_MEDIA_H */