Mercurial > hg > sv-dependency-builds

annotate src/libvorbis-1.3.3/doc/vorbis-errors.txt @ 94:d278df1123f9

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add liblo
author Chris Cannam <cannam@all-day-breakfast.com>
date Wed, 20 Mar 2013 15:25:02 +0000
parents 98c1576536ae
children
rev   line source
cannam@86 1 Error return codes possible from libvorbis and libvorbisfile:
cannam@86 2
cannam@86 3 All 'failure' style returns are <0; this either indicates a generic
cannam@86 4 'false' value (eg, ready? T or F) or an error condition. Code can
cannam@86 5 safely just test for < 0, or look at the specific return code for more
cannam@86 6 detail.
cannam@86 7
cannam@86 8 *** Return codes:
cannam@86 9
cannam@86 10 OV_FALSE The call returned a 'false' status (eg, ov_bitrate_instant
cannam@86 11 can return OV_FALSE if playback is not in progress, and thus
cannam@86 12 there is no instantaneous bitrate information to report.
cannam@86 13
cannam@86 14 OV_HOLE libvorbis/libvorbisfile is alerting the application that
cannam@86 15 there was an interruption in the data (one of: garbage
cannam@86 16 between pages, loss of sync followed by recapture, or a
cannam@86 17 corrupt page)
cannam@86 18
cannam@86 19 OV_EREAD A read from media returned an error.
cannam@86 20
cannam@86 21 OV_EFAULT Internal logic fault; indicates a bug or heap/stack
cannam@86 22 corruption.
cannam@86 23
cannam@86 24 OV_EIMPL The bitstream makes use of a feature not implemented in this
cannam@86 25 library version.
cannam@86 26
cannam@86 27 OV_EINVAL Invalid argument value.
cannam@86 28
cannam@86 29 OV_ENOTVORBIS Bitstream/page/packet is not Vorbis data.
cannam@86 30
cannam@86 31 OV_EBADHEADER Invalid Vorbis bitstream header.
cannam@86 32
cannam@86 33 OV_EVERSION Vorbis version mismatch.
cannam@86 34
cannam@86 35 OV_ENOTAUDIO Packet data submitted to vorbis_synthesis is not audio data.
cannam@86 36
cannam@86 37 OV_EBADPACKET Invalid packet submitted to vorbis_synthesis.
cannam@86 38
cannam@86 39 OV_EBADLINK Invalid stream section supplied to libvorbis/libvorbisfile,
cannam@86 40 or the requested link is corrupt.
cannam@86 41
cannam@86 42 OV_ENOSEEK Bitstream is not seekable.
cannam@86 43
cannam@86 44
cannam@86 45 ****************************************************************
cannam@86 46 *** Libvorbis functions that can return failure/error codes:
cannam@86 47
cannam@86 48 int vorbis_analysis_headerout()
cannam@86 49 OV_EIMPL
cannam@86 50
cannam@86 51 int vorbis_analysis_wrote()
cannam@86 52 OV_EINVAL
cannam@86 53
cannam@86 54 int vorbis_synthesis_headerin()
cannam@86 55 OV_ENOTVORBIS, OV_EVERSION, OV_EBADHEADER
cannam@86 56
cannam@86 57 int vorbis_synthesis()
cannam@86 58 OV_ENOTAUDIO, OV_EBADPACKET
cannam@86 59
cannam@86 60 int vorbis_synthesis_read()
cannam@86 61 OV_EINVAL
cannam@86 62
cannam@86 63 ****************************************************************
cannam@86 64 *** Libvorbisfile functions that can return failure/error codes:
cannam@86 65
cannam@86 66 int ov_open_callbacks()
cannam@86 67 OV_EREAD, OV_ENOTVORBIS, OV_EVERSION, OV_EBADHEADER, OV_FAULT
cannam@86 68
cannam@86 69 int ov_open()
cannam@86 70 OV_EREAD, OV_ENOTVORBIS, OV_EVERSION, OV_EBADHEADER, OV_FAULT
cannam@86 71
cannam@86 72 long ov_bitrate()
cannam@86 73 OV_EINVAL, OV_FALSE
cannam@86 74
cannam@86 75 long ov_bitrate_instant()
cannam@86 76 OV_FALSE
cannam@86 77
cannam@86 78 ogg_int64_t ov_raw_total()
cannam@86 79 OV_EINVAL
cannam@86 80
cannam@86 81 ogg_int64_t ov_pcm_total()
cannam@86 82 OV_EINVAL
cannam@86 83
cannam@86 84 double ov_time_total()
cannam@86 85 OV_EINVAL
cannam@86 86
cannam@86 87 int ov_raw_seek()
cannam@86 88 OV_ENOSEEK, OV_EINVAL, OV_BADLINK
cannam@86 89
cannam@86 90 int ov_pcm_seek_page()
cannam@86 91 OV_ENOSEEK, OV_EINVAL, OV_EREAD, OV_BADLINK, OV_FAULT
cannam@86 92
cannam@86 93 int ov_pcm_seek()
cannam@86 94 OV_ENOSEEK, OV_EINVAL, OV_EREAD, OV_BADLINK, OV_FAULT
cannam@86 95
cannam@86 96 int ov_time_seek()
cannam@86 97 OV_ENOSEEK, OV_EINVAL, OV_EREAD, OV_BADLINK, OV_FAULT
cannam@86 98
cannam@86 99 int ov_time_seek_page()
cannam@86 100 OV_ENOSEEK, OV_EINVAL, OV_EREAD, OV_BADLINK, OV_FAULT
cannam@86 101
cannam@86 102 long ov_read()
cannam@86 103 OV_HOLE, OV_EBADLINK