lavc: provide aliases to the PCM A-law/mu-law codecs
[ffmpeg.git] / libavcodec / pcm.c
1 /*
2  * PCM codecs
3  * Copyright (c) 2001 Fabrice Bellard
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  * PCM codecs
25  */
26
27 #include "avcodec.h"
28 #include "libavutil/common.h" /* for av_reverse */
29 #include "bytestream.h"
30 #include "internal.h"
31 #include "pcm_tablegen.h"
32
33 #define MAX_CHANNELS 64
34
35 static av_cold int pcm_encode_init(AVCodecContext *avctx)
36 {
37     avctx->frame_size = 0;
38     switch(avctx->codec->id) {
39     case CODEC_ID_PCM_ALAW:
40         pcm_alaw_tableinit();
41         break;
42     case CODEC_ID_PCM_MULAW:
43         pcm_ulaw_tableinit();
44         break;
45     default:
46         break;
47     }
48
49     avctx->bits_per_coded_sample = av_get_bits_per_sample(avctx->codec->id);
50     avctx->block_align = avctx->channels * avctx->bits_per_coded_sample/8;
51     avctx->coded_frame= avcodec_alloc_frame();
52     if (!avctx->coded_frame)
53         return AVERROR(ENOMEM);
54
55     return 0;
56 }
57
58 static av_cold int pcm_encode_close(AVCodecContext *avctx)
59 {
60     av_freep(&avctx->coded_frame);
61
62     return 0;
63 }
64
65 /**
66  * Write PCM samples macro
67  * @param type Datatype of native machine format
68  * @param endian bytestream_put_xxx() suffix
69  * @param src Source pointer (variable name)
70  * @param dst Destination pointer (variable name)
71  * @param n Total number of samples (variable name)
72  * @param shift Bitshift (bits)
73  * @param offset Sample value offset
74  */
75 #define ENCODE(type, endian, src, dst, n, shift, offset) \
76     samples_##type = (const type*) src; \
77     for(;n>0;n--) { \
78         register type v = (*samples_##type++ >> shift) + offset; \
79         bytestream_put_##endian(&dst, v); \
80     }
81
82 static int pcm_encode_frame(AVCodecContext *avctx, AVPacket *avpkt,
83                             const AVFrame *frame, int *got_packet_ptr)
84 {
85     int n, sample_size, v, ret;
86     const short *samples;
87     unsigned char *dst;
88     const uint8_t *srcu8;
89     const int16_t *samples_int16_t;
90     const int32_t *samples_int32_t;
91     const int64_t *samples_int64_t;
92     const uint16_t *samples_uint16_t;
93     const uint32_t *samples_uint32_t;
94
95     sample_size = av_get_bits_per_sample(avctx->codec->id)/8;
96     n           = frame->nb_samples * avctx->channels;
97     samples     = (const short *)frame->data[0];
98
99     if ((ret = ff_alloc_packet(avpkt, n * sample_size))) {
100         av_log(avctx, AV_LOG_ERROR, "Error getting output packet\n");
101         return ret;
102     }
103     dst = avpkt->data;
104
105     switch(avctx->codec->id) {
106     case CODEC_ID_PCM_U32LE:
107         ENCODE(uint32_t, le32, samples, dst, n, 0, 0x80000000)
108         break;
109     case CODEC_ID_PCM_U32BE:
110         ENCODE(uint32_t, be32, samples, dst, n, 0, 0x80000000)
111         break;
112     case CODEC_ID_PCM_S24LE:
113         ENCODE(int32_t, le24, samples, dst, n, 8, 0)
114         break;
115     case CODEC_ID_PCM_S24BE:
116         ENCODE(int32_t, be24, samples, dst, n, 8, 0)
117         break;
118     case CODEC_ID_PCM_U24LE:
119         ENCODE(uint32_t, le24, samples, dst, n, 8, 0x800000)
120         break;
121     case CODEC_ID_PCM_U24BE:
122         ENCODE(uint32_t, be24, samples, dst, n, 8, 0x800000)
123         break;
124     case CODEC_ID_PCM_S24DAUD:
125         for(;n>0;n--) {
126             uint32_t tmp = av_reverse[(*samples >> 8) & 0xff] +
127                            (av_reverse[*samples & 0xff] << 8);
128             tmp <<= 4; // sync flags would go here
129             bytestream_put_be24(&dst, tmp);
130             samples++;
131         }
132         break;
133     case CODEC_ID_PCM_U16LE:
134         ENCODE(uint16_t, le16, samples, dst, n, 0, 0x8000)
135         break;
136     case CODEC_ID_PCM_U16BE:
137         ENCODE(uint16_t, be16, samples, dst, n, 0, 0x8000)
138         break;
139     case CODEC_ID_PCM_S8:
140         srcu8 = frame->data[0];
141         for(;n>0;n--) {
142             v = *srcu8++;
143             *dst++ = v - 128;
144         }
145         break;
146 #if HAVE_BIGENDIAN
147     case CODEC_ID_PCM_F64LE:
148         ENCODE(int64_t, le64, samples, dst, n, 0, 0)
149         break;
150     case CODEC_ID_PCM_S32LE:
151     case CODEC_ID_PCM_F32LE:
152         ENCODE(int32_t, le32, samples, dst, n, 0, 0)
153         break;
154     case CODEC_ID_PCM_S16LE:
155         ENCODE(int16_t, le16, samples, dst, n, 0, 0)
156         break;
157     case CODEC_ID_PCM_F64BE:
158     case CODEC_ID_PCM_F32BE:
159     case CODEC_ID_PCM_S32BE:
160     case CODEC_ID_PCM_S16BE:
161 #else
162     case CODEC_ID_PCM_F64BE:
163         ENCODE(int64_t, be64, samples, dst, n, 0, 0)
164         break;
165     case CODEC_ID_PCM_F32BE:
166     case CODEC_ID_PCM_S32BE:
167         ENCODE(int32_t, be32, samples, dst, n, 0, 0)
168         break;
169     case CODEC_ID_PCM_S16BE:
170         ENCODE(int16_t, be16, samples, dst, n, 0, 0)
171         break;
172     case CODEC_ID_PCM_F64LE:
173     case CODEC_ID_PCM_F32LE:
174     case CODEC_ID_PCM_S32LE:
175     case CODEC_ID_PCM_S16LE:
176 #endif /* HAVE_BIGENDIAN */
177     case CODEC_ID_PCM_U8:
178         memcpy(dst, samples, n*sample_size);
179         dst += n*sample_size;
180         break;
181     case CODEC_ID_PCM_ALAW:
182         for(;n>0;n--) {
183             v = *samples++;
184             *dst++ = linear_to_alaw[(v + 32768) >> 2];
185         }
186         break;
187     case CODEC_ID_PCM_MULAW:
188         for(;n>0;n--) {
189             v = *samples++;
190             *dst++ = linear_to_ulaw[(v + 32768) >> 2];
191         }
192         break;
193     default:
194         return -1;
195     }
196
197     *got_packet_ptr = 1;
198     return 0;
199 }
200
201 typedef struct PCMDecode {
202     AVFrame frame;
203     short table[256];
204 } PCMDecode;
205
206 static av_cold int pcm_decode_init(AVCodecContext * avctx)
207 {
208     PCMDecode *s = avctx->priv_data;
209     int i;
210
211     if (avctx->channels <= 0 || avctx->channels > MAX_CHANNELS) {
212         av_log(avctx, AV_LOG_ERROR, "PCM channels out of bounds\n");
213         return AVERROR(EINVAL);
214     }
215
216     switch(avctx->codec->id) {
217     case CODEC_ID_PCM_ALAW:
218         for(i=0;i<256;i++)
219             s->table[i] = alaw2linear(i);
220         break;
221     case CODEC_ID_PCM_MULAW:
222         for(i=0;i<256;i++)
223             s->table[i] = ulaw2linear(i);
224         break;
225     default:
226         break;
227     }
228
229     avctx->sample_fmt = avctx->codec->sample_fmts[0];
230
231     if (avctx->sample_fmt == AV_SAMPLE_FMT_S32)
232         avctx->bits_per_raw_sample = av_get_bits_per_sample(avctx->codec->id);
233
234     avcodec_get_frame_defaults(&s->frame);
235     avctx->coded_frame = &s->frame;
236
237     return 0;
238 }
239
240 /**
241  * Read PCM samples macro
242  * @param size Data size of native machine format
243  * @param endian bytestream_get_xxx() endian suffix
244  * @param src Source pointer (variable name)
245  * @param dst Destination pointer (variable name)
246  * @param n Total number of samples (variable name)
247  * @param shift Bitshift (bits)
248  * @param offset Sample value offset
249  */
250 #define DECODE(size, endian, src, dst, n, shift, offset) \
251     for(;n>0;n--) { \
252         uint##size##_t v = bytestream_get_##endian(&src); \
253         AV_WN##size##A(dst, (v - offset) << shift); \
254         dst += size / 8; \
255     }
256
257 static int pcm_decode_frame(AVCodecContext *avctx, void *data,
258                             int *got_frame_ptr, AVPacket *avpkt)
259 {
260     const uint8_t *src = avpkt->data;
261     int buf_size = avpkt->size;
262     PCMDecode *s = avctx->priv_data;
263     int sample_size, c, n, ret, samples_per_block;
264     uint8_t *samples;
265     int32_t *dst_int32_t;
266
267     sample_size = av_get_bits_per_sample(avctx->codec_id)/8;
268
269     /* av_get_bits_per_sample returns 0 for CODEC_ID_PCM_DVD */
270     samples_per_block = 1;
271     if (CODEC_ID_PCM_DVD == avctx->codec_id) {
272         if (avctx->bits_per_coded_sample != 20 &&
273             avctx->bits_per_coded_sample != 24) {
274             av_log(avctx, AV_LOG_ERROR,
275                    "PCM DVD unsupported sample depth %i\n",
276                    avctx->bits_per_coded_sample);
277             return AVERROR(EINVAL);
278         }
279         /* 2 samples are interleaved per block in PCM_DVD */
280         samples_per_block = 2;
281         sample_size = avctx->bits_per_coded_sample * 2 / 8;
282     } else if (avctx->codec_id == CODEC_ID_PCM_LXF) {
283         /* we process 40-bit blocks per channel for LXF */
284         samples_per_block = 2;
285         sample_size = 5;
286     }
287
288     if (sample_size == 0) {
289         av_log(avctx, AV_LOG_ERROR, "Invalid sample_size\n");
290         return AVERROR(EINVAL);
291     }
292
293     n = avctx->channels * sample_size;
294
295     if(n && buf_size % n){
296         if (buf_size < n) {
297             av_log(avctx, AV_LOG_ERROR, "invalid PCM packet\n");
298             return -1;
299         }else
300             buf_size -= buf_size % n;
301     }
302
303     n = buf_size/sample_size;
304
305     /* get output buffer */
306     s->frame.nb_samples = n * samples_per_block / avctx->channels;
307     if ((ret = avctx->get_buffer(avctx, &s->frame)) < 0) {
308         av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
309         return ret;
310     }
311     samples = s->frame.data[0];
312
313     switch(avctx->codec->id) {
314     case CODEC_ID_PCM_U32LE:
315         DECODE(32, le32, src, samples, n, 0, 0x80000000)
316         break;
317     case CODEC_ID_PCM_U32BE:
318         DECODE(32, be32, src, samples, n, 0, 0x80000000)
319         break;
320     case CODEC_ID_PCM_S24LE:
321         DECODE(32, le24, src, samples, n, 8, 0)
322         break;
323     case CODEC_ID_PCM_S24BE:
324         DECODE(32, be24, src, samples, n, 8, 0)
325         break;
326     case CODEC_ID_PCM_U24LE:
327         DECODE(32, le24, src, samples, n, 8, 0x800000)
328         break;
329     case CODEC_ID_PCM_U24BE:
330         DECODE(32, be24, src, samples, n, 8, 0x800000)
331         break;
332     case CODEC_ID_PCM_S24DAUD:
333         for(;n>0;n--) {
334           uint32_t v = bytestream_get_be24(&src);
335           v >>= 4; // sync flags are here
336           AV_WN16A(samples, av_reverse[(v >> 8) & 0xff] +
337                            (av_reverse[v & 0xff] << 8));
338           samples += 2;
339         }
340         break;
341     case CODEC_ID_PCM_S16LE_PLANAR:
342     {
343         const uint8_t *src2[MAX_CHANNELS];
344         n /= avctx->channels;
345         for(c=0;c<avctx->channels;c++)
346             src2[c] = &src[c*n*2];
347         for(;n>0;n--)
348             for(c=0;c<avctx->channels;c++) {
349                 AV_WN16A(samples, bytestream_get_le16(&src2[c]));
350                 samples += 2;
351             }
352         break;
353     }
354     case CODEC_ID_PCM_U16LE:
355         DECODE(16, le16, src, samples, n, 0, 0x8000)
356         break;
357     case CODEC_ID_PCM_U16BE:
358         DECODE(16, be16, src, samples, n, 0, 0x8000)
359         break;
360     case CODEC_ID_PCM_S8:
361         for(;n>0;n--) {
362             *samples++ = *src++ + 128;
363         }
364         break;
365 #if HAVE_BIGENDIAN
366     case CODEC_ID_PCM_F64LE:
367         DECODE(64, le64, src, samples, n, 0, 0)
368         break;
369     case CODEC_ID_PCM_S32LE:
370     case CODEC_ID_PCM_F32LE:
371         DECODE(32, le32, src, samples, n, 0, 0)
372         break;
373     case CODEC_ID_PCM_S16LE:
374         DECODE(16, le16, src, samples, n, 0, 0)
375         break;
376     case CODEC_ID_PCM_F64BE:
377     case CODEC_ID_PCM_F32BE:
378     case CODEC_ID_PCM_S32BE:
379     case CODEC_ID_PCM_S16BE:
380 #else
381     case CODEC_ID_PCM_F64BE:
382         DECODE(64, be64, src, samples, n, 0, 0)
383         break;
384     case CODEC_ID_PCM_F32BE:
385     case CODEC_ID_PCM_S32BE:
386         DECODE(32, be32, src, samples, n, 0, 0)
387         break;
388     case CODEC_ID_PCM_S16BE:
389         DECODE(16, be16, src, samples, n, 0, 0)
390         break;
391     case CODEC_ID_PCM_F64LE:
392     case CODEC_ID_PCM_F32LE:
393     case CODEC_ID_PCM_S32LE:
394     case CODEC_ID_PCM_S16LE:
395 #endif /* HAVE_BIGENDIAN */
396     case CODEC_ID_PCM_U8:
397         memcpy(samples, src, n*sample_size);
398         break;
399     case CODEC_ID_PCM_ZORK:
400         for (; n > 0; n--) {
401             int v = *src++;
402             if (v < 128)
403                 v = 128 - v;
404             *samples++ = v;
405         }
406         break;
407     case CODEC_ID_PCM_ALAW:
408     case CODEC_ID_PCM_MULAW:
409         for(;n>0;n--) {
410             AV_WN16A(samples, s->table[*src++]);
411             samples += 2;
412         }
413         break;
414     case CODEC_ID_PCM_DVD:
415     {
416         const uint8_t *src8;
417         dst_int32_t = (int32_t *)s->frame.data[0];
418         n /= avctx->channels;
419         switch (avctx->bits_per_coded_sample) {
420         case 20:
421             while (n--) {
422                 c = avctx->channels;
423                 src8 = src + 4*c;
424                 while (c--) {
425                     *dst_int32_t++ = (bytestream_get_be16(&src) << 16) + ((*src8   &0xf0) << 8);
426                     *dst_int32_t++ = (bytestream_get_be16(&src) << 16) + ((*src8++ &0x0f) << 12);
427                 }
428                 src = src8;
429             }
430             break;
431         case 24:
432             while (n--) {
433                 c = avctx->channels;
434                 src8 = src + 4*c;
435                 while (c--) {
436                     *dst_int32_t++ = (bytestream_get_be16(&src) << 16) + ((*src8++) << 8);
437                     *dst_int32_t++ = (bytestream_get_be16(&src) << 16) + ((*src8++) << 8);
438                 }
439                 src = src8;
440             }
441             break;
442         }
443         break;
444     }
445     case CODEC_ID_PCM_LXF:
446     {
447         int i;
448         const uint8_t *src8;
449         dst_int32_t = (int32_t *)s->frame.data[0];
450         n /= avctx->channels;
451         //unpack and de-planerize
452         for (i = 0; i < n; i++) {
453             for (c = 0, src8 = src + i*5; c < avctx->channels; c++, src8 += n*5) {
454                 //extract low 20 bits and expand to 32 bits
455                 *dst_int32_t++ = (src8[2] << 28) | (src8[1] << 20) | (src8[0] << 12) |
456                                  ((src8[2] & 0xF) << 8) | src8[1];
457             }
458
459             for (c = 0, src8 = src + i*5; c < avctx->channels; c++, src8 += n*5) {
460                 //extract high 20 bits and expand to 32 bits
461                 *dst_int32_t++ = (src8[4] << 24) | (src8[3] << 16) |
462                                  ((src8[2] & 0xF0) << 8) | (src8[4] << 4) | (src8[3] >> 4);
463             }
464         }
465         break;
466     }
467     default:
468         return -1;
469     }
470
471     *got_frame_ptr   = 1;
472     *(AVFrame *)data = s->frame;
473
474     return buf_size;
475 }
476
477 #if CONFIG_ENCODERS
478 #define PCM_ENCODER(id_,sample_fmt_,name_,long_name_) \
479 AVCodec ff_ ## name_ ## _encoder = {            \
480     .name        = #name_,                      \
481     .type        = AVMEDIA_TYPE_AUDIO,          \
482     .id          = id_,                         \
483     .init        = pcm_encode_init,             \
484     .encode2     = pcm_encode_frame,            \
485     .close       = pcm_encode_close,            \
486     .capabilities = CODEC_CAP_VARIABLE_FRAME_SIZE, \
487     .sample_fmts = (const enum AVSampleFormat[]){sample_fmt_,AV_SAMPLE_FMT_NONE}, \
488     .long_name = NULL_IF_CONFIG_SMALL(long_name_), \
489 }
490 #else
491 #define PCM_ENCODER(id,sample_fmt_,name,long_name_)
492 #endif
493
494 #if CONFIG_DECODERS
495 #define PCM_DECODER(id_,sample_fmt_,name_,long_name_)         \
496 AVCodec ff_ ## name_ ## _decoder = {            \
497     .name           = #name_,                   \
498     .type           = AVMEDIA_TYPE_AUDIO,       \
499     .id             = id_,                      \
500     .priv_data_size = sizeof(PCMDecode),        \
501     .init           = pcm_decode_init,          \
502     .decode         = pcm_decode_frame,         \
503     .capabilities   = CODEC_CAP_DR1,            \
504     .sample_fmts = (const enum AVSampleFormat[]){sample_fmt_,AV_SAMPLE_FMT_NONE}, \
505     .long_name = NULL_IF_CONFIG_SMALL(long_name_), \
506 }
507 #else
508 #define PCM_DECODER(id,sample_fmt_,name,long_name_)
509 #endif
510
511 #define PCM_CODEC(id, sample_fmt_, name, long_name_)         \
512     PCM_ENCODER(id,sample_fmt_,name,long_name_); PCM_DECODER(id,sample_fmt_,name,long_name_)
513
514 /* Note: Do not forget to add new entries to the Makefile as well. */
515 PCM_CODEC  (CODEC_ID_PCM_ALAW,  AV_SAMPLE_FMT_S16, pcm_alaw, "PCM A-law / G.711 A-law");
516 PCM_DECODER(CODEC_ID_PCM_DVD,   AV_SAMPLE_FMT_S32, pcm_dvd, "PCM signed 20|24-bit big-endian");
517 PCM_CODEC  (CODEC_ID_PCM_F32BE, AV_SAMPLE_FMT_FLT, pcm_f32be, "PCM 32-bit floating point big-endian");
518 PCM_CODEC  (CODEC_ID_PCM_F32LE, AV_SAMPLE_FMT_FLT, pcm_f32le, "PCM 32-bit floating point little-endian");
519 PCM_CODEC  (CODEC_ID_PCM_F64BE, AV_SAMPLE_FMT_DBL, pcm_f64be, "PCM 64-bit floating point big-endian");
520 PCM_CODEC  (CODEC_ID_PCM_F64LE, AV_SAMPLE_FMT_DBL, pcm_f64le, "PCM 64-bit floating point little-endian");
521 PCM_DECODER(CODEC_ID_PCM_LXF,   AV_SAMPLE_FMT_S32, pcm_lxf, "PCM signed 20-bit little-endian planar");
522 PCM_CODEC  (CODEC_ID_PCM_MULAW, AV_SAMPLE_FMT_S16, pcm_mulaw, "PCM mu-law / G.711 mu-law");
523 PCM_CODEC  (CODEC_ID_PCM_S8,    AV_SAMPLE_FMT_U8,  pcm_s8, "PCM signed 8-bit");
524 PCM_CODEC  (CODEC_ID_PCM_S16BE, AV_SAMPLE_FMT_S16, pcm_s16be, "PCM signed 16-bit big-endian");
525 PCM_CODEC  (CODEC_ID_PCM_S16LE, AV_SAMPLE_FMT_S16, pcm_s16le, "PCM signed 16-bit little-endian");
526 PCM_DECODER(CODEC_ID_PCM_S16LE_PLANAR, AV_SAMPLE_FMT_S16, pcm_s16le_planar, "PCM 16-bit little-endian planar");
527 PCM_CODEC  (CODEC_ID_PCM_S24BE, AV_SAMPLE_FMT_S32, pcm_s24be, "PCM signed 24-bit big-endian");
528 PCM_CODEC  (CODEC_ID_PCM_S24DAUD, AV_SAMPLE_FMT_S16,  pcm_s24daud, "PCM D-Cinema audio signed 24-bit");
529 PCM_CODEC  (CODEC_ID_PCM_S24LE, AV_SAMPLE_FMT_S32, pcm_s24le, "PCM signed 24-bit little-endian");
530 PCM_CODEC  (CODEC_ID_PCM_S32BE, AV_SAMPLE_FMT_S32, pcm_s32be, "PCM signed 32-bit big-endian");
531 PCM_CODEC  (CODEC_ID_PCM_S32LE, AV_SAMPLE_FMT_S32, pcm_s32le, "PCM signed 32-bit little-endian");
532 PCM_CODEC  (CODEC_ID_PCM_U8,    AV_SAMPLE_FMT_U8,  pcm_u8, "PCM unsigned 8-bit");
533 PCM_CODEC  (CODEC_ID_PCM_U16BE, AV_SAMPLE_FMT_S16, pcm_u16be, "PCM unsigned 16-bit big-endian");
534 PCM_CODEC  (CODEC_ID_PCM_U16LE, AV_SAMPLE_FMT_S16, pcm_u16le, "PCM unsigned 16-bit little-endian");
535 PCM_CODEC  (CODEC_ID_PCM_U24BE, AV_SAMPLE_FMT_S32, pcm_u24be, "PCM unsigned 24-bit big-endian");
536 PCM_CODEC  (CODEC_ID_PCM_U24LE, AV_SAMPLE_FMT_S32, pcm_u24le, "PCM unsigned 24-bit little-endian");
537 PCM_CODEC  (CODEC_ID_PCM_U32BE, AV_SAMPLE_FMT_S32, pcm_u32be, "PCM unsigned 32-bit big-endian");
538 PCM_CODEC  (CODEC_ID_PCM_U32LE, AV_SAMPLE_FMT_S32, pcm_u32le, "PCM unsigned 32-bit little-endian");
539 PCM_DECODER(CODEC_ID_PCM_ZORK,  AV_SAMPLE_FMT_U8,  pcm_zork,  "PCM Zork");