doxygen: do not include license boilerplate in Doxygen documentation
[ffmpeg.git] / libavcodec / vorbisdec.c
1 /*
2  * This file is part of Libav.
3  *
4  * Libav is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * Libav is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with Libav; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  */
18
19 /**
20  * @file
21  * Vorbis I decoder
22  * @author Denes Balatoni  ( dbalatoni programozo hu )
23  */
24
25 #include <inttypes.h>
26 #include <math.h>
27
28 #define ALT_BITSTREAM_READER_LE
29 #include "avcodec.h"
30 #include "get_bits.h"
31 #include "dsputil.h"
32 #include "fft.h"
33 #include "fmtconvert.h"
34
35 #include "vorbis.h"
36 #include "xiph.h"
37
38 #define V_NB_BITS 8
39 #define V_NB_BITS2 11
40 #define V_MAX_VLCS (1 << 16)
41 #define V_MAX_PARTITIONS (1 << 20)
42
43 #undef NDEBUG
44 #include <assert.h>
45
46 typedef struct {
47     uint8_t      dimensions;
48     uint8_t      lookup_type;
49     uint8_t      maxdepth;
50     VLC          vlc;
51     float       *codevectors;
52     unsigned int nb_bits;
53 } vorbis_codebook;
54
55 typedef union  vorbis_floor_u  vorbis_floor_data;
56 typedef struct vorbis_floor0_s vorbis_floor0;
57 typedef struct vorbis_floor1_s vorbis_floor1;
58 struct vorbis_context_s;
59 typedef
60 int (* vorbis_floor_decode_func)
61     (struct vorbis_context_s *, vorbis_floor_data *, float *);
62 typedef struct {
63     uint8_t floor_type;
64     vorbis_floor_decode_func decode;
65     union vorbis_floor_u {
66         struct vorbis_floor0_s {
67             uint8_t       order;
68             uint16_t      rate;
69             uint16_t      bark_map_size;
70             int32_t      *map[2];
71             uint32_t      map_size[2];
72             uint8_t       amplitude_bits;
73             uint8_t       amplitude_offset;
74             uint8_t       num_books;
75             uint8_t      *book_list;
76             float        *lsp;
77         } t0;
78         struct vorbis_floor1_s {
79             uint8_t       partitions;
80             uint8_t       partition_class[32];
81             uint8_t       class_dimensions[16];
82             uint8_t       class_subclasses[16];
83             uint8_t       class_masterbook[16];
84             int16_t       subclass_books[16][8];
85             uint8_t       multiplier;
86             uint16_t      x_list_dim;
87             vorbis_floor1_entry *list;
88         } t1;
89     } data;
90 } vorbis_floor;
91
92 typedef struct {
93     uint16_t      type;
94     uint32_t      begin;
95     uint32_t      end;
96     unsigned      partition_size;
97     uint8_t       classifications;
98     uint8_t       classbook;
99     int16_t       books[64][8];
100     uint8_t       maxpass;
101     uint16_t      ptns_to_read;
102     uint8_t      *classifs;
103 } vorbis_residue;
104
105 typedef struct {
106     uint8_t       submaps;
107     uint16_t      coupling_steps;
108     uint8_t      *magnitude;
109     uint8_t      *angle;
110     uint8_t      *mux;
111     uint8_t       submap_floor[16];
112     uint8_t       submap_residue[16];
113 } vorbis_mapping;
114
115 typedef struct {
116     uint8_t       blockflag;
117     uint16_t      windowtype;
118     uint16_t      transformtype;
119     uint8_t       mapping;
120 } vorbis_mode;
121
122 typedef struct vorbis_context_s {
123     AVCodecContext *avccontext;
124     GetBitContext gb;
125     DSPContext dsp;
126     FmtConvertContext fmt_conv;
127
128     FFTContext mdct[2];
129     uint8_t       first_frame;
130     uint32_t      version;
131     uint8_t       audio_channels;
132     uint32_t      audio_samplerate;
133     uint32_t      bitrate_maximum;
134     uint32_t      bitrate_nominal;
135     uint32_t      bitrate_minimum;
136     uint32_t      blocksize[2];
137     const float  *win[2];
138     uint16_t      codebook_count;
139     vorbis_codebook *codebooks;
140     uint8_t       floor_count;
141     vorbis_floor *floors;
142     uint8_t       residue_count;
143     vorbis_residue *residues;
144     uint8_t       mapping_count;
145     vorbis_mapping *mappings;
146     uint8_t       mode_count;
147     vorbis_mode  *modes;
148     uint8_t       mode_number; // mode number for the current packet
149     uint8_t       previous_window;
150     float        *channel_residues;
151     float        *channel_floors;
152     float        *saved;
153     float         scale_bias; // for float->int conversion
154 } vorbis_context;
155
156 /* Helper functions */
157
158 #define BARK(x) \
159     (13.1f * atan(0.00074f * (x)) + 2.24f * atan(1.85e-8f * (x) * (x)) + 1e-4f * (x))
160
161 static const char idx_err_str[] = "Index value %d out of range (0 - %d) for %s at %s:%i\n";
162 #define VALIDATE_INDEX(idx, limit) \
163     if (idx >= limit) {\
164         av_log(vc->avccontext, AV_LOG_ERROR,\
165                idx_err_str,\
166                (int)(idx), (int)(limit - 1), #idx, __FILE__, __LINE__);\
167         return -1;\
168     }
169 #define GET_VALIDATED_INDEX(idx, bits, limit) \
170     {\
171         idx = get_bits(gb, bits);\
172         VALIDATE_INDEX(idx, limit)\
173     }
174
175 static float vorbisfloat2float(unsigned val)
176 {
177     double mant = val & 0x1fffff;
178     long exp    = (val & 0x7fe00000L) >> 21;
179     if (val & 0x80000000)
180         mant = -mant;
181     return ldexp(mant, exp - 20 - 768);
182 }
183
184
185 // Free all allocated memory -----------------------------------------
186
187 static void vorbis_free(vorbis_context *vc)
188 {
189     int i;
190
191     av_freep(&vc->channel_residues);
192     av_freep(&vc->channel_floors);
193     av_freep(&vc->saved);
194
195     for (i = 0; i < vc->residue_count; i++)
196         av_free(vc->residues[i].classifs);
197     av_freep(&vc->residues);
198     av_freep(&vc->modes);
199
200     ff_mdct_end(&vc->mdct[0]);
201     ff_mdct_end(&vc->mdct[1]);
202
203     for (i = 0; i < vc->codebook_count; ++i) {
204         av_free(vc->codebooks[i].codevectors);
205         free_vlc(&vc->codebooks[i].vlc);
206     }
207     av_freep(&vc->codebooks);
208
209     for (i = 0; i < vc->floor_count; ++i) {
210         if (vc->floors[i].floor_type == 0) {
211             av_free(vc->floors[i].data.t0.map[0]);
212             av_free(vc->floors[i].data.t0.map[1]);
213             av_free(vc->floors[i].data.t0.book_list);
214             av_free(vc->floors[i].data.t0.lsp);
215         } else {
216             av_free(vc->floors[i].data.t1.list);
217         }
218     }
219     av_freep(&vc->floors);
220
221     for (i = 0; i < vc->mapping_count; ++i) {
222         av_free(vc->mappings[i].magnitude);
223         av_free(vc->mappings[i].angle);
224         av_free(vc->mappings[i].mux);
225     }
226     av_freep(&vc->mappings);
227 }
228
229 // Parse setup header -------------------------------------------------
230
231 // Process codebooks part
232
233 static int vorbis_parse_setup_hdr_codebooks(vorbis_context *vc)
234 {
235     unsigned cb;
236     uint8_t  *tmp_vlc_bits;
237     uint32_t *tmp_vlc_codes;
238     GetBitContext *gb = &vc->gb;
239     uint16_t *codebook_multiplicands;
240
241     vc->codebook_count = get_bits(gb, 8) + 1;
242
243     av_dlog(NULL, " Codebooks: %d \n", vc->codebook_count);
244
245     vc->codebooks = av_mallocz(vc->codebook_count * sizeof(*vc->codebooks));
246     tmp_vlc_bits  = av_mallocz(V_MAX_VLCS * sizeof(*tmp_vlc_bits));
247     tmp_vlc_codes = av_mallocz(V_MAX_VLCS * sizeof(*tmp_vlc_codes));
248     codebook_multiplicands = av_malloc(V_MAX_VLCS * sizeof(*codebook_multiplicands));
249
250     for (cb = 0; cb < vc->codebook_count; ++cb) {
251         vorbis_codebook *codebook_setup = &vc->codebooks[cb];
252         unsigned ordered, t, entries, used_entries = 0;
253
254         av_dlog(NULL, " %u. Codebook\n", cb);
255
256         if (get_bits(gb, 24) != 0x564342) {
257             av_log(vc->avccontext, AV_LOG_ERROR,
258                    " %u. Codebook setup data corrupt.\n", cb);
259             goto error;
260         }
261
262         codebook_setup->dimensions=get_bits(gb, 16);
263         if (codebook_setup->dimensions > 16 || codebook_setup->dimensions == 0) {
264             av_log(vc->avccontext, AV_LOG_ERROR,
265                    " %u. Codebook's dimension is invalid (%d).\n",
266                    cb, codebook_setup->dimensions);
267             goto error;
268         }
269         entries = get_bits(gb, 24);
270         if (entries > V_MAX_VLCS) {
271             av_log(vc->avccontext, AV_LOG_ERROR,
272                    " %u. Codebook has too many entries (%u).\n",
273                    cb, entries);
274             goto error;
275         }
276
277         ordered = get_bits1(gb);
278
279         av_dlog(NULL, " codebook_dimensions %d, codebook_entries %u\n",
280                 codebook_setup->dimensions, entries);
281
282         if (!ordered) {
283             unsigned ce, flag;
284             unsigned sparse = get_bits1(gb);
285
286             av_dlog(NULL, " not ordered \n");
287
288             if (sparse) {
289                 av_dlog(NULL, " sparse \n");
290
291                 used_entries = 0;
292                 for (ce = 0; ce < entries; ++ce) {
293                     flag = get_bits1(gb);
294                     if (flag) {
295                         tmp_vlc_bits[ce] = get_bits(gb, 5) + 1;
296                         ++used_entries;
297                     } else
298                         tmp_vlc_bits[ce] = 0;
299                 }
300             } else {
301                 av_dlog(NULL, " not sparse \n");
302
303                 used_entries = entries;
304                 for (ce = 0; ce < entries; ++ce)
305                     tmp_vlc_bits[ce] = get_bits(gb, 5) + 1;
306             }
307         } else {
308             unsigned current_entry  = 0;
309             unsigned current_length = get_bits(gb, 5) + 1;
310
311             av_dlog(NULL, " ordered, current length: %u\n", current_length);  //FIXME
312
313             used_entries = entries;
314             for (; current_entry < used_entries && current_length <= 32; ++current_length) {
315                 unsigned i, number;
316
317                 av_dlog(NULL, " number bits: %u ", ilog(entries - current_entry));
318
319                 number = get_bits(gb, ilog(entries - current_entry));
320
321                 av_dlog(NULL, " number: %u\n", number);
322
323                 for (i = current_entry; i < number+current_entry; ++i)
324                     if (i < used_entries)
325                         tmp_vlc_bits[i] = current_length;
326
327                 current_entry+=number;
328             }
329             if (current_entry>used_entries) {
330                 av_log(vc->avccontext, AV_LOG_ERROR, " More codelengths than codes in codebook. \n");
331                 goto error;
332             }
333         }
334
335         codebook_setup->lookup_type = get_bits(gb, 4);
336
337         av_dlog(NULL, " lookup type: %d : %s \n", codebook_setup->lookup_type,
338                 codebook_setup->lookup_type ? "vq" : "no lookup");
339
340 // If the codebook is used for (inverse) VQ, calculate codevectors.
341
342         if (codebook_setup->lookup_type == 1) {
343             unsigned i, j, k;
344             unsigned codebook_lookup_values = ff_vorbis_nth_root(entries, codebook_setup->dimensions);
345
346             float codebook_minimum_value = vorbisfloat2float(get_bits_long(gb, 32));
347             float codebook_delta_value   = vorbisfloat2float(get_bits_long(gb, 32));
348             unsigned codebook_value_bits = get_bits(gb, 4) + 1;
349             unsigned codebook_sequence_p = get_bits1(gb);
350
351             av_dlog(NULL, " We expect %d numbers for building the codevectors. \n",
352                     codebook_lookup_values);
353             av_dlog(NULL, "  delta %f minmum %f \n",
354                     codebook_delta_value, codebook_minimum_value);
355
356             for (i = 0; i < codebook_lookup_values; ++i) {
357                 codebook_multiplicands[i] = get_bits(gb, codebook_value_bits);
358
359                 av_dlog(NULL, " multiplicands*delta+minmum : %e \n",
360                         (float)codebook_multiplicands[i] * codebook_delta_value + codebook_minimum_value);
361                 av_dlog(NULL, " multiplicand %u\n", codebook_multiplicands[i]);
362             }
363
364 // Weed out unused vlcs and build codevector vector
365             codebook_setup->codevectors = used_entries ? av_mallocz(used_entries *
366                                                                     codebook_setup->dimensions *
367                                                                     sizeof(*codebook_setup->codevectors))
368                                                        : NULL;
369             for (j = 0, i = 0; i < entries; ++i) {
370                 unsigned dim = codebook_setup->dimensions;
371
372                 if (tmp_vlc_bits[i]) {
373                     float last = 0.0;
374                     unsigned lookup_offset = i;
375
376                     av_dlog(vc->avccontext, "Lookup offset %u ,", i);
377
378                     for (k = 0; k < dim; ++k) {
379                         unsigned multiplicand_offset = lookup_offset % codebook_lookup_values;
380                         codebook_setup->codevectors[j * dim + k] = codebook_multiplicands[multiplicand_offset] * codebook_delta_value + codebook_minimum_value + last;
381                         if (codebook_sequence_p)
382                             last = codebook_setup->codevectors[j * dim + k];
383                         lookup_offset/=codebook_lookup_values;
384                     }
385                     tmp_vlc_bits[j] = tmp_vlc_bits[i];
386
387                     av_dlog(vc->avccontext, "real lookup offset %u, vector: ", j);
388                     for (k = 0; k < dim; ++k)
389                         av_dlog(vc->avccontext, " %f ",
390                                 codebook_setup->codevectors[j * dim + k]);
391                     av_dlog(vc->avccontext, "\n");
392
393                     ++j;
394                 }
395             }
396             if (j != used_entries) {
397                 av_log(vc->avccontext, AV_LOG_ERROR, "Bug in codevector vector building code. \n");
398                 goto error;
399             }
400             entries = used_entries;
401         } else if (codebook_setup->lookup_type >= 2) {
402             av_log(vc->avccontext, AV_LOG_ERROR, "Codebook lookup type not supported. \n");
403             goto error;
404         }
405
406 // Initialize VLC table
407         if (ff_vorbis_len2vlc(tmp_vlc_bits, tmp_vlc_codes, entries)) {
408             av_log(vc->avccontext, AV_LOG_ERROR, " Invalid code lengths while generating vlcs. \n");
409             goto error;
410         }
411         codebook_setup->maxdepth = 0;
412         for (t = 0; t < entries; ++t)
413             if (tmp_vlc_bits[t] >= codebook_setup->maxdepth)
414                 codebook_setup->maxdepth = tmp_vlc_bits[t];
415
416         if (codebook_setup->maxdepth > 3 * V_NB_BITS)
417             codebook_setup->nb_bits = V_NB_BITS2;
418         else
419             codebook_setup->nb_bits = V_NB_BITS;
420
421         codebook_setup->maxdepth = (codebook_setup->maxdepth+codebook_setup->nb_bits - 1) / codebook_setup->nb_bits;
422
423         if (init_vlc(&codebook_setup->vlc, codebook_setup->nb_bits, entries, tmp_vlc_bits, sizeof(*tmp_vlc_bits), sizeof(*tmp_vlc_bits), tmp_vlc_codes, sizeof(*tmp_vlc_codes), sizeof(*tmp_vlc_codes), INIT_VLC_LE)) {
424             av_log(vc->avccontext, AV_LOG_ERROR, " Error generating vlc tables. \n");
425             goto error;
426         }
427     }
428
429     av_free(tmp_vlc_bits);
430     av_free(tmp_vlc_codes);
431     av_free(codebook_multiplicands);
432     return 0;
433
434 // Error:
435 error:
436     av_free(tmp_vlc_bits);
437     av_free(tmp_vlc_codes);
438     av_free(codebook_multiplicands);
439     return -1;
440 }
441
442 // Process time domain transforms part (unused in Vorbis I)
443
444 static int vorbis_parse_setup_hdr_tdtransforms(vorbis_context *vc)
445 {
446     GetBitContext *gb = &vc->gb;
447     unsigned i, vorbis_time_count = get_bits(gb, 6) + 1;
448
449     for (i = 0; i < vorbis_time_count; ++i) {
450         unsigned vorbis_tdtransform = get_bits(gb, 16);
451
452         av_dlog(NULL, " Vorbis time domain transform %u: %u\n",
453                 vorbis_time_count, vorbis_tdtransform);
454
455         if (vorbis_tdtransform) {
456             av_log(vc->avccontext, AV_LOG_ERROR, "Vorbis time domain transform data nonzero. \n");
457             return -1;
458         }
459     }
460     return 0;
461 }
462
463 // Process floors part
464
465 static int vorbis_floor0_decode(vorbis_context *vc,
466                                 vorbis_floor_data *vfu, float *vec);
467 static void create_map(vorbis_context *vc, unsigned floor_number);
468 static int vorbis_floor1_decode(vorbis_context *vc,
469                                 vorbis_floor_data *vfu, float *vec);
470 static int vorbis_parse_setup_hdr_floors(vorbis_context *vc)
471 {
472     GetBitContext *gb = &vc->gb;
473     int i,j,k;
474
475     vc->floor_count = get_bits(gb, 6) + 1;
476
477     vc->floors = av_mallocz(vc->floor_count * sizeof(*vc->floors));
478
479     for (i = 0; i < vc->floor_count; ++i) {
480         vorbis_floor *floor_setup = &vc->floors[i];
481
482         floor_setup->floor_type = get_bits(gb, 16);
483
484         av_dlog(NULL, " %d. floor type %d \n", i, floor_setup->floor_type);
485
486         if (floor_setup->floor_type == 1) {
487             int maximum_class = -1;
488             unsigned rangebits, rangemax, floor1_values = 2;
489
490             floor_setup->decode = vorbis_floor1_decode;
491
492             floor_setup->data.t1.partitions = get_bits(gb, 5);
493
494             av_dlog(NULL, " %d.floor: %d partitions \n",
495                     i, floor_setup->data.t1.partitions);
496
497             for (j = 0; j < floor_setup->data.t1.partitions; ++j) {
498                 floor_setup->data.t1.partition_class[j] = get_bits(gb, 4);
499                 if (floor_setup->data.t1.partition_class[j] > maximum_class)
500                     maximum_class = floor_setup->data.t1.partition_class[j];
501
502                 av_dlog(NULL, " %d. floor %d partition class %d \n",
503                         i, j, floor_setup->data.t1.partition_class[j]);
504
505             }
506
507             av_dlog(NULL, " maximum class %d \n", maximum_class);
508
509             for (j = 0; j <= maximum_class; ++j) {
510                 floor_setup->data.t1.class_dimensions[j] = get_bits(gb, 3) + 1;
511                 floor_setup->data.t1.class_subclasses[j] = get_bits(gb, 2);
512
513                 av_dlog(NULL, " %d floor %d class dim: %d subclasses %d \n", i, j,
514                         floor_setup->data.t1.class_dimensions[j],
515                         floor_setup->data.t1.class_subclasses[j]);
516
517                 if (floor_setup->data.t1.class_subclasses[j]) {
518                     GET_VALIDATED_INDEX(floor_setup->data.t1.class_masterbook[j], 8, vc->codebook_count)
519
520                     av_dlog(NULL, "   masterbook: %d \n", floor_setup->data.t1.class_masterbook[j]);
521                 }
522
523                 for (k = 0; k < (1 << floor_setup->data.t1.class_subclasses[j]); ++k) {
524                     int16_t bits = get_bits(gb, 8) - 1;
525                     if (bits != -1)
526                         VALIDATE_INDEX(bits, vc->codebook_count)
527                     floor_setup->data.t1.subclass_books[j][k] = bits;
528
529                     av_dlog(NULL, "    book %d. : %d \n", k, floor_setup->data.t1.subclass_books[j][k]);
530                 }
531             }
532
533             floor_setup->data.t1.multiplier = get_bits(gb, 2) + 1;
534             floor_setup->data.t1.x_list_dim = 2;
535
536             for (j = 0; j < floor_setup->data.t1.partitions; ++j)
537                 floor_setup->data.t1.x_list_dim+=floor_setup->data.t1.class_dimensions[floor_setup->data.t1.partition_class[j]];
538
539             floor_setup->data.t1.list = av_mallocz(floor_setup->data.t1.x_list_dim *
540                                                    sizeof(*floor_setup->data.t1.list));
541
542
543             rangebits = get_bits(gb, 4);
544             rangemax = (1 << rangebits);
545             if (rangemax > vc->blocksize[1] / 2) {
546                 av_log(vc->avccontext, AV_LOG_ERROR,
547                        "Floor value is too large for blocksize: %u (%"PRIu32")\n",
548                        rangemax, vc->blocksize[1] / 2);
549                 return -1;
550             }
551             floor_setup->data.t1.list[0].x = 0;
552             floor_setup->data.t1.list[1].x = rangemax;
553
554             for (j = 0; j < floor_setup->data.t1.partitions; ++j) {
555                 for (k = 0; k < floor_setup->data.t1.class_dimensions[floor_setup->data.t1.partition_class[j]]; ++k, ++floor1_values) {
556                     floor_setup->data.t1.list[floor1_values].x = get_bits(gb, rangebits);
557
558                     av_dlog(NULL, " %u. floor1 Y coord. %d\n", floor1_values,
559                             floor_setup->data.t1.list[floor1_values].x);
560                 }
561             }
562
563 // Precalculate order of x coordinates - needed for decode
564             ff_vorbis_ready_floor1_list(floor_setup->data.t1.list, floor_setup->data.t1.x_list_dim);
565         } else if (floor_setup->floor_type == 0) {
566             unsigned max_codebook_dim = 0;
567
568             floor_setup->decode = vorbis_floor0_decode;
569
570             floor_setup->data.t0.order          = get_bits(gb,  8);
571             floor_setup->data.t0.rate           = get_bits(gb, 16);
572             floor_setup->data.t0.bark_map_size  = get_bits(gb, 16);
573             floor_setup->data.t0.amplitude_bits = get_bits(gb,  6);
574             /* zero would result in a div by zero later *
575              * 2^0 - 1 == 0                             */
576             if (floor_setup->data.t0.amplitude_bits == 0) {
577                 av_log(vc->avccontext, AV_LOG_ERROR,
578                        "Floor 0 amplitude bits is 0.\n");
579                 return -1;
580             }
581             floor_setup->data.t0.amplitude_offset = get_bits(gb, 8);
582             floor_setup->data.t0.num_books        = get_bits(gb, 4) + 1;
583
584             /* allocate mem for booklist */
585             floor_setup->data.t0.book_list =
586                 av_malloc(floor_setup->data.t0.num_books);
587             if (!floor_setup->data.t0.book_list)
588                 return -1;
589             /* read book indexes */
590             {
591                 int idx;
592                 unsigned book_idx;
593                 for (idx = 0; idx < floor_setup->data.t0.num_books; ++idx) {
594                     GET_VALIDATED_INDEX(book_idx, 8, vc->codebook_count)
595                     floor_setup->data.t0.book_list[idx] = book_idx;
596                     if (vc->codebooks[book_idx].dimensions > max_codebook_dim)
597                         max_codebook_dim = vc->codebooks[book_idx].dimensions;
598                 }
599             }
600
601             create_map(vc, i);
602
603             /* codebook dim is for padding if codebook dim doesn't *
604              * divide order+1 then we need to read more data       */
605             floor_setup->data.t0.lsp =
606                 av_malloc((floor_setup->data.t0.order + 1 + max_codebook_dim)
607                           * sizeof(*floor_setup->data.t0.lsp));
608             if (!floor_setup->data.t0.lsp)
609                 return -1;
610
611             /* debug output parsed headers */
612             av_dlog(NULL, "floor0 order: %u\n", floor_setup->data.t0.order);
613             av_dlog(NULL, "floor0 rate: %u\n", floor_setup->data.t0.rate);
614             av_dlog(NULL, "floor0 bark map size: %u\n",
615                     floor_setup->data.t0.bark_map_size);
616             av_dlog(NULL, "floor0 amplitude bits: %u\n",
617                     floor_setup->data.t0.amplitude_bits);
618             av_dlog(NULL, "floor0 amplitude offset: %u\n",
619                     floor_setup->data.t0.amplitude_offset);
620             av_dlog(NULL, "floor0 number of books: %u\n",
621                     floor_setup->data.t0.num_books);
622             av_dlog(NULL, "floor0 book list pointer: %p\n",
623                     floor_setup->data.t0.book_list);
624             {
625                 int idx;
626                 for (idx = 0; idx < floor_setup->data.t0.num_books; ++idx) {
627                     av_dlog(NULL, "  Book %d: %u\n", idx + 1,
628                             floor_setup->data.t0.book_list[idx]);
629                 }
630             }
631         } else {
632             av_log(vc->avccontext, AV_LOG_ERROR, "Invalid floor type!\n");
633             return -1;
634         }
635     }
636     return 0;
637 }
638
639 // Process residues part
640
641 static int vorbis_parse_setup_hdr_residues(vorbis_context *vc)
642 {
643     GetBitContext *gb = &vc->gb;
644     unsigned i, j, k;
645
646     vc->residue_count = get_bits(gb, 6)+1;
647     vc->residues      = av_mallocz(vc->residue_count * sizeof(*vc->residues));
648
649     av_dlog(NULL, " There are %d residues. \n", vc->residue_count);
650
651     for (i = 0; i < vc->residue_count; ++i) {
652         vorbis_residue *res_setup = &vc->residues[i];
653         uint8_t cascade[64];
654         unsigned high_bits, low_bits;
655
656         res_setup->type = get_bits(gb, 16);
657
658         av_dlog(NULL, " %u. residue type %d\n", i, res_setup->type);
659
660         res_setup->begin          = get_bits(gb, 24);
661         res_setup->end            = get_bits(gb, 24);
662         res_setup->partition_size = get_bits(gb, 24) + 1;
663         /* Validations to prevent a buffer overflow later. */
664         if (res_setup->begin>res_setup->end ||
665             res_setup->end > vc->avccontext->channels * vc->blocksize[1] / 2 ||
666             (res_setup->end-res_setup->begin) / res_setup->partition_size > V_MAX_PARTITIONS) {
667             av_log(vc->avccontext, AV_LOG_ERROR,
668                    "partition out of bounds: type, begin, end, size, blocksize: %"PRIu16", %"PRIu32", %"PRIu32", %u, %"PRIu32"\n",
669                    res_setup->type, res_setup->begin, res_setup->end,
670                    res_setup->partition_size, vc->blocksize[1] / 2);
671             return -1;
672         }
673
674         res_setup->classifications = get_bits(gb, 6) + 1;
675         GET_VALIDATED_INDEX(res_setup->classbook, 8, vc->codebook_count)
676
677         res_setup->ptns_to_read =
678             (res_setup->end - res_setup->begin) / res_setup->partition_size;
679         res_setup->classifs = av_malloc(res_setup->ptns_to_read *
680                                         vc->audio_channels *
681                                         sizeof(*res_setup->classifs));
682         if (!res_setup->classifs)
683             return AVERROR(ENOMEM);
684
685         av_dlog(NULL, "    begin %d end %d part.size %d classif.s %d classbook %d \n",
686                 res_setup->begin, res_setup->end, res_setup->partition_size,
687                 res_setup->classifications, res_setup->classbook);
688
689         for (j = 0; j < res_setup->classifications; ++j) {
690             high_bits = 0;
691             low_bits  = get_bits(gb, 3);
692             if (get_bits1(gb))
693                 high_bits = get_bits(gb, 5);
694             cascade[j] = (high_bits << 3) + low_bits;
695
696             av_dlog(NULL, "     %u class cascade depth: %d\n", j, ilog(cascade[j]));
697         }
698
699         res_setup->maxpass = 0;
700         for (j = 0; j < res_setup->classifications; ++j) {
701             for (k = 0; k < 8; ++k) {
702                 if (cascade[j]&(1 << k)) {
703                     GET_VALIDATED_INDEX(res_setup->books[j][k], 8, vc->codebook_count)
704
705                     av_dlog(NULL, "     %u class cascade depth %u book: %d\n",
706                             j, k, res_setup->books[j][k]);
707
708                     if (k>res_setup->maxpass)
709                         res_setup->maxpass = k;
710                 } else {
711                     res_setup->books[j][k] = -1;
712                 }
713             }
714         }
715     }
716     return 0;
717 }
718
719 // Process mappings part
720
721 static int vorbis_parse_setup_hdr_mappings(vorbis_context *vc)
722 {
723     GetBitContext *gb = &vc->gb;
724     unsigned i, j;
725
726     vc->mapping_count = get_bits(gb, 6)+1;
727     vc->mappings      = av_mallocz(vc->mapping_count * sizeof(*vc->mappings));
728
729     av_dlog(NULL, " There are %d mappings. \n", vc->mapping_count);
730
731     for (i = 0; i < vc->mapping_count; ++i) {
732         vorbis_mapping *mapping_setup = &vc->mappings[i];
733
734         if (get_bits(gb, 16)) {
735             av_log(vc->avccontext, AV_LOG_ERROR, "Other mappings than type 0 are not compliant with the Vorbis I specification. \n");
736             return -1;
737         }
738         if (get_bits1(gb)) {
739             mapping_setup->submaps = get_bits(gb, 4) + 1;
740         } else {
741             mapping_setup->submaps = 1;
742         }
743
744         if (get_bits1(gb)) {
745             mapping_setup->coupling_steps = get_bits(gb, 8) + 1;
746             mapping_setup->magnitude      = av_mallocz(mapping_setup->coupling_steps *
747                                                        sizeof(*mapping_setup->magnitude));
748             mapping_setup->angle          = av_mallocz(mapping_setup->coupling_steps *
749                                                        sizeof(*mapping_setup->angle));
750             for (j = 0; j < mapping_setup->coupling_steps; ++j) {
751                 GET_VALIDATED_INDEX(mapping_setup->magnitude[j], ilog(vc->audio_channels - 1), vc->audio_channels)
752                 GET_VALIDATED_INDEX(mapping_setup->angle[j],     ilog(vc->audio_channels - 1), vc->audio_channels)
753             }
754         } else {
755             mapping_setup->coupling_steps = 0;
756         }
757
758         av_dlog(NULL, "   %u mapping coupling steps: %d\n",
759                 i, mapping_setup->coupling_steps);
760
761         if (get_bits(gb, 2)) {
762             av_log(vc->avccontext, AV_LOG_ERROR, "%u. mapping setup data invalid.\n", i);
763             return -1; // following spec.
764         }
765
766         if (mapping_setup->submaps>1) {
767             mapping_setup->mux = av_mallocz(vc->audio_channels *
768                                             sizeof(*mapping_setup->mux));
769             for (j = 0; j < vc->audio_channels; ++j)
770                 mapping_setup->mux[j] = get_bits(gb, 4);
771         }
772
773         for (j = 0; j < mapping_setup->submaps; ++j) {
774             skip_bits(gb, 8); // FIXME check?
775             GET_VALIDATED_INDEX(mapping_setup->submap_floor[j],   8, vc->floor_count)
776             GET_VALIDATED_INDEX(mapping_setup->submap_residue[j], 8, vc->residue_count)
777
778             av_dlog(NULL, "   %u mapping %u submap : floor %d, residue %d\n", i, j,
779                     mapping_setup->submap_floor[j],
780                     mapping_setup->submap_residue[j]);
781         }
782     }
783     return 0;
784 }
785
786 // Process modes part
787
788 static void create_map(vorbis_context *vc, unsigned floor_number)
789 {
790     vorbis_floor *floors = vc->floors;
791     vorbis_floor0 *vf;
792     int idx;
793     int blockflag, n;
794     int32_t *map;
795
796     for (blockflag = 0; blockflag < 2; ++blockflag) {
797         n = vc->blocksize[blockflag] / 2;
798         floors[floor_number].data.t0.map[blockflag] =
799             av_malloc((n + 1) * sizeof(int32_t)); // n + sentinel
800
801         map =  floors[floor_number].data.t0.map[blockflag];
802         vf  = &floors[floor_number].data.t0;
803
804         for (idx = 0; idx < n; ++idx) {
805             map[idx] = floor(BARK((vf->rate * idx) / (2.0f * n)) *
806                              ((vf->bark_map_size) /
807                               BARK(vf->rate / 2.0f)));
808             if (vf->bark_map_size-1 < map[idx])
809                 map[idx] = vf->bark_map_size - 1;
810         }
811         map[n] = -1;
812         vf->map_size[blockflag] = n;
813     }
814
815     for (idx = 0; idx <= n; ++idx) {
816         av_dlog(NULL, "floor0 map: map at pos %d is %d\n", idx, map[idx]);
817     }
818 }
819
820 static int vorbis_parse_setup_hdr_modes(vorbis_context *vc)
821 {
822     GetBitContext *gb = &vc->gb;
823     unsigned i;
824
825     vc->mode_count = get_bits(gb, 6) + 1;
826     vc->modes      = av_mallocz(vc->mode_count * sizeof(*vc->modes));
827
828     av_dlog(NULL, " There are %d modes.\n", vc->mode_count);
829
830     for (i = 0; i < vc->mode_count; ++i) {
831         vorbis_mode *mode_setup = &vc->modes[i];
832
833         mode_setup->blockflag     = get_bits1(gb);
834         mode_setup->windowtype    = get_bits(gb, 16); //FIXME check
835         mode_setup->transformtype = get_bits(gb, 16); //FIXME check
836         GET_VALIDATED_INDEX(mode_setup->mapping, 8, vc->mapping_count);
837
838         av_dlog(NULL, " %u mode: blockflag %d, windowtype %d, transformtype %d, mapping %d\n",
839                 i, mode_setup->blockflag, mode_setup->windowtype,
840                 mode_setup->transformtype, mode_setup->mapping);
841     }
842     return 0;
843 }
844
845 // Process the whole setup header using the functions above
846
847 static int vorbis_parse_setup_hdr(vorbis_context *vc)
848 {
849     GetBitContext *gb = &vc->gb;
850
851     if ((get_bits(gb, 8) != 'v') || (get_bits(gb, 8) != 'o') ||
852         (get_bits(gb, 8) != 'r') || (get_bits(gb, 8) != 'b') ||
853         (get_bits(gb, 8) != 'i') || (get_bits(gb, 8) != 's')) {
854         av_log(vc->avccontext, AV_LOG_ERROR, " Vorbis setup header packet corrupt (no vorbis signature). \n");
855         return -1;
856     }
857
858     if (vorbis_parse_setup_hdr_codebooks(vc)) {
859         av_log(vc->avccontext, AV_LOG_ERROR, " Vorbis setup header packet corrupt (codebooks). \n");
860         return -2;
861     }
862     if (vorbis_parse_setup_hdr_tdtransforms(vc)) {
863         av_log(vc->avccontext, AV_LOG_ERROR, " Vorbis setup header packet corrupt (time domain transforms). \n");
864         return -3;
865     }
866     if (vorbis_parse_setup_hdr_floors(vc)) {
867         av_log(vc->avccontext, AV_LOG_ERROR, " Vorbis setup header packet corrupt (floors). \n");
868         return -4;
869     }
870     if (vorbis_parse_setup_hdr_residues(vc)) {
871         av_log(vc->avccontext, AV_LOG_ERROR, " Vorbis setup header packet corrupt (residues). \n");
872         return -5;
873     }
874     if (vorbis_parse_setup_hdr_mappings(vc)) {
875         av_log(vc->avccontext, AV_LOG_ERROR, " Vorbis setup header packet corrupt (mappings). \n");
876         return -6;
877     }
878     if (vorbis_parse_setup_hdr_modes(vc)) {
879         av_log(vc->avccontext, AV_LOG_ERROR, " Vorbis setup header packet corrupt (modes). \n");
880         return -7;
881     }
882     if (!get_bits1(gb)) {
883         av_log(vc->avccontext, AV_LOG_ERROR, " Vorbis setup header packet corrupt (framing flag). \n");
884         return -8; // framing flag bit unset error
885     }
886
887     return 0;
888 }
889
890 // Process the identification header
891
892 static int vorbis_parse_id_hdr(vorbis_context *vc)
893 {
894     GetBitContext *gb = &vc->gb;
895     unsigned bl0, bl1;
896
897     if ((get_bits(gb, 8) != 'v') || (get_bits(gb, 8) != 'o') ||
898         (get_bits(gb, 8) != 'r') || (get_bits(gb, 8) != 'b') ||
899         (get_bits(gb, 8) != 'i') || (get_bits(gb, 8) != 's')) {
900         av_log(vc->avccontext, AV_LOG_ERROR, " Vorbis id header packet corrupt (no vorbis signature). \n");
901         return -1;
902     }
903
904     vc->version        = get_bits_long(gb, 32);    //FIXME check 0
905     vc->audio_channels = get_bits(gb, 8);
906     if (vc->audio_channels <= 0) {
907         av_log(vc->avccontext, AV_LOG_ERROR, "Invalid number of channels\n");
908         return -1;
909     }
910     vc->audio_samplerate = get_bits_long(gb, 32);
911     if (vc->audio_samplerate <= 0) {
912         av_log(vc->avccontext, AV_LOG_ERROR, "Invalid samplerate\n");
913         return -1;
914     }
915     vc->bitrate_maximum = get_bits_long(gb, 32);
916     vc->bitrate_nominal = get_bits_long(gb, 32);
917     vc->bitrate_minimum = get_bits_long(gb, 32);
918     bl0 = get_bits(gb, 4);
919     bl1 = get_bits(gb, 4);
920     vc->blocksize[0] = (1 << bl0);
921     vc->blocksize[1] = (1 << bl1);
922     if (bl0 > 13 || bl0 < 6 || bl1 > 13 || bl1 < 6 || bl1 < bl0) {
923         av_log(vc->avccontext, AV_LOG_ERROR, " Vorbis id header packet corrupt (illegal blocksize). \n");
924         return -3;
925     }
926     // output format int16
927     if (vc->blocksize[1] / 2 * vc->audio_channels * 2 > AVCODEC_MAX_AUDIO_FRAME_SIZE) {
928         av_log(vc->avccontext, AV_LOG_ERROR, "Vorbis channel count makes "
929                "output packets too large.\n");
930         return -4;
931     }
932     vc->win[0] = ff_vorbis_vwin[bl0 - 6];
933     vc->win[1] = ff_vorbis_vwin[bl1 - 6];
934
935     if ((get_bits1(gb)) == 0) {
936         av_log(vc->avccontext, AV_LOG_ERROR, " Vorbis id header packet corrupt (framing flag not set). \n");
937         return -2;
938     }
939
940     vc->channel_residues =  av_malloc((vc->blocksize[1]  / 2) * vc->audio_channels * sizeof(*vc->channel_residues));
941     vc->channel_floors   =  av_malloc((vc->blocksize[1]  / 2) * vc->audio_channels * sizeof(*vc->channel_floors));
942     vc->saved            =  av_mallocz((vc->blocksize[1] / 4) * vc->audio_channels * sizeof(*vc->saved));
943     vc->previous_window  = 0;
944
945     ff_mdct_init(&vc->mdct[0], bl0, 1, -vc->scale_bias);
946     ff_mdct_init(&vc->mdct[1], bl1, 1, -vc->scale_bias);
947
948     av_dlog(NULL, " vorbis version %d \n audio_channels %d \n audio_samplerate %d \n bitrate_max %d \n bitrate_nom %d \n bitrate_min %d \n blk_0 %d blk_1 %d \n ",
949             vc->version, vc->audio_channels, vc->audio_samplerate, vc->bitrate_maximum, vc->bitrate_nominal, vc->bitrate_minimum, vc->blocksize[0], vc->blocksize[1]);
950
951 /*
952     BLK = vc->blocksize[0];
953     for (i = 0; i < BLK / 2; ++i) {
954         vc->win[0][i] = sin(0.5*3.14159265358*(sin(((float)i + 0.5) / (float)BLK*3.14159265358))*(sin(((float)i + 0.5) / (float)BLK*3.14159265358)));
955     }
956 */
957
958     return 0;
959 }
960
961 // Process the extradata using the functions above (identification header, setup header)
962
963 static av_cold int vorbis_decode_init(AVCodecContext *avccontext)
964 {
965     vorbis_context *vc = avccontext->priv_data ;
966     uint8_t *headers   = avccontext->extradata;
967     int headers_len    = avccontext->extradata_size;
968     uint8_t *header_start[3];
969     int header_len[3];
970     GetBitContext *gb = &(vc->gb);
971     int hdr_type;
972
973     vc->avccontext = avccontext;
974     dsputil_init(&vc->dsp, avccontext);
975     ff_fmt_convert_init(&vc->fmt_conv, avccontext);
976
977     if (avccontext->request_sample_fmt == AV_SAMPLE_FMT_FLT) {
978         avccontext->sample_fmt = AV_SAMPLE_FMT_FLT;
979         vc->scale_bias = 1.0f;
980     } else {
981         avccontext->sample_fmt = AV_SAMPLE_FMT_S16;
982         vc->scale_bias = 32768.0f;
983     }
984
985     if (!headers_len) {
986         av_log(avccontext, AV_LOG_ERROR, "Extradata missing.\n");
987         return -1;
988     }
989
990     if (ff_split_xiph_headers(headers, headers_len, 30, header_start, header_len) < 0) {
991         av_log(avccontext, AV_LOG_ERROR, "Extradata corrupt.\n");
992         return -1;
993     }
994
995     init_get_bits(gb, header_start[0], header_len[0]*8);
996     hdr_type = get_bits(gb, 8);
997     if (hdr_type != 1) {
998         av_log(avccontext, AV_LOG_ERROR, "First header is not the id header.\n");
999         return -1;
1000     }
1001     if (vorbis_parse_id_hdr(vc)) {
1002         av_log(avccontext, AV_LOG_ERROR, "Id header corrupt.\n");
1003         vorbis_free(vc);
1004         return -1;
1005     }
1006
1007     init_get_bits(gb, header_start[2], header_len[2]*8);
1008     hdr_type = get_bits(gb, 8);
1009     if (hdr_type != 5) {
1010         av_log(avccontext, AV_LOG_ERROR, "Third header is not the setup header.\n");
1011         vorbis_free(vc);
1012         return -1;
1013     }
1014     if (vorbis_parse_setup_hdr(vc)) {
1015         av_log(avccontext, AV_LOG_ERROR, "Setup header corrupt.\n");
1016         vorbis_free(vc);
1017         return -1;
1018     }
1019
1020     if (vc->audio_channels > 8)
1021         avccontext->channel_layout = 0;
1022     else
1023         avccontext->channel_layout = ff_vorbis_channel_layouts[vc->audio_channels - 1];
1024
1025     avccontext->channels    = vc->audio_channels;
1026     avccontext->sample_rate = vc->audio_samplerate;
1027     avccontext->frame_size  = FFMIN(vc->blocksize[0], vc->blocksize[1]) >> 2;
1028
1029     return 0 ;
1030 }
1031
1032 // Decode audiopackets -------------------------------------------------
1033
1034 // Read and decode floor
1035
1036 static int vorbis_floor0_decode(vorbis_context *vc,
1037                                 vorbis_floor_data *vfu, float *vec)
1038 {
1039     vorbis_floor0 *vf = &vfu->t0;
1040     float *lsp = vf->lsp;
1041     unsigned amplitude, book_idx;
1042     unsigned blockflag = vc->modes[vc->mode_number].blockflag;
1043
1044     amplitude = get_bits(&vc->gb, vf->amplitude_bits);
1045     if (amplitude > 0) {
1046         float last = 0;
1047         unsigned idx, lsp_len = 0;
1048         vorbis_codebook codebook;
1049
1050         book_idx = get_bits(&vc->gb, ilog(vf->num_books));
1051         if (book_idx >= vf->num_books) {
1052             av_log(vc->avccontext, AV_LOG_ERROR,
1053                     "floor0 dec: booknumber too high!\n");
1054             book_idx =  0;
1055         }
1056         av_dlog(NULL, "floor0 dec: booknumber: %u\n", book_idx);
1057         codebook = vc->codebooks[vf->book_list[book_idx]];
1058         /* Invalid codebook! */
1059         if (!codebook.codevectors)
1060             return -1;
1061
1062         while (lsp_len<vf->order) {
1063             int vec_off;
1064
1065             av_dlog(NULL, "floor0 dec: book dimension: %d\n", codebook.dimensions);
1066             av_dlog(NULL, "floor0 dec: maximum depth: %d\n", codebook.maxdepth);
1067             /* read temp vector */
1068             vec_off = get_vlc2(&vc->gb, codebook.vlc.table,
1069                                codebook.nb_bits, codebook.maxdepth)
1070                       * codebook.dimensions;
1071             av_dlog(NULL, "floor0 dec: vector offset: %d\n", vec_off);
1072             /* copy each vector component and add last to it */
1073             for (idx = 0; idx < codebook.dimensions; ++idx)
1074                 lsp[lsp_len+idx] = codebook.codevectors[vec_off+idx] + last;
1075             last = lsp[lsp_len+idx-1]; /* set last to last vector component */
1076
1077             lsp_len += codebook.dimensions;
1078         }
1079         /* DEBUG: output lsp coeffs */
1080         {
1081             int idx;
1082             for (idx = 0; idx < lsp_len; ++idx)
1083                 av_dlog(NULL, "floor0 dec: coeff at %d is %f\n", idx, lsp[idx]);
1084         }
1085
1086         /* synthesize floor output vector */
1087         {
1088             int i;
1089             int order = vf->order;
1090             float wstep = M_PI / vf->bark_map_size;
1091
1092             for (i = 0; i < order; i++)
1093                 lsp[i] = 2.0f * cos(lsp[i]);
1094
1095             av_dlog(NULL, "floor0 synth: map_size = %"PRIu32"; m = %d; wstep = %f\n",
1096                     vf->map_size[blockflag], order, wstep);
1097
1098             i = 0;
1099             while (i < vf->map_size[blockflag]) {
1100                 int j, iter_cond = vf->map[blockflag][i];
1101                 float p = 0.5f;
1102                 float q = 0.5f;
1103                 float two_cos_w = 2.0f * cos(wstep * iter_cond); // needed all times
1104
1105                 /* similar part for the q and p products */
1106                 for (j = 0; j + 1 < order; j += 2) {
1107                     q *= lsp[j]     - two_cos_w;
1108                     p *= lsp[j + 1] - two_cos_w;
1109                 }
1110                 if (j == order) { // even order
1111                     p *= p * (2.0f - two_cos_w);
1112                     q *= q * (2.0f + two_cos_w);
1113                 } else { // odd order
1114                     q *= two_cos_w-lsp[j]; // one more time for q
1115
1116                     /* final step and square */
1117                     p *= p * (4.f - two_cos_w * two_cos_w);
1118                     q *= q;
1119                 }
1120
1121                 /* calculate linear floor value */
1122                 q = exp((((amplitude*vf->amplitude_offset) /
1123                           (((1 << vf->amplitude_bits) - 1) * sqrt(p + q)))
1124                          - vf->amplitude_offset) * .11512925f);
1125
1126                 /* fill vector */
1127                 do {
1128                     vec[i] = q; ++i;
1129                 } while (vf->map[blockflag][i] == iter_cond);
1130             }
1131         }
1132     } else {
1133         /* this channel is unused */
1134         return 1;
1135     }
1136
1137     av_dlog(NULL, " Floor0 decoded\n");
1138
1139     return 0;
1140 }
1141
1142 static int vorbis_floor1_decode(vorbis_context *vc,
1143                                 vorbis_floor_data *vfu, float *vec)
1144 {
1145     vorbis_floor1 *vf = &vfu->t1;
1146     GetBitContext *gb = &vc->gb;
1147     uint16_t range_v[4] = { 256, 128, 86, 64 };
1148     unsigned range = range_v[vf->multiplier - 1];
1149     uint16_t floor1_Y[258];
1150     uint16_t floor1_Y_final[258];
1151     int floor1_flag[258];
1152     unsigned class, cdim, cbits, csub, cval, offset, i, j;
1153     int book, adx, ady, dy, off, predicted, err;
1154
1155
1156     if (!get_bits1(gb)) // silence
1157         return 1;
1158
1159 // Read values (or differences) for the floor's points
1160
1161     floor1_Y[0] = get_bits(gb, ilog(range - 1));
1162     floor1_Y[1] = get_bits(gb, ilog(range - 1));
1163
1164     av_dlog(NULL, "floor 0 Y %d floor 1 Y %d \n", floor1_Y[0], floor1_Y[1]);
1165
1166     offset = 2;
1167     for (i = 0; i < vf->partitions; ++i) {
1168         class = vf->partition_class[i];
1169         cdim   = vf->class_dimensions[class];
1170         cbits  = vf->class_subclasses[class];
1171         csub = (1 << cbits) - 1;
1172         cval = 0;
1173
1174         av_dlog(NULL, "Cbits %u\n", cbits);
1175
1176         if (cbits) // this reads all subclasses for this partition's class
1177             cval = get_vlc2(gb, vc->codebooks[vf->class_masterbook[class]].vlc.table,
1178                             vc->codebooks[vf->class_masterbook[class]].nb_bits, 3);
1179
1180         for (j = 0; j < cdim; ++j) {
1181             book = vf->subclass_books[class][cval & csub];
1182
1183             av_dlog(NULL, "book %d Cbits %u cval %u  bits:%d\n",
1184                     book, cbits, cval, get_bits_count(gb));
1185
1186             cval = cval >> cbits;
1187             if (book > -1) {
1188                 floor1_Y[offset+j] = get_vlc2(gb, vc->codebooks[book].vlc.table,
1189                 vc->codebooks[book].nb_bits, 3);
1190             } else {
1191                 floor1_Y[offset+j] = 0;
1192             }
1193
1194             av_dlog(NULL, " floor(%d) = %d \n",
1195                     vf->list[offset+j].x, floor1_Y[offset+j]);
1196         }
1197         offset+=cdim;
1198     }
1199
1200 // Amplitude calculation from the differences
1201
1202     floor1_flag[0] = 1;
1203     floor1_flag[1] = 1;
1204     floor1_Y_final[0] = floor1_Y[0];
1205     floor1_Y_final[1] = floor1_Y[1];
1206
1207     for (i = 2; i < vf->x_list_dim; ++i) {
1208         unsigned val, highroom, lowroom, room, high_neigh_offs, low_neigh_offs;
1209
1210         low_neigh_offs  = vf->list[i].low;
1211         high_neigh_offs = vf->list[i].high;
1212         dy  = floor1_Y_final[high_neigh_offs] - floor1_Y_final[low_neigh_offs];  // render_point begin
1213         adx = vf->list[high_neigh_offs].x - vf->list[low_neigh_offs].x;
1214         ady = FFABS(dy);
1215         err = ady * (vf->list[i].x - vf->list[low_neigh_offs].x);
1216         off = err / adx;
1217         if (dy < 0) {
1218             predicted = floor1_Y_final[low_neigh_offs] - off;
1219         } else {
1220             predicted = floor1_Y_final[low_neigh_offs] + off;
1221         } // render_point end
1222
1223         val = floor1_Y[i];
1224         highroom = range-predicted;
1225         lowroom  = predicted;
1226         if (highroom < lowroom) {
1227             room = highroom * 2;
1228         } else {
1229             room = lowroom * 2;   // SPEC mispelling
1230         }
1231         if (val) {
1232             floor1_flag[low_neigh_offs]  = 1;
1233             floor1_flag[high_neigh_offs] = 1;
1234             floor1_flag[i]               = 1;
1235             if (val >= room) {
1236                 if (highroom > lowroom) {
1237                     floor1_Y_final[i] = val - lowroom + predicted;
1238                 } else {
1239                     floor1_Y_final[i] = predicted - val + highroom - 1;
1240                 }
1241             } else {
1242                 if (val & 1) {
1243                     floor1_Y_final[i] = predicted - (val + 1) / 2;
1244                 } else {
1245                     floor1_Y_final[i] = predicted + val / 2;
1246                 }
1247             }
1248         } else {
1249             floor1_flag[i]    = 0;
1250             floor1_Y_final[i] = predicted;
1251         }
1252
1253         av_dlog(NULL, " Decoded floor(%d) = %u / val %u\n",
1254                 vf->list[i].x, floor1_Y_final[i], val);
1255     }
1256
1257 // Curve synth - connect the calculated dots and convert from dB scale FIXME optimize ?
1258
1259     ff_vorbis_floor1_render_list(vf->list, vf->x_list_dim, floor1_Y_final, floor1_flag, vf->multiplier, vec, vf->list[1].x);
1260
1261     av_dlog(NULL, " Floor decoded\n");
1262
1263     return 0;
1264 }
1265
1266 // Read and decode residue
1267
1268 static av_always_inline int vorbis_residue_decode_internal(vorbis_context *vc,
1269                                                            vorbis_residue *vr,
1270                                                            unsigned ch,
1271                                                            uint8_t *do_not_decode,
1272                                                            float *vec,
1273                                                            unsigned vlen,
1274                                                            int vr_type)
1275 {
1276     GetBitContext *gb = &vc->gb;
1277     unsigned c_p_c        = vc->codebooks[vr->classbook].dimensions;
1278     unsigned ptns_to_read = vr->ptns_to_read;
1279     uint8_t *classifs = vr->classifs;
1280     unsigned pass, ch_used, i, j, k, l;
1281
1282     if (vr_type == 2) {
1283         for (j = 1; j < ch; ++j)
1284             do_not_decode[0] &= do_not_decode[j];  // FIXME - clobbering input
1285         if (do_not_decode[0])
1286             return 0;
1287         ch_used = 1;
1288     } else {
1289         ch_used = ch;
1290     }
1291
1292     av_dlog(NULL, " residue type 0/1/2 decode begin, ch: %d  cpc %d  \n", ch, c_p_c);
1293
1294     for (pass = 0; pass <= vr->maxpass; ++pass) { // FIXME OPTIMIZE?
1295         uint16_t voffset, partition_count, j_times_ptns_to_read;
1296
1297         voffset = vr->begin;
1298         for (partition_count = 0; partition_count < ptns_to_read;) {  // SPEC        error
1299             if (!pass) {
1300                 unsigned inverse_class = ff_inverse[vr->classifications];
1301                 for (j_times_ptns_to_read = 0, j = 0; j < ch_used; ++j) {
1302                     if (!do_not_decode[j]) {
1303                         unsigned temp = get_vlc2(gb, vc->codebooks[vr->classbook].vlc.table,
1304                                                  vc->codebooks[vr->classbook].nb_bits, 3);
1305
1306                         av_dlog(NULL, "Classword: %u\n", temp);
1307
1308                         assert(vr->classifications > 1 && temp <= 65536); //needed for inverse[]
1309                         for (i = 0; i < c_p_c; ++i) {
1310                             unsigned temp2;
1311
1312                             temp2 = (((uint64_t)temp) * inverse_class) >> 32;
1313                             if (partition_count + c_p_c - 1 - i < ptns_to_read)
1314                                 classifs[j_times_ptns_to_read + partition_count + c_p_c - 1 - i] = temp - temp2 * vr->classifications;
1315                             temp = temp2;
1316                         }
1317                     }
1318                     j_times_ptns_to_read += ptns_to_read;
1319                 }
1320             }
1321             for (i = 0; (i < c_p_c) && (partition_count < ptns_to_read); ++i) {
1322                 for (j_times_ptns_to_read = 0, j = 0; j < ch_used; ++j) {
1323                     unsigned voffs;
1324
1325                     if (!do_not_decode[j]) {
1326                         unsigned vqclass = classifs[j_times_ptns_to_read + partition_count];
1327                         int vqbook  = vr->books[vqclass][pass];
1328
1329                         if (vqbook >= 0 && vc->codebooks[vqbook].codevectors) {
1330                             unsigned coffs;
1331                             unsigned dim  = vc->codebooks[vqbook].dimensions;
1332                             unsigned step = dim == 1 ? vr->partition_size
1333                                                      : FASTDIV(vr->partition_size, dim);
1334                             vorbis_codebook codebook = vc->codebooks[vqbook];
1335
1336                             if (vr_type == 0) {
1337
1338                                 voffs = voffset+j*vlen;
1339                                 for (k = 0; k < step; ++k) {
1340                                     coffs = get_vlc2(gb, codebook.vlc.table, codebook.nb_bits, 3) * dim;
1341                                     for (l = 0; l < dim; ++l)
1342                                         vec[voffs + k + l * step] += codebook.codevectors[coffs + l];  // FPMATH
1343                                 }
1344                             } else if (vr_type == 1) {
1345                                 voffs = voffset + j * vlen;
1346                                 for (k = 0; k < step; ++k) {
1347                                     coffs = get_vlc2(gb, codebook.vlc.table, codebook.nb_bits, 3) * dim;
1348                                     for (l = 0; l < dim; ++l, ++voffs) {
1349                                         vec[voffs]+=codebook.codevectors[coffs+l];  // FPMATH
1350
1351                                         av_dlog(NULL, " pass %d offs: %d curr: %f change: %f cv offs.: %d  \n",
1352                                                 pass, voffs, vec[voffs], codebook.codevectors[coffs+l], coffs);
1353                                     }
1354                                 }
1355                             } else if (vr_type == 2 && ch == 2 && (voffset & 1) == 0 && (dim & 1) == 0) { // most frequent case optimized
1356                                 voffs = voffset >> 1;
1357
1358                                 if (dim == 2) {
1359                                     for (k = 0; k < step; ++k) {
1360                                         coffs = get_vlc2(gb, codebook.vlc.table, codebook.nb_bits, 3) * 2;
1361                                         vec[voffs + k       ] += codebook.codevectors[coffs    ];  // FPMATH
1362                                         vec[voffs + k + vlen] += codebook.codevectors[coffs + 1];  // FPMATH
1363                                     }
1364                                 } else if (dim == 4) {
1365                                     for (k = 0; k < step; ++k, voffs += 2) {
1366                                         coffs = get_vlc2(gb, codebook.vlc.table, codebook.nb_bits, 3) * 4;
1367                                         vec[voffs           ] += codebook.codevectors[coffs    ];  // FPMATH
1368                                         vec[voffs + 1       ] += codebook.codevectors[coffs + 2];  // FPMATH
1369                                         vec[voffs + vlen    ] += codebook.codevectors[coffs + 1];  // FPMATH
1370                                         vec[voffs + vlen + 1] += codebook.codevectors[coffs + 3];  // FPMATH
1371                                     }
1372                                 } else
1373                                 for (k = 0; k < step; ++k) {
1374                                     coffs = get_vlc2(gb, codebook.vlc.table, codebook.nb_bits, 3) * dim;
1375                                     for (l = 0; l < dim; l += 2, voffs++) {
1376                                         vec[voffs       ] += codebook.codevectors[coffs + l    ];  // FPMATH
1377                                         vec[voffs + vlen] += codebook.codevectors[coffs + l + 1];  // FPMATH
1378
1379                                         av_dlog(NULL, " pass %d offs: %d curr: %f change: %f cv offs.: %d+%d  \n",
1380                                                 pass, voffset / ch + (voffs % ch) * vlen,
1381                                                 vec[voffset / ch + (voffs % ch) * vlen],
1382                                                 codebook.codevectors[coffs + l], coffs, l);
1383                                     }
1384                                 }
1385
1386                             } else if (vr_type == 2) {
1387                                 voffs = voffset;
1388
1389                                 for (k = 0; k < step; ++k) {
1390                                     coffs = get_vlc2(gb, codebook.vlc.table, codebook.nb_bits, 3) * dim;
1391                                     for (l = 0; l < dim; ++l, ++voffs) {
1392                                         vec[voffs / ch + (voffs % ch) * vlen] += codebook.codevectors[coffs + l];  // FPMATH FIXME use if and counter instead of / and %
1393
1394                                         av_dlog(NULL, " pass %d offs: %d curr: %f change: %f cv offs.: %d+%d  \n",
1395                                                 pass, voffset / ch + (voffs % ch) * vlen,
1396                                                 vec[voffset / ch + (voffs % ch) * vlen],
1397                                                 codebook.codevectors[coffs + l], coffs, l);
1398                                     }
1399                                 }
1400                             }
1401                         }
1402                     }
1403                     j_times_ptns_to_read += ptns_to_read;
1404                 }
1405                 ++partition_count;
1406                 voffset += vr->partition_size;
1407             }
1408         }
1409     }
1410     return 0;
1411 }
1412
1413 static inline int vorbis_residue_decode(vorbis_context *vc, vorbis_residue *vr,
1414                                         unsigned ch,
1415                                         uint8_t *do_not_decode,
1416                                         float *vec, unsigned vlen)
1417 {
1418     if (vr->type == 2)
1419         return vorbis_residue_decode_internal(vc, vr, ch, do_not_decode, vec, vlen, 2);
1420     else if (vr->type == 1)
1421         return vorbis_residue_decode_internal(vc, vr, ch, do_not_decode, vec, vlen, 1);
1422     else if (vr->type == 0)
1423         return vorbis_residue_decode_internal(vc, vr, ch, do_not_decode, vec, vlen, 0);
1424     else {
1425         av_log(vc->avccontext, AV_LOG_ERROR, " Invalid residue type while residue decode?! \n");
1426         return -1;
1427     }
1428 }
1429
1430 void vorbis_inverse_coupling(float *mag, float *ang, int blocksize)
1431 {
1432     int i;
1433     for (i = 0;  i < blocksize;  i++) {
1434         if (mag[i] > 0.0) {
1435             if (ang[i] > 0.0) {
1436                 ang[i] = mag[i] - ang[i];
1437             } else {
1438                 float temp = ang[i];
1439                 ang[i]     = mag[i];
1440                 mag[i]    += temp;
1441             }
1442         } else {
1443             if (ang[i] > 0.0) {
1444                 ang[i] += mag[i];
1445             } else {
1446                 float temp = ang[i];
1447                 ang[i]     = mag[i];
1448                 mag[i]    -= temp;
1449             }
1450         }
1451     }
1452 }
1453
1454 // Decode the audio packet using the functions above
1455
1456 static int vorbis_parse_audio_packet(vorbis_context *vc)
1457 {
1458     GetBitContext *gb = &vc->gb;
1459     FFTContext *mdct;
1460     unsigned previous_window = vc->previous_window;
1461     unsigned mode_number, blockflag, blocksize;
1462     int i, j;
1463     uint8_t no_residue[255];
1464     uint8_t do_not_decode[255];
1465     vorbis_mapping *mapping;
1466     float *ch_res_ptr   = vc->channel_residues;
1467     float *ch_floor_ptr = vc->channel_floors;
1468     uint8_t res_chan[255];
1469     unsigned res_num = 0;
1470     int retlen  = 0;
1471
1472     if (get_bits1(gb)) {
1473         av_log(vc->avccontext, AV_LOG_ERROR, "Not a Vorbis I audio packet.\n");
1474         return -1; // packet type not audio
1475     }
1476
1477     if (vc->mode_count == 1) {
1478         mode_number = 0;
1479     } else {
1480         GET_VALIDATED_INDEX(mode_number, ilog(vc->mode_count-1), vc->mode_count)
1481     }
1482     vc->mode_number = mode_number;
1483     mapping = &vc->mappings[vc->modes[mode_number].mapping];
1484
1485     av_dlog(NULL, " Mode number: %u , mapping: %d , blocktype %d\n", mode_number,
1486             vc->modes[mode_number].mapping, vc->modes[mode_number].blockflag);
1487
1488     blockflag = vc->modes[mode_number].blockflag;
1489     blocksize = vc->blocksize[blockflag];
1490     if (blockflag)
1491         skip_bits(gb, 2); // previous_window, next_window
1492
1493     memset(ch_res_ptr,   0, sizeof(float) * vc->audio_channels * blocksize / 2); //FIXME can this be removed ?
1494     memset(ch_floor_ptr, 0, sizeof(float) * vc->audio_channels * blocksize / 2); //FIXME can this be removed ?
1495
1496 // Decode floor
1497
1498     for (i = 0; i < vc->audio_channels; ++i) {
1499         vorbis_floor *floor;
1500         int ret;
1501         if (mapping->submaps > 1) {
1502             floor = &vc->floors[mapping->submap_floor[mapping->mux[i]]];
1503         } else {
1504             floor = &vc->floors[mapping->submap_floor[0]];
1505         }
1506
1507         ret = floor->decode(vc, &floor->data, ch_floor_ptr);
1508
1509         if (ret < 0) {
1510             av_log(vc->avccontext, AV_LOG_ERROR, "Invalid codebook in vorbis_floor_decode.\n");
1511             return -1;
1512         }
1513         no_residue[i] = ret;
1514         ch_floor_ptr += blocksize / 2;
1515     }
1516
1517 // Nonzero vector propagate
1518
1519     for (i = mapping->coupling_steps - 1; i >= 0; --i) {
1520         if (!(no_residue[mapping->magnitude[i]] & no_residue[mapping->angle[i]])) {
1521             no_residue[mapping->magnitude[i]] = 0;
1522             no_residue[mapping->angle[i]]     = 0;
1523         }
1524     }
1525
1526 // Decode residue
1527
1528     for (i = 0; i < mapping->submaps; ++i) {
1529         vorbis_residue *residue;
1530         unsigned ch = 0;
1531
1532         for (j = 0; j < vc->audio_channels; ++j) {
1533             if ((mapping->submaps == 1) || (i == mapping->mux[j])) {
1534                 res_chan[j] = res_num;
1535                 if (no_residue[j]) {
1536                     do_not_decode[ch] = 1;
1537                 } else {
1538                     do_not_decode[ch] = 0;
1539                 }
1540                 ++ch;
1541                 ++res_num;
1542             }
1543         }
1544         residue = &vc->residues[mapping->submap_residue[i]];
1545         vorbis_residue_decode(vc, residue, ch, do_not_decode, ch_res_ptr, blocksize/2);
1546
1547         ch_res_ptr += ch * blocksize / 2;
1548     }
1549
1550 // Inverse coupling
1551
1552     for (i = mapping->coupling_steps - 1; i >= 0; --i) { //warning: i has to be signed
1553         float *mag, *ang;
1554
1555         mag = vc->channel_residues+res_chan[mapping->magnitude[i]] * blocksize / 2;
1556         ang = vc->channel_residues+res_chan[mapping->angle[i]]     * blocksize / 2;
1557         vc->dsp.vorbis_inverse_coupling(mag, ang, blocksize / 2);
1558     }
1559
1560 // Dotproduct, MDCT
1561
1562     mdct = &vc->mdct[blockflag];
1563
1564     for (j = vc->audio_channels-1;j >= 0; j--) {
1565         ch_floor_ptr = vc->channel_floors   + j           * blocksize / 2;
1566         ch_res_ptr   = vc->channel_residues + res_chan[j] * blocksize / 2;
1567         vc->dsp.vector_fmul(ch_floor_ptr, ch_floor_ptr, ch_res_ptr, blocksize / 2);
1568         mdct->imdct_half(mdct, ch_res_ptr, ch_floor_ptr);
1569     }
1570
1571 // Overlap/add, save data for next overlapping  FPMATH
1572
1573     retlen = (blocksize + vc->blocksize[previous_window]) / 4;
1574     for (j = 0; j < vc->audio_channels; j++) {
1575         unsigned bs0 = vc->blocksize[0];
1576         unsigned bs1 = vc->blocksize[1];
1577         float *residue    = vc->channel_residues + res_chan[j] * blocksize / 2;
1578         float *saved      = vc->saved + j * bs1 / 4;
1579         float *ret        = vc->channel_floors + j * retlen;
1580         float *buf        = residue;
1581         const float *win  = vc->win[blockflag & previous_window];
1582
1583         if (blockflag == previous_window) {
1584             vc->dsp.vector_fmul_window(ret, saved, buf, win, blocksize / 4);
1585         } else if (blockflag > previous_window) {
1586             vc->dsp.vector_fmul_window(ret, saved, buf, win, bs0 / 4);
1587             memcpy(ret+bs0/2, buf+bs0/4, ((bs1-bs0)/4) * sizeof(float));
1588         } else {
1589             memcpy(ret, saved, ((bs1 - bs0) / 4) * sizeof(float));
1590             vc->dsp.vector_fmul_window(ret + (bs1 - bs0) / 4, saved + (bs1 - bs0) / 4, buf, win, bs0 / 4);
1591         }
1592         memcpy(saved, buf + blocksize / 4, blocksize / 4 * sizeof(float));
1593     }
1594
1595     vc->previous_window = blockflag;
1596     return retlen;
1597 }
1598
1599 // Return the decoded audio packet through the standard api
1600
1601 static int vorbis_decode_frame(AVCodecContext *avccontext,
1602                                void *data, int *data_size,
1603                                AVPacket *avpkt)
1604 {
1605     const uint8_t *buf = avpkt->data;
1606     int buf_size       = avpkt->size;
1607     vorbis_context *vc = avccontext->priv_data ;
1608     GetBitContext *gb = &(vc->gb);
1609     const float *channel_ptrs[255];
1610     int i, len;
1611
1612     if (!buf_size)
1613         return 0;
1614
1615     av_dlog(NULL, "packet length %d \n", buf_size);
1616
1617     init_get_bits(gb, buf, buf_size*8);
1618
1619     len = vorbis_parse_audio_packet(vc);
1620
1621     if (len <= 0) {
1622         *data_size = 0;
1623         return buf_size;
1624     }
1625
1626     if (!vc->first_frame) {
1627         vc->first_frame = 1;
1628         *data_size = 0;
1629         return buf_size ;
1630     }
1631
1632     av_dlog(NULL, "parsed %d bytes %d bits, returned %d samples (*ch*bits) \n",
1633             get_bits_count(gb) / 8, get_bits_count(gb) % 8, len);
1634
1635     if (vc->audio_channels > 8) {
1636         for (i = 0; i < vc->audio_channels; i++)
1637             channel_ptrs[i] = vc->channel_floors + i * len;
1638     } else {
1639         for (i = 0; i < vc->audio_channels; i++)
1640             channel_ptrs[i] = vc->channel_floors +
1641                               len * ff_vorbis_channel_layout_offsets[vc->audio_channels - 1][i];
1642     }
1643
1644     if (avccontext->sample_fmt == AV_SAMPLE_FMT_FLT)
1645         vc->fmt_conv.float_interleave(data, channel_ptrs, len, vc->audio_channels);
1646     else
1647         vc->fmt_conv.float_to_int16_interleave(data, channel_ptrs, len,
1648                                                vc->audio_channels);
1649
1650     *data_size = len * vc->audio_channels *
1651                  av_get_bytes_per_sample(avccontext->sample_fmt);
1652
1653     return buf_size ;
1654 }
1655
1656 // Close decoder
1657
1658 static av_cold int vorbis_decode_close(AVCodecContext *avccontext)
1659 {
1660     vorbis_context *vc = avccontext->priv_data;
1661
1662     vorbis_free(vc);
1663
1664     return 0 ;
1665 }
1666
1667 AVCodec ff_vorbis_decoder = {
1668     "vorbis",
1669     AVMEDIA_TYPE_AUDIO,
1670     CODEC_ID_VORBIS,
1671     sizeof(vorbis_context),
1672     vorbis_decode_init,
1673     NULL,
1674     vorbis_decode_close,
1675     vorbis_decode_frame,
1676     .long_name = NULL_IF_CONFIG_SMALL("Vorbis"),
1677     .channel_layouts = ff_vorbis_channel_layouts,
1678     .sample_fmts = (const enum AVSampleFormat[]) {
1679         AV_SAMPLE_FMT_FLT, AV_SAMPLE_FMT_S16, AV_SAMPLE_FMT_NONE
1680     },
1681 };
1682