oggz_constants.h

Go to the documentation of this file.
00001 /*
00002    Copyright (C) 2003 Commonwealth Scientific and Industrial Research
00003    Organisation (CSIRO) Australia
00004 
00005    Redistribution and use in source and binary forms, with or without
00006    modification, are permitted provided that the following conditions
00007    are met:
00008 
00009    - Redistributions of source code must retain the above copyright
00010    notice, this list of conditions and the following disclaimer.
00011 
00012    - Redistributions in binary form must reproduce the above copyright
00013    notice, this list of conditions and the following disclaimer in the
00014    documentation and/or other materials provided with the distribution.
00015 
00016    - Neither the name of CSIRO Australia nor the names of its
00017    contributors may be used to endorse or promote products derived from
00018    this software without specific prior written permission.
00019 
00020    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00021    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00022    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
00023    PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE ORGANISATION OR
00024    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00025    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00026    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00027    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00028    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00029    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00030    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00031 */
00032 
00033 #ifndef __OGGZ_CONSTANTS_H__
00034 #define __OGGZ_CONSTANTS_H__
00035 
00046 enum OggzFlags {
00048   OGGZ_READ         = 0x00,
00049 
00051   OGGZ_WRITE        = 0x01,
00052 
00055   OGGZ_NONSTRICT    = 0x10,
00056 
00063   OGGZ_AUTO         = 0x20,
00064 
00068   OGGZ_PREFIX       = 0x40,
00069 
00073   OGGZ_SUFFIX       = 0x80
00074 
00075 };
00076 
00077 enum OggzStopCtl {
00079   OGGZ_CONTINUE     = 0,
00080 
00082   OGGZ_STOP_OK      = 1,
00083 
00085   OGGZ_STOP_ERR     = -1
00086 };
00087 
00091 enum OggzFlushOpts {
00093   OGGZ_FLUSH_BEFORE = 0x01,
00094 
00096   OGGZ_FLUSH_AFTER  = 0x02
00097 };
00098 
00102 typedef enum OggzStreamContent {
00103   OGGZ_CONTENT_THEORA = 0,
00104   OGGZ_CONTENT_VORBIS,
00105   OGGZ_CONTENT_SPEEX,
00106   OGGZ_CONTENT_PCM,
00107   OGGZ_CONTENT_CMML,
00108   OGGZ_CONTENT_ANX2,
00109   OGGZ_CONTENT_SKELETON,
00110   OGGZ_CONTENT_FLAC0,
00111   OGGZ_CONTENT_FLAC,
00112   OGGZ_CONTENT_ANXDATA,
00113   OGGZ_CONTENT_CELT,
00114   OGGZ_CONTENT_KATE,
00115   OGGZ_CONTENT_UNKNOWN
00116 } OggzStreamContent;
00117 
00121 enum OggzError {
00123   OGGZ_ERR_OK                           = 0,
00124 
00126   OGGZ_ERR_GENERIC                      = -1,
00127 
00129   OGGZ_ERR_BAD_OGGZ                     = -2,
00130 
00132   OGGZ_ERR_INVALID                      = -3,
00133 
00135   OGGZ_ERR_NO_STREAMS                   = -4,
00136 
00138   OGGZ_ERR_BOS                          = -5,
00139 
00141   OGGZ_ERR_EOS                          = -6,
00142 
00144   OGGZ_ERR_BAD_METRIC                   = -7,
00145 
00147   OGGZ_ERR_SYSTEM                       = -10,
00148 
00150   OGGZ_ERR_DISABLED                     = -11,
00151 
00153   OGGZ_ERR_NOSEEK                       = -13,
00154 
00158   OGGZ_ERR_STOP_OK                      = -14,
00159 
00163   OGGZ_ERR_STOP_ERR                     = -15,
00164 
00166   OGGZ_ERR_IO_AGAIN                     = -16,
00167 
00169   OGGZ_ERR_BAD_SERIALNO                 = -20,
00170 
00172   OGGZ_ERR_BAD_BYTES                    = -21,
00173 
00175   OGGZ_ERR_BAD_B_O_S                    = -22,
00176 
00178   OGGZ_ERR_BAD_E_O_S                    = -23,
00179 
00181   OGGZ_ERR_BAD_GRANULEPOS               = -24,
00182 
00184   OGGZ_ERR_BAD_PACKETNO                 = -25,
00185 
00187   /* 129 == 0x81 is the frame marker for Theora's comments page ;-) */
00188   OGGZ_ERR_COMMENT_INVALID              = -129,
00189 
00191   OGGZ_ERR_BAD_GUARD                    = -210,
00192 
00195   OGGZ_ERR_RECURSIVE_WRITE              = -266
00196 };
00197 
00198 #endif /* __OGGZ_CONSTANTS_H__ */

Generated on Fri Jul 4 18:32:29 2008 for liboggz by  doxygen 1.5.3