vlc_access.h
上传用户:kjfoods
上传日期:2020-07-06
资源大小:29949k
文件大小:6k
源码类别:

midi

开发平台:

Unix_Linux

  1. /*****************************************************************************
  2.  * vlc_access.h: Access descriptor, queries and methods
  3.  *****************************************************************************
  4.  * Copyright (C) 1999-2006 the VideoLAN team
  5.  * $Id: 92044ebb6d5992aa025bbe7863df9fc0f07f5a09 $
  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. #ifndef VLC_ACCESS_H
  24. #define VLC_ACCESS_H 1
  25. /**
  26.  * file
  27.  * This file defines functions and definitions for access object
  28.  */
  29. #include <vlc_block.h>
  30. /**
  31.  * defgroup access Access
  32.  * @{
  33.  */
  34. enum access_query_e
  35. {
  36.     /* capabilities */
  37.     ACCESS_CAN_SEEK,        /* arg1= bool*    cannot fail */
  38.     ACCESS_CAN_FASTSEEK,    /* arg1= bool*    cannot fail */
  39.     ACCESS_CAN_PAUSE,       /* arg1= bool*    cannot fail */
  40.     ACCESS_CAN_CONTROL_PACE,/* arg1= bool*    cannot fail */
  41.     /* */
  42.     ACCESS_GET_PTS_DELAY = 0x101,/* arg1= int64_t*       cannot fail */
  43.     /* */
  44.     ACCESS_GET_TITLE_INFO,  /* arg1=input_title_t*** arg2=int*      res=can fail */
  45.     /* Meta data */
  46.     ACCESS_GET_META,        /* arg1= vlc_meta_t **                  res=can fail */
  47.     /* */
  48.     ACCESS_GET_CONTENT_TYPE,/* arg1=char **ppsz_content_type                       res=can fail */
  49.     /* */
  50.     ACCESS_GET_SIGNAL,      /* arg1=double *pf_quality, arg2=double *pf_strength   res=can fail */
  51.     /* */
  52.     ACCESS_SET_PAUSE_STATE = 0x200, /* arg1= bool           can fail */
  53.     /* */
  54.     ACCESS_SET_TITLE,       /* arg1= int            can fail */
  55.     ACCESS_SET_SEEKPOINT,   /* arg1= int            can fail */
  56.     /* Special mode for access/demux communication
  57.      * XXX: avoid to use it unless you can't */
  58.     ACCESS_SET_PRIVATE_ID_STATE = 0x1000, /* arg1= int i_private_data, bool b_selected    res=can fail */
  59.     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 */
  60.     ACCESS_GET_PRIVATE_ID_STATE,          /* arg1=int i_private_data arg2=bool *          res=can fail */
  61. };
  62. struct access_t
  63. {
  64.     VLC_COMMON_MEMBERS
  65.     /* Module properties */
  66.     module_t    *p_module;
  67.     /* Access name (empty if non forced) */
  68.     char        *psz_access;
  69.     /* Access path/url/filename/.... */
  70.     char        *psz_path;
  71.     /* Access can fill this entry to force a demuxer
  72.      * XXX: fill it once you know for sure you will succeed
  73.      * (if you fail, this value won't be reseted */
  74.     char        *psz_demux;
  75.     /* pf_read/pf_block is used to read data.
  76.      * XXX A access should set one and only one of them */
  77.     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 */
  78.     block_t    *(*pf_block)( access_t * );                  /* return a block of data in his 'natural' size, NULL if not yet data or eof */
  79.     /* Called for each seek.
  80.      * XXX can be null */
  81.     int         (*pf_seek) ( access_t *, int64_t );         /* can be null if can't seek */
  82.     /* Used to retreive and configure the access
  83.      * XXX mandatory. look at access_query_e to know what query you *have to* support */
  84.     int         (*pf_control)( access_t *, int i_query, va_list args);
  85.     /* Access has to maintain them uptodate */
  86.     struct
  87.     {
  88.         unsigned int i_update;  /* Access sets them on change,
  89.                                    Input removes them once take into account*/
  90.         int64_t      i_size;    /* Write only for access, read only for input */
  91.         int64_t      i_pos;     /* idem */
  92.         bool         b_eof;     /* idem */
  93.         int          i_title;    /* idem, start from 0 (could be menu) */
  94.         int          i_seekpoint;/* idem, start from 0 */
  95.     } info;
  96.     access_sys_t *p_sys;
  97. };
  98. static inline int access_vaControl( access_t *p_access, int i_query, va_list args )
  99. {
  100.     if( !p_access ) return VLC_EGENERIC;
  101.     return p_access->pf_control( p_access, i_query, args );
  102. }
  103. static inline int access_Control( access_t *p_access, int i_query, ... )
  104. {
  105.     va_list args;
  106.     int     i_result;
  107.     va_start( args, i_query );
  108.     i_result = access_vaControl( p_access, i_query, args );
  109.     va_end( args );
  110.     return i_result;
  111. }
  112. static inline void access_InitFields( access_t *p_a )
  113. {
  114.     p_a->info.i_update = 0;
  115.     p_a->info.i_size = 0;
  116.     p_a->info.i_pos = 0;
  117.     p_a->info.b_eof = false;
  118.     p_a->info.i_title = 0;
  119.     p_a->info.i_seekpoint = 0;
  120. }
  121. #define ACCESS_SET_CALLBACKS( read, block, control, seek )              
  122.     p_access->pf_read = read;                                           
  123.     p_access->pf_block = block;                                         
  124.     p_access->pf_control = control;                                     
  125.     p_access->pf_seek = seek;
  126. #define STANDARD_READ_ACCESS_INIT                                       
  127.     access_InitFields( p_access );                                      
  128.     ACCESS_SET_CALLBACKS( Read, NULL, Control, Seek );                  
  129.     p_sys = p_access->p_sys = calloc( 1, sizeof( access_sys_t ));       
  130.     if( !p_sys ) return VLC_ENOMEM;
  131. #define STANDARD_BLOCK_ACCESS_INIT                                      
  132.     access_InitFields( p_access );                                      
  133.     ACCESS_SET_CALLBACKS( NULL, Block, Control, Seek );                 
  134.     p_sys = p_access->p_sys = calloc( 1, sizeof( access_sys_t ) );      
  135.     if( !p_sys ) return VLC_ENOMEM;
  136. #endif