libavutil/samplefmt.c
d63e456a
 /*
  * This file is part of FFmpeg.
  *
  * FFmpeg is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
  * version 2.1 of the License, or (at your option) any later version.
  *
  * FFmpeg is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
  * License along with FFmpeg; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
1d9c2dc8
 #include "common.h"
d63e456a
 #include "samplefmt.h"
 
7ffe76e5
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 
d63e456a
 typedef struct SampleFmtInfo {
208bcc6b
     char name[8];
d63e456a
     int bits;
8889cc4f
     int planar;
573ffbb3
     enum AVSampleFormat altform; ///< planar<->packed alternative form
d63e456a
 } SampleFmtInfo;
 
 /** this table gives more information about formats */
 static const SampleFmtInfo sample_fmt_info[AV_SAMPLE_FMT_NB] = {
573ffbb3
     [AV_SAMPLE_FMT_U8]   = { .name =   "u8", .bits =  8, .planar = 0, .altform = AV_SAMPLE_FMT_U8P  },
     [AV_SAMPLE_FMT_S16]  = { .name =  "s16", .bits = 16, .planar = 0, .altform = AV_SAMPLE_FMT_S16P },
     [AV_SAMPLE_FMT_S32]  = { .name =  "s32", .bits = 32, .planar = 0, .altform = AV_SAMPLE_FMT_S32P },
9876d8fc
     [AV_SAMPLE_FMT_S64]  = { .name =  "s64", .bits = 64, .planar = 0, .altform = AV_SAMPLE_FMT_S64P },
573ffbb3
     [AV_SAMPLE_FMT_FLT]  = { .name =  "flt", .bits = 32, .planar = 0, .altform = AV_SAMPLE_FMT_FLTP },
     [AV_SAMPLE_FMT_DBL]  = { .name =  "dbl", .bits = 64, .planar = 0, .altform = AV_SAMPLE_FMT_DBLP },
     [AV_SAMPLE_FMT_U8P]  = { .name =  "u8p", .bits =  8, .planar = 1, .altform = AV_SAMPLE_FMT_U8   },
     [AV_SAMPLE_FMT_S16P] = { .name = "s16p", .bits = 16, .planar = 1, .altform = AV_SAMPLE_FMT_S16  },
     [AV_SAMPLE_FMT_S32P] = { .name = "s32p", .bits = 32, .planar = 1, .altform = AV_SAMPLE_FMT_S32  },
9876d8fc
     [AV_SAMPLE_FMT_S64P] = { .name = "s64p", .bits = 64, .planar = 1, .altform = AV_SAMPLE_FMT_S64  },
573ffbb3
     [AV_SAMPLE_FMT_FLTP] = { .name = "fltp", .bits = 32, .planar = 1, .altform = AV_SAMPLE_FMT_FLT  },
     [AV_SAMPLE_FMT_DBLP] = { .name = "dblp", .bits = 64, .planar = 1, .altform = AV_SAMPLE_FMT_DBL  },
d63e456a
 };
 
 const char *av_get_sample_fmt_name(enum AVSampleFormat sample_fmt)
 {
     if (sample_fmt < 0 || sample_fmt >= AV_SAMPLE_FMT_NB)
         return NULL;
     return sample_fmt_info[sample_fmt].name;
 }
 
 enum AVSampleFormat av_get_sample_fmt(const char *name)
 {
     int i;
 
     for (i = 0; i < AV_SAMPLE_FMT_NB; i++)
         if (!strcmp(sample_fmt_info[i].name, name))
             return i;
     return AV_SAMPLE_FMT_NONE;
 }
 
573ffbb3
 enum AVSampleFormat av_get_alt_sample_fmt(enum AVSampleFormat sample_fmt, int planar)
 {
     if (sample_fmt < 0 || sample_fmt >= AV_SAMPLE_FMT_NB)
         return AV_SAMPLE_FMT_NONE;
     if (sample_fmt_info[sample_fmt].planar == planar)
         return sample_fmt;
     return sample_fmt_info[sample_fmt].altform;
 }
 
4d693b02
 enum AVSampleFormat av_get_packed_sample_fmt(enum AVSampleFormat sample_fmt)
 {
     if (sample_fmt < 0 || sample_fmt >= AV_SAMPLE_FMT_NB)
         return AV_SAMPLE_FMT_NONE;
     if (sample_fmt_info[sample_fmt].planar)
         return sample_fmt_info[sample_fmt].altform;
     return sample_fmt;
 }
 
 enum AVSampleFormat av_get_planar_sample_fmt(enum AVSampleFormat sample_fmt)
 {
     if (sample_fmt < 0 || sample_fmt >= AV_SAMPLE_FMT_NB)
         return AV_SAMPLE_FMT_NONE;
     if (sample_fmt_info[sample_fmt].planar)
         return sample_fmt;
     return sample_fmt_info[sample_fmt].altform;
 }
 
d63e456a
 char *av_get_sample_fmt_string (char *buf, int buf_size, enum AVSampleFormat sample_fmt)
 {
     /* print header */
     if (sample_fmt < 0)
         snprintf(buf, buf_size, "name  " " depth");
     else if (sample_fmt < AV_SAMPLE_FMT_NB) {
         SampleFmtInfo info = sample_fmt_info[sample_fmt];
         snprintf (buf, buf_size, "%-6s" "   %2d ", info.name, info.bits);
     }
 
     return buf;
 }
6f84cd12
 
a6703faa
 int av_get_bytes_per_sample(enum AVSampleFormat sample_fmt)
 {
      return sample_fmt < 0 || sample_fmt >= AV_SAMPLE_FMT_NB ?
         0 : sample_fmt_info[sample_fmt].bits >> 3;
 }
 
8889cc4f
 int av_sample_fmt_is_planar(enum AVSampleFormat sample_fmt)
 {
      if (sample_fmt < 0 || sample_fmt >= AV_SAMPLE_FMT_NB)
          return 0;
      return sample_fmt_info[sample_fmt].planar;
 }
bbb46f3e
 
 int av_samples_get_buffer_size(int *linesize, int nb_channels, int nb_samples,
                                enum AVSampleFormat sample_fmt, int align)
e98b8e2f
 {
bbb46f3e
     int line_size;
5fba761f
     int sample_size = av_get_bytes_per_sample(sample_fmt);
bbb46f3e
     int planar      = av_sample_fmt_is_planar(sample_fmt);
e98b8e2f
 
bbb46f3e
     /* validate parameter ranges */
     if (!sample_size || nb_samples <= 0 || nb_channels <= 0)
e98b8e2f
         return AVERROR(EINVAL);
 
0109a09d
     /* auto-select alignment if not specified */
83b26046
     if (!align) {
0e830094
         if (nb_samples > INT_MAX - 31)
             return AVERROR(EINVAL);
83b26046
         align = 1;
         nb_samples = FFALIGN(nb_samples, 32);
     }
0109a09d
 
bbb46f3e
     /* check for integer overflow */
     if (nb_channels > INT_MAX / align ||
         (int64_t)nb_channels * nb_samples > (INT_MAX - (align * nb_channels)) / sample_size)
         return AVERROR(EINVAL);
 
     line_size = planar ? FFALIGN(nb_samples * sample_size,               align) :
                          FFALIGN(nb_samples * sample_size * nb_channels, align);
     if (linesize)
         *linesize = line_size;
e98b8e2f
 
bbb46f3e
     return planar ? line_size * nb_channels : line_size;
e98b8e2f
 }
 
bbb46f3e
 int av_samples_fill_arrays(uint8_t **audio_data, int *linesize,
ce473de9
                            const uint8_t *buf, int nb_channels, int nb_samples,
bbb46f3e
                            enum AVSampleFormat sample_fmt, int align)
 {
18ed3788
     int ch, planar, buf_size, line_size;
bbb46f3e
 
     planar   = av_sample_fmt_is_planar(sample_fmt);
18ed3788
     buf_size = av_samples_get_buffer_size(&line_size, nb_channels, nb_samples,
bbb46f3e
                                           sample_fmt, align);
     if (buf_size < 0)
         return buf_size;
 
753a1b09
     audio_data[0] = (uint8_t *)buf;
bbb46f3e
     for (ch = 1; planar && ch < nb_channels; ch++)
18ed3788
         audio_data[ch] = audio_data[ch-1] + line_size;
 
     if (linesize)
         *linesize = line_size;
bbb46f3e
 
b473c993
     return buf_size;
bbb46f3e
 }
 
 int av_samples_alloc(uint8_t **audio_data, int *linesize, int nb_channels,
                      int nb_samples, enum AVSampleFormat sample_fmt, int align)
e98b8e2f
 {
     uint8_t *buf;
bbb46f3e
     int size = av_samples_get_buffer_size(NULL, nb_channels, nb_samples,
                                           sample_fmt, align);
     if (size < 0)
         return size;
e98b8e2f
 
cd15b7c0
     buf = av_malloc(size);
e98b8e2f
     if (!buf)
         return AVERROR(ENOMEM);
 
bbb46f3e
     size = av_samples_fill_arrays(audio_data, linesize, buf, nb_channels,
                                   nb_samples, sample_fmt, align);
     if (size < 0) {
         av_free(buf);
         return size;
     }
cd15b7c0
 
     av_samples_set_silence(audio_data, 0, nb_samples, nb_channels, sample_fmt);
 
b473c993
     return size;
e98b8e2f
 }
142e740d
 
5c73645d
 int av_samples_alloc_array_and_samples(uint8_t ***audio_data, int *linesize, int nb_channels,
                                        int nb_samples, enum AVSampleFormat sample_fmt, int align)
 {
     int ret, nb_planes = av_sample_fmt_is_planar(sample_fmt) ? nb_channels : 1;
 
63090842
     *audio_data = av_calloc(nb_planes, sizeof(**audio_data));
5c73645d
     if (!*audio_data)
         return AVERROR(ENOMEM);
     ret = av_samples_alloc(*audio_data, linesize, nb_channels,
                            nb_samples, sample_fmt, align);
     if (ret < 0)
         av_freep(audio_data);
     return ret;
 }
 
142e740d
 int av_samples_copy(uint8_t **dst, uint8_t * const *src, int dst_offset,
                     int src_offset, int nb_samples, int nb_channels,
                     enum AVSampleFormat sample_fmt)
 {
     int planar      = av_sample_fmt_is_planar(sample_fmt);
     int planes      = planar ? nb_channels : 1;
     int block_align = av_get_bytes_per_sample(sample_fmt) * (planar ? 1 : nb_channels);
     int data_size   = nb_samples * block_align;
     int i;
 
     dst_offset *= block_align;
     src_offset *= block_align;
 
375c0f74
     if((dst[0] < src[0] ? src[0] - dst[0] : dst[0] - src[0]) >= data_size) {
         for (i = 0; i < planes; i++)
             memcpy(dst[i] + dst_offset, src[i] + src_offset, data_size);
     } else {
         for (i = 0; i < planes; i++)
             memmove(dst[i] + dst_offset, src[i] + src_offset, data_size);
     }
142e740d
 
     return 0;
 }
6d7f6177
 
 int av_samples_set_silence(uint8_t **audio_data, int offset, int nb_samples,
                            int nb_channels, enum AVSampleFormat sample_fmt)
 {
     int planar      = av_sample_fmt_is_planar(sample_fmt);
     int planes      = planar ? nb_channels : 1;
     int block_align = av_get_bytes_per_sample(sample_fmt) * (planar ? 1 : nb_channels);
     int data_size   = nb_samples * block_align;
     int fill_char   = (sample_fmt == AV_SAMPLE_FMT_U8 ||
                      sample_fmt == AV_SAMPLE_FMT_U8P) ? 0x80 : 0x00;
     int i;
 
     offset *= block_align;
 
     for (i = 0; i < planes; i++)
         memset(audio_data[i] + offset, fill_char, data_size);
 
     return 0;
 }