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 /*****************************************************************************
  39  * media
  40  *****************************************************************************/
  41 /** \defgroup libvlc_media libvlc_media
  42  * \ingroup libvlc
  43  * LibVLC Media
  44  * @{
  45  */
  46
  47 typedef struct libvlc_media_t libvlc_media_t;
  48
  49 /* Meta Handling */
  50 /** defgroup libvlc_meta libvlc_meta
  51  * \ingroup libvlc_media
  52  * LibVLC Media Meta
  53  * @{
  54  */
  55
  56 typedef enum libvlc_meta_t {
  57     libvlc_meta_Title,
  58     libvlc_meta_Artist,
  59     libvlc_meta_Genre,
  60     libvlc_meta_Copyright,
  61     libvlc_meta_Album,
  62     libvlc_meta_TrackNumber,
  63     libvlc_meta_Description,
  64     libvlc_meta_Rating,
  65     libvlc_meta_Date,
  66     libvlc_meta_Setting,
  67     libvlc_meta_URL,
  68     libvlc_meta_Language,
  69     libvlc_meta_NowPlaying,
  70     libvlc_meta_Publisher,
  71     libvlc_meta_EncodedBy,
  72     libvlc_meta_ArtworkURL,
  73     libvlc_meta_TrackID,
  74     /* Add new meta types HERE */
  75 } libvlc_meta_t;
  76
  77 /** @}*/
  78
  79 /**
  80  * Note the order of libvlc_state_t enum must match exactly the order of
  81  * @see mediacontrol_PlayerStatus, @see input_state_e enums,
  82  * and VideoLAN.LibVLC.State (at bindings/cil/src/media.cs).
  83  *
  84  * Expected states by web plugins are:
  85  * IDLE/CLOSE=0, OPENING=1, BUFFERING=2, PLAYING=3, PAUSED=4,
  86  * STOPPING=5, ENDED=6, ERROR=7
  87  */
  88 typedef enum libvlc_state_t
  89 {
  90     libvlc_NothingSpecial=0,
  91     libvlc_Opening,
  92     libvlc_Buffering,
  93     libvlc_Playing,
  94     libvlc_Paused,
  95     libvlc_Stopped,
  96     libvlc_Ended,
  97     libvlc_Error
  98 } libvlc_state_t;
  99
 100 typedef enum libvlc_media_option_t
 101 {
 102     libvlc_media_option_trusted = 0x2,
 103     libvlc_media_option_unique = 0x100
 104 } libvlc_media_option_t;
 105
 106 typedef enum libvlc_es_type_t
 107 {
 108     libvlc_es_unknown   = -1,
 109     libvlc_es_audio     = 0,
 110     libvlc_es_video     = 1,
 111     libvlc_es_text      = 2,
 112 } libvlc_es_type_t;
 113
 114 /** defgroup libvlc_media_stats_t libvlc_media_stats_t
 115  * \ingroup libvlc_media
 116  * LibVLC Media statistics
 117  * @{
 118  */
 119 typedef struct libvlc_media_stats_t
 120 {
 121     /* Input */
 122     int         i_read_bytes;
 123     float       f_input_bitrate;
 124
 125     /* Demux */
 126     int         i_demux_read_bytes;
 127     float       f_demux_bitrate;
 128     int         i_demux_corrupted;
 129     int         i_demux_discontinuity;
 130
 131     /* Decoders */
 132     int         i_decoded_video;
 133     int         i_decoded_audio;
 134
 135     /* Video Output */
 136     int         i_displayed_pictures;
 137     int         i_lost_pictures;
 138
 139     /* Audio output */
 140     int         i_played_abuffers;
 141     int         i_lost_abuffers;
 142
 143     /* Stream output */
 144     int         i_sent_packets;
 145     int         i_sent_bytes;
 146     float       f_send_bitrate;
 147 } libvlc_media_stats_t;
 148 /** @}*/
 149
 150 typedef struct libvlc_media_es_t
 151 {
 152     /* Codec fourcc */
 153     uint32_t    i_codec;
 154     libvlc_es_type_t i_type;
 155
 156     /* Codec specific */
 157     int         i_profile;
 158     int         i_level;
 159
 160     /* Audio specific */
 161     unsigned    i_channels;
 162     unsigned    i_rate;
 163
 164     /* Video specific */
 165     unsigned    i_height;
 166     unsigned    i_width;
 167
 168 } libvlc_media_es_t;
 169
 170
 171 /**
 172  * Create a media with the given MRL.
 173  *
 174  * \param p_instance the instance
 175  * \param psz_mrl the MRL to read
 176  * \param p_e an initialized exception pointer
 177  * \return the newly created media
 178  */
 179 VLC_PUBLIC_API libvlc_media_t * libvlc_media_new(
 180                                    libvlc_instance_t *p_instance,
 181                                    const char * psz_mrl,
 182                                    libvlc_exception_t *p_e );
 183
 184 /**
 185  * Create a media as an empty node with the passed name.
 186  *
 187  * \param p_instance the instance
 188  * \param psz_name the name of the node
 189  * \param p_e an initialized exception pointer
 190  * \return the new empty media
 191  */
 192 VLC_PUBLIC_API libvlc_media_t * libvlc_media_new_as_node(
 193                                    libvlc_instance_t *p_instance,
 194                                    const char * psz_name,
 195                                    libvlc_exception_t *p_e );
 196
 197 /**
 198  * Add an option to the media.
 199  *
 200  * This option will be used to determine how the media_player will
 201  * read the media. This allows to use VLC's advanced
 202  * reading/streaming options on a per-media basis.
 203  *
 204  * The options are detailed in vlc --long-help, for instance "--sout-all"
 205  *
 206  * \param p_md the media descriptor
 207  * \param ppsz_options the options (as a string)
 208  */
 209 VLC_PUBLIC_API void libvlc_media_add_option(
 210                                    libvlc_media_t * p_md,
 211                                    const char * ppsz_options );
 212
 213 /**
 214  * Add an option to the media with configurable flags.
 215  *
 216  * This option will be used to determine how the media_player will
 217  * read the media. This allows to use VLC's advanced
 218  * reading/streaming options on a per-media basis.
 219  *
 220  * The options are detailed in vlc --long-help, for instance "--sout-all"
 221  *
 222  * \param p_md the media descriptor
 223  * \param ppsz_options the options (as a string)
 224  * \param i_flags the flags for this option
 225  */
 226 VLC_PUBLIC_API void libvlc_media_add_option_flag(
 227                                    libvlc_media_t * p_md,
 228                                    const char * ppsz_options,
 229                                    libvlc_media_option_t i_flags );
 230
 231
 232 /**
 233  * Retain a reference to a media descriptor object (libvlc_media_t). Use
 234  * libvlc_media_release() to decrement the reference count of a
 235  * media descriptor object.
 236  *
 237  * \param p_md the media descriptor
 238  */
 239 VLC_PUBLIC_API void libvlc_media_retain( libvlc_media_t *p_md );
 240
 241 /**
 242  * Decrement the reference count of a media descriptor object. If the
 243  * reference count is 0, then libvlc_media_release() will release the
 244  * media descriptor object. It will send out an libvlc_MediaFreed event
 245  * to all listeners. If the media descriptor object has been released it
 246  * should not be used again.
 247  *
 248  * \param p_md the media descriptor
 249  */
 250 VLC_PUBLIC_API void libvlc_media_release( libvlc_media_t *p_md );
 251
 252
 253 /**
 254  * Get the media resource locator (mrl) from a media descriptor object
 255  *
 256  * \param p_md a media descriptor object
 257  * \return string with mrl of media descriptor object
 258  */
 259 VLC_PUBLIC_API char * libvlc_media_get_mrl( libvlc_media_t * p_md );
 260
 261 /**
 262  * Duplicate a media descriptor object.
 263  *
 264  * \param p_meta_desc a media descriptor object.
 265  */
 266 VLC_PUBLIC_API libvlc_media_t * libvlc_media_duplicate( libvlc_media_t *p_md );
 267
 268 /**
 269  * Read the meta of the media.
 270  *
 271  * \param p_md the media descriptor
 272  * \param e_meta the meta to read
 273  * \return the media's meta
 274  */
 275 VLC_PUBLIC_API char * libvlc_media_get_meta( libvlc_media_t *p_md,
 276                                              libvlc_meta_t e_meta );
 277
 278 /**
 279  * Set the meta of the media (this function will not save the meta, call
 280  * libvlc_media_save_meta in order to save the meta)
 281  *
 282  * \param p_md the media descriptor
 283  * \param e_meta the meta to write
 284  * \param the media's meta
 285  */
 286 VLC_PUBLIC_API void libvlc_media_set_meta( libvlc_media_t *p_md,
 287                                            libvlc_meta_t e_meta,
 288                                            const char *psz_value );
 289
 290
 291 /**
 292  * Save the meta previously set
 293  *
 294  * \param p_md the media desriptor
 295  * \return true if the write operation was successfull
 296  */
 297 VLC_PUBLIC_API int libvlc_media_save_meta( libvlc_media_t *p_md );
 298
 299
 300 /**
 301  * Get current state of media descriptor object. Possible media states
 302  * are defined in libvlc_structures.c ( libvlc_NothingSpecial=0,
 303  * libvlc_Opening, libvlc_Buffering, libvlc_Playing, libvlc_Paused,
 304  * libvlc_Stopped, libvlc_Ended,
 305  * libvlc_Error).
 306  *
 307  * @see libvlc_state_t
 308  * \param p_meta_desc a media descriptor object
 309  * \return state of media descriptor object
 310  */
 311 VLC_PUBLIC_API libvlc_state_t libvlc_media_get_state(
 312                                    libvlc_media_t *p_meta_desc );
 313
 314
 315 /**
 316  * get the current statistics about the media
 317  * @param p_md: media descriptor object
 318  * @param p_stats: structure that contain the statistics about the media
 319  *                 (this structure must be allocated by the caller)
 320  * @return true if the statistics are available, false otherwise
 321  */
 322 VLC_PUBLIC_API int libvlc_media_get_stats( libvlc_media_t *p_md,
 323                                            libvlc_media_stats_t *p_stats );
 324
 325 /**
 326  * Get subitems of media descriptor object. This will increment
 327  * the reference count of supplied media descriptor object. Use
 328  * libvlc_media_list_release() to decrement the reference counting.
 329  *
 330  * \param p_md media descriptor object
 331  * \return list of media descriptor subitems or NULL
 332  */
 333
 334 /* This method uses libvlc_media_list_t, however, media_list usage is optionnal
 335  * and this is here for convenience */
 336 #define VLC_FORWARD_DECLARE_OBJECT(a) struct a
 337
 338 VLC_PUBLIC_API VLC_FORWARD_DECLARE_OBJECT(libvlc_media_list_t *)
 339 libvlc_media_subitems( libvlc_media_t *p_md );
 340
 341 /**
 342  * Get event manager from media descriptor object.
 343  * NOTE: this function doesn't increment reference counting.
 344  *
 345  * \param p_md a media descriptor object
 346  * \return event manager object
 347  */
 348 VLC_PUBLIC_API libvlc_event_manager_t *
 349     libvlc_media_event_manager( libvlc_media_t * p_md );
 350
 351 /**
 352  * Get duration (in ms) of media descriptor object item.
 353  *
 354  * \param p_md media descriptor object
 355  * \param p_e an initialized exception object
 356  * \return duration of media item
 357  */
 358 VLC_PUBLIC_API libvlc_time_t
 359    libvlc_media_get_duration( libvlc_media_t * p_md,
 360                                          libvlc_exception_t * p_e );
 361
 362 /**
 363  * Get preparsed status for media descriptor object.
 364  *
 365  * \param p_md media descriptor object
 366  * \return true if media object has been preparsed otherwise it returns false
 367  */
 368 VLC_PUBLIC_API int
 369    libvlc_media_is_preparsed( libvlc_media_t * p_md );
 370
 371 /**
 372  * Sets media descriptor's user_data. user_data is specialized data
 373  * accessed by the host application, VLC.framework uses it as a pointer to
 374  * an native object that references a libvlc_media_t pointer
 375  *
 376  * \param p_md media descriptor object
 377  * \param p_new_user_data pointer to user data
 378  */
 379 VLC_PUBLIC_API void
 380     libvlc_media_set_user_data( libvlc_media_t * p_md,
 381                                            void * p_new_user_data );
 382
 383 /**
 384  * Get media descriptor's user_data. user_data is specialized data
 385  * accessed by the host application, VLC.framework uses it as a pointer to
 386  * an native object that references a libvlc_media_t pointer
 387  *
 388  * \param p_md media descriptor object
 389  */
 390 VLC_PUBLIC_API void *
 391     libvlc_media_get_user_data( libvlc_media_t * p_md );
 392
 393 /**
 394  * Get media descriptor's elementary streams description
 395  *
 396  * Note, you need to play the media _one_ time with --sout="#description"
 397  * Not doing this will result in an empty array, and doing it more than once
 398  * will duplicate the entries in the array each time.
 399  *
 400  * \param p_md media descriptor object
 401  * \param pp_es adress to store an allocated array of Elementary Streams descriptions (must be freed by the caller)
 402  *
 403  * return the number of Elementary Streams
 404  */
 405 VLC_PUBLIC_API int
 406     libvlc_media_get_es( libvlc_media_t * p_md, libvlc_media_es_t ** pp_es );
 407
 408 /** @}*/
 409
 410 # ifdef __cplusplus
 411 }
 412 # endif
 413
 414 #endif /* VLC_LIBVLC_MEDIA_H */