869bbd3b3f10ff195107e3dd7eb42876425827ed
[vlc.git] / include / ninput.h
1 /*****************************************************************************
2  * ninput.h
3  *****************************************************************************
4  * Copyright (C) 1999-2001 VideoLAN
5  * $Id: ninput.h,v 1.6 2003/08/22 20:29:58 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 /**
28  * \defgroup stream Stream
29  *
30  *  This will allow you to easily handle read/seek in demuxer modules.
31  * @{
32  */
33
34 /**
35  * Possible commands to send to stream_Control() and stream_vaControl()
36  */
37 enum stream_query_e
38 {
39     /* capabilities */
40     STREAM_CAN_SEEK,            /**< arg1= vlc_bool_t *   res=cannot fail*/
41     STREAM_CAN_FASTSEEK,        /**< arg1= vlc_bool_t *   res=cannot fail*/
42
43     /* */
44     STREAM_SET_POSITION,        /**< arg1= int64_t        res=can fail  */
45     STREAM_GET_POSITION,        /**< arg1= int64_t *      res=cannot fail*/
46
47     STREAM_GET_SIZE,            /**< arg1= int64_t *      res=cannot fail (0 if no sense)*/
48 };
49
50 static int64_t inline stream_Tell( stream_t *s )
51 {
52     int64_t i_pos;
53     stream_Control( s, STREAM_GET_POSITION, &i_pos );
54
55     return i_pos;
56 }
57 static int64_t inline stream_Size( stream_t *s )
58 {
59     int64_t i_pos;
60     stream_Control( s, STREAM_GET_SIZE, &i_pos );
61
62     return i_pos;
63 }
64 static int inline stream_Seek( stream_t *s, int64_t i_pos )
65 {
66     return stream_Control( s, STREAM_SET_POSITION, i_pos );
67 }
68
69
70 /* Stream */
71 VLC_EXPORT( stream_t *,     stream_OpenInput,       ( input_thread_t * ) );
72 VLC_EXPORT( void,           stream_Release,         ( stream_t * ) );
73 VLC_EXPORT( int,            stream_vaControl,       ( stream_t *, int i_query, va_list ) );
74 VLC_EXPORT( int,            stream_Control,         ( stream_t *, int i_query, ... ) );
75 VLC_EXPORT( int,            stream_Read,            ( stream_t *, void *p_read, int i_read ) );
76 VLC_EXPORT( int,            stream_Peek,            ( stream_t *, uint8_t **pp_peek, int i_peek ) );
77 VLC_EXPORT( data_packet_t *,stream_DataPacket,      ( stream_t *, int i_size, vlc_bool_t b_force ) );
78 VLC_EXPORT( pes_packet_t *, stream_PesPacket,       ( stream_t *, int i_size ) );
79 /**
80  * @}
81  */
82
83 /**
84  * \defgroup demux Demux
85  * XXX: don't look at it yet.
86  * @{
87  */
88 #define DEMUX_POSITION_MAX  10000
89 enum demux_query_e
90 {
91     DEMUX_GET_POSITION,         /* arg1= int64_t *      res=    */
92     DEMUX_SET_POSITION,         /* arg1= int64_t        res=can fail    */
93
94     DEMUX_GET_TIME,             /* arg1= int64_t *      res=    */
95     DEMUX_SET_TIME,             /* arg1= int64_t        res=can fail    */
96
97     DEMUX_GET_LENGTH            /* arg1= int64_t *      res=can fail    */
98 };
99
100
101
102 /* Demux */
103 VLC_EXPORT( int,            demux_vaControl,        ( input_thread_t *, int i_query, va_list  ) );
104 VLC_EXPORT( int,            demux_Control,          ( input_thread_t *, int i_query, ...  ) );
105
106 /**
107  * @}
108  */
109 #endif
110