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     int         i_id;
 155     libvlc_es_type_t i_type;
 156
 157     /* Codec specific */
 158     int         i_profile;
 159     int         i_level;
 160
 161     /* Audio specific */
 162     unsigned    i_channels;
 163     unsigned    i_rate;
 164
 165     /* Video specific */
 166     unsigned    i_height;
 167     unsigned    i_width;
 168
 169 } libvlc_media_es_t;
 170
 171
 172 /**
 173  * Create a media with the given MRL.
 174  *
 175  * \param p_instance the instance
 176  * \param psz_mrl the MRL to read
 177  * \param p_e an initialized exception pointer
 178  * \return the newly created media
 179  */
 180 VLC_PUBLIC_API libvlc_media_t * libvlc_media_new(
 181                                    libvlc_instance_t *p_instance,
 182                                    const char * psz_mrl,
 183                                    libvlc_exception_t *p_e );
 184
 185 /**
 186  * Create a media as an empty node with the passed name.
 187  *
 188  * \param p_instance the instance
 189  * \param psz_name the name of the node
 190  * \param p_e an initialized exception pointer
 191  * \return the new empty media
 192  */
 193 VLC_PUBLIC_API libvlc_media_t * libvlc_media_new_as_node(
 194                                    libvlc_instance_t *p_instance,
 195                                    const char * psz_name,
 196                                    libvlc_exception_t *p_e );
 197
 198 /**
 199  * Add an option to the media.
 200  *
 201  * This option will be used to determine how the media_player will
 202  * read the media. This allows to use VLC's advanced
 203  * reading/streaming options on a per-media basis.
 204  *
 205  * The options are detailed in vlc --long-help, for instance "--sout-all"
 206  *
 207  * \param p_md the media descriptor
 208  * \param ppsz_options the options (as a string)
 209  */
 210 VLC_PUBLIC_API void libvlc_media_add_option(
 211                                    libvlc_media_t * p_md,
 212                                    const char * ppsz_options );
 213
 214 /**
 215  * Add an option to the media with configurable flags.
 216  *
 217  * This option will be used to determine how the media_player will
 218  * read the media. This allows to use VLC's advanced
 219  * reading/streaming options on a per-media basis.
 220  *
 221  * The options are detailed in vlc --long-help, for instance "--sout-all"
 222  *
 223  * \param p_md the media descriptor
 224  * \param ppsz_options the options (as a string)
 225  * \param i_flags the flags for this option
 226  */
 227 VLC_PUBLIC_API void libvlc_media_add_option_flag(
 228                                    libvlc_media_t * p_md,
 229                                    const char * ppsz_options,
 230                                    libvlc_media_option_t i_flags );
 231
 232
 233 /**
 234  * Retain a reference to a media descriptor object (libvlc_media_t). Use
 235  * libvlc_media_release() to decrement the reference count of a
 236  * media descriptor object.
 237  *
 238  * \param p_md the media descriptor
 239  */
 240 VLC_PUBLIC_API void libvlc_media_retain( libvlc_media_t *p_md );
 241
 242 /**
 243  * Decrement the reference count of a media descriptor object. If the
 244  * reference count is 0, then libvlc_media_release() will release the
 245  * media descriptor object. It will send out an libvlc_MediaFreed event
 246  * to all listeners. If the media descriptor object has been released it
 247  * should not be used again.
 248  *
 249  * \param p_md the media descriptor
 250  */
 251 VLC_PUBLIC_API void libvlc_media_release( libvlc_media_t *p_md );
 252
 253
 254 /**
 255  * Get the media resource locator (mrl) from a media descriptor object
 256  *
 257  * \param p_md a media descriptor object
 258  * \return string with mrl of media descriptor object
 259  */
 260 VLC_PUBLIC_API char * libvlc_media_get_mrl( libvlc_media_t * p_md );
 261
 262 /**
 263  * Duplicate a media descriptor object.
 264  *
 265  * \param p_meta_desc a media descriptor object.
 266  */
 267 VLC_PUBLIC_API libvlc_media_t * libvlc_media_duplicate( libvlc_media_t *p_md );
 268
 269 /**
 270  * Read the meta of the media.
 271  *
 272  * \param p_md the media descriptor
 273  * \param e_meta the meta to read
 274  * \return the media's meta
 275  */
 276 VLC_PUBLIC_API char * libvlc_media_get_meta( libvlc_media_t *p_md,
 277                                              libvlc_meta_t e_meta );
 278
 279 /**
 280  * Set the meta of the media (this function will not save the meta, call
 281  * libvlc_media_save_meta in order to save the meta)
 282  *
 283  * \param p_md the media descriptor
 284  * \param e_meta the meta to write
 285  * \param the media's meta
 286  */
 287 VLC_PUBLIC_API void libvlc_media_set_meta( libvlc_media_t *p_md,
 288                                            libvlc_meta_t e_meta,
 289                                            const char *psz_value );
 290
 291
 292 /**
 293  * Save the meta previously set
 294  *
 295  * \param p_md the media desriptor
 296  * \return true if the write operation was successfull
 297  */
 298 VLC_PUBLIC_API int libvlc_media_save_meta( libvlc_media_t *p_md );
 299
 300
 301 /**
 302  * Get current state of media descriptor object. Possible media states
 303  * are defined in libvlc_structures.c ( libvlc_NothingSpecial=0,
 304  * libvlc_Opening, libvlc_Buffering, libvlc_Playing, libvlc_Paused,
 305  * libvlc_Stopped, libvlc_Ended,
 306  * libvlc_Error).
 307  *
 308  * @see libvlc_state_t
 309  * \param p_meta_desc a media descriptor object
 310  * \return state of media descriptor object
 311  */
 312 VLC_PUBLIC_API libvlc_state_t libvlc_media_get_state(
 313                                    libvlc_media_t *p_meta_desc );
 314
 315
 316 /**
 317  * get the current statistics about the media
 318  * @param p_md: media descriptor object
 319  * @param p_stats: structure that contain the statistics about the media
 320  *                 (this structure must be allocated by the caller)
 321  * @return true if the statistics are available, false otherwise
 322  */
 323 VLC_PUBLIC_API int libvlc_media_get_stats( libvlc_media_t *p_md,
 324                                            libvlc_media_stats_t *p_stats );
 325
 326 /**
 327  * Get subitems of media descriptor object. This will increment
 328  * the reference count of supplied media descriptor object. Use
 329  * libvlc_media_list_release() to decrement the reference counting.
 330  *
 331  * \param p_md media descriptor object
 332  * \return list of media descriptor subitems or NULL
 333  */
 334
 335 /* This method uses libvlc_media_list_t, however, media_list usage is optionnal
 336  * and this is here for convenience */
 337 #define VLC_FORWARD_DECLARE_OBJECT(a) struct a
 338
 339 VLC_PUBLIC_API VLC_FORWARD_DECLARE_OBJECT(libvlc_media_list_t *)
 340 libvlc_media_subitems( libvlc_media_t *p_md );
 341
 342 /**
 343  * Get event manager from media descriptor object.
 344  * NOTE: this function doesn't increment reference counting.
 345  *
 346  * \param p_md a media descriptor object
 347  * \return event manager object
 348  */
 349 VLC_PUBLIC_API libvlc_event_manager_t *
 350     libvlc_media_event_manager( libvlc_media_t * p_md );
 351
 352 /**
 353  * Get duration (in ms) of media descriptor object item.
 354  *
 355  * \param p_md media descriptor object
 356  * \param p_e an initialized exception object
 357  * \return duration of media item
 358  */
 359 VLC_PUBLIC_API libvlc_time_t
 360    libvlc_media_get_duration( libvlc_media_t * p_md,
 361                                          libvlc_exception_t * p_e );
 362
 363 /**
 364  * Get preparsed status for media descriptor object.
 365  *
 366  * \param p_md media descriptor object
 367  * \return true if media object has been preparsed otherwise it returns false
 368  */
 369 VLC_PUBLIC_API int
 370    libvlc_media_is_preparsed( libvlc_media_t * p_md );
 371
 372 /**
 373  * Sets media descriptor's user_data. user_data is specialized data
 374  * accessed by the host application, VLC.framework uses it as a pointer to
 375  * an native object that references a libvlc_media_t pointer
 376  *
 377  * \param p_md media descriptor object
 378  * \param p_new_user_data pointer to user data
 379  */
 380 VLC_PUBLIC_API void
 381     libvlc_media_set_user_data( libvlc_media_t * p_md,
 382                                            void * p_new_user_data );
 383
 384 /**
 385  * Get media descriptor's user_data. user_data is specialized data
 386  * accessed by the host application, VLC.framework uses it as a pointer to
 387  * an native object that references a libvlc_media_t pointer
 388  *
 389  * \param p_md media descriptor object
 390  */
 391 VLC_PUBLIC_API void *
 392     libvlc_media_get_user_data( libvlc_media_t * p_md );
 393
 394 /**
 395  * Get media descriptor's elementary streams description
 396  *
 397  * Note, you need to play the media _one_ time with --sout="#description"
 398  * Not doing this will result in an empty array, and doing it more than once
 399  * will duplicate the entries in the array each time.
 400  *
 401  * \param p_md media descriptor object
 402  * \param pp_es adress to store an allocated array of Elementary Streams descriptions (must be freed by the caller)
 403  *
 404  * return the number of Elementary Streams
 405  */
 406 VLC_PUBLIC_API int
 407     libvlc_media_get_es( libvlc_media_t * p_md, libvlc_media_es_t ** pp_es );
 408
 409 /** @}*/
 410
 411 # ifdef __cplusplus
 412 }
 413 # endif
 414
 415 #endif /* VLC_LIBVLC_MEDIA_H */