8svx: copy start value in output samples.
[ffmpeg.git] / libavcodec / 8svx.c
1 /*
2  * Copyright (C) 2008 Jaikrishnan Menon
3  * Copyright (C) 2011 Stefano Sabatini
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 /**
23  * @file
24  * 8svx audio decoder
25  * @author Jaikrishnan Menon
26  *
27  * supports: fibonacci delta encoding
28  *         : exponential encoding
29  *
30  * For more information about the 8SVX format:
31  * http://netghost.narod.ru/gff/vendspec/iff/iff.txt
32  * http://sox.sourceforge.net/AudioFormats-11.html
33  * http://aminet.net/package/mus/misc/wavepak
34  * http://amigan.1emu.net/reg/8SVX.txt
35  *
36  * Samples can be found here:
37  * http://aminet.net/mods/smpl/
38  */
39
40 #include "libavutil/avassert.h"
41 #include "avcodec.h"
42 #include "libavutil/common.h"
43
44 /** decoder context */
45 typedef struct EightSvxContext {
46     AVFrame frame;
47     const int8_t *table;
48
49     /* buffer used to store the whole audio decoded/interleaved chunk,
50      * which is sent with the first packet */
51     uint8_t *samples;
52     int64_t samples_size;
53     int samples_idx;
54 } EightSvxContext;
55
56 static const int8_t fibonacci[16]   = { -34,  -21, -13,  -8, -5, -3, -2, -1, 0, 1, 2, 3, 5, 8,  13, 21 };
57 static const int8_t exponential[16] = { -128, -64, -32, -16, -8, -4, -2, -1, 0, 1, 2, 4, 8, 16, 32, 64 };
58
59 #define MAX_FRAME_SIZE 2048
60
61 /**
62  * Delta decode the compressed values in src, and put the resulting
63  * decoded n samples in dst.
64  *
65  * @param val starting value assumed by the delta sequence
66  * @param table delta sequence table
67  * @return size in bytes of the decoded data, must be src_size*2
68  */
69 static int delta_decode(int8_t *dst, const uint8_t *src, int src_size,
70                         int8_t val, const int8_t *table)
71 {
72     int n = src_size;
73     int8_t *dst0 = dst;
74
75     while (n--) {
76         uint8_t d = *src++;
77         val = av_clip(val + table[d & 0x0f], -127, 128);
78         *dst++ = val;
79         val = av_clip(val + table[d >> 4]  , -127, 128);
80         *dst++ = val;
81     }
82
83     return dst-dst0;
84 }
85
86 /** decode a frame */
87 static int eightsvx_decode_frame(AVCodecContext *avctx, void *data,
88                                  int *got_frame_ptr, AVPacket *avpkt)
89 {
90     EightSvxContext *esc = avctx->priv_data;
91     int n, out_data_size;
92     int ch, ret;
93     uint8_t *src, *dst;
94
95     /* decode and interleave the first packet */
96     if (!esc->samples && avpkt) {
97         int packet_size = avpkt->size;
98
99         if (packet_size % avctx->channels) {
100             av_log(avctx, AV_LOG_WARNING, "Packet with odd size, ignoring last byte\n");
101             if (packet_size < avctx->channels)
102                 return packet_size;
103             packet_size -= packet_size % avctx->channels;
104         }
105         esc->samples_size = !esc->table ?
106             packet_size : avctx->channels + (packet_size-avctx->channels) * 2;
107         if (!(esc->samples = av_malloc(esc->samples_size)))
108             return AVERROR(ENOMEM);
109
110         /* decompress */
111         if (esc->table) {
112             const uint8_t *buf = avpkt->data;
113             uint8_t *dst;
114             int buf_size = avpkt->size;
115             int i, n = esc->samples_size;
116
117             if (buf_size < 2) {
118                 av_log(avctx, AV_LOG_ERROR, "packet size is too small\n");
119                 return AVERROR(EINVAL);
120             }
121
122             /* the uncompressed starting value is contained in the first byte */
123             dst = esc->samples;
124             for (i = 0; i < avctx->channels; i++) {
125                 *(dst++) = buf[0];
126                 delta_decode(dst, buf + 1, buf_size / avctx->channels - 1, buf[0], esc->table);
127                 buf += buf_size / avctx->channels;
128                 dst += n / avctx->channels - 1;
129             }
130         } else {
131             memcpy(esc->samples, avpkt->data, esc->samples_size);
132         }
133     }
134
135     /* get output buffer */
136     av_assert1(!(esc->samples_size % avctx->channels || esc->samples_idx % avctx->channels));
137     esc->frame.nb_samples = FFMIN(MAX_FRAME_SIZE, esc->samples_size - esc->samples_idx)  / avctx->channels;
138     if ((ret = avctx->get_buffer(avctx, &esc->frame)) < 0) {
139         av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
140         return ret;
141     }
142
143     *got_frame_ptr   = 1;
144     *(AVFrame *)data = esc->frame;
145
146     out_data_size = esc->frame.nb_samples;
147     for (ch = 0; ch<avctx->channels; ch++) {
148         dst = esc->frame.data[ch];
149         src = esc->samples + esc->samples_idx / avctx->channels + ch * esc->samples_size / avctx->channels;
150         for (n = out_data_size; n > 0; n--)
151             *dst++ = *src++ + 128;
152     }
153     out_data_size *= avctx->channels;
154     esc->samples_idx += out_data_size;
155
156     return esc->table ?
157         (avctx->frame_number == 0)*2 + out_data_size / 2 :
158         out_data_size;
159 }
160
161 static av_cold int eightsvx_decode_init(AVCodecContext *avctx)
162 {
163     EightSvxContext *esc = avctx->priv_data;
164
165     if (avctx->channels < 1 || avctx->channels > 2) {
166         av_log(avctx, AV_LOG_ERROR, "8SVX does not support more than 2 channels\n");
167         return AVERROR_INVALIDDATA;
168     }
169
170     switch (avctx->codec->id) {
171     case AV_CODEC_ID_8SVX_FIB: esc->table = fibonacci;    break;
172     case AV_CODEC_ID_8SVX_EXP: esc->table = exponential;  break;
173     case AV_CODEC_ID_PCM_S8_PLANAR:
174     case AV_CODEC_ID_8SVX_RAW: esc->table = NULL;         break;
175     default:
176         av_log(avctx, AV_LOG_ERROR, "Invalid codec id %d.\n", avctx->codec->id);
177         return AVERROR_INVALIDDATA;
178     }
179     avctx->sample_fmt = AV_SAMPLE_FMT_U8P;
180
181     avcodec_get_frame_defaults(&esc->frame);
182     avctx->coded_frame = &esc->frame;
183
184     return 0;
185 }
186
187 static av_cold int eightsvx_decode_close(AVCodecContext *avctx)
188 {
189     EightSvxContext *esc = avctx->priv_data;
190
191     av_freep(&esc->samples);
192     esc->samples_size = 0;
193     esc->samples_idx = 0;
194
195     return 0;
196 }
197
198 #if CONFIG_EIGHTSVX_FIB_DECODER
199 AVCodec ff_eightsvx_fib_decoder = {
200   .name           = "8svx_fib",
201   .type           = AVMEDIA_TYPE_AUDIO,
202   .id             = AV_CODEC_ID_8SVX_FIB,
203   .priv_data_size = sizeof (EightSvxContext),
204   .init           = eightsvx_decode_init,
205   .decode         = eightsvx_decode_frame,
206   .close          = eightsvx_decode_close,
207   .capabilities   = CODEC_CAP_DR1,
208   .long_name      = NULL_IF_CONFIG_SMALL("8SVX fibonacci"),
209   .sample_fmts    = (const enum AVSampleFormat[]) { AV_SAMPLE_FMT_U8P,
210                                                     AV_SAMPLE_FMT_NONE },
211 };
212 #endif
213 #if CONFIG_EIGHTSVX_EXP_DECODER
214 AVCodec ff_eightsvx_exp_decoder = {
215   .name           = "8svx_exp",
216   .type           = AVMEDIA_TYPE_AUDIO,
217   .id             = AV_CODEC_ID_8SVX_EXP,
218   .priv_data_size = sizeof (EightSvxContext),
219   .init           = eightsvx_decode_init,
220   .decode         = eightsvx_decode_frame,
221   .close          = eightsvx_decode_close,
222   .capabilities   = CODEC_CAP_DR1,
223   .long_name      = NULL_IF_CONFIG_SMALL("8SVX exponential"),
224   .sample_fmts    = (const enum AVSampleFormat[]) { AV_SAMPLE_FMT_U8P,
225                                                     AV_SAMPLE_FMT_NONE },
226 };
227 #endif
228 #if CONFIG_PCM_S8_PLANAR_DECODER
229 AVCodec ff_pcm_s8_planar_decoder = {
230     .name           = "pcm_s8_planar",
231     .type           = AVMEDIA_TYPE_AUDIO,
232     .id             = AV_CODEC_ID_PCM_S8_PLANAR,
233     .priv_data_size = sizeof(EightSvxContext),
234     .init           = eightsvx_decode_init,
235     .close          = eightsvx_decode_close,
236     .decode         = eightsvx_decode_frame,
237     .capabilities   = CODEC_CAP_DR1,
238     .long_name      = NULL_IF_CONFIG_SMALL("PCM signed 8-bit planar"),
239     .sample_fmts    = (const enum AVSampleFormat[]) { AV_SAMPLE_FMT_U8P,
240                                                       AV_SAMPLE_FMT_NONE },
241 };
242 #endif