]> git.sesse.net Git - vlc/blobdiff - include/vlc_demux.h
Turkish translation update by Yuksel Yildirim
[vlc] / include / vlc_demux.h
index 1a680ac4fbf2774bc07b2d0cb26fcd2e28c461af..e7a39da157c48b290f7111d814864dbe14503581 100644 (file)
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
-#if !defined( __LIBVLC__ )
-  #error You are not libvlc or one of its plugins. You cannot include this file
-#endif
-
 #ifndef _VLC_DEMUX_H
 #define _VLC_DEMUX_H 1
 
@@ -72,6 +68,16 @@ struct demux_t
     demux_sys_t *p_sys;
 };
 
+
+/* demux_meta_t is returned by "meta reader" module to the demuxer */
+struct demux_meta_t
+{
+    vlc_meta_t *p_meta;                 /**< meta data */
+
+    int i_attachments;                  /**< number of attachments */
+    input_attachment_t **attachments;    /**< array of attachments */
+};
+
 enum demux_query_e
 {
     /* I. Common queries to access_demux and demux */
@@ -85,7 +91,7 @@ enum demux_query_e
     DEMUX_SET_TIME,             /* arg1= int64_t        res=can fail    */
 
     /* TITLE_INFO only if more than 1 title or 1 chapter */
-    DEMUX_GET_TITLE_INFO,       /* arg1=input_title_t*** arg2=int* 
+    DEMUX_GET_TITLE_INFO,       /* arg1=input_title_t*** arg2=int*
                                    arg3=int*pi_title_offset(0), arg4=int*pi_seekpoint_offset(0) can fail */
     /* TITLE/SEEKPOINT, only when TITLE_INFO succeed */
     DEMUX_SET_TITLE,            /* arg1= int            can fail */
@@ -98,82 +104,94 @@ enum demux_query_e
     DEMUX_SET_GROUP,            /* arg1= int            can fail */
 
     /* Ask the demux to demux until the given date at the next pf_demux call
-     * but not more (and not less, at the precision avaiable of course).
+     * but not more (and not less, at the precision available of course).
      * XXX: not mandatory (except for subtitle demux) but I will help a lot
      * for multi-input
      */
     DEMUX_SET_NEXT_DEMUX_TIME,  /* arg1= int64_t *      can fail */
     /* FPS for correct subtitles handling */
-    DEMUX_GET_FPS,              /* arg1= float *        res=can fail    */
+    DEMUX_GET_FPS,              /* arg1= double *       res=can fail    */
 
     /* Meta data */
     DEMUX_GET_META,             /* arg1= vlc_meta_t **  res=can fail    */
+    DEMUX_HAS_UNSUPPORTED_META, /* arg1= bool *   res can fail    */
 
     /* Attachments */
     DEMUX_GET_ATTACHMENTS,      /* arg1=input_attachment_t***, int* res=can fail */
 
     /* II. Specific access_demux queries */
-    DEMUX_CAN_PAUSE,            /* arg1= vlc_bool_t*    cannot fail */
-    DEMUX_CAN_CONTROL_PACE,     /* arg1= vlc_bool_t*    cannot fail */
+    DEMUX_CAN_PAUSE,            /* arg1= bool*    can fail (assume false)*/
+    DEMUX_SET_PAUSE_STATE,      /* arg1= bool     can fail */
+
     DEMUX_GET_PTS_DELAY,        /* arg1= int64_t*       cannot fail */
-    DEMUX_SET_PAUSE_STATE       /* arg1= vlc_bool_t     can fail */
+
+    /* DEMUX_CAN_CONTROL_PACE returns true (*pb_pace) if we can read the
+     * data at our pace */
+    DEMUX_CAN_CONTROL_PACE,     /* arg1= bool*pb_pace    can fail (assume false) */
+
+    /* DEMUX_CAN_CONTROL_RATE is called only if DEMUX_CAN_CONTROL_PACE has returned false.
+     * *pb_rate should be true when the rate can be changed (using DEMUX_SET_RATE)
+     * *pb_ts_rescale should be true when the timestamps (pts/dts/pcr) have to be rescaled */
+    DEMUX_CAN_CONTROL_RATE,     /* arg1= bool*pb_rate arg2= bool*pb_ts_rescale  can fail(assume false) */
+    /* DEMUX_SET_RATE is called only if DEMUX_CAN_CONTROL_RATE has returned true.
+     * It should return the value really used in *pi_rate */
+    DEMUX_SET_RATE,             /* arg1= int*pi_rate                                        can fail */
+
+    DEMUX_CAN_SEEK,            /* arg1= bool*    can fail (assume false)*/
 };
 
-VLC_EXPORT( int,       demux2_vaControlHelper, ( stream_t *, int64_t i_start, int64_t i_end, int i_bitrate, int i_align, int i_query, va_list args ) );
+VLC_EXPORT( int,       demux_vaControlHelper, ( stream_t *, int64_t i_start, int64_t i_end, int i_bitrate, int i_align, int i_query, va_list args ) );
 
 /*************************************************************************
  * Miscellaneous helpers for demuxers
  *************************************************************************/
 
-static inline vlc_bool_t demux2_IsPathExtension( demux_t *p_demux, const char *psz_extension )
+static inline bool demux_IsPathExtension( demux_t *p_demux, const char *psz_extension )
 {
     const char *psz_ext = strrchr ( p_demux->psz_path, '.' );
-    if( !psz_ext || strcmp( psz_ext, psz_extension ) )
-        return VLC_FALSE;
-    return VLC_TRUE;
+    if( !psz_ext || strcasecmp( psz_ext, psz_extension ) )
+        return false;
+    return true;
 }
 
-static inline vlc_bool_t demux2_IsForced( demux_t *p_demux, const char *psz_name )
+static inline bool demux_IsForced( demux_t *p_demux, const char *psz_name )
 {
    if( !p_demux->psz_demux || strcmp( p_demux->psz_demux, psz_name ) )
-        return VLC_FALSE;
-    return VLC_TRUE;
+        return false;
+    return true;
 }
 
-#define STANDARD_DEMUX_INIT \
-    p_demux->pf_control = Control; \
-    p_demux->pf_demux = Demux; \
+#define DEMUX_INIT_COMMON() do {            \
+    p_demux->pf_control = Control;          \
+    p_demux->pf_demux = Demux;              \
     MALLOC_ERR( p_demux->p_sys, demux_sys_t ); \
-    memset( p_demux->p_sys, 0, sizeof( demux_sys_t ) );
+    memset( p_demux->p_sys, 0, sizeof( demux_sys_t ) ); } while(0)
 
-#define STANDARD_DEMUX_INIT_MSG( msg ) \
-    p_demux->pf_control = Control; \
-    p_demux->pf_demux = Demux; \
-    MALLOC_ERR( p_demux->p_sys, demux_sys_t ); \
-    memset( p_demux->p_sys, 0, sizeof( demux_sys_t ) ); \
-    msg_Dbg( p_demux, msg ); \
+#define STANDARD_DEMUX_INIT_MSG( msg ) do { \
+    DEMUX_INIT_COMMON();                    \
+    msg_Dbg( p_demux, msg ); } while(0)
 
 #define DEMUX_BY_EXTENSION( ext ) \
     demux_t *p_demux = (demux_t *)p_this; \
-    if( !demux2_IsPathExtension( p_demux, ext ) ) \
+    if( !demux_IsPathExtension( p_demux, ext ) ) \
         return VLC_EGENERIC; \
-    STANDARD_DEMUX_INIT;
+    DEMUX_INIT_COMMON();
 
 #define DEMUX_BY_EXTENSION_MSG( ext, msg ) \
     demux_t *p_demux = (demux_t *)p_this; \
-    if( !demux2_IsPathExtension( p_demux, ext ) ) \
+    if( !demux_IsPathExtension( p_demux, ext ) ) \
         return VLC_EGENERIC; \
     STANDARD_DEMUX_INIT_MSG( msg );
 
 #define DEMUX_BY_EXTENSION_OR_FORCED( ext, module ) \
     demux_t *p_demux = (demux_t *)p_this; \
-    if( !demux2_IsPathExtension( p_demux, ext ) && !demux2_IsForced( p_demux, module ) ) \
+    if( !demux_IsPathExtension( p_demux, ext ) && !demux_IsForced( p_demux, module ) ) \
         return VLC_EGENERIC; \
-    STANDARD_DEMUX_INIT;
+    DEMUX_INIT_COMMON();
 
 #define DEMUX_BY_EXTENSION_OR_FORCED_MSG( ext, module, msg ) \
     demux_t *p_demux = (demux_t *)p_this; \
-    if( !demux2_IsPathExtension( p_demux, ext ) && !demux2_IsForced( p_demux, module ) ) \
+    if( !demux_IsPathExtension( p_demux, ext ) && !demux_IsForced( p_demux, module ) ) \
         return VLC_EGENERIC; \
     STANDARD_DEMUX_INIT_MSG( msg );
 
@@ -185,10 +203,7 @@ static inline vlc_bool_t demux2_IsForced( demux_t *p_demux, const char *psz_name
     if( stream_Peek( p_demux->s , &zepeek, size ) < size ) { \
         msg_Dbg( p_demux, "not enough data" ); goto error; }
 
-#define CHECK_DISCARD_PEEK( size ) { uint8_t *p_peek; \
-    if( stream_Peek( p_demux->s , &p_peek, size ) < size ) return VLC_EGENERIC;}
-
-#define POKE( peek, stuff, size ) (strncasecmp( (char *)peek, stuff, size )==0)
+#define POKE( peek, stuff, size ) (strncasecmp( (const char *)peek, stuff, size )==0)
 
 #define COMMON_INIT_PACKETIZER( location ) \
     location = vlc_object_create( p_demux, VLC_OBJECT_PACKETIZER ); \
@@ -213,7 +228,7 @@ static inline vlc_bool_t demux2_IsForced( demux_t *p_demux, const char *psz_name
         module_Need( location, "packetizer", NULL, 0 ); \
     if( location->p_module == NULL ) \
     { \
-        vlc_object_destroy( location ); \
+        vlc_object_release( location ); \
         msg_Err( p_demux, "cannot find packetizer for " # msg ); \
         free( p_sys ); \
         return VLC_EGENERIC; \
@@ -221,7 +236,7 @@ static inline vlc_bool_t demux2_IsForced( demux_t *p_demux, const char *psz_name
 
 #define DESTROY_PACKETIZER( location ) \
     if( location->p_module ) module_Unneed( location, location->p_module ); \
-    vlc_object_destroy( location );
+    vlc_object_release( location );
 
 /**
  * @}