]> git.sesse.net Git - vlc/blobdiff - include/vlc/libvlc_media.h
Build fix
[vlc] / include / vlc / libvlc_media.h
index a67778d98aba5b90a81fa9e6843375f44049236f..3eed6053848ad13c7d1f8b787a903e85e990c7b6 100644 (file)
@@ -99,6 +99,44 @@ typedef enum libvlc_media_option_t
     libvlc_media_option_unique = 0x100
 } libvlc_media_option_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;
+/** @}*/
+
+
 /**
  * Create a media with the given MRL.
  *
@@ -134,14 +172,13 @@ 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)
- * \param p_e an initialized exception pointer
  */
 VLC_PUBLIC_API void libvlc_media_add_option(
                                    libvlc_media_t * p_md,
-                                   const char * ppsz_options,
-                                   libvlc_exception_t * p_e );
+                                   const char * ppsz_options );
+
 /**
  * Add an option to the media with configurable flags.
  *
@@ -151,16 +188,14 @@ 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
- * \param p_e an initialized exception pointer
  */
 VLC_PUBLIC_API void libvlc_media_add_option_flag(
                                    libvlc_media_t * p_md,
                                    const char * ppsz_options,
-                                   libvlc_media_option_t i_flags,
-                                   libvlc_exception_t * p_e );
+                                   libvlc_media_option_t i_flags );
 
 
 /**
@@ -168,10 +203,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
@@ -180,41 +214,58 @@ 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 );
 
 
 /**
  * Get the media resource locator (mrl) from a media descriptor object
  *
  * \param p_md a media descriptor object
- * \param p_e an initialized exception object
  * \return string with mrl of media descriptor object
  */
-VLC_PUBLIC_API char * libvlc_media_get_mrl( libvlc_media_t * p_md,
-                                                       libvlc_exception_t * p_e );
+VLC_PUBLIC_API char * libvlc_media_get_mrl( libvlc_media_t * p_md );
 
 /**
  * Duplicate a media descriptor object.
  *
  * \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 e_meta_desc the meta to read
- * \param p_e an initialized exception pointer
+ * \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,
-                                   libvlc_exception_t *p_e );
+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 read
+ * \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 werite 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
  * are defined in libvlc_structures.c ( libvlc_NothingSpecial=0,
@@ -224,13 +275,21 @@ VLC_PUBLIC_API char * libvlc_media_get_meta(
  *
  * @see libvlc_state_t
  * \param p_meta_desc a media descriptor object
- * \param p_e an initialized exception object
  * \return state of media descriptor object
  */
 VLC_PUBLIC_API libvlc_state_t libvlc_media_get_state(
-                                   libvlc_media_t *p_meta_desc,
-                                   libvlc_exception_t *p_e );
+                                   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
@@ -238,7 +297,6 @@ VLC_PUBLIC_API libvlc_state_t libvlc_media_get_state(
  * libvlc_media_list_release() to decrement the reference counting.
  *
  * \param p_md media descriptor object
- * \param p_e initalized exception object
  * \return list of media descriptor subitems or NULL
  */
 
@@ -247,23 +305,20 @@ VLC_PUBLIC_API libvlc_state_t libvlc_media_get_state(
 #define VLC_FORWARD_DECLARE_OBJECT(a) struct a
 
 VLC_PUBLIC_API VLC_FORWARD_DECLARE_OBJECT(libvlc_media_list_t *)
-libvlc_media_subitems( libvlc_media_t *p_md,
-                      libvlc_exception_t *p_e );
+libvlc_media_subitems( libvlc_media_t *p_md );
 
 /**
  * Get event manager from media descriptor object.
  * NOTE: this function doesn't increment reference counting.
  *
  * \param p_md a media descriptor object
- * \param p_e an initialized exception object
  * \return event manager object
  */
 VLC_PUBLIC_API libvlc_event_manager_t *
-    libvlc_media_event_manager( libvlc_media_t * p_md,
-                                           libvlc_exception_t * p_e );
+    libvlc_media_event_manager( libvlc_media_t * p_md );
 
 /**
- * Get duration of media descriptor object item.
+ * Get duration (in ms) of media descriptor object item.
  *
  * \param p_md media descriptor object
  * \param p_e an initialized exception object
@@ -277,12 +332,10 @@ VLC_PUBLIC_API libvlc_time_t
  * Get preparsed status for media descriptor object.
  *
  * \param p_md media descriptor object
- * \param p_e an initialized exception object
  * \return true if media object has been preparsed otherwise it returns false
  */
 VLC_PUBLIC_API int
-   libvlc_media_is_preparsed( libvlc_media_t * p_md,
-                                         libvlc_exception_t * p_e );
+   libvlc_media_is_preparsed( libvlc_media_t * p_md );
 
 /**
  * Sets media descriptor's user_data. user_data is specialized data
@@ -291,12 +344,10 @@ VLC_PUBLIC_API int
  *
  * \param p_md media descriptor object
  * \param p_new_user_data pointer to user data
- * \param p_e an initialized exception object
  */
 VLC_PUBLIC_API void
     libvlc_media_set_user_data( libvlc_media_t * p_md,
-                                           void * p_new_user_data,
-                                           libvlc_exception_t * p_e);
+                                           void * p_new_user_data );
 
 /**
  * Get media descriptor's user_data. user_data is specialized data
@@ -304,11 +355,9 @@ VLC_PUBLIC_API void
  * an native object that references a libvlc_media_t pointer
  *
  * \param p_md media descriptor object
- * \param p_e an initialized exception object
  */
 VLC_PUBLIC_API void *
-    libvlc_media_get_user_data( libvlc_media_t * p_md,
-                                           libvlc_exception_t * p_e);
+    libvlc_media_get_user_data( libvlc_media_t * p_md );
 
 /** @}*/