]> git.sesse.net Git - vlc/blob - include/vlc_access.h
Update release howto
[vlc] / include / vlc_access.h
1 /*****************************************************************************
2  * vlc_access.h
3  *****************************************************************************
4  * Copyright (C) 1999-2004 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_ACCESS_H
25 #define _VLC_ACCESS_H 1
26
27 /**
28  * \defgroup access Access
29  * @{
30  */
31
32 enum access_query_e
33 {
34     /* capabilities */
35     ACCESS_CAN_SEEK,        /* arg1= vlc_bool_t*    cannot fail */
36     ACCESS_CAN_FASTSEEK,    /* arg1= vlc_bool_t*    cannot fail */
37     ACCESS_CAN_PAUSE,       /* arg1= vlc_bool_t*    cannot fail */
38     ACCESS_CAN_CONTROL_PACE,/* arg1= vlc_bool_t*    cannot fail */
39
40     /* */
41     ACCESS_GET_MTU,         /* arg1= int*           cannot fail(0 if no sense)*/
42     ACCESS_GET_PTS_DELAY,   /* arg1= int64_t*       cannot fail */
43     /* */
44     ACCESS_GET_TITLE_INFO,  /* arg1=input_title_t*** arg2=int* can fail */
45     /* Meta data */
46     ACCESS_GET_META,        /* arg1= vlc_meta_t **  res=can fail    */
47
48     /* */
49     ACCESS_SET_PAUSE_STATE, /* arg1= vlc_bool_t     can fail */
50
51     /* */
52     ACCESS_SET_TITLE,       /* arg1= int            can fail */
53     ACCESS_SET_SEEKPOINT,   /* arg1= int            can fail */
54
55     /* Special mode for access/demux communication
56      * XXX: avoid to use it unless you can't */
57     ACCESS_SET_PRIVATE_ID_STATE,    /* arg1= int i_private_data, vlc_bool_t b_selected can fail */
58     ACCESS_SET_PRIVATE_ID_CA,    /* arg1= int i_program_number, uint16_t i_vpid, uint16_t i_apid1, uint16_t i_apid2, uint16_t i_apid3, uint8_t i_length, uint8_t *p_data */
59     ACCESS_GET_PRIVATE_ID_STATE     /* arg1=int i_private_data arg2=vlc_bool_t *  res=can fail */
60 };
61
62 struct access_t
63 {
64     VLC_COMMON_MEMBERS
65
66     /* Module properties */
67     module_t    *p_module;
68
69     /* Access name (empty if non forced) */
70     char        *psz_access;
71     /* Access path/url/filename/.... */
72     char        *psz_path;
73     /* Access source for access_filter (NULL for regular access) */
74     access_t    *p_source;
75
76     /* Access can fill this entry to force a demuxer
77      * XXX: fill it once you know for sure you will succed
78      * (if you fail, this value won't be reseted */
79     char        *psz_demux;
80
81     /* pf_read/pf_block is used to read data.
82      * XXX A access should set one and only one of them */
83     int         (*pf_read) ( access_t *, uint8_t *, int );  /* Return -1 if no data yet, 0 if no more data, else real data read */
84     block_t    *(*pf_block)( access_t * );                  /* return a block of data in his 'natural' size, NULL if not yet data or eof */
85
86     /* Called for each seek.
87      * XXX can be null */
88     int         (*pf_seek) ( access_t *, int64_t );         /* can be null if can't seek */
89
90     /* Used to retreive and configure the access
91      * XXX mandatory. look at access_query_e to know what query you *have to* support */
92     int         (*pf_control)( access_t *, int i_query, va_list args);
93
94     /* Access has to maintain them uptodate */
95     struct
96     {
97         unsigned int i_update;  /* Access sets them on change,
98                                    Input removes them once take into account*/
99
100         int64_t      i_size;    /* Write only for access, read only for input */
101         int64_t      i_pos;     /* idem */
102         vlc_bool_t   b_eof;     /* idem */
103
104         int          i_title;    /* idem, start from 0 (could be menu) */
105         int          i_seekpoint;/* idem, start from 0 */
106
107         vlc_bool_t   b_prebuffered; /* Read only for input */ 
108     } info;
109     access_sys_t *p_sys;
110 };
111
112 #define access2_New( a, b, c, d, e ) __access2_New(VLC_OBJECT(a), b, c, d, e )
113 VLC_EXPORT( access_t *, __access2_New,  ( vlc_object_t *p_obj, char *psz_access, char *psz_demux, char *psz_path, vlc_bool_t b_quick ) );
114 VLC_EXPORT( access_t *, access2_FilterNew, ( access_t *p_source, char *psz_access_filter ) );
115 VLC_EXPORT( void,      access2_Delete, ( access_t * ) );
116
117 static inline int access2_vaControl( access_t *p_access, int i_query, va_list args )
118 {
119     if( !p_access ) return VLC_EGENERIC;
120     return p_access->pf_control( p_access, i_query, args );
121 }
122 static inline int access2_Control( access_t *p_access, int i_query, ... )
123 {
124     va_list args;
125     int     i_result;
126
127     va_start( args, i_query );
128     i_result = access2_vaControl( p_access, i_query, args );
129     va_end( args );
130     return i_result;
131 }
132
133 #endif