source-git / liboggz

Clone
Source Code
GIT

Blame doc/liboggz/html/oggz__constants_8h.html

c8 master
  1.   a38265c151febe58ffeccb687eb04df20f600a9d
  2.   doc
  3.   liboggz
  4.   html
  5.   oggz__constants_8h.html
Blob History Raw
Packit a38265
Packit a38265 
<html xmlns="http://www.w3.org/1999/xhtml">
Packit a38265 
<head>
Packit a38265 
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
Packit a38265 
<title>liboggz: oggz_constants.h File Reference</title>
Packit a38265 
<link href="tabs.css" rel="stylesheet" type="text/css"/>
Packit a38265 
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
Packit a38265 
</head>
Packit a38265 
<body>
Packit a38265
Packit a38265
Packit a38265
Packit a38265
    Packit a38265 
          
  • Main Page
    		•
    Packit a38265 
          
  • Modules
    		•
    Packit a38265 
          
  • Data Structures
    		•
    Packit a38265 
          
  • Files
    		•
    Packit a38265
    Packit a38265
    Packit a38265
    Packit a38265
      Packit a38265 
            
    • File List
      		•
      Packit a38265 
            
    • Globals
      		•
      Packit a38265
      Packit a38265
      Packit a38265
      Packit a38265
      Packit a38265 
      oggz_constants.h File Reference
      Packit a38265 
      General constants used by liboggz.
      Packit a38265 
      More...
      Packit a38265
      Packit a38265 
      Go to the source code of this file.
      Packit a38265
      Packit a38265 
      Typedefs
      Packit a38265
      Packit a38265 
      typedef enum OggzStreamContent OggzStreamContent
      Packit a38265 
       Definition of stream content types.
      Packit a38265 
      Enumerations
      Packit a38265 
      enum  OggzFlags {
      Packit a38265 
        OGGZ_READ =  0x00,
      Packit a38265 
      OGGZ_WRITE =  0x01,
      Packit a38265 
      OGGZ_NONSTRICT =  0x10,
      Packit a38265 
      OGGZ_AUTO =  0x20,
      Packit a38265

      Packit a38265 
        OGGZ_PREFIX =  0x40,
      Packit a38265 
      OGGZ_SUFFIX =  0x80
      Packit a38265

      Packit a38265 
       }
      Packit a38265 
       
      Flags to oggz_new(), oggz_open(), and oggz_openfd().
      Packit a38265 
       More...
      Packit a38265 
      enum  OggzStopCtl { OGGZ_CONTINUE =  0,
      Packit a38265 
      OGGZ_STOP_OK =  1,
      Packit a38265 
      OGGZ_STOP_ERR =  -1
      Packit a38265 
       }
      Packit a38265 
      enum  OggzFlushOpts { OGGZ_FLUSH_BEFORE =  0x01,
      Packit a38265 
      OGGZ_FLUSH_AFTER =  0x02
      Packit a38265 
       }
      Packit a38265 
       
      Flush options for oggz_write_feed; can be or'ed together.
      Packit a38265 
       More...
      Packit a38265 
      enum  OggzStreamContent {
      Packit a38265 
        OGGZ_CONTENT_THEORA =  0,
      Packit a38265 
      OGGZ_CONTENT_VORBIS,
      Packit a38265 
      OGGZ_CONTENT_SPEEX,
      Packit a38265 
      OGGZ_CONTENT_PCM,
      Packit a38265

      Packit a38265 
        OGGZ_CONTENT_CMML,
      Packit a38265 
      OGGZ_CONTENT_ANX2,
      Packit a38265 
      OGGZ_CONTENT_SKELETON,
      Packit a38265 
      OGGZ_CONTENT_FLAC0,
      Packit a38265

      Packit a38265 
        OGGZ_CONTENT_FLAC,
      Packit a38265 
      OGGZ_CONTENT_ANXDATA,
      Packit a38265 
      OGGZ_CONTENT_CELT,
      Packit a38265 
      OGGZ_CONTENT_KATE,
      Packit a38265

      Packit a38265 
        OGGZ_CONTENT_DIRAC,
      Packit a38265 
      OGGZ_CONTENT_UNKNOWN
      Packit a38265

      Packit a38265 
       }
      Packit a38265 
       
      Definition of stream content types.
      Packit a38265

      Packit a38265 
      enum  OggzError {
      Packit a38265 
        OGGZ_ERR_OK =  0,
      Packit a38265 
      OGGZ_ERR_GENERIC =  -1,
      Packit a38265 
      OGGZ_ERR_BAD_OGGZ =  -2,
      Packit a38265 
      OGGZ_ERR_INVALID =  -3,
      Packit a38265

      Packit a38265 
        OGGZ_ERR_NO_STREAMS =  -4,
      Packit a38265 
      OGGZ_ERR_BOS =  -5,
      Packit a38265 
      OGGZ_ERR_EOS =  -6,
      Packit a38265 
      OGGZ_ERR_BAD_METRIC =  -7,
      Packit a38265

      Packit a38265 
        OGGZ_ERR_SYSTEM =  -10,
      Packit a38265 
      OGGZ_ERR_DISABLED =  -11,
      Packit a38265 
      OGGZ_ERR_NOSEEK =  -13,
      Packit a38265 
      OGGZ_ERR_STOP_OK =  -14,
      Packit a38265

      Packit a38265 
        OGGZ_ERR_STOP_ERR =  -15,
      Packit a38265 
      OGGZ_ERR_IO_AGAIN =  -16,
      Packit a38265 
      OGGZ_ERR_HOLE_IN_DATA =  -17,
      Packit a38265 
      OGGZ_ERR_OUT_OF_MEMORY =  -18,
      Packit a38265

      Packit a38265 
        OGGZ_ERR_BAD_SERIALNO =  -20,
      Packit a38265 
      OGGZ_ERR_BAD_BYTES =  -21,
      Packit a38265 
      OGGZ_ERR_BAD_B_O_S =  -22,
      Packit a38265 
      OGGZ_ERR_BAD_E_O_S =  -23,
      Packit a38265

      Packit a38265 
        OGGZ_ERR_BAD_GRANULEPOS =  -24,
      Packit a38265 
      OGGZ_ERR_BAD_PACKETNO =  -25,
      Packit a38265 
      OGGZ_ERR_COMMENT_INVALID =  -129,
      Packit a38265 
      OGGZ_ERR_BAD_GUARD =  -210,
      Packit a38265

      Packit a38265 
        OGGZ_ERR_RECURSIVE_WRITE =  -266
      Packit a38265

      Packit a38265 
       }
      Packit a38265 
       
      Definitions of error return values.
      Packit a38265 
       More...
      Packit a38265
      Packit a38265 
      Detailed Description
      Packit a38265 
      General constants used by liboggz.
      Packit a38265 
      Enumeration Type Documentation
      Packit a38265
      Packit a38265
      Packit a38265
      Packit a38265
      Packit a38265
      Packit a38265 
                enum OggzError
      Packit a38265
      Packit a38265
      Packit a38265
      Packit a38265
      Packit a38265
      Packit a38265 
      Definitions of error return values.
      Packit a38265 
      Enumerator:
      Packit a38265 
      OGGZ_ERR_OK 
      Packit a38265 
      No error.
      Packit a38265
      Packit a38265 
      OGGZ_ERR_GENERIC 
      Packit a38265 
      generic error
      Packit a38265
      Packit a38265 
      OGGZ_ERR_BAD_OGGZ 
      Packit a38265 
      oggz is not a valid OGGZ
      Packit a38265
      Packit a38265 
      OGGZ_ERR_INVALID 
      Packit a38265 
      The requested operation is not suitable for this OGGZ.
      Packit a38265
      Packit a38265 
      OGGZ_ERR_NO_STREAMS 
      Packit a38265 
      oggz contains no logical bitstreams
      Packit a38265
      Packit a38265 
      OGGZ_ERR_BOS 
      Packit a38265 
      Operation is inappropriate for oggz in current bos state.
      Packit a38265
      Packit a38265 
      OGGZ_ERR_EOS 
      Packit a38265 
      Operation is inappropriate for oggz in current eos state.
      Packit a38265
      Packit a38265 
      OGGZ_ERR_BAD_METRIC 
      Packit a38265 
      Operation requires a valid metric, but none has been set.
      Packit a38265
      Packit a38265 
      OGGZ_ERR_SYSTEM 
      Packit a38265 
      System specific error; check errno for details.
      Packit a38265
      Packit a38265 
      OGGZ_ERR_DISABLED 
      Packit a38265 
      Functionality disabled at build time.
      Packit a38265
      Packit a38265 
      OGGZ_ERR_NOSEEK 
      Packit a38265 
      Seeking operation is not possible for this OGGZ.
      Packit a38265
      Packit a38265 
      OGGZ_ERR_STOP_OK 
      Packit a38265 
      Reading was stopped by an OggzReadCallback returning OGGZ_STOP_OK or writing was stopped by an OggzWriteHungry callback returning OGGZ_STOP_OK.
      Packit a38265
      Packit a38265 
      OGGZ_ERR_STOP_ERR 
      Packit a38265 
      Reading was stopped by an OggzReadCallback returning OGGZ_STOP_ERR or writing was stopped by an OggzWriteHungry callback returning OGGZ_STOP_ERR.
      Packit a38265
      Packit a38265 
      OGGZ_ERR_IO_AGAIN 
      Packit a38265 
      no data available from IO, try again
      Packit a38265
      Packit a38265 
      OGGZ_ERR_HOLE_IN_DATA 
      Packit a38265 
      Hole (sequence number gap) detected in input data.
      Packit a38265
      Packit a38265 
      OGGZ_ERR_OUT_OF_MEMORY 
      Packit a38265 
      Out of memory.
      Packit a38265
      Packit a38265 
      OGGZ_ERR_BAD_SERIALNO 
      Packit a38265 
      The requested serialno does not exist in this OGGZ.
      Packit a38265
      Packit a38265 
      OGGZ_ERR_BAD_BYTES 
      Packit a38265 
      Packet disallowed due to invalid byte length.
      Packit a38265
      Packit a38265 
      OGGZ_ERR_BAD_B_O_S 
      Packit a38265 
      Packet disallowed due to invalid b_o_s (beginning of stream) flag.
      Packit a38265
      Packit a38265 
      OGGZ_ERR_BAD_E_O_S 
      Packit a38265 
      Packet disallowed due to invalid e_o_s (end of stream) flag.
      Packit a38265
      Packit a38265 
      OGGZ_ERR_BAD_GRANULEPOS 
      Packit a38265 
      Packet disallowed due to invalid granulepos.
      Packit a38265
      Packit a38265 
      OGGZ_ERR_BAD_PACKETNO 
      Packit a38265 
      Packet disallowed due to invalid packetno.
      Packit a38265
      Packit a38265 
      OGGZ_ERR_COMMENT_INVALID 
      Packit a38265 
      Comment violates VorbisComment restrictions.
      Packit a38265
      Packit a38265 
      OGGZ_ERR_BAD_GUARD 
      Packit a38265 
      Guard provided by user has non-zero value.
      Packit a38265
      Packit a38265 
      OGGZ_ERR_RECURSIVE_WRITE 
      Packit a38265 
      Attempt to call oggz_write() or oggz_write_output() from within a hungry() callback.
      Packit a38265
      Packit a38265
      Packit a38265
      Packit a38265
      Packit a38265
      Packit a38265
      Packit a38265
      Packit a38265
      Packit a38265
      Packit a38265
      Packit a38265
      Packit a38265
      Packit a38265 
                enum OggzFlags
      Packit a38265
      Packit a38265
      Packit a38265
      Packit a38265
      Packit a38265
      Packit a38265 
      Flags to oggz_new(), oggz_open(), and oggz_openfd().
      Packit a38265 
      Can be or'ed together in the following combinations:
      Packit a38265
        Packit a38265 
      • OGGZ_READ | OGGZ_AUTO
        		•
        Packit a38265 
      • OGGZ_WRITE | OGGZ_NONSTRICT | OGGZ_PREFIX | OGGZ_SUFFIX
        • Packit a38265
        Packit a38265 
        Enumerator:
        Packit a38265 
        OGGZ_READ 
        Packit a38265 
        Read only.
        Packit a38265
        Packit a38265 
        OGGZ_WRITE 
        Packit a38265 
        Write only.
        Packit a38265
        Packit a38265 
        OGGZ_NONSTRICT 
        Packit a38265 
        Disable strict adherence to mapping constraints, eg for handling an incomplete stream.
        Packit a38265
        Packit a38265 
        OGGZ_AUTO 
        Packit a38265 
        Scan for known headers while reading, and automatically set metrics appropriately.
        Packit a38265 
        Opening a file for reading with flags = OGGZ_READ | OGGZ_AUTO will allow seeking on Speex, Vorbis, FLAC, Theora, CMML and all Annodex streams in units of milliseconds, once all bos pages have been delivered.
        Packit a38265
        Packit a38265 
        OGGZ_PREFIX 
        Packit a38265 
        Write Prefix: Assume that we are only writing the prefix of an Ogg stream, ie.
        Packit a38265 
        disable checking for conformance with end-of-stream constraints.
        Packit a38265
        Packit a38265 
        OGGZ_SUFFIX 
        Packit a38265 
        Write Suffix: Assume that we are only writing the suffix of an Ogg stream, ie.
        Packit a38265 
        disable checking for conformance with beginning-of-stream constraints.
        Packit a38265
        Packit a38265
        Packit a38265
        Packit a38265
        Packit a38265
        Packit a38265
        Packit a38265
        Packit a38265
        Packit a38265
        Packit a38265
        Packit a38265
        Packit a38265
        Packit a38265 
                  enum OggzFlushOpts
        Packit a38265
        Packit a38265
        Packit a38265
        Packit a38265
        Packit a38265
        Packit a38265 
        Flush options for oggz_write_feed; can be or'ed together.
        Packit a38265 
        Enumerator:
        Packit a38265 
        OGGZ_FLUSH_BEFORE 
        Packit a38265 
        Flush all streams before beginning this packet.
        Packit a38265
        Packit a38265 
        OGGZ_FLUSH_AFTER 
        Packit a38265 
        Flush after this packet.
        Packit a38265
        Packit a38265
        Packit a38265
        Packit a38265
        Packit a38265
        Packit a38265
        Packit a38265
        Packit a38265
        Packit a38265
        Packit a38265
        Packit a38265
        Packit a38265
        Packit a38265 
                  enum OggzStopCtl
        Packit a38265
        Packit a38265
        Packit a38265
        Packit a38265
        Packit a38265 
        Enumerator:
        Packit a38265 
        OGGZ_CONTINUE 
        Packit a38265 
        Continue calling read callbacks.
        Packit a38265
        Packit a38265 
        OGGZ_STOP_OK 
        Packit a38265 
        Stop calling callbacks, but retain buffered packet data.
        Packit a38265
        Packit a38265 
        OGGZ_STOP_ERR 
        Packit a38265 
        Stop calling callbacks, and purge buffered packet data.
        Packit a38265
        Packit a38265
        Packit a38265
        Packit a38265
        Packit a38265
        Packit a38265
        Packit a38265
        Packit a38265
        Packit a38265 
        <address style="text-align: right;"><small>Generated on Sat Apr 24 09:13:55 2010 for liboggz by 
        Packit a38265
        Packit a38265 
        doxygen 1.6.3 </small></address>
        Packit a38265 
        </body>
        Packit a38265 
        </html>

        Powered by Pagure 5.13.3

        SSH Hostkey/Fingerprint | Documentation