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

   1 /*****************************************************************************
   2  * ninput.h
   3  *****************************************************************************
   4  * Copyright (C) 1999-2001 VideoLAN
   5  * $Id: ninput.h,v 1.23 2004/01/07 15:31:31 fenrir Exp $
   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 _NINPUT_H
  25 #define _NINPUT_H 1
  26
  27 #include "vlc_es.h"
  28
  29 enum es_out_mode_e
  30 {
  31     ES_OUT_MODE_NONE,   /* don't select anything */
  32     ES_OUT_MODE_ALL,    /* eg for stream output */
  33     ES_OUT_MODE_AUTO    /* best audio/video or for input follow audio-channel, spu-channel */
  34 };
  35
  36 enum es_out_query_e
  37 {
  38     /* activate apply of mode */
  39     ES_OUT_SET_ACTIVE,  /* arg1= vlc_bool_t                     */
  40     /* see if mode is currently aplied or not */
  41     ES_OUT_GET_ACTIVE,  /* arg1= vlc_bool_t*                    */
  42
  43     /* set/get mode */
  44     ES_OUT_SET_MODE,    /* arg1= int                            */
  45     ES_OUT_GET_MODE,    /* arg2= int*                           */
  46
  47     /* set es selected for the es category(audio/video/spu) */
  48     ES_OUT_SET_ES,      /* arg1= es_out_id_t*                   */
  49
  50     /* force selection/unselection of the ES (bypass current mode)*/
  51     ES_OUT_SET_ES_STATE,/* arg1= es_out_id_t* arg2=vlc_bool_t   */
  52     ES_OUT_GET_ES_STATE,/* arg1= es_out_id_t* arg2=vlc_bool_t*  */
  53
  54     /* XXX XXX XXX Don't use them YET !!! */
  55     ES_OUT_SET_PCR,             /* arg1=int64_t i_pcr(microsecond!) (using default group 0)*/
  56     ES_OUT_SET_GROUP_PCR,       /* arg1= int i_group, arg2=int64_t i_pcr(microsecond!)*/
  57     ES_OUT_RESET_PCR,   /* no arg */
  58 };
  59
  60 struct es_out_t
  61 {
  62     es_out_id_t *(*pf_add)    ( es_out_t *, es_format_t * );
  63     int          (*pf_send)   ( es_out_t *, es_out_id_t *, block_t * );
  64     void         (*pf_del)    ( es_out_t *, es_out_id_t * );
  65     int          (*pf_control)( es_out_t *, int i_query, va_list );
  66
  67     es_out_sys_t    *p_sys;
  68 };
  69
  70 static inline es_out_id_t * es_out_Add( es_out_t *out, es_format_t *fmt )
  71 {
  72     return out->pf_add( out, fmt );
  73 }
  74 static inline void es_out_Del( es_out_t *out, es_out_id_t *id )
  75 {
  76     out->pf_del( out, id );
  77 }
  78 static inline int es_out_Send( es_out_t *out, es_out_id_t *id,
  79                                block_t *p_block )
  80 {
  81     return out->pf_send( out, id, p_block );
  82 }
  83
  84 static inline int es_out_vaControl( es_out_t *out, int i_query, va_list args )
  85 {
  86     return out->pf_control( out, i_query, args );
  87 }
  88 static inline int es_out_Control( es_out_t *out, int i_query, ... )
  89 {
  90     va_list args;
  91     int     i_result;
  92
  93     va_start( args, i_query );
  94     i_result = es_out_vaControl( out, i_query, args );
  95     va_end( args );
  96     return i_result;
  97 }
  98
  99 /**
 100  * \defgroup stream Stream
 101  *
 102  *  This will allow you to easily handle read/seek in demuxer modules.
 103  * @{
 104  */
 105
 106 /**
 107  * Possible commands to send to stream_Control() and stream_vaControl()
 108  */
 109 enum stream_query_e
 110 {
 111     /* capabilities */
 112     STREAM_CAN_SEEK,            /**< arg1= vlc_bool_t *   res=cannot fail*/
 113     STREAM_CAN_FASTSEEK,        /**< arg1= vlc_bool_t *   res=cannot fail*/
 114
 115     /* */
 116     STREAM_SET_POSITION,        /**< arg1= int64_t        res=can fail  */
 117     STREAM_GET_POSITION,        /**< arg1= int64_t *      res=cannot fail*/
 118
 119     STREAM_GET_SIZE,            /**< arg1= int64_t *      res=cannot fail (0 if no sense)*/
 120 };
 121
 122 /* Stream */
 123 VLC_EXPORT( stream_t *,     stream_OpenInput,       ( input_thread_t * ) );
 124 VLC_EXPORT( void,           stream_Release,         ( stream_t * ) );
 125 VLC_EXPORT( int,            stream_vaControl,       ( stream_t *, int i_query, va_list ) );
 126 VLC_EXPORT( int,            stream_Control,         ( stream_t *, int i_query, ... ) );
 127 VLC_EXPORT( int,            stream_Read,            ( stream_t *, void *p_read, int i_read ) );
 128 VLC_EXPORT( int,            stream_Peek,            ( stream_t *, uint8_t **pp_peek, int i_peek ) );
 129 VLC_EXPORT( char *,         stream_ReadLine,        ( stream_t * ) );
 130 VLC_EXPORT( data_packet_t *,stream_DataPacket,      ( stream_t *, int i_size, vlc_bool_t b_force ) );
 131 VLC_EXPORT( pes_packet_t *, stream_PesPacket,       ( stream_t *, int i_size ) );
 132 VLC_EXPORT( block_t *,      stream_Block,           ( stream_t *, int i_size ) );
 133
 134 static int64_t inline stream_Tell( stream_t *s )
 135 {
 136     int64_t i_pos;
 137     stream_Control( s, STREAM_GET_POSITION, &i_pos );
 138
 139     return i_pos;
 140 }
 141 static int64_t inline stream_Size( stream_t *s )
 142 {
 143     int64_t i_pos;
 144     stream_Control( s, STREAM_GET_SIZE, &i_pos );
 145
 146     return i_pos;
 147 }
 148 static int inline stream_Seek( stream_t *s, int64_t i_pos )
 149 {
 150     return stream_Control( s, STREAM_SET_POSITION, i_pos );
 151 }
 152
 153
 154 /**
 155  * @}
 156  */
 157
 158 /**
 159  * \defgroup demux Demux
 160  * @{
 161  */
 162
 163
 164 struct demux_t
 165 {
 166     VLC_COMMON_MEMBERS
 167
 168     /* Module properties */
 169     module_t    *p_module;
 170
 171     /* eg informative but needed (we can have access+demux) */
 172     char        *psz_access;
 173     char        *psz_demux;
 174     char        *psz_path;
 175
 176     /* input stream */
 177     stream_t    *s;     /* NULL in case of a access+demux in one */
 178
 179     /* es output */
 180     es_out_t    *out;   /* ou p_es_out */
 181
 182     /* set by demuxer */
 183     int (*pf_demux)  ( demux_t * );   /* demux one frame only */
 184     int (*pf_control)( demux_t *, int i_query, va_list args);
 185     demux_sys_t *p_sys;
 186 };
 187
 188 enum demux_query_e
 189 {
 190     DEMUX_GET_POSITION,         /* arg1= double *       res=    */
 191     DEMUX_SET_POSITION,         /* arg1= double         res=can fail    */
 192
 193     DEMUX_GET_TIME,             /* arg1= int64_t *      res=    */
 194     DEMUX_SET_TIME,             /* arg1= int64_t        res=can fail    */
 195
 196     DEMUX_GET_LENGTH,           /* arg1= int64_t *      res=can fail    */
 197
 198     DEMUX_GET_FPS               /* arg1= float *        res=can fail    */
 199 };
 200
 201
 202
 203 /* Demux */
 204 VLC_EXPORT( int,            demux_vaControl,        ( input_thread_t *, int i_query, va_list  ) );
 205 VLC_EXPORT( int,            demux_Control,          ( input_thread_t *, int i_query, ...  ) );
 206
 207 VLC_EXPORT( int,            demux_vaControlDefault, ( input_thread_t *, int i_query, va_list  ) );
 208
 209
 210 /* New demux arch: don't touch that */
 211 /* stream_t *s could be null and then it mean a access+demux in one */
 212 #define demux2_New( a, b, c, d ) __demux2_New(VLC_OBJECT(a), b, c, d)
 213 VLC_EXPORT( demux_t *, __demux2_New,  ( vlc_object_t *p_obj, char *psz_mrl, stream_t *s, es_out_t *out ) );
 214 VLC_EXPORT( void,      demux2_Delete, ( demux_t * ) );
 215
 216 static inline int demux2_Demux( demux_t *p_demux )
 217 {
 218     return p_demux->pf_demux( p_demux );
 219 }
 220 static inline int demux2_vaControl( demux_t *p_demux, int i_query, va_list args )
 221 {
 222     return p_demux->pf_control( p_demux, i_query, args );
 223 }
 224 static inline int demux2_Control( demux_t *p_demux, int i_query, ... )
 225 {
 226     va_list args;
 227     int     i_result;
 228
 229     va_start( args, i_query );
 230     i_result = demux2_vaControl( p_demux, i_query, args );
 231     va_end( args );
 232     return i_result;
 233 }
 234
 235
 236 /* Subtitles */
 237 VLC_EXPORT( char **,        subtitles_Detect,       ( input_thread_t *, char* path, char *fname ) );
 238
 239 /**
 240  * @}
 241  */
 242
 243 #endif
 244