Fixed ES_OUT_SET_DEFAULT name (added ES_).

[vlc] / include / vlc_es_out.h

diff --git a/include/vlc_es_out.h b/include/vlc_es_out.h
index dbb0da48218ea05a43200436d9ab1be8bd89525e..d7fb754d5b072a5ab9e02e9856ea153226a674b0 100644 (file)
--- a/include/vlc_es_out.h
+++ b/include/vlc_es_out.h
@@ -21,8 +21,13 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
-#ifndef _VLC_ES_OUT_H
-#define _VLC_ES_OUT_H 1
+#ifndef VLC_ES_OUT_H
+#define VLC_ES_OUT_H 1
+
+/**
+ * \file
+ * This file defines functions and structures for handling es_out in stream output
+ */
 
 /**
  * \defgroup es out Es Out
@@ -39,31 +44,35 @@ enum es_out_mode_e
 
 enum es_out_query_e
 {
-    /* activate apply of mode */
-    ES_OUT_SET_ACTIVE,  /* arg1= vlc_bool_t                     */
+    /* activate application of mode */
+    ES_OUT_SET_ACTIVE,  /* arg1= bool                     */
     /* see if mode is currently aplied or not */
-    ES_OUT_GET_ACTIVE,  /* arg1= vlc_bool_t*                    */
+    ES_OUT_GET_ACTIVE,  /* arg1= bool*                    */
 
     /* set/get mode */
     ES_OUT_SET_MODE,    /* arg1= int                            */
     ES_OUT_GET_MODE,    /* arg2= int*                           */
 
-    /* set es selected for the es category(audio/video/spu) */
+    /* set ES selected for the es category (audio/video/spu) */
     ES_OUT_SET_ES,      /* arg1= es_out_id_t*                   */
+    ES_OUT_RESTART_ES,  /* arg1= es_out_id_t*                   */
 
-    /* force selection/unselection of the ES (bypass current mode)*/
-    ES_OUT_SET_ES_STATE,/* arg1= es_out_id_t* arg2=vlc_bool_t   */
-    ES_OUT_GET_ES_STATE,/* arg1= es_out_id_t* arg2=vlc_bool_t*  */
+    /* set 'default' tag on ES (copied across from container) */
+    ES_OUT_SET_ES_DEFAULT, /* arg1= es_out_id_t*                */
+
+    /* force selection/unselection of the ES (bypass current mode) */
+    ES_OUT_SET_ES_STATE,/* arg1= es_out_id_t* arg2=bool   */
+    ES_OUT_GET_ES_STATE,/* arg1= es_out_id_t* arg2=bool*  */
 
     /* */
     ES_OUT_SET_GROUP,   /* arg1= int                            */
     ES_OUT_GET_GROUP,   /* arg1= int*                           */
 
-    /* PCR handling, dts/pts will be automatically computed using thoses PCR
-     * XXX: SET_PCR(_GROUP) is in charge of the pace control. They will wait to slow
-     * down the demuxer to read at the right speed.
-     * XXX: if you want PREROLL just call RESET_PCR and ES_OUT_SET_NEXT_DISPLAY_TIME and send
-     * data to the decoder *without* calling SET_PCR until preroll is finished.
+    /* PCR handling, DTS/PTS will be automatically computed using thoses PCR
+     * XXX: SET_PCR(_GROUP) are in charge of the pace control. They will wait
+     * to slow down the demuxer so that it reads at the right speed.
+     * XXX: if you want PREROLL just call ES_OUT_SET_NEXT_DISPLAY_TIME and send
+     * as you would normally do.
      */
     ES_OUT_SET_PCR,             /* arg1=int64_t i_pcr(microsecond!) (using default group 0)*/
     ES_OUT_SET_GROUP_PCR,       /* arg1= int i_group, arg2=int64_t i_pcr(microsecond!)*/
@@ -76,12 +85,17 @@ enum es_out_query_e
     /* Try not to use this one as it is a bit hacky */
     ES_OUT_SET_FMT,     /* arg1= es_out_id_t* arg2=es_format_t* */
 
-    /* Allow preroll of data (data with dts/pts < i_pts for one ES will be decoded but not displayed */
-    ES_OUT_SET_NEXT_DISPLAY_TIME,   /* arg1=es_out_id_t* arg2=int64_t i_pts(microsecond) */
+    /* Allow preroll of data (data with dts/pts < i_pts for all ES will be decoded but not displayed */
+    ES_OUT_SET_NEXT_DISPLAY_TIME,   /* arg1=int64_t i_pts(microsecond) */
     /* Set meta data for group (dynamic) */
     ES_OUT_SET_GROUP_META,  /* arg1=int i_group arg2=vlc_meta_t */
+    /* Set epg for group (dynamic) */
+    ES_OUT_SET_GROUP_EPG,   /* arg1=int i_group arg2=vlc_epg_t */
     /* */
-    ES_OUT_DEL_GROUP        /* arg1=int i_group */
+    ES_OUT_DEL_GROUP,       /* arg1=int i_group */
+
+    /* First value usable for private control */
+    ES_OUT_PRIVATE_START = 0x10000,
 };
 
 struct es_out_t
@@ -90,18 +104,24 @@ struct es_out_t
     int          (*pf_send)   ( es_out_t *, es_out_id_t *, block_t * );
     void         (*pf_del)    ( es_out_t *, es_out_id_t * );
     int          (*pf_control)( es_out_t *, int i_query, va_list );
+    void         (*pf_destroy)( es_out_t * );
+
+    bool         b_sout;
 
     es_out_sys_t    *p_sys;
 };
 
+LIBVLC_USED
 static inline es_out_id_t * es_out_Add( es_out_t *out, es_format_t *fmt )
 {
     return out->pf_add( out, fmt );
 }
+
 static inline void es_out_Del( es_out_t *out, es_out_id_t *id )
 {
     out->pf_del( out, id );
 }
+
 static inline int es_out_Send( es_out_t *out, es_out_id_t *id,
                                block_t *p_block )
 {
@@ -112,6 +132,7 @@ static inline int es_out_vaControl( es_out_t *out, int i_query, va_list args )
 {
     return out->pf_control( out, i_query, args );
 }
+
 static inline int es_out_Control( es_out_t *out, int i_query, ... )
 {
     va_list args;
@@ -123,6 +144,11 @@ static inline int es_out_Control( es_out_t *out, int i_query, ... )
     return i_result;
 }
 
+static inline void es_out_Delete( es_out_t *p_out )
+{
+    p_out->pf_destroy( p_out );
+}
+
 /**
  * @}
  */