lavf/segment: apply misc fixes to the private options internal documentation
[ffmpeg.git] / libavcodec / vorbis.c
1 /**
2  * @file
3  * Common code for Vorbis I encoder and decoder
4  * @author Denes Balatoni  ( dbalatoni programozo hu )
5  *
6  * This file is part of FFmpeg.
7  *
8  * FFmpeg is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * FFmpeg is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with FFmpeg; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  */
22
23 /**
24  * @file
25  * Common code for Vorbis I encoder and decoder
26  * @author Denes Balatoni  ( dbalatoni programozo hu )
27  */
28
29 #define BITSTREAM_READER_LE
30 #include "avcodec.h"
31 #include "get_bits.h"
32
33 #include "vorbis.h"
34
35
36 /* Helper functions */
37
38 // x^(1/n)
39 unsigned int ff_vorbis_nth_root(unsigned int x, unsigned int n)
40 {
41     unsigned int ret = 0, i, j;
42
43     do {
44         ++ret;
45         for (i = 0, j = ret; i < n - 1; i++)
46             j *= ret;
47     } while (j <= x);
48
49     return ret - 1;
50 }
51
52 // Generate vlc codes from vorbis huffman code lengths
53
54 // the two bits[p] > 32 checks should be redundant, all calling code should
55 // already ensure that, but since it allows overwriting the stack it seems
56 // reasonable to check redundantly.
57 int ff_vorbis_len2vlc(uint8_t *bits, uint32_t *codes, unsigned num)
58 {
59     uint32_t exit_at_level[33] = { 404 };
60
61     unsigned i, j, p, code;
62
63 #ifdef DEBUG
64     GetBitContext gb;
65 #endif
66
67     for (p = 0; (bits[p] == 0) && (p < num); ++p)
68         ;
69     if (p == num) {
70 //        av_log(vc->avccontext, AV_LOG_INFO, "An empty codebook. Heh?! \n");
71         return 0;
72     }
73
74     codes[p] = 0;
75     if (bits[p] > 32)
76         return 1;
77     for (i = 0; i < bits[p]; ++i)
78         exit_at_level[i+1] = 1 << i;
79
80 #ifdef DEBUG
81     av_log(NULL, AV_LOG_INFO, " %u. of %u code len %d code %d - ", p, num, bits[p], codes[p]);
82     init_get_bits(&gb, (uint8_t *)&codes[p], bits[p]);
83     for (i = 0; i < bits[p]; ++i)
84         av_log(NULL, AV_LOG_INFO, "%s", get_bits1(&gb) ? "1" : "0");
85     av_log(NULL, AV_LOG_INFO, "\n");
86 #endif
87
88     ++p;
89
90     for (; p < num; ++p) {
91         if (bits[p] > 32)
92              return 1;
93         if (bits[p] == 0)
94              continue;
95         // find corresponding exit(node which the tree can grow further from)
96         for (i = bits[p]; i > 0; --i)
97             if (exit_at_level[i])
98                 break;
99         if (!i) // overspecified tree
100              return 1;
101         code = exit_at_level[i];
102         exit_at_level[i] = 0;
103         // construct code (append 0s to end) and introduce new exits
104         for (j = i + 1 ;j <= bits[p]; ++j)
105             exit_at_level[j] = code + (1 << (j - 1));
106         codes[p] = code;
107
108 #ifdef DEBUG
109         av_log(NULL, AV_LOG_INFO, " %d. code len %d code %d - ", p, bits[p], codes[p]);
110         init_get_bits(&gb, (uint8_t *)&codes[p], bits[p]);
111         for (i = 0; i < bits[p]; ++i)
112             av_log(NULL, AV_LOG_INFO, "%s", get_bits1(&gb) ? "1" : "0");
113         av_log(NULL, AV_LOG_INFO, "\n");
114 #endif
115
116     }
117
118     //no exits should be left (underspecified tree - ie. unused valid vlcs - not allowed by SPEC)
119     for (p = 1; p < 33; p++)
120         if (exit_at_level[p])
121             return 1;
122
123     return 0;
124 }
125
126 int ff_vorbis_ready_floor1_list(AVCodecContext *avccontext,
127                                 vorbis_floor1_entry *list, int values)
128 {
129     int i;
130     list[0].sort = 0;
131     list[1].sort = 1;
132     for (i = 2; i < values; i++) {
133         int j;
134         list[i].low  = 0;
135         list[i].high = 1;
136         list[i].sort = i;
137         for (j = 2; j < i; j++) {
138             int tmp = list[j].x;
139             if (tmp < list[i].x) {
140                 if (tmp > list[list[i].low].x)
141                     list[i].low  =  j;
142             } else {
143                 if (tmp < list[list[i].high].x)
144                     list[i].high = j;
145             }
146         }
147     }
148     for (i = 0; i < values - 1; i++) {
149         int j;
150         for (j = i + 1; j < values; j++) {
151             if (list[i].x == list[j].x) {
152                 av_log(avccontext, AV_LOG_ERROR,
153                        "Duplicate value found in floor 1 X coordinates\n");
154                 return AVERROR_INVALIDDATA;
155             }
156             if (list[list[i].sort].x > list[list[j].sort].x) {
157                 int tmp = list[i].sort;
158                 list[i].sort = list[j].sort;
159                 list[j].sort = tmp;
160             }
161         }
162     }
163     return 0;
164 }
165
166 static inline void render_line_unrolled(intptr_t x, int y, int x1,
167                                         intptr_t sy, int ady, int adx,
168                                         float *buf)
169 {
170     int err = -adx;
171     x -= x1 - 1;
172     buf += x1 - 1;
173     while (++x < 0) {
174         err += ady;
175         if (err >= 0) {
176             err += ady - adx;
177             y   += sy;
178             buf[x++] = ff_vorbis_floor1_inverse_db_table[av_clip_uint8(y)];
179         }
180         buf[x] = ff_vorbis_floor1_inverse_db_table[av_clip_uint8(y)];
181     }
182     if (x <= 0) {
183         if (err + ady >= 0)
184             y += sy;
185         buf[x] = ff_vorbis_floor1_inverse_db_table[av_clip_uint8(y)];
186     }
187 }
188
189 static void render_line(int x0, int y0, int x1, int y1, float *buf)
190 {
191     int dy  = y1 - y0;
192     int adx = x1 - x0;
193     int ady = FFABS(dy);
194     int sy  = dy < 0 ? -1 : 1;
195     buf[x0] = ff_vorbis_floor1_inverse_db_table[av_clip_uint8(y0)];
196     if (ady*2 <= adx) { // optimized common case
197         render_line_unrolled(x0, y0, x1, sy, ady, adx, buf);
198     } else {
199         int base  = dy / adx;
200         int x     = x0;
201         int y     = y0;
202         int err   = -adx;
203         ady -= FFABS(base) * adx;
204         while (++x < x1) {
205             y += base;
206             err += ady;
207             if (err >= 0) {
208                 err -= adx;
209                 y   += sy;
210             }
211             buf[x] = ff_vorbis_floor1_inverse_db_table[av_clip_uint8(y)];
212         }
213     }
214 }
215
216 void ff_vorbis_floor1_render_list(vorbis_floor1_entry * list, int values,
217                                   uint16_t *y_list, int *flag,
218                                   int multiplier, float *out, int samples)
219 {
220     int lx, ly, i;
221     lx = 0;
222     ly = y_list[0] * multiplier;
223     for (i = 1; i < values; i++) {
224         int pos = list[i].sort;
225         if (flag[pos]) {
226             int x1 = list[pos].x;
227             int y1 = y_list[pos] * multiplier;
228             if (lx < samples)
229                 render_line(lx, ly, FFMIN(x1,samples), y1, out);
230             lx = x1;
231             ly = y1;
232         }
233         if (lx >= samples)
234             break;
235     }
236     if (lx < samples)
237         render_line(lx, ly, samples, ly, out);
238 }