git.sesse.net Git - vlc/blob - include/vlc_demux.h

   1 /*****************************************************************************
   2  * vlc_demux.h: Demuxer descriptor, queries and methods
   3  *****************************************************************************
   4  * Copyright (C) 1999-2005 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  22  *****************************************************************************/
  23
  24 #ifndef _VLC_DEMUX_H
  25 #define _VLC_DEMUX_H 1
  26
  27 /**
  28  * \defgroup demux Demux
  29  * @{
  30  */
  31
  32 struct demux_t
  33 {
  34     VLC_COMMON_MEMBERS
  35
  36     /* Module properties */
  37     module_t    *p_module;
  38
  39     /* eg informative but needed (we can have access+demux) */
  40     char        *psz_access;
  41     char        *psz_demux;
  42     char        *psz_path;
  43
  44     /* input stream */
  45     stream_t    *s;     /* NULL in case of a access+demux in one */
  46
  47     /* es output */
  48     es_out_t    *out;   /* our p_es_out */
  49
  50     /* set by demuxer */
  51     int (*pf_demux)  ( demux_t * );   /* demux one frame only */
  52     int (*pf_control)( demux_t *, int i_query, va_list args);
  53
  54     /* Demux has to maintain them uptodate
  55      * when it is responsible of seekpoint/title */
  56     struct
  57     {
  58         unsigned int i_update;  /* Demux sets them on change,
  59                                    Input removes them once take into account*/
  60         /* Seekpoint/Title at demux level */
  61         int          i_title;       /* idem, start from 0 (could be menu) */
  62         int          i_seekpoint;   /* idem, start from 0 */
  63     } info;
  64     demux_sys_t *p_sys;
  65 };
  66
  67 enum demux_query_e
  68 {
  69     /* I. Common queries to access_demux and demux */
  70     /* POSITION double between 0.0 and 1.0 */
  71     DEMUX_GET_POSITION,         /* arg1= double *       res=    */
  72     DEMUX_SET_POSITION,         /* arg1= double         res=can fail    */
  73
  74     /* LENGTH/TIME in microsecond, 0 if unknown */
  75     DEMUX_GET_LENGTH,           /* arg1= int64_t *      res=    */
  76     DEMUX_GET_TIME,             /* arg1= int64_t *      res=    */
  77     DEMUX_SET_TIME,             /* arg1= int64_t        res=can fail    */
  78
  79     /* TITLE_INFO only if more than 1 title or 1 chapter */
  80     DEMUX_GET_TITLE_INFO,       /* arg1=input_title_t*** arg2=int* can fail */
  81
  82     /* TITLE/SEEKPOINT, only when TITLE_INFO succeed */
  83     DEMUX_SET_TITLE,            /* arg1= int            can fail */
  84     DEMUX_SET_SEEKPOINT,        /* arg1= int            can fail */
  85
  86     /* DEMUX_SET_GROUP only a hit for demuxer (mainly DVB) to allow not
  87      * reading everything (you should not use this to call es_out_Control)
  88      * if you don't know what to do with it, just IGNORE it, it is safe(r)
  89      * -1 means all group, 0 default group (first es added) */
  90     DEMUX_SET_GROUP,            /* arg1= int            can fail */
  91
  92     /* Ask the demux to demux until the given date at the next pf_demux call
  93      * but not more (and not less, at the precision avaiable of course).
  94      * XXX: not mandatory (except for subtitle demux) but I will help a lot
  95      * for multi-input
  96      */
  97     DEMUX_SET_NEXT_DEMUX_TIME,  /* arg1= int64_t *      can fail */
  98     /* FPS for correct subtitles handling */
  99     DEMUX_GET_FPS,              /* arg1= float *        res=can fail    */
 100     /* Meta data */
 101     DEMUX_GET_META,             /* arg1= vlc_meta_t **  res=can fail    */
 102
 103
 104     /* II. Specific access_demux queries */
 105     DEMUX_CAN_PAUSE,            /* arg1= vlc_bool_t*    cannot fail */
 106     DEMUX_CAN_CONTROL_PACE,     /* arg1= vlc_bool_t*    cannot fail */
 107     DEMUX_GET_PTS_DELAY,        /* arg1= int64_t*       cannot fail */
 108     DEMUX_SET_PAUSE_STATE       /* arg1= vlc_bool_t     can fail */
 109 };
 110
 111 /* stream_t *s could be null and then it mean a access+demux in one */
 112 #define demux2_New( a, b, c, d, e, f,g ) __demux2_New(VLC_OBJECT(a),b,c,d,e,f,g)
 113 VLC_EXPORT( demux_t *, __demux2_New,  ( vlc_object_t *p_obj, char *psz_access, char *psz_demux, char *psz_path, stream_t *s, es_out_t *out, vlc_bool_t ) );
 114 VLC_EXPORT( void,      demux2_Delete, ( demux_t * ) );
 115 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 ) );
 116
 117 static inline int demux2_Demux( demux_t *p_demux )
 118 {
 119     return p_demux->pf_demux( p_demux );
 120 }
 121 static inline int demux2_vaControl( demux_t *p_demux, int i_query, va_list args )
 122 {
 123     return p_demux->pf_control( p_demux, i_query, args );
 124 }
 125 static inline int demux2_Control( demux_t *p_demux, int i_query, ... )
 126 {
 127     va_list args;
 128     int     i_result;
 129
 130     va_start( args, i_query );
 131     i_result = demux2_vaControl( p_demux, i_query, args );
 132     va_end( args );
 133     return i_result;
 134 }
 135 /**
 136  * @}
 137  */
 138
 139 #endif