1 /*****************************************************************************
2 * vlc_access.h: Access descriptor, queries and methods
3 *****************************************************************************
4 * Copyright (C) 1999-2006 the VideoLAN team
7 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
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.
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.
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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
25 #define VLC_ACCESS_H 1
29 * This file defines functions and definitions for access object
32 #include <vlc_block.h>
35 * \defgroup access Access
42 ACCESS_CAN_SEEK, /* arg1= bool* cannot fail */
43 ACCESS_CAN_FASTSEEK, /* arg1= bool* cannot fail */
44 ACCESS_CAN_PAUSE, /* arg1= bool* cannot fail */
45 ACCESS_CAN_CONTROL_PACE,/* arg1= bool* cannot fail */
48 ACCESS_GET_MTU = 0x100, /* arg1= int* cannot fail(0 if no sense)*/
49 ACCESS_GET_PTS_DELAY, /* arg1= int64_t* cannot fail */
51 ACCESS_GET_TITLE_INFO, /* arg1=input_title_t*** arg2=int* res=can fail */
53 ACCESS_GET_META, /* arg1= vlc_meta_t ** res=can fail */
56 ACCESS_GET_CONTENT_TYPE,/* arg1=char **ppsz_content_type res=can fail */
59 ACCESS_GET_SIGNAL, /* arg1=double *pf_quality, arg2=double *pf_strength res=can fail */
62 ACCESS_SET_PAUSE_STATE = 0x200, /* arg1= bool can fail */
65 ACCESS_SET_TITLE, /* arg1= int can fail */
66 ACCESS_SET_SEEKPOINT, /* arg1= int can fail */
68 /* Special mode for access/demux communication
69 * XXX: avoid to use it unless you can't */
70 ACCESS_SET_PRIVATE_ID_STATE = 0x1000, /* arg1= int i_private_data, bool b_selected res=can fail */
71 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 */
72 ACCESS_GET_PRIVATE_ID_STATE, /* arg1=int i_private_data arg2=bool * res=can fail */
79 /* Module properties */
82 /* Access name (empty if non forced) */
84 /* Access path/url/filename/.... */
87 /* Access can fill this entry to force a demuxer
88 * XXX: fill it once you know for sure you will succeed
89 * (if you fail, this value won't be reseted */
92 /* pf_read/pf_block is used to read data.
93 * XXX A access should set one and only one of them */
94 ssize_t (*pf_read) ( access_t *, uint8_t *, size_t ); /* Return -1 if no data yet, 0 if no more data, else real data read */
95 block_t *(*pf_block)( access_t * ); /* return a block of data in his 'natural' size, NULL if not yet data or eof */
97 /* Called for each seek.
99 int (*pf_seek) ( access_t *, int64_t ); /* can be null if can't seek */
101 /* Used to retreive and configure the access
102 * XXX mandatory. look at access_query_e to know what query you *have to* support */
103 int (*pf_control)( access_t *, int i_query, va_list args);
105 /* Access has to maintain them uptodate */
108 unsigned int i_update; /* Access sets them on change,
109 Input removes them once take into account*/
111 int64_t i_size; /* Write only for access, read only for input */
112 int64_t i_pos; /* idem */
113 bool b_eof; /* idem */
115 int i_title; /* idem, start from 0 (could be menu) */
116 int i_seekpoint;/* idem, start from 0 */
121 static inline int access_vaControl( access_t *p_access, int i_query, va_list args )
123 if( !p_access ) return VLC_EGENERIC;
124 return p_access->pf_control( p_access, i_query, args );
127 static inline int access_Control( access_t *p_access, int i_query, ... )
132 va_start( args, i_query );
133 i_result = access_vaControl( p_access, i_query, args );
138 static inline void access_InitFields( access_t *p_a )
140 p_a->info.i_update = 0;
141 p_a->info.i_size = 0;
143 p_a->info.b_eof = false;
144 p_a->info.i_title = 0;
145 p_a->info.i_seekpoint = 0;
148 #define ACCESS_SET_CALLBACKS( read, block, control, seek ) \
149 p_access->pf_read = read; \
150 p_access->pf_block = block; \
151 p_access->pf_control = control; \
152 p_access->pf_seek = seek;
154 #define STANDARD_READ_ACCESS_INIT \
155 access_InitFields( p_access ); \
156 ACCESS_SET_CALLBACKS( Read, NULL, Control, Seek ); \
157 p_sys = p_access->p_sys = calloc( 1, sizeof( access_sys_t )); \
158 if( !p_sys ) return VLC_ENOMEM;
160 #define STANDARD_BLOCK_ACCESS_INIT \
161 access_InitFields( p_access ); \
162 ACCESS_SET_CALLBACKS( NULL, Block, Control, Seek ); \
163 p_sys = p_access->p_sys = calloc( 1, sizeof( access_sys_t ) ); \
164 if( !p_sys ) return VLC_ENOMEM;