src/input/stream.h

   1 /*****************************************************************************
   2  * stream.h: Input stream functions
   3  *****************************************************************************
   4  * Copyright (C) 1998-2008 the VideoLAN team
   5  * Copyright (C) 2008 Laurent Aimar
   6  * $Id$
   7  *
   8  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 #if defined(__PLUGIN__) || defined(__BUILTIN__) || !defined(__LIBVLC__)
  26 # error This header file can only be included from LibVLC.
  27 #endif
  28
  29 #ifndef _INPUT_STREAM_H
  30 #define _INPUT_STREAM_H 1
  31
  32 #include <vlc_common.h>
  33 #include <vlc_stream.h>
  34
  35 struct stream_text_t
  36 {
  37     /* UTF-16 and UTF-32 file reading */
  38     vlc_iconv_t     conv;
  39     int             i_char_width;
  40     bool            b_little_endian;
  41 };
  42
  43 /* */
  44 stream_t *stream_CommonNew( vlc_object_t * );
  45 void stream_CommonDelete( stream_t * );
  46
  47 /**
  48  * This function creates a stream_t from a provided access_t.
  49  *
  50  * An optional NULL terminated list of file may be provided. The content
  51  * of these extra files will be concatenated after to the main access.
  52  *
  53  * XXX ppsz_list is treated as const (I failed to avoid a warning when
  54  * using const keywords for pointer of pointers)
  55  */
  56 stream_t *stream_AccessNew( access_t *p_access, char **ppsz_list );
  57
  58 /**
  59  * This function creates a new stream_t filter.
  60  *
  61  * You must release it using stream_Delete unless it is used as a
  62  * source to another filter.
  63  */
  64 stream_t *stream_FilterNew( stream_t *p_source,
  65                             const char *psz_stream_filter );
  66
  67 /**
  68  * This function creates a chain of filters:
  69  * - first, automatic probed stream filters are inserted.
  70  * - then, optional user filters (configured by psz_chain) are inserted.
  71  * - finaly, an optional record filter is inserted if b_record is true.
  72  *
  73  * You must release the returned value using stream_Delete unless it is used as a
  74  * source to another filter.
  75  */
  76 stream_t *stream_FilterChainNew( stream_t *p_source,
  77                                  const char *psz_chain,
  78                                  bool b_record );
  79 #endif
  80