libvlc_media.h 27.6 KB
Newer Older
1
/*****************************************************************************
Pere Orga's avatar
Pere Orga committed
2
 * libvlc_media.h:  libvlc external API
3
 *****************************************************************************
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
4
 * Copyright (C) 1998-2009 VLC authors and VideoLAN
5 6 7 8 9 10
 * $Id$
 *
 * Authors: Clément Stenac <zorglub@videolan.org>
 *          Jean-Paul Saman <jpsaman@videolan.org>
 *          Pierre d'Herbemont <pdherbemont@videolan.org>
 *
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
11 12 13
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
14 15 16 17
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
18 19
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
20
 *
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
21 22 23
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24 25 26 27 28
 *****************************************************************************/

#ifndef VLC_LIBVLC_MEDIA_H
#define VLC_LIBVLC_MEDIA_H 1

29 30 31 32
# ifdef __cplusplus
extern "C" {
# endif

33
/** \defgroup libvlc_media LibVLC media
34
 * \ingroup libvlc
35 36
 * @ref libvlc_media_t is an abstract representation of a playable media.
 * It consists of a media location and various optional meta data.
37
 * @{
38 39
 * \file
 * LibVLC media item/descriptor external API
40 41 42 43
 */

typedef struct libvlc_media_t libvlc_media_t;

44
/** Meta data types */
45
typedef enum libvlc_meta_t {
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
    libvlc_meta_Title,
    libvlc_meta_Artist,
    libvlc_meta_Genre,
    libvlc_meta_Copyright,
    libvlc_meta_Album,
    libvlc_meta_TrackNumber,
    libvlc_meta_Description,
    libvlc_meta_Rating,
    libvlc_meta_Date,
    libvlc_meta_Setting,
    libvlc_meta_URL,
    libvlc_meta_Language,
    libvlc_meta_NowPlaying,
    libvlc_meta_Publisher,
    libvlc_meta_EncodedBy,
    libvlc_meta_ArtworkURL,
62 63 64 65 66 67
    libvlc_meta_TrackID,
    libvlc_meta_TrackTotal,
    libvlc_meta_Director,
    libvlc_meta_Season,
    libvlc_meta_Episode,
    libvlc_meta_ShowName,
68
    libvlc_meta_Actors,
69
    libvlc_meta_AlbumArtist,
70 71
    libvlc_meta_DiscNumber,
    libvlc_meta_DiscTotal
72
    /* Add new meta types HERE */
73
} libvlc_meta_t;
74 75 76

/**
 * Note the order of libvlc_state_t enum must match exactly the order of
77
 * \see mediacontrol_PlayerStatus, \see input_state_e enums,
78 79 80
 * and VideoLAN.LibVLC.State (at bindings/cil/src/media.cs).
 *
 * Expected states by web plugins are:
81
 * IDLE/CLOSE=0, OPENING=1, PLAYING=3, PAUSED=4,
82 83
 * STOPPING=5, ENDED=6, ERROR=7
 */
84
typedef enum libvlc_state_t
85 86 87
{
    libvlc_NothingSpecial=0,
    libvlc_Opening,
88 89 90
    libvlc_Buffering, /* XXX: Deprecated value. Check the
                       * libvlc_MediaPlayerBuffering event to know the
                       * buffering state of a libvlc_media_player */
91 92 93 94 95
    libvlc_Playing,
    libvlc_Paused,
    libvlc_Stopped,
    libvlc_Ended,
    libvlc_Error
96
} libvlc_state_t;
97

98
enum
99 100 101
{
    libvlc_media_option_trusted = 0x2,
    libvlc_media_option_unique = 0x100
102
};
103

104
typedef enum libvlc_track_type_t
105
{
106 107 108
    libvlc_track_unknown   = -1,
    libvlc_track_audio     = 0,
    libvlc_track_video     = 1,
109
    libvlc_track_text      = 2
110
} libvlc_track_type_t;
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141

typedef struct libvlc_media_stats_t
{
    /* Input */
    int         i_read_bytes;
    float       f_input_bitrate;

    /* Demux */
    int         i_demux_read_bytes;
    float       f_demux_bitrate;
    int         i_demux_corrupted;
    int         i_demux_discontinuity;

    /* Decoders */
    int         i_decoded_video;
    int         i_decoded_audio;

    /* Video Output */
    int         i_displayed_pictures;
    int         i_lost_pictures;

    /* Audio output */
    int         i_played_abuffers;
    int         i_lost_abuffers;

    /* Stream output */
    int         i_sent_packets;
    int         i_sent_bytes;
    float       f_send_bitrate;
} libvlc_media_stats_t;

142
typedef struct libvlc_media_track_info_t
143 144 145
{
    /* Codec fourcc */
    uint32_t    i_codec;
146
    int         i_id;
147
    libvlc_track_type_t i_type;
148 149 150 151 152

    /* Codec specific */
    int         i_profile;
    int         i_level;

153 154 155 156 157 158 159 160 161 162 163 164
    union {
        struct {
            /* Audio specific */
            unsigned    i_channels;
            unsigned    i_rate;
        } audio;
        struct {
            /* Video specific */
            unsigned    i_height;
            unsigned    i_width;
        } video;
    } u;
165

166
} libvlc_media_track_info_t;
167

168

169 170 171 172 173 174
typedef struct libvlc_audio_track_t
{
    unsigned    i_channels;
    unsigned    i_rate;
} libvlc_audio_track_t;

175 176 177 178 179 180 181 182 183 184 185 186
typedef enum libvlc_video_orient_t
{
    libvlc_video_orient_top_left,       /**< Normal. Top line represents top, left column left. */
    libvlc_video_orient_top_right,      /**< Flipped horizontally */
    libvlc_video_orient_bottom_left,    /**< Flipped vertically */
    libvlc_video_orient_bottom_right,   /**< Rotated 180 degrees */
    libvlc_video_orient_left_top,       /**< Transposed */
    libvlc_video_orient_left_bottom,    /**< Rotated 90 degrees clockwise (or 270 anti-clockwise) */
    libvlc_video_orient_right_top,      /**< Rotated 90 degrees anti-clockwise */
    libvlc_video_orient_right_bottom    /**< Anti-transposed */
} libvlc_video_orient_t;

187 188 189 190 191 192 193 194
typedef enum libvlc_video_projection_t
{
    libvlc_video_projection_rectangular,
    libvlc_video_projection_equirectangular, /**< 360 spherical */

    libvlc_video_projection_cubemap_layout_standard = 0x100,
} libvlc_video_projection_t;

195 196 197 198 199 200 201 202
typedef struct libvlc_video_track_t
{
    unsigned    i_height;
    unsigned    i_width;
    unsigned    i_sar_num;
    unsigned    i_sar_den;
    unsigned    i_frame_rate_num;
    unsigned    i_frame_rate_den;
203 204

    libvlc_video_orient_t       i_orientation;
205 206 207 208 209 210 211
    libvlc_video_projection_t   i_projection;
    struct {
        float f_yaw_degrees;    /**< View point yaw in degrees ]-180;180] */
        float f_pitch_degrees;  /**< View point pitch in degrees ]-90;90] */
        float f_roll_degrees;   /**< View point roll in degrees ]-180;180] */
        float f_fov_degrees;    /**< View point fov in degrees ]0;180[ */
    } pose; /**< Initial view point */
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242
} libvlc_video_track_t;

typedef struct libvlc_subtitle_track_t
{
    char *psz_encoding;
} libvlc_subtitle_track_t;

typedef struct libvlc_media_track_t
{
    /* Codec fourcc */
    uint32_t    i_codec;
    uint32_t    i_original_fourcc;
    int         i_id;
    libvlc_track_type_t i_type;

    /* Codec specific */
    int         i_profile;
    int         i_level;

    union {
        libvlc_audio_track_t *audio;
        libvlc_video_track_t *video;
        libvlc_subtitle_track_t *subtitle;
    };

    unsigned int i_bitrate;
    char *psz_language;
    char *psz_description;

} libvlc_media_track_t;

243 244 245 246 247 248 249 250 251 252 253 254 255 256
/**
 * Media type
 *
 * \see libvlc_media_get_type
 */
typedef enum libvlc_media_type_t {
    libvlc_media_type_unknown,
    libvlc_media_type_file,
    libvlc_media_type_directory,
    libvlc_media_type_disc,
    libvlc_media_type_stream,
    libvlc_media_type_playlist,
} libvlc_media_type_t;

257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
/**
 * Parse flags used by libvlc_media_parse_with_options()
 *
 * \see libvlc_media_parse_with_options
 */
typedef enum libvlc_media_parse_flag_t
{
    /**
     * Parse media if it's a local file
     */
    libvlc_media_parse_local    = 0x00,
    /**
     * Parse media even if it's a network file
     */
    libvlc_media_parse_network  = 0x01,
    /**
     * Fetch meta and covert art using local resources
     */
    libvlc_media_fetch_local    = 0x02,
    /**
     * Fetch meta and covert art using network resources
     */
    libvlc_media_fetch_network  = 0x04,
280 281 282 283 284 285
    /**
     * Interact with the user (via libvlc_dialog_cbs) when preparsing this item
     * (and not its sub items). Set this flag in order to receive a callback
     * when the input is asking for credentials.
     */
    libvlc_media_do_interact    = 0x08,
286
} libvlc_media_parse_flag_t;
287

288
/**
289 290
 * Parse status used sent by libvlc_media_parse_with_options() or returned by
 * libvlc_media_get_parsed_status()
291 292
 *
 * \see libvlc_media_parse_with_options
293
 * \see libvlc_media_get_parsed_status
294 295 296
 */
typedef enum libvlc_media_parsed_status_t
{
297
    libvlc_media_parsed_status_skipped = 1,
298
    libvlc_media_parsed_status_failed,
299
    libvlc_media_parsed_status_timeout,
300
    libvlc_media_parsed_status_done,
301 302
} libvlc_media_parsed_status_t;

303 304 305
/**
 * Type of a media slave: subtitle or audio.
 */
306
typedef enum libvlc_media_slave_type_t
307 308 309 310 311 312 313 314 315
{
    libvlc_media_slave_type_subtitle,
    libvlc_media_slave_type_audio,
} libvlc_media_slave_type_t;

/**
 * A slave of a libvlc_media_t
 * \see libvlc_media_slaves_get
 */
316
typedef struct libvlc_media_slave_t
317
{
318
    char *                          psz_uri;
319 320 321 322
    libvlc_media_slave_type_t       i_type;
    unsigned int                    i_priority;
} libvlc_media_slave_t;

323 324 325 326 327 328
/**
 * Callback prototype to open a custom bitstream input media.
 *
 * The same media item can be opened multiple times. Each time, this callback
 * is invoked. It should allocate and initialize any instance-specific
 * resources, then store them in *datap. The instance resources can be freed
329
 * in the @ref libvlc_media_close_cb callback.
330 331 332
 *
 * \param opaque private pointer as passed to libvlc_media_new_callbacks()
 * \param datap storage space for a private data pointer [OUT]
333
 * \param sizep byte length of the bitstream or UINT64_MAX if unknown [OUT]
334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380
 *
 * \note For convenience, *datap is initially NULL and *sizep is initially 0.
 *
 * \return 0 on success, non-zero on error. In case of failure, the other
 * callbacks will not be invoked and any value stored in *datap and *sizep is
 * discarded.
 */
typedef int (*libvlc_media_open_cb)(void *opaque, void **datap,
                                    uint64_t *sizep);

/**
 * Callback prototype to read data from a custom bitstream input media.
 *
 * \param opaque private pointer as set by the @ref libvlc_media_open_cb
 *               callback
 * \param buf start address of the buffer to read data into
 * \param len bytes length of the buffer
 *
 * \return strictly positive number of bytes read, 0 on end-of-stream,
 *         or -1 on non-recoverable error
 *
 * \note If no data is immediately available, then the callback should sleep.
 * \warning The application is responsible for avoiding deadlock situations.
 * In particular, the callback should return an error if playback is stopped;
 * if it does not return, then libvlc_media_player_stop() will never return.
 */
typedef ssize_t (*libvlc_media_read_cb)(void *opaque, unsigned char *buf,
                                        size_t len);

/**
 * Callback prototype to seek a custom bitstream input media.
 *
 * \param opaque private pointer as set by the @ref libvlc_media_open_cb
 *               callback
 * \param offset absolute byte offset to seek to
 * \return 0 on success, -1 on error.
 */
typedef int (*libvlc_media_seek_cb)(void *opaque, uint64_t offset);

/**
 * Callback prototype to close a custom bitstream input media.
 *
 * \param opaque private pointer as set by the @ref libvlc_media_open_cb
 *               callback
 */
typedef void (*libvlc_media_close_cb)(void *opaque);

381
/**
382 383 384 385 386 387 388
 * Create a media with a certain given media resource location,
 * for instance a valid URL.
 *
 * \note To refer to a local file with this function,
 * the file://... URI syntax <b>must</b> be used (see IETF RFC3986).
 * We recommend using libvlc_media_new_path() instead when dealing with
 * local files.
389
 *
390 391
 * \see libvlc_media_release
 *
392
 * \param p_instance the instance
393
 * \param psz_mrl the media location
394
 * \return the newly created media or NULL on error
395
 */
396
LIBVLC_API libvlc_media_t *libvlc_media_new_location(
397
                                   libvlc_instance_t *p_instance,
398
                                   const char * psz_mrl );
399

400
/**
401
 * Create a media for a certain file path.
402
 *
403 404
 * \see libvlc_media_release
 *
405 406 407 408
 * \param p_instance the instance
 * \param path local filesystem path
 * \return the newly created media or NULL on error
 */
409
LIBVLC_API libvlc_media_t *libvlc_media_new_path(
410 411 412
                                   libvlc_instance_t *p_instance,
                                   const char *path );

413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436
/**
 * Create a media for an already open file descriptor.
 * The file descriptor shall be open for reading (or reading and writing).
 *
 * Regular file descriptors, pipe read descriptors and character device
 * descriptors (including TTYs) are supported on all platforms.
 * Block device descriptors are supported where available.
 * Directory descriptors are supported on systems that provide fdopendir().
 * Sockets are supported on all platforms where they are file descriptors,
 * i.e. all except Windows.
 *
 * \note This library will <b>not</b> automatically close the file descriptor
 * under any circumstance. Nevertheless, a file descriptor can usually only be
 * rendered once in a media player. To render it a second time, the file
 * descriptor should probably be rewound to the beginning with lseek().
 *
 * \see libvlc_media_release
 *
 * \version LibVLC 1.1.5 and later.
 *
 * \param p_instance the instance
 * \param fd open file descriptor
 * \return the newly created media or NULL on error
 */
437
LIBVLC_API libvlc_media_t *libvlc_media_new_fd(
438 439 440
                                   libvlc_instance_t *p_instance,
                                   int fd );

441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473
/**
 * Create a media with custom callbacks to read the data from.
 *
 * \param instance LibVLC instance
 * \param open_cb callback to open the custom bitstream input media
 * \param read_cb callback to read data (must not be NULL)
 * \param seek_cb callback to seek, or NULL if seeking is not supported
 * \param close_cb callback to close the media, or NULL if unnecessary
 * \param opaque data pointer for the open callback
 *
 * \return the newly created media or NULL on error
 *
 * \note If open_cb is NULL, the opaque pointer will be passed to read_cb,
 * seek_cb and close_cb, and the stream size will be treated as unknown.
 *
 * \note The callbacks may be called asynchronously (from another thread).
 * A single stream instance need not be reentrant. However the open_cb needs to
 * be reentrant if the media is used by multiple player instances.
 *
 * \warning The callbacks may be used until all or any player instances
 * that were supplied the media item are stopped.
 *
 * \see libvlc_media_release
 *
 * \version LibVLC 3.0.0 and later.
 */
LIBVLC_API libvlc_media_t *libvlc_media_new_callbacks(
                                   libvlc_instance_t *instance,
                                   libvlc_media_open_cb open_cb,
                                   libvlc_media_read_cb read_cb,
                                   libvlc_media_seek_cb seek_cb,
                                   libvlc_media_close_cb close_cb,
                                   void *opaque );
474

475
/**
476
 * Create a media as an empty node with a given name.
477
 *
478 479
 * \see libvlc_media_release
 *
480 481
 * \param p_instance the instance
 * \param psz_name the name of the node
482
 * \return the new empty media or NULL on error
483
 */
484
LIBVLC_API libvlc_media_t *libvlc_media_new_as_node(
485
                                   libvlc_instance_t *p_instance,
486
                                   const char * psz_name );
487 488 489 490 491 492 493 494

/**
 * Add an option to the media.
 *
 * This option will be used to determine how the media_player will
 * read the media. This allows to use VLC's advanced
 * reading/streaming options on a per-media basis.
 *
495 496 497 498 499 500 501
 * \note The options are listed in 'vlc --long-help' from the command line,
 * e.g. "-sout-all". Keep in mind that available options and their semantics
 * vary across LibVLC versions and builds.
 * \warning Not all options affects libvlc_media_t objects:
 * Specifically, due to architectural issues most audio and video options,
 * such as text renderer options, have no effects on an individual media.
 * These options must be set through libvlc_new() instead.
502
 *
503
 * \param p_md the media descriptor
Olivier Aubert's avatar
Olivier Aubert committed
504
 * \param psz_options the options (as a string)
505
 */
506
LIBVLC_API void libvlc_media_add_option(
507
                                   libvlc_media_t *p_md,
Olivier Aubert's avatar
Olivier Aubert committed
508
                                   const char * psz_options );
509

510
/**
511
 * Add an option to the media with configurable flags.
512 513 514 515 516
 *
 * This option will be used to determine how the media_player will
 * read the media. This allows to use VLC's advanced
 * reading/streaming options on a per-media basis.
 *
517 518 519 520 521
 * The options are detailed in vlc --long-help, for instance
 * "--sout-all". Note that all options are not usable on medias:
 * specifically, due to architectural issues, video-related options
 * such as text renderer options cannot be set on a single media. They
 * must be set on the whole libvlc instance instead.
522
 *
523
 * \param p_md the media descriptor
Olivier Aubert's avatar
Olivier Aubert committed
524
 * \param psz_options the options (as a string)
525
 * \param i_flags the flags for this option
526
 */
527
LIBVLC_API void libvlc_media_add_option_flag(
528
                                   libvlc_media_t *p_md,
Olivier Aubert's avatar
Olivier Aubert committed
529
                                   const char * psz_options,
530
                                   unsigned i_flags );
531 532 533 534 535 536 537


/**
 * Retain a reference to a media descriptor object (libvlc_media_t). Use
 * libvlc_media_release() to decrement the reference count of a
 * media descriptor object.
 *
538
 * \param p_md the media descriptor
539
 */
540
LIBVLC_API void libvlc_media_retain( libvlc_media_t *p_md );
541 542 543 544 545 546 547 548

/**
 * Decrement the reference count of a media descriptor object. If the
 * reference count is 0, then libvlc_media_release() will release the
 * media descriptor object. It will send out an libvlc_MediaFreed event
 * to all listeners. If the media descriptor object has been released it
 * should not be used again.
 *
549
 * \param p_md the media descriptor
550
 */
551
LIBVLC_API void libvlc_media_release( libvlc_media_t *p_md );
552 553 554 555 556 557 558 559


/**
 * Get the media resource locator (mrl) from a media descriptor object
 *
 * \param p_md a media descriptor object
 * \return string with mrl of media descriptor object
 */
560
LIBVLC_API char *libvlc_media_get_mrl( libvlc_media_t *p_md );
561 562 563 564

/**
 * Duplicate a media descriptor object.
 *
565
 * \param p_md a media descriptor object.
566
 */
567
LIBVLC_API libvlc_media_t *libvlc_media_duplicate( libvlc_media_t *p_md );
568 569 570 571

/**
 * Read the meta of the media.
 *
572 573 574
 * If the media has not yet been parsed this will return NULL.
 *
 * \see libvlc_media_parse
575
 * \see libvlc_media_parse_with_options
576 577
 * \see libvlc_MediaMetaChanged
 *
578
 * \param p_md the media descriptor
579
 * \param e_meta the meta to read
580 581
 * \return the media's meta
 */
582
LIBVLC_API char *libvlc_media_get_meta( libvlc_media_t *p_md,
583
                                             libvlc_meta_t e_meta );
584

585 586 587 588 589
/**
 * Set the meta of the media (this function will not save the meta, call
 * libvlc_media_save_meta in order to save the meta)
 *
 * \param p_md the media descriptor
590
 * \param e_meta the meta to write
591
 * \param psz_value the media's meta
592
 */
593
LIBVLC_API void libvlc_media_set_meta( libvlc_media_t *p_md,
594 595 596 597 598 599 600 601
                                           libvlc_meta_t e_meta,
                                           const char *psz_value );


/**
 * Save the meta previously set
 *
 * \param p_md the media desriptor
602
 * \return true if the write operation was successful
603
 */
604
LIBVLC_API int libvlc_media_save_meta( libvlc_media_t *p_md );
605 606


607
/**
608 609 610
 * Get current state of media descriptor object. Possible media states are
 * libvlc_NothingSpecial=0, libvlc_Opening, libvlc_Playing, libvlc_Paused,
 * libvlc_Stopped, libvlc_Ended, libvlc_Error.
611
 *
612 613
 * \see libvlc_state_t
 * \param p_md a media descriptor object
614 615
 * \return state of media descriptor object
 */
616
LIBVLC_API libvlc_state_t libvlc_media_get_state(
617
                                   libvlc_media_t *p_md );
618 619


620
/**
621 622 623
 * Get the current statistics about the media
 * \param p_md: media descriptor object
 * \param p_stats: structure that contain the statistics about the media
624
 *                 (this structure must be allocated by the caller)
625
 * \return true if the statistics are available, false otherwise
626 627
 *
 * \libvlc_return_bool
628
 */
629
LIBVLC_API int libvlc_media_get_stats( libvlc_media_t *p_md,
630 631
                                           libvlc_media_stats_t *p_stats );

632 633 634 635
/* The following method uses libvlc_media_list_t, however, media_list usage is optionnal
 * and this is here for convenience */
#define VLC_FORWARD_DECLARE_OBJECT(a) struct a

636 637 638 639 640 641 642 643
/**
 * Get subitems of media descriptor object. This will increment
 * the reference count of supplied media descriptor object. Use
 * libvlc_media_list_release() to decrement the reference counting.
 *
 * \param p_md media descriptor object
 * \return list of media descriptor subitems or NULL
 */
644
LIBVLC_API VLC_FORWARD_DECLARE_OBJECT(libvlc_media_list_t *)
645
libvlc_media_subitems( libvlc_media_t *p_md );
646 647 648 649 650 651 652 653

/**
 * Get event manager from media descriptor object.
 * NOTE: this function doesn't increment reference counting.
 *
 * \param p_md a media descriptor object
 * \return event manager object
 */
654
LIBVLC_API libvlc_event_manager_t *
655
    libvlc_media_event_manager( libvlc_media_t *p_md );
656 657

/**
658
 * Get duration (in ms) of media descriptor object item.
659 660
 *
 * \param p_md media descriptor object
661
 * \return duration of media item or -1 on error
662
 */
663
LIBVLC_API libvlc_time_t
664
   libvlc_media_get_duration( libvlc_media_t *p_md );
665

666 667 668 669
/**
 * Parse the media asynchronously with options.
 *
 * This fetches (local or network) art, meta data and/or tracks information.
670
 * This method is the extended version of libvlc_media_parse_with_options().
671
 *
672
 * To track when this is over you can listen to libvlc_MediaParsedChanged
673 674
 * event. However if this functions returns an error, you will not receive any
 * events.
675 676 677 678 679
 *
 * It uses a flag to specify parse options (see libvlc_media_parse_flag_t). All
 * these flags can be combined. By default, media is parsed if it's a local
 * file.
 *
680 681
 * \note Parsing can be aborted with libvlc_media_parse_stop().
 *
682
 * \see libvlc_MediaParsedChanged
683 684
 * \see libvlc_media_get_meta
 * \see libvlc_media_tracks_get
685
 * \see libvlc_media_get_parsed_status
686 687 688 689
 * \see libvlc_media_parse_flag_t
 *
 * \param p_md media descriptor object
 * \param parse_flag parse options:
690 691 692
 * \param timeout maximum time allowed to preparse the media. If -1, the
 * default "preparse-timeout" option will be used as a timeout. If 0, it will
 * wait indefinitely. If > 0, the timeout will be used (in milliseconds).
693 694 695 696 697
 * \return -1 in case of error, 0 otherwise
 * \version LibVLC 3.0.0 or later
 */
LIBVLC_API int
libvlc_media_parse_with_options( libvlc_media_t *p_md,
698 699
                                 libvlc_media_parse_flag_t parse_flag,
                                 int timeout );
700

701 702 703 704 705 706 707 708 709 710 711 712 713 714
/**
 * Stop the parsing of the media
 *
 * When the media parsing is stopped, the libvlc_MediaParsedChanged event will
 * be sent with the libvlc_media_parsed_status_timeout status.
 *
 * \see libvlc_media_parse_with_options
 *
 * \param p_md media descriptor object
 * \version LibVLC 3.0.0 or later
 */
LIBVLC_API void
libvlc_media_parse_stop( libvlc_media_t *p_md );

715 716 717
/**
 * Get Parsed status for media descriptor object.
 *
718
 * \see libvlc_MediaParsedChanged
719 720 721 722 723 724 725 726 727
 * \see libvlc_media_parsed_status_t
 *
 * \param p_md media descriptor object
 * \return a value of the libvlc_media_parsed_status_t enum
 * \version LibVLC 3.0.0 or later
 */
LIBVLC_API libvlc_media_parsed_status_t
   libvlc_media_get_parsed_status( libvlc_media_t *p_md );

728 729 730 731 732 733 734 735
/**
 * Sets media descriptor's user_data. user_data is specialized data
 * accessed by the host application, VLC.framework uses it as a pointer to
 * an native object that references a libvlc_media_t pointer
 *
 * \param p_md media descriptor object
 * \param p_new_user_data pointer to user data
 */
736
LIBVLC_API void
737
    libvlc_media_set_user_data( libvlc_media_t *p_md, void *p_new_user_data );
738 739 740 741 742 743 744 745

/**
 * Get media descriptor's user_data. user_data is specialized data
 * accessed by the host application, VLC.framework uses it as a pointer to
 * an native object that references a libvlc_media_t pointer
 *
 * \param p_md media descriptor object
 */
746
LIBVLC_API void *libvlc_media_get_user_data( libvlc_media_t *p_md );
747

748 749 750 751 752 753 754 755 756 757 758 759 760 761
/**
 * Get media descriptor's elementary streams description
 *
 * Note, you need to call libvlc_media_parse() or play the media at least once
 * before calling this function.
 * Not doing this will result in an empty array.
 *
 * \version LibVLC 2.1.0 and later.
 *
 * \param p_md media descriptor object
 * \param tracks address to store an allocated array of Elementary Streams
 *        descriptions (must be freed with libvlc_media_tracks_release
          by the caller) [OUT]
 *
762
 * \return the number of Elementary Streams (zero on error)
763 764
 */
LIBVLC_API
765 766
unsigned libvlc_media_tracks_get( libvlc_media_t *p_md,
                                  libvlc_media_track_t ***tracks );
767

768 769 770 771 772 773 774 775 776 777 778 779 780 781 782
/**
 * Get codec description from media elementary stream
 *
 * \version LibVLC 3.0.0 and later.
 *
 * \see libvlc_media_track_t
 *
 * \param i_type i_type from libvlc_media_track_t
 * \param i_codec i_codec or i_original_fourcc from libvlc_media_track_t
 *
 * \return codec description
 */
LIBVLC_API
const char *libvlc_media_get_codec_description( libvlc_track_type_t i_type,
                                                uint32_t i_codec );
783 784 785 786 787 788 789 790 791 792 793

/**
 * Release media descriptor's elementary streams description array
 *
 * \version LibVLC 2.1.0 and later.
 *
 * \param p_tracks tracks info array to release
 * \param i_count number of elements in the array
 */
LIBVLC_API
void libvlc_media_tracks_release( libvlc_media_track_t **p_tracks,
794
                                  unsigned i_count );
795

796 797 798 799 800 801 802 803 804 805 806 807 808 809
/**
 * Get the media type of the media descriptor object
 *
 * \version LibVLC 3.0.0 and later.
 *
 * \see libvlc_media_type_t
 *
 * \param p_md media descriptor object
 *
 * \return media type
 */
LIBVLC_API
libvlc_media_type_t libvlc_media_get_type( libvlc_media_t *p_md );

810 811 812 813 814 815 816 817 818 819 820 821 822 823 824
/**
 * Add a slave to the current media.
 *
 * A slave is an external input source that may contains an additional subtitle
 * track (like a .srt) or an additional audio track (like a .ac3).
 *
 * \note This function must be called before the media is parsed (via
 * libvlc_media_parse_with_options()) or before the media is played (via
 * libvlc_media_player_play())
 *
 * \version LibVLC 3.0.0 and later.
 *
 * \param p_md media descriptor object
 * \param i_type subtitle or audio
 * \param i_priority from 0 (low priority) to 4 (high priority)
825
 * \param psz_uri Uri of the slave (should contain a valid scheme).
826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878
 *
 * \return 0 on success, -1 on error.
 */
LIBVLC_API
int libvlc_media_slaves_add( libvlc_media_t *p_md,
                             libvlc_media_slave_type_t i_type,
                             unsigned int i_priority,
                             const char *psz_uri );

/**
 * Clear all slaves previously added by libvlc_media_slaves_add() or
 * internally.
 *
 * \version LibVLC 3.0.0 and later.
 *
 * \param p_md media descriptor object
 */
LIBVLC_API
void libvlc_media_slaves_clear( libvlc_media_t *p_md );

/**
 * Get a media descriptor's slave list
 *
 * The list will contain slaves parsed by VLC or previously added by
 * libvlc_media_slaves_add(). The typical use case of this function is to save
 * a list of slave in a database for a later use.
 *
 * \version LibVLC 3.0.0 and later.
 *
 * \see libvlc_media_slaves_add
 *
 * \param p_md media descriptor object
 * \param ppp_slaves address to store an allocated array of slaves (must be
 * freed with libvlc_media_slaves_release()) [OUT]
 *
 * \return the number of slaves (zero on error)
 */
LIBVLC_API
unsigned int libvlc_media_slaves_get( libvlc_media_t *p_md,
                                      libvlc_media_slave_t ***ppp_slaves );

/**
 * Release a media descriptor's slave list
 *
 * \version LibVLC 3.0.0 and later.
 *
 * \param pp_slaves slave array to release
 * \param i_count number of elements in the array
 */
LIBVLC_API
void libvlc_media_slaves_release( libvlc_media_slave_t **pp_slaves,
                                  unsigned int i_count );

879 880
/** @}*/

881 882 883 884
# ifdef __cplusplus
}
# endif

885
#endif /* VLC_LIBVLC_MEDIA_H */