Merge branch_beta3 onto the mainline.
[platform/upstream/libvorbis.git] / lib / vorbis-errors.txt
1 All 'failure' style returns are <0; this either indicates a generic
2 'false' value (eg, ready?  T or F) or an error condition.  Code can
3 safely just test for < 0, or look at the specific return code for more
4 detail.
5
6 ---------- (internal calls) ------------
7
8
9 long _get_next_page()
10     OV_FALSE, OV_EOF, OV_EREAD  
11
12 long _get_prev_page()
13     OV_EREAD, OV_FAULT
14
15 int _bisect_forward_serialno()
16     OV_EREAD
17
18 int _fetch_headers()
19     OV_EREAD, OV_ENOTVORBIS, OV_EVERSION, OV_EBADHEADER
20
21 int _open_seekable()    
22     OV_EREAD, OV_ENOTVORBIS, OV_EVERSION, OV_EBADHEADER, OV_FAULT
23         + ov_raw_seek
24
25 int _open_nonseekable()
26     OV_EREAD, OV_ENOTVORBIS, OV_EVERSION, OV_EBADHEADER
27
28 int _process_packet()
29     OV_EOF, OV_HOLE, OV_EBADLINK
30
31 ---------- public calls ------------
32
33 int vorbis_analysis_headerout()
34     OV_EIMPL
35
36 int vorbis_analysis_wrote()
37     OV_EINVAL
38
39 int vorbis_synthesis_headerin()
40     OV_ENOTVORBIS, OV_EVERSION, OV_EBADHEADER
41
42 int vorbis_synthesis()
43     OV_ENOTAUDIO, OV_EBADPACKET
44
45 int vorbis_synthesis_read()
46     OV_EINVAL
47
48 int ov_open_callbacks()   
49     OV_EREAD, OV_ENOTVORBIS, OV_EVERSION, OV_EBADHEADER, OV_FAULT
50
51 int ov_open()
52     OV_EREAD, OV_ENOTVORBIS, OV_EVERSION, OV_EBADHEADER, OV_FAULT
53
54 long ov_bitrate()
55     OV_EINVAL, OV_FALSE
56
57 long ov_bitrate_instant()
58     OV_FALSE
59
60 ogg_int64_t ov_raw_total()
61     OV_EINVAL
62
63 ogg_int64_t ov_pcm_total()
64     OV_EINVAL
65
66 double ov_time_total()
67     OV_EINVAL
68
69 int ov_raw_seek()
70     OV_ENOSEEK, OV_EINVAL, OV_BADLINK
71
72 int ov_pcm_seek_page()
73     OV_ENOSEEK, OV_EINVAL, OV_EREAD, OV_BADLINK, OV_FAULT
74
75 int ov_pcm_seek()
76     OV_ENOSEEK, OV_EINVAL, OV_EREAD, OV_BADLINK, OV_FAULT
77
78 int ov_time_seek()
79     OV_ENOSEEK, OV_EINVAL, OV_EREAD, OV_BADLINK, OV_FAULT
80
81 int ov_time_seek_page()
82     OV_ENOSEEK, OV_EINVAL, OV_EREAD, OV_BADLINK, OV_FAULT
83