git.sesse.net Git - vlc/blob - include/vlc_stream.h

   1 /*****************************************************************************
   2  * vlc_stream.h: Stream (between access and demux) descriptor and methods
   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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #if !defined( __LIBVLC__ )
  25   #error You are not libvlc or one of its plugins. You cannot include this file
  26 #endif
  27
  28 #ifndef _VLC_STREAM_H
  29 #define _VLC_STREAM_H 1
  30
  31 #include <vlc_block.h>
  32
  33 # ifdef __cplusplus
  34 extern "C" {
  35 # endif
  36
  37 /**
  38  * \defgroup stream Stream
  39  *
  40  *  This will allow you to easily handle read/seek in demuxer modules.
  41  * @{
  42  */
  43
  44 /**
  45  * Possible commands to send to stream_Control() and stream_vaControl()
  46  */
  47 enum stream_query_e
  48 {
  49     /* capabilities */
  50     STREAM_CAN_SEEK,            /**< arg1= vlc_bool_t *   res=cannot fail*/
  51     STREAM_CAN_FASTSEEK,        /**< arg1= vlc_bool_t *   res=cannot fail*/
  52
  53     /* */
  54     STREAM_SET_POSITION,        /**< arg1= int64_t        res=can fail  */
  55     STREAM_GET_POSITION,        /**< arg1= int64_t *      res=cannot fail*/
  56
  57     STREAM_GET_SIZE,            /**< arg1= int64_t *      res=cannot fail (0 if no sense)*/
  58
  59     STREAM_GET_MTU,             /**< arg1= int *          res=cannot fail (0 if no sense)*/
  60
  61     /* Special for direct access control from demuxer.
  62      * XXX: avoid using it by all means */
  63     STREAM_CONTROL_ACCESS   /* arg1= int i_access_query, args   res: can fail
  64                              if access unreachable or access control answer */
  65 };
  66
  67 VLC_EXPORT( int, stream_Read, ( stream_t *s, void *p_read, int i_read ) );
  68 VLC_EXPORT( int, stream_Peek, ( stream_t *s, const uint8_t **pp_peek, int i_peek ) );
  69 VLC_EXPORT( int, stream_vaControl, ( stream_t *s, int i_query, va_list args ) );
  70 VLC_EXPORT( void, stream_Delete, ( stream_t *s ) );
  71 VLC_EXPORT( int, stream_Control, ( stream_t *s, int i_query, ... ) );
  72 VLC_EXPORT( block_t *, stream_Block, ( stream_t *s, int i_size ) );
  73 VLC_EXPORT( char *, stream_ReadLine, ( stream_t * ) );
  74
  75 /**
  76  * Get the current position in a stream
  77  */
  78 static inline int64_t stream_Tell( stream_t *s )
  79 {
  80     int64_t i_pos;
  81     stream_Control( s, STREAM_GET_POSITION, &i_pos );
  82     return i_pos;
  83 }
  84
  85 /**
  86  * Get the size of the stream.
  87  */
  88 static inline int64_t stream_Size( stream_t *s )
  89 {
  90     int64_t i_pos;
  91     stream_Control( s, STREAM_GET_SIZE, &i_pos );
  92     return i_pos;
  93 }
  94 static inline int stream_MTU( stream_t *s )
  95 {
  96     int i_mtu;
  97     stream_Control( s, STREAM_GET_MTU, &i_mtu );
  98     return i_mtu;
  99 }
 100 static inline int stream_Seek( stream_t *s, int64_t i_pos )
 101 {
 102     return stream_Control( s, STREAM_SET_POSITION, i_pos );
 103 }
 104
 105 /**
 106  * Create a special stream and a demuxer, this allows chaining demuxers
 107  */
 108 #define stream_DemuxNew( a, b, c ) __stream_DemuxNew( VLC_OBJECT(a), b, c)
 109 VLC_EXPORT( stream_t *,__stream_DemuxNew, ( vlc_object_t *p_obj, const char *psz_demux, es_out_t *out ) );
 110 VLC_EXPORT( void,      stream_DemuxSend,  ( stream_t *s, block_t *p_block ) );
 111 VLC_EXPORT( void,      stream_DemuxDelete,( stream_t *s ) );
 112
 113
 114 #define stream_MemoryNew( a, b, c, d ) __stream_MemoryNew( VLC_OBJECT(a), b, c, d )
 115 VLC_EXPORT( stream_t *,__stream_MemoryNew, (vlc_object_t *p_obj, uint8_t *p_buffer, int64_t i_size, vlc_bool_t i_preserve_memory ) );
 116 #define stream_UrlNew( a, b ) __stream_UrlNew( VLC_OBJECT(a), b )
 117 VLC_EXPORT( stream_t *,__stream_UrlNew, (vlc_object_t *p_this, const char *psz_url ) );
 118
 119 /**
 120  * @}
 121  */
 122
 123 # ifdef __cplusplus
 124 }
 125 # endif
 126
 127 # if defined (__PLUGIN__) || defined (__BUILTIN__)
 128    /* FIXME UGLY HACK to keep VLC_OBJECT working */
 129    /* Maybe we should make VLC_OBJECT a simple cast noawadays... */
 130 struct stream_t
 131 {
 132     VLC_COMMON_MEMBERS
 133 };
 134 # endif
 135
 136 #endif