media/liboggz/include/oggz/oggz_stream.h

   1 /*
   2    Copyright (C) 2007 Annodex Association
   3
   4    Redistribution and use in source and binary forms, with or without
   5    modification, are permitted provided that the following conditions
   6    are met:
   7
   8    - Redistributions of source code must retain the above copyright
   9    notice, this list of conditions and the following disclaimer.
  10
  11    - Redistributions in binary form must reproduce the above copyright
  12    notice, this list of conditions and the following disclaimer in the
  13    documentation and/or other materials provided with the distribution.
  14
  15    - Neither the name of the Annodex Association nor the names of its
  16    contributors may be used to endorse or promote products derived from
  17    this software without specific prior written permission.
  18
  19    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  22    PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE ASSOCIATION OR
  23    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  24    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  25    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  26    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  27    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  28    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  29    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30 */
  31
  32 #ifndef __OGGZ_STREAM_H__
  33 #define __OGGZ_STREAM_H__
  34
  35 /** \file
  36  * Interfaces for querying Ogg streams
  37  */
  38
  39 /**
  40  * Determine the content type of the oggz stream referred to by \a serialno
  41  *
  42  * \param oggz An OGGZ handle
  43  * \param serialno An ogg stream serialno
  44  * \retval OGGZ_CONTENT_THEORA..OGGZ_CONTENT_UNKNOWN content successfully
  45  *          identified
  46  * \retval OGGZ_ERR_BAD_OGGZ \a oggz does not refer to an existing OGGZ
  47  * \retval OGGZ_ERR_BAD_SERIALNO \a serialno does not refer to an existing
  48  *          stream
  49  */
  50 OggzStreamContent oggz_stream_get_content (OGGZ * oggz, long serialno);
  51
  52 /**
  53  * Return human-readable string representation of content type of oggz stream
  54  * referred to by \a serialno
  55  *
  56  * \param oggz An OGGZ handle
  57  * \param serialno An ogg stream serialno
  58  * \retval string the name of the content type
  59  * \retval NULL \a oggz or \a serialno invalid
  60  */
  61 const char * oggz_stream_get_content_type (OGGZ *oggz, long serialno);
  62
  63 /**
  64  * Determine the number of headers of the oggz stream referred to by
  65  * \a serialno
  66  *
  67  * \param oggz An OGGZ handle
  68  * \param serialno An ogg stream serialno
  69  * \retval OGGZ_CONTENT_THEORA..OGGZ_CONTENT_UNKNOWN content successfully
  70  *          identified
  71  * \retval OGGZ_ERR_BAD_OGGZ \a oggz does not refer to an existing OGGZ
  72  * \retval OGGZ_ERR_BAD_SERIALNO \a serialno does not refer to an existing
  73  *          stream
  74  */
  75 int oggz_stream_get_numheaders (OGGZ * oggz, long serialno);
  76
  77 #endif /* __OGGZ_STREAM_H__ */