]> git.sesse.net Git - vlc/blobdiff - include/vlc/libvlc_media.h
LibVLC media: remove exceptions
[vlc] / include / vlc / libvlc_media.h
index c3cd38d045fd20f6ef8023977b92613637ff5fb1..9d9d810969bf7d631d75e989f34dc82b71413d25 100644 (file)
 #ifndef VLC_LIBVLC_MEDIA_H
 #define VLC_LIBVLC_MEDIA_H 1
 
+# ifdef __cplusplus
+extern "C" {
+# endif
+
 /*****************************************************************************
  * media
  *****************************************************************************/
@@ -99,31 +103,93 @@ typedef enum libvlc_media_option_t
     libvlc_media_option_unique = 0x100
 } libvlc_media_option_t;
 
+typedef enum libvlc_es_type_t
+{
+    libvlc_es_unknown   = -1,
+    libvlc_es_audio     = 0,
+    libvlc_es_video     = 1,
+    libvlc_es_text      = 2,
+} libvlc_es_type_t;
+
+/** defgroup libvlc_media_stats_t libvlc_media_stats_t
+ * \ingroup libvlc_media
+ * LibVLC Media statistics
+ * @{
+ */
+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;
+/** @}*/
+
+typedef struct libvlc_media_es_t
+{
+    /* Codec fourcc */
+    uint32_t    i_codec;
+    int         i_id;
+    libvlc_es_type_t i_type;
+
+    /* Codec specific */
+    int         i_profile;
+    int         i_level;
+
+    /* Audio specific */
+    unsigned    i_channels;
+    unsigned    i_rate;
+
+    /* Video specific */
+    unsigned    i_height;
+    unsigned    i_width;
+
+} libvlc_media_es_t;
+
+
 /**
  * Create a media with the given MRL.
  *
  * \param p_instance the instance
  * \param psz_mrl the MRL to read
- * \param p_e an initialized exception pointer
- * \return the newly created media
+ * \return the newly created media or NULL on error
  */
 VLC_PUBLIC_API libvlc_media_t * libvlc_media_new(
                                    libvlc_instance_t *p_instance,
-                                   const char * psz_mrl,
-                                   libvlc_exception_t *p_e );
+                                   const char * psz_mrl );
 
 /**
- * Create a media as an empty node with the passed name.
+ * Create a media as an empty node with a given name.
  *
  * \param p_instance the instance
  * \param psz_name the name of the node
- * \param p_e an initialized exception pointer
- * \return the new empty media
+ * \return the new empty media or NULL on error
  */
 VLC_PUBLIC_API libvlc_media_t * libvlc_media_new_as_node(
                                    libvlc_instance_t *p_instance,
-                                   const char * psz_name,
-                                   libvlc_exception_t *p_e );
+                                   const char * psz_name );
 
 /**
  * Add an option to the media.
@@ -134,7 +200,7 @@ VLC_PUBLIC_API libvlc_media_t * libvlc_media_new_as_node(
  *
  * The options are detailed in vlc --long-help, for instance "--sout-all"
  *
- * \param p_instance the instance
+ * \param p_md the media descriptor
  * \param ppsz_options the options (as a string)
  */
 VLC_PUBLIC_API void libvlc_media_add_option(
@@ -150,7 +216,7 @@ VLC_PUBLIC_API void libvlc_media_add_option(
  *
  * The options are detailed in vlc --long-help, for instance "--sout-all"
  *
- * \param p_instance the instance
+ * \param p_md the media descriptor
  * \param ppsz_options the options (as a string)
  * \param i_flags the flags for this option
  */
@@ -165,10 +231,9 @@ VLC_PUBLIC_API void libvlc_media_add_option_flag(
  * libvlc_media_release() to decrement the reference count of a
  * media descriptor object.
  *
- * \param p_meta_desc a media descriptor object.
+ * \param p_md the media descriptor
  */
-VLC_PUBLIC_API void libvlc_media_retain(
-                                   libvlc_media_t *p_meta_desc );
+VLC_PUBLIC_API void libvlc_media_retain( libvlc_media_t *p_md );
 
 /**
  * Decrement the reference count of a media descriptor object. If the
@@ -177,10 +242,9 @@ VLC_PUBLIC_API void libvlc_media_retain(
  * to all listeners. If the media descriptor object has been released it
  * should not be used again.
  *
- * \param p_meta_desc a media descriptor object.
+ * \param p_md the media descriptor
  */
-VLC_PUBLIC_API void libvlc_media_release(
-                                   libvlc_media_t *p_meta_desc );
+VLC_PUBLIC_API void libvlc_media_release( libvlc_media_t *p_md );
 
 
 /**
@@ -196,18 +260,39 @@ VLC_PUBLIC_API char * libvlc_media_get_mrl( libvlc_media_t * p_md );
  *
  * \param p_meta_desc a media descriptor object.
  */
-VLC_PUBLIC_API libvlc_media_t * libvlc_media_duplicate( libvlc_media_t * );
+VLC_PUBLIC_API libvlc_media_t * libvlc_media_duplicate( libvlc_media_t *p_md );
 
 /**
  * Read the meta of the media.
  *
- * \param p_meta_desc the media to read
+ * \param p_md the media descriptor
  * \param e_meta the meta to read
  * \return the media's meta
  */
-VLC_PUBLIC_API char * libvlc_media_get_meta(
-                                   libvlc_media_t *p_meta_desc,
-                                   libvlc_meta_t e_meta );
+VLC_PUBLIC_API char * libvlc_media_get_meta( libvlc_media_t *p_md,
+                                             libvlc_meta_t e_meta );
+
+/**
+ * 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
+ * \param e_meta the meta to write
+ * \param the media's meta
+ */
+VLC_PUBLIC_API void libvlc_media_set_meta( libvlc_media_t *p_md,
+                                           libvlc_meta_t e_meta,
+                                           const char *psz_value );
+
+
+/**
+ * Save the meta previously set
+ *
+ * \param p_md the media desriptor
+ * \return true if the write operation was successfull
+ */
+VLC_PUBLIC_API int libvlc_media_save_meta( libvlc_media_t *p_md );
+
 
 /**
  * Get current state of media descriptor object. Possible media states
@@ -224,6 +309,16 @@ VLC_PUBLIC_API libvlc_state_t libvlc_media_get_state(
                                    libvlc_media_t *p_meta_desc );
 
 
+/**
+ * get the current statistics about the media
+ * @param p_md: media descriptor object
+ * @param p_stats: structure that contain the statistics about the media
+ *                 (this structure must be allocated by the caller)
+ * @return true if the statistics are available, false otherwise
+ */
+VLC_PUBLIC_API int libvlc_media_get_stats( libvlc_media_t *p_md,
+                                           libvlc_media_stats_t *p_stats );
+
 /**
  * Get subitems of media descriptor object. This will increment
  * the reference count of supplied media descriptor object. Use
@@ -254,12 +349,10 @@ VLC_PUBLIC_API libvlc_event_manager_t *
  * Get duration (in ms) of media descriptor object item.
  *
  * \param p_md media descriptor object
- * \param p_e an initialized exception object
- * \return duration of media item
+ * \return duration of media item or -1 on error
  */
 VLC_PUBLIC_API libvlc_time_t
-   libvlc_media_get_duration( libvlc_media_t * p_md,
-                                         libvlc_exception_t * p_e );
+   libvlc_media_get_duration( libvlc_media_t * p_md );
 
 /**
  * Get preparsed status for media descriptor object.
@@ -292,6 +385,25 @@ VLC_PUBLIC_API void
 VLC_PUBLIC_API void *
     libvlc_media_get_user_data( libvlc_media_t * p_md );
 
+/**
+ * Get media descriptor's elementary streams description
+ *
+ * Note, you need to play the media _one_ time with --sout="#description"
+ * Not doing this will result in an empty array, and doing it more than once
+ * will duplicate the entries in the array each time.
+ *
+ * \param p_md media descriptor object
+ * \param pp_es adress to store an allocated array of Elementary Streams descriptions (must be freed by the caller)
+ *
+ * return the number of Elementary Streams
+ */
+VLC_PUBLIC_API int
+    libvlc_media_get_es( libvlc_media_t * p_md, libvlc_media_es_t ** pp_es );
+
 /** @}*/
 
+# ifdef __cplusplus
+}
+# endif
+
 #endif /* VLC_LIBVLC_MEDIA_H */