home *** CD-ROM | disk | FTP | other *** search
/ Maximum CD 2009 May / maximum-cd-2009-05.iso / DiscContents / vlc-0.9.8a-win32.exe / sdk / include / vlc / plugins / vlc_stream.h < prev    next >
Encoding:
C/C++ Source or Header  |  2008-12-06  |  4.8 KB  |  153 lines
  1. /*****************************************************************************
  2.  * vlc_stream.h: Stream (between access and demux) descriptor and methods
  3.  *****************************************************************************
  4.  * Copyright (C) 1999-2004 the VideoLAN team
  5.  * $Id: eba91cf7e9197ecd180bc4f9e0da775d1b7c3091 $
  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_STREAM_H
  25. #define VLC_STREAM_H 1
  26.  
  27. #include <vlc_block.h>
  28.  
  29. /**
  30.  * \file
  31.  * This file defines structures and functions for stream (between access and demux) descriptor in vlc
  32.  */
  33.  
  34. # ifdef __cplusplus
  35. extern "C" {
  36. # endif
  37.  
  38. /**
  39.  * \defgroup stream Stream
  40.  *
  41.  *  This will allow you to easily handle read/seek in demuxer modules.
  42.  * @{
  43.  */
  44.  
  45. /**
  46.  * Possible commands to send to stream_Control() and stream_vaControl()
  47.  */
  48. enum stream_query_e
  49. {
  50.     /* capabilities */
  51.     STREAM_CAN_SEEK,            /**< arg1= bool *   res=cannot fail*/
  52.     STREAM_CAN_FASTSEEK,        /**< arg1= bool *   res=cannot fail*/
  53.  
  54.     /* */
  55.     STREAM_SET_POSITION,        /**< arg1= int64_t        res=can fail  */
  56.     STREAM_GET_POSITION,        /**< arg1= int64_t *      res=cannot fail*/
  57.  
  58.     STREAM_GET_SIZE,            /**< arg1= int64_t *      res=cannot fail (0 if no sense)*/
  59.  
  60.     STREAM_GET_MTU,             /**< arg1= int *          res=cannot fail (0 if no sense)*/
  61.  
  62.     /* Special for direct access control from demuxer.
  63.      * XXX: avoid using it by all means */
  64.     STREAM_CONTROL_ACCESS,  /* arg1= int i_access_query, args   res: can fail
  65.                              if access unreachable or access control answer */
  66.  
  67.     STREAM_GET_CONTENT_TYPE,   /**< arg1= char **         res=can file */
  68. };
  69.  
  70. VLC_EXPORT( int, stream_Read, ( stream_t *s, void *p_read, int i_read ) );
  71. VLC_EXPORT( int, stream_Peek, ( stream_t *s, const uint8_t **pp_peek, int i_peek ) );
  72. VLC_EXPORT( int, stream_vaControl, ( stream_t *s, int i_query, va_list args ) );
  73. VLC_EXPORT( void, stream_Delete, ( stream_t *s ) );
  74. VLC_EXPORT( int, stream_Control, ( stream_t *s, int i_query, ... ) );
  75. VLC_EXPORT( block_t *, stream_Block, ( stream_t *s, int i_size ) );
  76. VLC_EXPORT( char *, stream_ReadLine, ( stream_t * ) );
  77.  
  78. /**
  79.  * Get the current position in a stream
  80.  */
  81. static inline int64_t stream_Tell( stream_t *s )
  82. {
  83.     int64_t i_pos;
  84.     stream_Control( s, STREAM_GET_POSITION, &i_pos );
  85.     return i_pos;
  86. }
  87.  
  88. /**
  89.  * Get the size of the stream.
  90.  */
  91. static inline int64_t stream_Size( stream_t *s )
  92. {
  93.     int64_t i_pos;
  94.     stream_Control( s, STREAM_GET_SIZE, &i_pos );
  95.     return i_pos;
  96. }
  97.  
  98. static inline int stream_MTU( stream_t *s )
  99. {
  100.     int i_mtu;
  101.     stream_Control( s, STREAM_GET_MTU, &i_mtu );
  102.     return i_mtu;
  103. }
  104.  
  105. static inline int stream_Seek( stream_t *s, int64_t i_pos )
  106. {
  107.     return stream_Control( s, STREAM_SET_POSITION, i_pos );
  108. }
  109.  
  110. /**
  111.  * Get the Content-Type of a stream, or NULL if unknown.
  112.  * Result must be free()'d.
  113.  */
  114. static inline char *stream_ContentType( stream_t *s )
  115. {
  116.     char *res;
  117.     if( stream_Control( s, STREAM_GET_CONTENT_TYPE, &res ) )
  118.         return NULL;
  119.     return res;
  120. }
  121.  
  122. /**
  123.  * Create a special stream and a demuxer, this allows chaining demuxers
  124.  */
  125. #define stream_DemuxNew( a, b, c ) __stream_DemuxNew( VLC_OBJECT(a), b, c)
  126. VLC_EXPORT( stream_t *,__stream_DemuxNew, ( vlc_object_t *p_obj, const char *psz_demux, es_out_t *out ) );
  127. VLC_EXPORT( void,      stream_DemuxSend,  ( stream_t *s, block_t *p_block ) );
  128. VLC_EXPORT( void,      stream_DemuxDelete,( stream_t *s ) );
  129.  
  130. #define stream_MemoryNew( a, b, c, d ) __stream_MemoryNew( VLC_OBJECT(a), b, c, d )
  131. VLC_EXPORT( stream_t *,__stream_MemoryNew, (vlc_object_t *p_obj, uint8_t *p_buffer, int64_t i_size, bool i_preserve_memory ) );
  132. #define stream_UrlNew( a, b ) __stream_UrlNew( VLC_OBJECT(a), b )
  133. VLC_EXPORT( stream_t *,__stream_UrlNew, (vlc_object_t *p_this, const char *psz_url ) );
  134.  
  135. /**
  136.  * @}
  137.  */
  138.  
  139. # ifdef __cplusplus
  140. }
  141. # endif
  142.  
  143. # if defined (__PLUGIN__) || defined (__BUILTIN__)
  144.    /* FIXME UGLY HACK to keep VLC_OBJECT working */
  145.    /* Maybe we should make VLC_OBJECT a simple cast noawadays... */
  146. struct stream_t
  147. {
  148.     VLC_COMMON_MEMBERS
  149. };
  150. # endif
  151.  
  152. #endif
  153.