FFmpeg
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
pcm.c
Go to the documentation of this file.
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 "libavutil/attributes.h"
28 #include "avcodec.h"
29 #include "bytestream.h"
30 #include "internal.h"
31 #include "mathops.h"
32 #include "pcm_tablegen.h"
33 
35 {
36  avctx->frame_size = 0;
37  switch (avctx->codec->id) {
40  break;
43  break;
44  default:
45  break;
46  }
47 
49  avctx->block_align = avctx->channels * avctx->bits_per_coded_sample / 8;
50  avctx->bit_rate = avctx->block_align * avctx->sample_rate * 8;
52  if (!avctx->coded_frame)
53  return AVERROR(ENOMEM);
54 
55  return 0;
56 }
57 
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 #define ENCODE_PLANAR(type, endian, dst, n, shift, offset) \
83  n /= avctx->channels; \
84  for (c = 0; c < avctx->channels; c++) { \
85  int i; \
86  samples_ ## type = (const type *) frame->extended_data[c]; \
87  for (i = n; i > 0; i--) { \
88  register type v = (*samples_ ## type++ >> shift) + offset; \
89  bytestream_put_ ## endian(&dst, v); \
90  } \
91  }
92 
93 static int pcm_encode_frame(AVCodecContext *avctx, AVPacket *avpkt,
94  const AVFrame *frame, int *got_packet_ptr)
95 {
96  int n, c, sample_size, v, ret;
97  const short *samples;
98  unsigned char *dst;
99  const uint8_t *samples_uint8_t;
100  const int16_t *samples_int16_t;
101  const int32_t *samples_int32_t;
102  const int64_t *samples_int64_t;
103  const uint16_t *samples_uint16_t;
104  const uint32_t *samples_uint32_t;
105 
106  sample_size = av_get_bits_per_sample(avctx->codec->id) / 8;
107  n = frame->nb_samples * avctx->channels;
108  samples = (const short *)frame->data[0];
109 
110  if ((ret = ff_alloc_packet2(avctx, avpkt, n * sample_size)))
111  return ret;
112  dst = avpkt->data;
113 
114  switch (avctx->codec->id) {
116  ENCODE(uint32_t, le32, samples, dst, n, 0, 0x80000000)
117  break;
119  ENCODE(uint32_t, be32, samples, dst, n, 0, 0x80000000)
120  break;
122  ENCODE(int32_t, le24, samples, dst, n, 8, 0)
123  break;
125  ENCODE_PLANAR(int32_t, le24, dst, n, 8, 0)
126  break;
128  ENCODE(int32_t, be24, samples, dst, n, 8, 0)
129  break;
131  ENCODE(uint32_t, le24, samples, dst, n, 8, 0x800000)
132  break;
134  ENCODE(uint32_t, be24, samples, dst, n, 8, 0x800000)
135  break;
137  for (; n > 0; n--) {
138  uint32_t tmp = ff_reverse[(*samples >> 8) & 0xff] +
139  (ff_reverse[*samples & 0xff] << 8);
140  tmp <<= 4; // sync flags would go here
141  bytestream_put_be24(&dst, tmp);
142  samples++;
143  }
144  break;
146  ENCODE(uint16_t, le16, samples, dst, n, 0, 0x8000)
147  break;
149  ENCODE(uint16_t, be16, samples, dst, n, 0, 0x8000)
150  break;
151  case AV_CODEC_ID_PCM_S8:
152  ENCODE(uint8_t, byte, samples, dst, n, 0, -128)
153  break;
155  ENCODE_PLANAR(uint8_t, byte, dst, n, 0, -128)
156  break;
157 #if HAVE_BIGENDIAN
159  ENCODE(int64_t, le64, samples, dst, n, 0, 0)
160  break;
163  ENCODE(int32_t, le32, samples, dst, n, 0, 0)
164  break;
166  ENCODE_PLANAR(int32_t, le32, dst, n, 0, 0)
167  break;
169  ENCODE(int16_t, le16, samples, dst, n, 0, 0)
170  break;
172  ENCODE_PLANAR(int16_t, le16, dst, n, 0, 0)
173  break;
178 #else
180  ENCODE(int64_t, be64, samples, dst, n, 0, 0)
181  break;
184  ENCODE(int32_t, be32, samples, dst, n, 0, 0)
185  break;
187  ENCODE(int16_t, be16, samples, dst, n, 0, 0)
188  break;
190  ENCODE_PLANAR(int16_t, be16, dst, n, 0, 0)
191  break;
196 #endif /* HAVE_BIGENDIAN */
197  case AV_CODEC_ID_PCM_U8:
198  memcpy(dst, samples, n * sample_size);
199  break;
200 #if HAVE_BIGENDIAN
202 #else
205 #endif /* HAVE_BIGENDIAN */
206  n /= avctx->channels;
207  for (c = 0; c < avctx->channels; c++) {
208  const uint8_t *src = frame->extended_data[c];
209  bytestream_put_buffer(&dst, src, n * sample_size);
210  }
211  break;
213  for (; n > 0; n--) {
214  v = *samples++;
215  *dst++ = linear_to_alaw[(v + 32768) >> 2];
216  }
217  break;
219  for (; n > 0; n--) {
220  v = *samples++;
221  *dst++ = linear_to_ulaw[(v + 32768) >> 2];
222  }
223  break;
224  default:
225  return -1;
226  }
227 
228  *got_packet_ptr = 1;
229  return 0;
230 }
231 
232 typedef struct PCMDecode {
234  short table[256];
235 } PCMDecode;
236 
238 {
239  PCMDecode *s = avctx->priv_data;
240  int i;
241 
242  if (avctx->channels <= 0) {
243  av_log(avctx, AV_LOG_ERROR, "PCM channels out of bounds\n");
244  return AVERROR(EINVAL);
245  }
246 
247  switch (avctx->codec_id) {
249  for (i = 0; i < 256; i++)
250  s->table[i] = alaw2linear(i);
251  break;
253  for (i = 0; i < 256; i++)
254  s->table[i] = ulaw2linear(i);
255  break;
256  default:
257  break;
258  }
259 
260  avctx->sample_fmt = avctx->codec->sample_fmts[0];
261 
262  if (avctx->sample_fmt == AV_SAMPLE_FMT_S32)
264 
266  avctx->coded_frame = &s->frame;
267 
268  return 0;
269 }
270 
271 /**
272  * Read PCM samples macro
273  * @param size Data size of native machine format
274  * @param endian bytestream_get_xxx() endian suffix
275  * @param src Source pointer (variable name)
276  * @param dst Destination pointer (variable name)
277  * @param n Total number of samples (variable name)
278  * @param shift Bitshift (bits)
279  * @param offset Sample value offset
280  */
281 #define DECODE(size, endian, src, dst, n, shift, offset) \
282  for (; n > 0; n--) { \
283  uint ## size ## _t v = bytestream_get_ ## endian(&src); \
284  AV_WN ## size ## A(dst, (v - offset) << shift); \
285  dst += size / 8; \
286  }
287 
288 #define DECODE_PLANAR(size, endian, src, dst, n, shift, offset) \
289  n /= avctx->channels; \
290  for (c = 0; c < avctx->channels; c++) { \
291  int i; \
292  dst = s->frame.extended_data[c]; \
293  for (i = n; i > 0; i--) { \
294  uint ## size ## _t v = bytestream_get_ ## endian(&src); \
295  AV_WN ## size ## A(dst, (v - offset) << shift); \
296  dst += size / 8; \
297  } \
298  }
299 
300 static int pcm_decode_frame(AVCodecContext *avctx, void *data,
301  int *got_frame_ptr, AVPacket *avpkt)
302 {
303  const uint8_t *src = avpkt->data;
304  int buf_size = avpkt->size;
305  PCMDecode *s = avctx->priv_data;
306  int sample_size, c, n, ret, samples_per_block;
307  uint8_t *samples;
308  int32_t *dst_int32_t;
309 
310  sample_size = av_get_bits_per_sample(avctx->codec_id) / 8;
311 
312  /* av_get_bits_per_sample returns 0 for AV_CODEC_ID_PCM_DVD */
313  samples_per_block = 1;
314  if (AV_CODEC_ID_PCM_DVD == avctx->codec_id) {
315  if (avctx->bits_per_coded_sample != 20 &&
316  avctx->bits_per_coded_sample != 24) {
317  av_log(avctx, AV_LOG_ERROR,
318  "PCM DVD unsupported sample depth %i\n",
319  avctx->bits_per_coded_sample);
320  return AVERROR(EINVAL);
321  }
322  /* 2 samples are interleaved per block in PCM_DVD */
323  samples_per_block = 2;
324  sample_size = avctx->bits_per_coded_sample * 2 / 8;
325  } else if (avctx->codec_id == AV_CODEC_ID_PCM_LXF) {
326  /* we process 40-bit blocks per channel for LXF */
327  samples_per_block = 2;
328  sample_size = 5;
329  }
330 
331  if (sample_size == 0) {
332  av_log(avctx, AV_LOG_ERROR, "Invalid sample_size\n");
333  return AVERROR(EINVAL);
334  }
335 
336  if (avctx->channels == 0) {
337  av_log(avctx, AV_LOG_ERROR, "Invalid number of channels\n");
338  return AVERROR(EINVAL);
339  }
340 
341  if (avctx->codec_id != avctx->codec->id) {
342  av_log(avctx, AV_LOG_ERROR, "codec ids mismatch\n");
343  return AVERROR(EINVAL);
344  }
345 
346  n = avctx->channels * sample_size;
347 
348  if (n && buf_size % n) {
349  if (buf_size < n) {
350  av_log(avctx, AV_LOG_ERROR,
351  "Invalid PCM packet, data has size %d but at least a size of %d was expected\n",
352  buf_size, n);
353  return AVERROR_INVALIDDATA;
354  } else
355  buf_size -= buf_size % n;
356  }
357 
358  n = buf_size / sample_size;
359 
360  /* get output buffer */
361  s->frame.nb_samples = n * samples_per_block / avctx->channels;
362  if ((ret = ff_get_buffer(avctx, &s->frame)) < 0) {
363  av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
364  return ret;
365  }
366  samples = s->frame.data[0];
367 
368  switch (avctx->codec_id) {
370  DECODE(32, le32, src, samples, n, 0, 0x80000000)
371  break;
373  DECODE(32, be32, src, samples, n, 0, 0x80000000)
374  break;
376  DECODE(32, le24, src, samples, n, 8, 0)
377  break;
379  DECODE_PLANAR(32, le24, src, samples, n, 8, 0);
380  break;
382  DECODE(32, be24, src, samples, n, 8, 0)
383  break;
385  DECODE(32, le24, src, samples, n, 8, 0x800000)
386  break;
388  DECODE(32, be24, src, samples, n, 8, 0x800000)
389  break;
391  for (; n > 0; n--) {
392  uint32_t v = bytestream_get_be24(&src);
393  v >>= 4; // sync flags are here
394  AV_WN16A(samples, ff_reverse[(v >> 8) & 0xff] +
395  (ff_reverse[v & 0xff] << 8));
396  samples += 2;
397  }
398  break;
400  DECODE(16, le16, src, samples, n, 0, 0x8000)
401  break;
403  DECODE(16, be16, src, samples, n, 0, 0x8000)
404  break;
405  case AV_CODEC_ID_PCM_S8:
406  for (; n > 0; n--)
407  *samples++ = *src++ + 128;
408  break;
410  n /= avctx->channels;
411  for (c = 0; c < avctx->channels; c++) {
412  int i;
413  samples = s->frame.extended_data[c];
414  for (i = n; i > 0; i--)
415  *samples++ = *src++ + 128;
416  }
417  break;
418 #if HAVE_BIGENDIAN
420  DECODE(64, le64, src, samples, n, 0, 0)
421  break;
424  DECODE(32, le32, src, samples, n, 0, 0)
425  break;
427  DECODE_PLANAR(32, le32, src, samples, n, 0, 0);
428  break;
430  DECODE(16, le16, src, samples, n, 0, 0)
431  break;
433  DECODE_PLANAR(16, le16, src, samples, n, 0, 0);
434  break;
439 #else
441  DECODE(64, be64, src, samples, n, 0, 0)
442  break;
445  DECODE(32, be32, src, samples, n, 0, 0)
446  break;
448  DECODE(16, be16, src, samples, n, 0, 0)
449  break;
451  DECODE_PLANAR(16, be16, src, samples, n, 0, 0);
452  break;
457 #endif /* HAVE_BIGENDIAN */
458  case AV_CODEC_ID_PCM_U8:
459  memcpy(samples, src, n * sample_size);
460  break;
461 #if HAVE_BIGENDIAN
463 #else
466 #endif /* HAVE_BIGENDIAN */
467  n /= avctx->channels;
468  for (c = 0; c < avctx->channels; c++) {
469  samples = s->frame.extended_data[c];
470  bytestream_get_buffer(&src, samples, n * sample_size);
471  }
472  break;
474  for (; n > 0; n--) {
475  int v = *src++;
476  if (v < 128)
477  v = 128 - v;
478  *samples++ = v;
479  }
480  break;
483  for (; n > 0; n--) {
484  AV_WN16A(samples, s->table[*src++]);
485  samples += 2;
486  }
487  break;
488  case AV_CODEC_ID_PCM_DVD:
489  {
490  const uint8_t *src8;
491  dst_int32_t = (int32_t *)s->frame.data[0];
492  n /= avctx->channels;
493  switch (avctx->bits_per_coded_sample) {
494  case 20:
495  while (n--) {
496  c = avctx->channels;
497  src8 = src + 4 * c;
498  while (c--) {
499  *dst_int32_t++ = (bytestream_get_be16(&src) << 16) + ((*src8 & 0xf0) << 8);
500  *dst_int32_t++ = (bytestream_get_be16(&src) << 16) + ((*src8++ & 0x0f) << 12);
501  }
502  src = src8;
503  }
504  break;
505  case 24:
506  while (n--) {
507  c = avctx->channels;
508  src8 = src + 4 * c;
509  while (c--) {
510  *dst_int32_t++ = (bytestream_get_be16(&src) << 16) + ((*src8++) << 8);
511  *dst_int32_t++ = (bytestream_get_be16(&src) << 16) + ((*src8++) << 8);
512  }
513  src = src8;
514  }
515  break;
516  }
517  break;
518  }
519  case AV_CODEC_ID_PCM_LXF:
520  {
521  int i;
522  n /= avctx->channels;
523  for (c = 0; c < avctx->channels; c++) {
524  dst_int32_t = (int32_t *)s->frame.extended_data[c];
525  for (i = 0; i < n; i++) {
526  // extract low 20 bits and expand to 32 bits
527  *dst_int32_t++ = (src[2] << 28) |
528  (src[1] << 20) |
529  (src[0] << 12) |
530  ((src[2] & 0x0F) << 8) |
531  src[1];
532  // extract high 20 bits and expand to 32 bits
533  *dst_int32_t++ = (src[4] << 24) |
534  (src[3] << 16) |
535  ((src[2] & 0xF0) << 8) |
536  (src[4] << 4) |
537  (src[3] >> 4);
538  src += 5;
539  }
540  }
541  break;
542  }
543  default:
544  return -1;
545  }
546 
547  *got_frame_ptr = 1;
548  *(AVFrame *)data = s->frame;
549 
550  return buf_size;
551 }
552 
553 #define PCM_ENCODER_0(id_, sample_fmt_, name_, long_name_)
554 #define PCM_ENCODER_1(id_, sample_fmt_, name_, long_name_) \
555 AVCodec ff_ ## name_ ## _encoder = { \
556  .name = #name_, \
557  .type = AVMEDIA_TYPE_AUDIO, \
558  .id = AV_CODEC_ID_ ## id_, \
559  .init = pcm_encode_init, \
560  .encode2 = pcm_encode_frame, \
561  .close = pcm_encode_close, \
562  .capabilities = CODEC_CAP_VARIABLE_FRAME_SIZE, \
563  .sample_fmts = (const enum AVSampleFormat[]){ sample_fmt_, \
564  AV_SAMPLE_FMT_NONE }, \
565  .long_name = NULL_IF_CONFIG_SMALL(long_name_), \
566 }
567 
568 #define PCM_ENCODER_2(cf, id, sample_fmt, name, long_name) \
569  PCM_ENCODER_ ## cf(id, sample_fmt, name, long_name)
570 #define PCM_ENCODER_3(cf, id, sample_fmt, name, long_name) \
571  PCM_ENCODER_2(cf, id, sample_fmt, name, long_name)
572 #define PCM_ENCODER(id, sample_fmt, name, long_name) \
573  PCM_ENCODER_3(CONFIG_ ## id ## _ENCODER, id, sample_fmt, name, long_name)
574 
575 #define PCM_DECODER_0(id, sample_fmt, name, long_name)
576 #define PCM_DECODER_1(id_, sample_fmt_, name_, long_name_) \
577 AVCodec ff_ ## name_ ## _decoder = { \
578  .name = #name_, \
579  .type = AVMEDIA_TYPE_AUDIO, \
580  .id = AV_CODEC_ID_ ## id_, \
581  .priv_data_size = sizeof(PCMDecode), \
582  .init = pcm_decode_init, \
583  .decode = pcm_decode_frame, \
584  .capabilities = CODEC_CAP_DR1, \
585  .sample_fmts = (const enum AVSampleFormat[]){ sample_fmt_, \
586  AV_SAMPLE_FMT_NONE }, \
587  .long_name = NULL_IF_CONFIG_SMALL(long_name_), \
588 }
589 
590 #define PCM_DECODER_2(cf, id, sample_fmt, name, long_name) \
591  PCM_DECODER_ ## cf(id, sample_fmt, name, long_name)
592 #define PCM_DECODER_3(cf, id, sample_fmt, name, long_name) \
593  PCM_DECODER_2(cf, id, sample_fmt, name, long_name)
594 #define PCM_DECODER(id, sample_fmt, name, long_name) \
595  PCM_DECODER_3(CONFIG_ ## id ## _DECODER, id, sample_fmt, name, long_name)
596 
597 #define PCM_CODEC(id, sample_fmt_, name, long_name_) \
598  PCM_ENCODER(id, sample_fmt_, name, long_name_); \
599  PCM_DECODER(id, sample_fmt_, name, long_name_)
600 
601 /* Note: Do not forget to add new entries to the Makefile as well. */
602 PCM_CODEC (PCM_ALAW, AV_SAMPLE_FMT_S16, pcm_alaw, "PCM A-law / G.711 A-law");
603 PCM_DECODER(PCM_DVD, AV_SAMPLE_FMT_S32, pcm_dvd, "PCM signed 20|24-bit big-endian");
604 PCM_CODEC (PCM_F32BE, AV_SAMPLE_FMT_FLT, pcm_f32be, "PCM 32-bit floating point big-endian");
605 PCM_CODEC (PCM_F32LE, AV_SAMPLE_FMT_FLT, pcm_f32le, "PCM 32-bit floating point little-endian");
606 PCM_CODEC (PCM_F64BE, AV_SAMPLE_FMT_DBL, pcm_f64be, "PCM 64-bit floating point big-endian");
607 PCM_CODEC (PCM_F64LE, AV_SAMPLE_FMT_DBL, pcm_f64le, "PCM 64-bit floating point little-endian");
608 PCM_DECODER(PCM_LXF, AV_SAMPLE_FMT_S32P,pcm_lxf, "PCM signed 20-bit little-endian planar");
609 PCM_CODEC (PCM_MULAW, AV_SAMPLE_FMT_S16, pcm_mulaw, "PCM mu-law / G.711 mu-law");
610 PCM_CODEC (PCM_S8, AV_SAMPLE_FMT_U8, pcm_s8, "PCM signed 8-bit");
611 PCM_CODEC (PCM_S8_PLANAR, AV_SAMPLE_FMT_U8P, pcm_s8_planar, "PCM signed 8-bit planar");
612 PCM_CODEC (PCM_S16BE, AV_SAMPLE_FMT_S16, pcm_s16be, "PCM signed 16-bit big-endian");
613 PCM_CODEC (PCM_S16BE_PLANAR, AV_SAMPLE_FMT_S16P,pcm_s16be_planar, "PCM signed 16-bit big-endian planar");
614 PCM_CODEC (PCM_S16LE, AV_SAMPLE_FMT_S16, pcm_s16le, "PCM signed 16-bit little-endian");
615 PCM_CODEC (PCM_S16LE_PLANAR, AV_SAMPLE_FMT_S16P,pcm_s16le_planar, "PCM signed 16-bit little-endian planar");
616 PCM_CODEC (PCM_S24BE, AV_SAMPLE_FMT_S32, pcm_s24be, "PCM signed 24-bit big-endian");
617 PCM_CODEC (PCM_S24DAUD, AV_SAMPLE_FMT_S16, pcm_s24daud, "PCM D-Cinema audio signed 24-bit");
618 PCM_CODEC (PCM_S24LE, AV_SAMPLE_FMT_S32, pcm_s24le, "PCM signed 24-bit little-endian");
619 PCM_CODEC (PCM_S24LE_PLANAR, AV_SAMPLE_FMT_S32P,pcm_s24le_planar, "PCM signed 24-bit little-endian planar");
620 PCM_CODEC (PCM_S32BE, AV_SAMPLE_FMT_S32, pcm_s32be, "PCM signed 32-bit big-endian");
621 PCM_CODEC (PCM_S32LE, AV_SAMPLE_FMT_S32, pcm_s32le, "PCM signed 32-bit little-endian");
622 PCM_CODEC (PCM_S32LE_PLANAR, AV_SAMPLE_FMT_S32P,pcm_s32le_planar, "PCM signed 32-bit little-endian planar");
623 PCM_CODEC (PCM_U8, AV_SAMPLE_FMT_U8, pcm_u8, "PCM unsigned 8-bit");
624 PCM_CODEC (PCM_U16BE, AV_SAMPLE_FMT_S16, pcm_u16be, "PCM unsigned 16-bit big-endian");
625 PCM_CODEC (PCM_U16LE, AV_SAMPLE_FMT_S16, pcm_u16le, "PCM unsigned 16-bit little-endian");
626 PCM_CODEC (PCM_U24BE, AV_SAMPLE_FMT_S32, pcm_u24be, "PCM unsigned 24-bit big-endian");
627 PCM_CODEC (PCM_U24LE, AV_SAMPLE_FMT_S32, pcm_u24le, "PCM unsigned 24-bit little-endian");
628 PCM_CODEC (PCM_U32BE, AV_SAMPLE_FMT_S32, pcm_u32be, "PCM unsigned 32-bit big-endian");
629 PCM_CODEC (PCM_U32LE, AV_SAMPLE_FMT_S32, pcm_u32le, "PCM unsigned 32-bit little-endian");
630 PCM_DECODER(PCM_ZORK, AV_SAMPLE_FMT_U8, pcm_zork, "PCM Zork");
631