Ahem. Fix crappy previous commit.

[vlc] / include / vlc_stream.h

diff --git a/include/vlc_stream.h b/include/vlc_stream.h
index 565961c6091f6f2ec9db4746a77c533b0e230660..6f02e8b5cbb436620f9be7120519029b3b4f8a6b 100644 (file)
--- a/include/vlc_stream.h
+++ b/include/vlc_stream.h
@@ -1,7 +1,7 @@
 /*****************************************************************************
- * vlc_stream.h
+ * vlc_stream.h: Stream (between access and demux) descriptor and methods
  *****************************************************************************
- * Copyright (C) 1999-2004 VideoLAN
+ * Copyright (C) 1999-2004 the VideoLAN team
  * $Id$
  *
  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
@@ -18,12 +18,22 @@
  *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
+#if !defined( __LIBVLC__ )
+  #error You are not libvlc or one of its plugins. You cannot include this file
+#endif
+
 #ifndef _VLC_STREAM_H
 #define _VLC_STREAM_H 1
 
+#include <vlc_block.h>
+
+# ifdef __cplusplus
+extern "C" {
+# endif
+
 /**
  * \defgroup stream Stream
  *
@@ -50,8 +60,8 @@ enum stream_query_e
 
     /* Special for direct access control from demuxer.
      * XXX: avoid using it by all means */
-    STREAM_CONTROL_ACCESS,      /* arg1= int i_access_query, args   res: can fail
-                                   if access unreachable or access control answer */
+    STREAM_CONTROL_ACCESS   /* arg1= int i_access_query, args   res: can fail
+                             if access unreachable or access control answer */
 };
 
 /**
@@ -65,8 +75,14 @@ struct stream_t
     int      (*pf_read)   ( stream_t *, void *p_read, int i_read );
     int      (*pf_peek)   ( stream_t *, uint8_t **pp_peek, int i_peek );
     int      (*pf_control)( stream_t *, int i_query, va_list );
+    void     (*pf_destroy)( stream_t *);
 
     stream_sys_t *p_sys;
+
+    /* UTF-16 and UTF-32 file reading */
+    vlc_iconv_t     conv;
+    int             i_char_width;
+    vlc_bool_t      b_little_endian;
 };
 
 /**
@@ -104,22 +120,42 @@ static inline int stream_vaControl( stream_t *s, int i_query, va_list args )
 {
     return s->pf_control( s, i_query, args );
 }
+
+/**
+ * Destroy a stream
+ */
+static inline void stream_Delete( stream_t *s )
+{
+    s->pf_destroy( s );
+}
+
 static inline int stream_Control( stream_t *s, int i_query, ... )
 {
     va_list args;
     int     i_result;
 
+    if ( s == NULL )
+        return VLC_EGENERIC;
+
     va_start( args, i_query );
     i_result = s->pf_control( s, i_query, args );
     va_end( args );
     return i_result;
 }
+
+/**
+ * Get the current position in a stream
+ */
 static inline int64_t stream_Tell( stream_t *s )
 {
     int64_t i_pos;
     stream_Control( s, STREAM_GET_POSITION, &i_pos );
     return i_pos;
 }
+
+/**
+ * Get the size of the stream.
+ */
 static inline int64_t stream_Size( stream_t *s )
 {
     int64_t i_pos;
@@ -173,14 +209,22 @@ VLC_EXPORT( char *, stream_ReadLine, ( stream_t * ) );
  * Create a special stream and a demuxer, this allows chaining demuxers
  */
 #define stream_DemuxNew( a, b, c ) __stream_DemuxNew( VLC_OBJECT(a), b, c)
-VLC_EXPORT( stream_t *,__stream_DemuxNew, ( vlc_object_t *p_obj, char *psz_demux, es_out_t *out ) );
+VLC_EXPORT( stream_t *,__stream_DemuxNew, ( vlc_object_t *p_obj, const char *psz_demux, es_out_t *out ) );
 VLC_EXPORT( void,      stream_DemuxSend,  ( stream_t *s, block_t *p_block ) );
 VLC_EXPORT( void,      stream_DemuxDelete,( stream_t *s ) );
-#define stream_MemoryNew( a, b, c ) __stream_MemoryNew( VLC_OBJECT(a), b, c )
-VLC_EXPORT( stream_t *,__stream_MemoryNew, (vlc_object_t *p_obj, uint8_t *p_buffer, int64_t i_size ) );
-VLC_EXPORT( void,      stream_MemoryDelete,( stream_t *s, vlc_bool_t b_free_buffer ) );
+
+
+#define stream_MemoryNew( a, b, c, d ) __stream_MemoryNew( VLC_OBJECT(a), b, c, d )
+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 ) );
+#define stream_UrlNew( a, b ) __stream_UrlNew( VLC_OBJECT(a), b )
+VLC_EXPORT( stream_t *,__stream_UrlNew, (vlc_object_t *p_this, const char *psz_url ) );
+
 /**
  * @}
  */
 
+# ifdef __cplusplus
+}
+# endif
+
 #endif