include/vlc_access.h

   1 /*****************************************************************************
   2  * vlc_access.h: Access descriptor, queries and methods
   3  *****************************************************************************
   4  * Copyright (C) 1999-2006 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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #ifndef VLC_ACCESS_H
  25 #define VLC_ACCESS_H 1
  26
  27 /**
  28  * \file
  29  * This file defines functions and definitions for access object
  30  */
  31
  32 #include <vlc_block.h>
  33
  34 /**
  35  * \defgroup access Access
  36  * @{
  37  */
  38
  39 enum access_query_e
  40 {
  41     /* capabilities */
  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 */
  46
  47     /* */
  48     ACCESS_GET_MTU,         /* arg1= int*           cannot fail(0 if no sense)*/
  49     ACCESS_GET_PTS_DELAY,   /* arg1= int64_t*       cannot fail */
  50     /* */
  51     ACCESS_GET_TITLE_INFO,  /* arg1=input_title_t*** arg2=int* can fail */
  52     /* Meta data */
  53     ACCESS_GET_META,        /* arg1= vlc_meta_t **  res=can fail    */
  54
  55     /* */
  56     ACCESS_SET_PAUSE_STATE, /* arg1= bool     can fail */
  57
  58     /* */
  59     ACCESS_SET_TITLE,       /* arg1= int            can fail */
  60     ACCESS_SET_SEEKPOINT,   /* arg1= int            can fail */
  61
  62     /* Special mode for access/demux communication
  63      * XXX: avoid to use it unless you can't */
  64     ACCESS_SET_PRIVATE_ID_STATE,    /* arg1= int i_private_data, bool b_selected can fail */
  65     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 */
  66     ACCESS_GET_PRIVATE_ID_STATE,    /* arg1=int i_private_data arg2=bool *  res=can fail */
  67
  68     ACCESS_GET_CONTENT_TYPE, /* arg1=char **ppsz_content_type */
  69 };
  70
  71 struct access_t
  72 {
  73     VLC_COMMON_MEMBERS
  74
  75     /* Module properties */
  76     module_t    *p_module;
  77
  78     /* Access name (empty if non forced) */
  79     char        *psz_access;
  80     /* Access path/url/filename/.... */
  81     char        *psz_path;
  82     /* Access source for access_filter (NULL for regular access) */
  83     access_t    *p_source;
  84
  85     /* Access can fill this entry to force a demuxer
  86      * XXX: fill it once you know for sure you will succeed
  87      * (if you fail, this value won't be reseted */
  88     char        *psz_demux;
  89
  90     /* pf_read/pf_block is used to read data.
  91      * XXX A access should set one and only one of them */
  92     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 */
  93     block_t    *(*pf_block)( access_t * );                  /* return a block of data in his 'natural' size, NULL if not yet data or eof */
  94
  95     /* Called for each seek.
  96      * XXX can be null */
  97     int         (*pf_seek) ( access_t *, int64_t );         /* can be null if can't seek */
  98
  99     /* Used to retreive and configure the access
 100      * XXX mandatory. look at access_query_e to know what query you *have to* support */
 101     int         (*pf_control)( access_t *, int i_query, va_list args);
 102
 103     /* Access has to maintain them uptodate */
 104     struct
 105     {
 106         unsigned int i_update;  /* Access sets them on change,
 107                                    Input removes them once take into account*/
 108
 109         int64_t      i_size;    /* Write only for access, read only for input */
 110         int64_t      i_pos;     /* idem */
 111         bool   b_eof;     /* idem */
 112
 113         int          i_title;    /* idem, start from 0 (could be menu) */
 114         int          i_seekpoint;/* idem, start from 0 */
 115
 116         bool   b_prebuffered; /* Read only for input */
 117     } info;
 118     access_sys_t *p_sys;
 119 };
 120
 121 static inline int access_vaControl( access_t *p_access, int i_query, va_list args )
 122 {
 123     if( !p_access ) return VLC_EGENERIC;
 124     return p_access->pf_control( p_access, i_query, args );
 125 }
 126
 127 static inline int access_Control( access_t *p_access, int i_query, ... )
 128 {
 129     va_list args;
 130     int     i_result;
 131
 132     va_start( args, i_query );
 133     i_result = access_vaControl( p_access, i_query, args );
 134     va_end( args );
 135     return i_result;
 136 }
 137
 138 static inline char *access_GetContentType( access_t *p_access )
 139 {
 140     char *res;
 141     if( access_Control( p_access, ACCESS_GET_CONTENT_TYPE, &res ) )
 142         return NULL;
 143     return res;
 144 }
 145
 146 static inline void access_InitFields( access_t *p_a )
 147 {
 148     p_a->info.i_update = 0;
 149     p_a->info.i_size = 0;
 150     p_a->info.i_pos = 0;
 151     p_a->info.b_eof = false;
 152     p_a->info.i_title = 0;
 153     p_a->info.i_seekpoint = 0;
 154 }
 155
 156 #define ACCESS_SET_CALLBACKS( read, block, control, seek ) \
 157     p_access->pf_read = read;  \
 158     p_access->pf_block = block; \
 159     p_access->pf_control = control; \
 160     p_access->pf_seek = seek; \
 161
 162 #define STANDARD_READ_ACCESS_INIT \
 163     access_InitFields( p_access ); \
 164     ACCESS_SET_CALLBACKS( Read, NULL, Control, Seek ); \
 165     MALLOC_ERR( p_access->p_sys, access_sys_t ); \
 166     p_sys = p_access->p_sys; memset( p_sys, 0, sizeof( access_sys_t ) );
 167
 168 #define STANDARD_BLOCK_ACCESS_INIT \
 169     access_InitFields( p_access ); \
 170     ACCESS_SET_CALLBACKS( NULL, Block, Control, Seek ); \
 171     MALLOC_ERR( p_access->p_sys, access_sys_t ); \
 172     p_sys = p_access->p_sys; memset( p_sys, 0, sizeof( access_sys_t ) );
 173
 174 #endif