src/input/stream.h

   1 /*****************************************************************************
   2  * stream.h: Input stream functions
   3  *****************************************************************************
   4  * Copyright (C) 1998-2008 VLC authors and VideoLAN
   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 it
  11  * under the terms of the GNU Lesser General Public License as published by
  12  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public License
  21  * along with this program; if not, write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 #ifndef LIBVLC_INPUT_STREAM_H
  26 #define LIBVLC_INPUT_STREAM_H 1
  27
  28 #include <vlc_common.h>
  29 #include <vlc_stream.h>
  30
  31 /* */
  32 void stream_CommonDelete( stream_t *s );
  33
  34 /**
  35  * This function creates a stream_t with an access_t back-end.
  36  */
  37 stream_t *stream_AccessNew(vlc_object_t *, input_thread_t *, bool, const char *);
  38
  39 /**
  40  * Automatically wraps a stream with any applicable stream filter.
  41  * @return the (outermost/downstream) stream filter; if no filters were added,
  42  * then the function return the source parameter.
  43  * @note The function never returns NULL.
  44  */
  45 stream_t *stream_FilterAutoNew( stream_t *source ) VLC_USED;
  46
  47 /**
  48  * This function creates a chain of filters according to the colon-separated
  49  * list.
  50  *
  51  * You must release the returned value using vlc_stream_Delete unless it is
  52  * used as a source to another filter.
  53  */
  54 stream_t *stream_FilterChainNew( stream_t *p_source, const char *psz_chain );
  55
  56 /**
  57  * Attach \ref stream_extractor%s according to specified data
  58  *
  59  * This function will parse the passed data, and try to attach a \ref
  60  * stream_extractor for each specified entity as per the fragment specification
  61  * associated with a \ref mrl,
  62  *
  63  * \warning The data in `*stream` can be modified even if this function only
  64  *          locates some of the entities specified in `psz_data`. It is up to
  65  *          the caller to free the resource referred to by `*stream`, no matter
  66  *          what this function returns.
  67  *
  68  * \warning Please see \ref vlc_stream_extractor_Attach for a function that
  69  *          will not modify the passed stream upon failure. \ref
  70  *          stream_extractor_AttachParsed shall only be used when the caller
  71  *          only cares about the stream on successful attachment of **all**
  72  *          stream-extractors referred to by `psz_data`, something which is not
  73  *          guaranteed.
  74  *
  75  * \param[out] source a pointer-to-pointer to stream where the attached
  76  *             stream-extractor will be applied. `*stream` will refer
  77  *             to the last successful attachment.
  78  * \param[out] out_extra `*out_extra` will point to any additional data
  79  *             in `psz_data` that does not specify an entity (if any).
  80  * \return VLC_SUCCESS on success, an error-code on failure
  81  **/
  82 int stream_extractor_AttachParsed( stream_t** stream, const char* psz_data,
  83                                    char const** out_extra );
  84
  85 char *get_path(const char *location);
  86
  87 #endif