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
 107 /** defgroup libvlc_media_stats_t libvlc_media_stats_t
 108  * \ingroup libvlc_media
 109  * LibVLC Media statistics
 110  * @{
 111  */
 112 typedef struct libvlc_media_stats_t
 113 {
 114     /* Input */
 115     int         i_read_bytes;
 116     float       f_input_bitrate;
 117
 118     /* Demux */
 119     int         i_demux_read_bytes;
 120     float       f_demux_bitrate;
 121     int         i_demux_corrupted;
 122     int         i_demux_discontinuity;
 123
 124     /* Decoders */
 125     int         i_decoded_video;
 126     int         i_decoded_audio;
 127
 128     /* Video Output */
 129     int         i_displayed_pictures;
 130     int         i_lost_pictures;
 131
 132     /* Audio output */
 133     int         i_played_abuffers;
 134     int         i_lost_abuffers;
 135
 136     /* Stream output */
 137     int         i_sent_packets;
 138     int         i_sent_bytes;
 139     float       f_send_bitrate;
 140 } libvlc_media_stats_t;
 141 /** @}*/
 142
 143
 144 /**
 145  * Create a media with the given MRL.
 146  *
 147  * \param p_instance the instance
 148  * \param psz_mrl the MRL to read
 149  * \param p_e an initialized exception pointer
 150  * \return the newly created media
 151  */
 152 VLC_PUBLIC_API libvlc_media_t * libvlc_media_new(
 153                                    libvlc_instance_t *p_instance,
 154                                    const char * psz_mrl,
 155                                    libvlc_exception_t *p_e );
 156
 157 /**
 158  * Create a media as an empty node with the passed name.
 159  *
 160  * \param p_instance the instance
 161  * \param psz_name the name of the node
 162  * \param p_e an initialized exception pointer
 163  * \return the new empty media
 164  */
 165 VLC_PUBLIC_API libvlc_media_t * libvlc_media_new_as_node(
 166                                    libvlc_instance_t *p_instance,
 167                                    const char * psz_name,
 168                                    libvlc_exception_t *p_e );
 169
 170 /**
 171  * Add an option to the media.
 172  *
 173  * This option will be used to determine how the media_player will
 174  * read the media. This allows to use VLC's advanced
 175  * reading/streaming options on a per-media basis.
 176  *
 177  * The options are detailed in vlc --long-help, for instance "--sout-all"
 178  *
 179  * \param p_md the media descriptor
 180  * \param ppsz_options the options (as a string)
 181  */
 182 VLC_PUBLIC_API void libvlc_media_add_option(
 183                                    libvlc_media_t * p_md,
 184                                    const char * ppsz_options );
 185
 186 /**
 187  * Add an option to the media with configurable flags.
 188  *
 189  * This option will be used to determine how the media_player will
 190  * read the media. This allows to use VLC's advanced
 191  * reading/streaming options on a per-media basis.
 192  *
 193  * The options are detailed in vlc --long-help, for instance "--sout-all"
 194  *
 195  * \param p_md the media descriptor
 196  * \param ppsz_options the options (as a string)
 197  * \param i_flags the flags for this option
 198  */
 199 VLC_PUBLIC_API void libvlc_media_add_option_flag(
 200                                    libvlc_media_t * p_md,
 201                                    const char * ppsz_options,
 202                                    libvlc_media_option_t i_flags );
 203
 204
 205 /**
 206  * Retain a reference to a media descriptor object (libvlc_media_t). Use
 207  * libvlc_media_release() to decrement the reference count of a
 208  * media descriptor object.
 209  *
 210  * \param p_md the media descriptor
 211  */
 212 VLC_PUBLIC_API void libvlc_media_retain( libvlc_media_t *p_md );
 213
 214 /**
 215  * Decrement the reference count of a media descriptor object. If the
 216  * reference count is 0, then libvlc_media_release() will release the
 217  * media descriptor object. It will send out an libvlc_MediaFreed event
 218  * to all listeners. If the media descriptor object has been released it
 219  * should not be used again.
 220  *
 221  * \param p_md the media descriptor
 222  */
 223 VLC_PUBLIC_API void libvlc_media_release( libvlc_media_t *p_md );
 224
 225
 226 /**
 227  * Get the media resource locator (mrl) from a media descriptor object
 228  *
 229  * \param p_md a media descriptor object
 230  * \return string with mrl of media descriptor object
 231  */
 232 VLC_PUBLIC_API char * libvlc_media_get_mrl( libvlc_media_t * p_md );
 233
 234 /**
 235  * Duplicate a media descriptor object.
 236  *
 237  * \param p_meta_desc a media descriptor object.
 238  */
 239 VLC_PUBLIC_API libvlc_media_t * libvlc_media_duplicate( libvlc_media_t *p_md );
 240
 241 /**
 242  * Read the meta of the media.
 243  *
 244  * \param p_md the media descriptor
 245  * \param e_meta the meta to read
 246  * \return the media's meta
 247  */
 248 VLC_PUBLIC_API char * libvlc_media_get_meta( libvlc_media_t *p_md,
 249                                              libvlc_meta_t e_meta );
 250
 251 /**
 252  * Set the meta of the media (this function will not save the meta, call
 253  * libvlc_media_save_meta in order to save the meta)
 254  *
 255  * \param p_md the media descriptor
 256  * \param e_meta the meta to write
 257  * \param the media's meta
 258  */
 259 VLC_PUBLIC_API void libvlc_media_set_meta( libvlc_media_t *p_md,
 260                                            libvlc_meta_t e_meta,
 261                                            const char *psz_value );
 262
 263
 264 /**
 265  * Save the meta previously set
 266  *
 267  * \param p_md the media desriptor
 268  * \return true if the write operation was successfull
 269  */
 270 VLC_PUBLIC_API int libvlc_media_save_meta( libvlc_media_t *p_md );
 271
 272
 273 /**
 274  * Get current state of media descriptor object. Possible media states
 275  * are defined in libvlc_structures.c ( libvlc_NothingSpecial=0,
 276  * libvlc_Opening, libvlc_Buffering, libvlc_Playing, libvlc_Paused,
 277  * libvlc_Stopped, libvlc_Ended,
 278  * libvlc_Error).
 279  *
 280  * @see libvlc_state_t
 281  * \param p_meta_desc a media descriptor object
 282  * \return state of media descriptor object
 283  */
 284 VLC_PUBLIC_API libvlc_state_t libvlc_media_get_state(
 285                                    libvlc_media_t *p_meta_desc );
 286
 287
 288 /**
 289  * get the current statistics about the media
 290  * @param p_md: media descriptor object
 291  * @param p_stats: structure that contain the statistics about the media
 292  *                 (this structure must be allocated by the caller)
 293  * @return true if the statistics are available, false otherwise
 294  */
 295 VLC_PUBLIC_API int libvlc_media_get_stats( libvlc_media_t *p_md,
 296                                            libvlc_media_stats_t *p_stats );
 297
 298 /**
 299  * Get subitems of media descriptor object. This will increment
 300  * the reference count of supplied media descriptor object. Use
 301  * libvlc_media_list_release() to decrement the reference counting.
 302  *
 303  * \param p_md media descriptor object
 304  * \return list of media descriptor subitems or NULL
 305  */
 306
 307 /* This method uses libvlc_media_list_t, however, media_list usage is optionnal
 308  * and this is here for convenience */
 309 #define VLC_FORWARD_DECLARE_OBJECT(a) struct a
 310
 311 VLC_PUBLIC_API VLC_FORWARD_DECLARE_OBJECT(libvlc_media_list_t *)
 312 libvlc_media_subitems( libvlc_media_t *p_md );
 313
 314 /**
 315  * Get event manager from media descriptor object.
 316  * NOTE: this function doesn't increment reference counting.
 317  *
 318  * \param p_md a media descriptor object
 319  * \return event manager object
 320  */
 321 VLC_PUBLIC_API libvlc_event_manager_t *
 322     libvlc_media_event_manager( libvlc_media_t * p_md );
 323
 324 /**
 325  * Get duration (in ms) of media descriptor object item.
 326  *
 327  * \param p_md media descriptor object
 328  * \param p_e an initialized exception object
 329  * \return duration of media item
 330  */
 331 VLC_PUBLIC_API libvlc_time_t
 332    libvlc_media_get_duration( libvlc_media_t * p_md,
 333                                          libvlc_exception_t * p_e );
 334
 335 /**
 336  * Get preparsed status for media descriptor object.
 337  *
 338  * \param p_md media descriptor object
 339  * \return true if media object has been preparsed otherwise it returns false
 340  */
 341 VLC_PUBLIC_API int
 342    libvlc_media_is_preparsed( libvlc_media_t * p_md );
 343
 344 /**
 345  * Sets media descriptor's user_data. user_data is specialized data
 346  * accessed by the host application, VLC.framework uses it as a pointer to
 347  * an native object that references a libvlc_media_t pointer
 348  *
 349  * \param p_md media descriptor object
 350  * \param p_new_user_data pointer to user data
 351  */
 352 VLC_PUBLIC_API void
 353     libvlc_media_set_user_data( libvlc_media_t * p_md,
 354                                            void * p_new_user_data );
 355
 356 /**
 357  * Get media descriptor's user_data. user_data is specialized data
 358  * accessed by the host application, VLC.framework uses it as a pointer to
 359  * an native object that references a libvlc_media_t pointer
 360  *
 361  * \param p_md media descriptor object
 362  */
 363 VLC_PUBLIC_API void *
 364     libvlc_media_get_user_data( libvlc_media_t * p_md );
 365
 366 /** @}*/
 367
 368 # ifdef __cplusplus
 369 }
 370 # endif
 371
 372 #endif /* VLC_LIBVLC_MEDIA_H */