Add libvlc interface to video_filter/logo module, like the

[vlc] / include / vlc / libvlc_media.h

diff --git a/include/vlc/libvlc_media.h b/include/vlc/libvlc_media.h
index c3cd38d045fd20f6ef8023977b92613637ff5fb1..d300722256a04f0f8daaf00f912dcd1bdd52f796 100644 (file)
--- a/include/vlc/libvlc_media.h
+++ b/include/vlc/libvlc_media.h
@@ -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,7 +172,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 +188,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 +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
@@ -177,10 +214,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 +232,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 +281,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