media/liboggz/include/oggz/oggz_constants.h

   1 /*
   2    Copyright (C) 2003 Commonwealth Scientific and Industrial Research
   3    Organisation (CSIRO) Australia
   4
   5    Redistribution and use in source and binary forms, with or without
   6    modification, are permitted provided that the following conditions
   7    are met:
   8
   9    - Redistributions of source code must retain the above copyright
  10    notice, this list of conditions and the following disclaimer.
  11
  12    - Redistributions in binary form must reproduce the above copyright
  13    notice, this list of conditions and the following disclaimer in the
  14    documentation and/or other materials provided with the distribution.
  15
  16    - Neither the name of CSIRO Australia nor the names of its
  17    contributors may be used to endorse or promote products derived from
  18    this software without specific prior written permission.
  19
  20    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  23    PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE ORGANISATION OR
  24    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  25    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  26    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  27    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  28    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  29    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  30    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31 */
  32
  33 #ifndef __OGGZ_CONSTANTS_H__
  34 #define __OGGZ_CONSTANTS_H__
  35
  36 /** \file
  37  * General constants used by liboggz.
  38  */
  39
  40 /**
  41  * Flags to oggz_new(), oggz_open(), and oggz_openfd().
  42  * Can be or'ed together in the following combinations:
  43  * - OGGZ_READ | OGGZ_AUTO
  44  * - OGGZ_WRITE | OGGZ_NONSTRICT
  45  */
  46 enum OggzFlags {
  47   /** Read only */
  48   OGGZ_READ         = 0x00,
  49
  50   /** Write only */
  51   OGGZ_WRITE        = 0x01,
  52
  53   /** Disable strict adherence to mapping constraints, eg for
  54    * handling an incomplete stream */
  55   OGGZ_NONSTRICT    = 0x10,
  56
  57   /**
  58    * Scan for known headers while reading, and automatically set
  59    * metrics appropriately. Opening a file for reading with
  60    * \a flags = OGGZ_READ | OGGZ_AUTO will allow seeking on Speex,
  61    * Vorbis, FLAC, Theora, CMML and all Annodex streams in units of
  62    * milliseconds, once all bos pages have been delivered. */
  63   OGGZ_AUTO         = 0x20,
  64
  65   /**
  66    * Prefix
  67    */
  68   OGGZ_PREFIX       = 0x40,
  69
  70   /**
  71    * Suffix
  72    */
  73   OGGZ_SUFFIX       = 0x80
  74
  75 };
  76
  77 enum OggzStopCtl {
  78   /** Continue calling read callbacks */
  79   OGGZ_CONTINUE     = 0,
  80
  81   /** Stop calling callbacks, but retain buffered packet data */
  82   OGGZ_STOP_OK      = 1,
  83
  84   /** Stop calling callbacks, and purge buffered packet data */
  85   OGGZ_STOP_ERR     = -1
  86 };
  87
  88 /**
  89  * Flush options for oggz_write_feed; can be or'ed together
  90  */
  91 enum OggzFlushOpts {
  92   /** Flush all streams before beginning this packet */
  93   OGGZ_FLUSH_BEFORE = 0x01,
  94
  95   /** Flush after this packet */
  96   OGGZ_FLUSH_AFTER  = 0x02
  97 };
  98
  99 /**
 100  * Definition of stream content types
 101  */
 102 typedef enum OggzStreamContent {
 103   OGGZ_CONTENT_THEORA = 0,
 104   OGGZ_CONTENT_VORBIS,
 105   OGGZ_CONTENT_SPEEX,
 106   OGGZ_CONTENT_PCM,
 107   OGGZ_CONTENT_CMML,
 108   OGGZ_CONTENT_ANX2,
 109   OGGZ_CONTENT_SKELETON,
 110   OGGZ_CONTENT_FLAC0,
 111   OGGZ_CONTENT_FLAC,
 112   OGGZ_CONTENT_ANXDATA,
 113   OGGZ_CONTENT_CELT,
 114   OGGZ_CONTENT_KATE,
 115   OGGZ_CONTENT_UNKNOWN
 116 } OggzStreamContent;
 117
 118 /**
 119  * Definitions of error return values
 120  */
 121 enum OggzError {
 122   /** No error */
 123   OGGZ_ERR_OK                           = 0,
 124
 125   /** generic error */
 126   OGGZ_ERR_GENERIC                      = -1,
 127
 128   /** oggz is not a valid OGGZ */
 129   OGGZ_ERR_BAD_OGGZ                     = -2,
 130
 131   /** The requested operation is not suitable for this OGGZ */
 132   OGGZ_ERR_INVALID                      = -3,
 133
 134   /** oggz contains no logical bitstreams */
 135   OGGZ_ERR_NO_STREAMS                   = -4,
 136
 137   /** Operation is inappropriate for oggz in current bos state */
 138   OGGZ_ERR_BOS                          = -5,
 139
 140   /** Operation is inappropriate for oggz in current eos state */
 141   OGGZ_ERR_EOS                          = -6,
 142
 143   /** Operation requires a valid metric, but none has been set */
 144   OGGZ_ERR_BAD_METRIC                   = -7,
 145
 146   /** System specific error; check errno for details */
 147   OGGZ_ERR_SYSTEM                       = -10,
 148
 149   /** Functionality disabled at build time */
 150   OGGZ_ERR_DISABLED                     = -11,
 151
 152   /** Seeking operation is not possible for this OGGZ */
 153   OGGZ_ERR_NOSEEK                       = -13,
 154
 155   /** Reading was stopped by an OggzReadCallback returning OGGZ_STOP_OK
 156    * or writing was stopped by an  OggzWriteHungry callback returning
 157    * OGGZ_STOP_OK */
 158   OGGZ_ERR_STOP_OK                      = -14,
 159
 160   /** Reading was stopped by an OggzReadCallback returning OGGZ_STOP_ERR
 161    * or writing was stopped by an OggzWriteHungry callback returning
 162    * OGGZ_STOP_ERR */
 163   OGGZ_ERR_STOP_ERR                     = -15,
 164
 165   /** no data available from IO, try again */
 166   OGGZ_ERR_IO_AGAIN                     = -16,
 167
 168   /** The requested serialno does not exist in this OGGZ */
 169   OGGZ_ERR_BAD_SERIALNO                 = -20,
 170
 171   /** Packet disallowed due to invalid byte length */
 172   OGGZ_ERR_BAD_BYTES                    = -21,
 173
 174   /** Packet disallowed due to invalid b_o_s (beginning of stream) flag */
 175   OGGZ_ERR_BAD_B_O_S                    = -22,
 176
 177   /** Packet disallowed due to invalid e_o_s (end of stream) flag */
 178   OGGZ_ERR_BAD_E_O_S                    = -23,
 179
 180   /** Packet disallowed due to invalid granulepos */
 181   OGGZ_ERR_BAD_GRANULEPOS               = -24,
 182
 183   /** Packet disallowed due to invalid packetno */
 184   OGGZ_ERR_BAD_PACKETNO                 = -25,
 185
 186   /** Comment violates VorbisComment restrictions */
 187   /* 129 == 0x81 is the frame marker for Theora's comments page ;-) */
 188   OGGZ_ERR_COMMENT_INVALID              = -129,
 189
 190   /** Guard provided by user has non-zero value */
 191   OGGZ_ERR_BAD_GUARD                    = -210,
 192
 193   /** Attempt to call oggz_write() or oggz_write_output() from within
 194    * a hungry() callback */
 195   OGGZ_ERR_RECURSIVE_WRITE              = -266
 196 };
 197
 198 #endif /* __OGGZ_CONSTANTS_H__ */