FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
samplefmt.c
Go to the documentation of this file.
1 /*
2  * This file is part of FFmpeg.
3  *
4  * FFmpeg 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  * FFmpeg 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 FFmpeg; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  */
18 
19 #include "common.h"
20 #include "samplefmt.h"
21 
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25 
26 typedef struct SampleFmtInfo {
27  char name[8];
28  int bits;
29  int planar;
30  enum AVSampleFormat altform; ///< planar<->packed alternative form
32 
33 /** this table gives more information about formats */
35  [AV_SAMPLE_FMT_U8] = { .name = "u8", .bits = 8, .planar = 0, .altform = AV_SAMPLE_FMT_U8P },
36  [AV_SAMPLE_FMT_S16] = { .name = "s16", .bits = 16, .planar = 0, .altform = AV_SAMPLE_FMT_S16P },
37  [AV_SAMPLE_FMT_S32] = { .name = "s32", .bits = 32, .planar = 0, .altform = AV_SAMPLE_FMT_S32P },
38  [AV_SAMPLE_FMT_FLT] = { .name = "flt", .bits = 32, .planar = 0, .altform = AV_SAMPLE_FMT_FLTP },
39  [AV_SAMPLE_FMT_DBL] = { .name = "dbl", .bits = 64, .planar = 0, .altform = AV_SAMPLE_FMT_DBLP },
40  [AV_SAMPLE_FMT_U8P] = { .name = "u8p", .bits = 8, .planar = 1, .altform = AV_SAMPLE_FMT_U8 },
41  [AV_SAMPLE_FMT_S16P] = { .name = "s16p", .bits = 16, .planar = 1, .altform = AV_SAMPLE_FMT_S16 },
42  [AV_SAMPLE_FMT_S32P] = { .name = "s32p", .bits = 32, .planar = 1, .altform = AV_SAMPLE_FMT_S32 },
43  [AV_SAMPLE_FMT_FLTP] = { .name = "fltp", .bits = 32, .planar = 1, .altform = AV_SAMPLE_FMT_FLT },
44  [AV_SAMPLE_FMT_DBLP] = { .name = "dblp", .bits = 64, .planar = 1, .altform = AV_SAMPLE_FMT_DBL },
45 };
46 
47 const char *av_get_sample_fmt_name(enum AVSampleFormat sample_fmt)
48 {
49  if (sample_fmt < 0 || sample_fmt >= AV_SAMPLE_FMT_NB)
50  return NULL;
51  return sample_fmt_info[sample_fmt].name;
52 }
53 
55 {
56  int i;
57 
58  for (i = 0; i < AV_SAMPLE_FMT_NB; i++)
59  if (!strcmp(sample_fmt_info[i].name, name))
60  return i;
61  return AV_SAMPLE_FMT_NONE;
62 }
63 
64 enum AVSampleFormat av_get_alt_sample_fmt(enum AVSampleFormat sample_fmt, int planar)
65 {
66  if (sample_fmt < 0 || sample_fmt >= AV_SAMPLE_FMT_NB)
67  return AV_SAMPLE_FMT_NONE;
68  if (sample_fmt_info[sample_fmt].planar == planar)
69  return sample_fmt;
70  return sample_fmt_info[sample_fmt].altform;
71 }
72 
74 {
75  if (sample_fmt < 0 || sample_fmt >= AV_SAMPLE_FMT_NB)
76  return AV_SAMPLE_FMT_NONE;
77  if (sample_fmt_info[sample_fmt].planar)
78  return sample_fmt_info[sample_fmt].altform;
79  return sample_fmt;
80 }
81 
83 {
84  if (sample_fmt < 0 || sample_fmt >= AV_SAMPLE_FMT_NB)
85  return AV_SAMPLE_FMT_NONE;
86  if (sample_fmt_info[sample_fmt].planar)
87  return sample_fmt;
88  return sample_fmt_info[sample_fmt].altform;
89 }
90 
91 char *av_get_sample_fmt_string (char *buf, int buf_size, enum AVSampleFormat sample_fmt)
92 {
93  /* print header */
94  if (sample_fmt < 0)
95  snprintf(buf, buf_size, "name " " depth");
96  else if (sample_fmt < AV_SAMPLE_FMT_NB) {
97  SampleFmtInfo info = sample_fmt_info[sample_fmt];
98  snprintf (buf, buf_size, "%-6s" " %2d ", info.name, info.bits);
99  }
100 
101  return buf;
102 }
103 
105 {
106  return sample_fmt < 0 || sample_fmt >= AV_SAMPLE_FMT_NB ?
107  0 : sample_fmt_info[sample_fmt].bits >> 3;
108 }
109 
111 {
112  if (sample_fmt < 0 || sample_fmt >= AV_SAMPLE_FMT_NB)
113  return 0;
114  return sample_fmt_info[sample_fmt].planar;
115 }
116 
117 int av_samples_get_buffer_size(int *linesize, int nb_channels, int nb_samples,
118  enum AVSampleFormat sample_fmt, int align)
119 {
120  int line_size;
121  int sample_size = av_get_bytes_per_sample(sample_fmt);
122  int planar = av_sample_fmt_is_planar(sample_fmt);
123 
124  /* validate parameter ranges */
125  if (!sample_size || nb_samples <= 0 || nb_channels <= 0)
126  return AVERROR(EINVAL);
127 
128  /* auto-select alignment if not specified */
129  if (!align) {
130  if (nb_samples > INT_MAX - 31)
131  return AVERROR(EINVAL);
132  align = 1;
133  nb_samples = FFALIGN(nb_samples, 32);
134  }
135 
136  /* check for integer overflow */
137  if (nb_channels > INT_MAX / align ||
138  (int64_t)nb_channels * nb_samples > (INT_MAX - (align * nb_channels)) / sample_size)
139  return AVERROR(EINVAL);
140 
141  line_size = planar ? FFALIGN(nb_samples * sample_size, align) :
142  FFALIGN(nb_samples * sample_size * nb_channels, align);
143  if (linesize)
144  *linesize = line_size;
145 
146  return planar ? line_size * nb_channels : line_size;
147 }
148 
149 int av_samples_fill_arrays(uint8_t **audio_data, int *linesize,
150  const uint8_t *buf, int nb_channels, int nb_samples,
151  enum AVSampleFormat sample_fmt, int align)
152 {
153  int ch, planar, buf_size, line_size;
154 
155  planar = av_sample_fmt_is_planar(sample_fmt);
156  buf_size = av_samples_get_buffer_size(&line_size, nb_channels, nb_samples,
157  sample_fmt, align);
158  if (buf_size < 0)
159  return buf_size;
160 
161  audio_data[0] = (uint8_t *)buf;
162  for (ch = 1; planar && ch < nb_channels; ch++)
163  audio_data[ch] = audio_data[ch-1] + line_size;
164 
165  if (linesize)
166  *linesize = line_size;
167 
168  return buf_size;
169 }
170 
171 int av_samples_alloc(uint8_t **audio_data, int *linesize, int nb_channels,
172  int nb_samples, enum AVSampleFormat sample_fmt, int align)
173 {
174  uint8_t *buf;
175  int size = av_samples_get_buffer_size(NULL, nb_channels, nb_samples,
176  sample_fmt, align);
177  if (size < 0)
178  return size;
179 
180  buf = av_malloc(size);
181  if (!buf)
182  return AVERROR(ENOMEM);
183 
184  size = av_samples_fill_arrays(audio_data, linesize, buf, nb_channels,
185  nb_samples, sample_fmt, align);
186  if (size < 0) {
187  av_free(buf);
188  return size;
189  }
190 
191  av_samples_set_silence(audio_data, 0, nb_samples, nb_channels, sample_fmt);
192 
193  return size;
194 }
195 
196 int av_samples_alloc_array_and_samples(uint8_t ***audio_data, int *linesize, int nb_channels,
197  int nb_samples, enum AVSampleFormat sample_fmt, int align)
198 {
199  int ret, nb_planes = av_sample_fmt_is_planar(sample_fmt) ? nb_channels : 1;
200 
201  *audio_data = av_calloc(nb_planes, sizeof(**audio_data));
202  if (!*audio_data)
203  return AVERROR(ENOMEM);
204  ret = av_samples_alloc(*audio_data, linesize, nb_channels,
205  nb_samples, sample_fmt, align);
206  if (ret < 0)
207  av_freep(audio_data);
208  return ret;
209 }
210 
211 int av_samples_copy(uint8_t **dst, uint8_t * const *src, int dst_offset,
212  int src_offset, int nb_samples, int nb_channels,
213  enum AVSampleFormat sample_fmt)
214 {
215  int planar = av_sample_fmt_is_planar(sample_fmt);
216  int planes = planar ? nb_channels : 1;
217  int block_align = av_get_bytes_per_sample(sample_fmt) * (planar ? 1 : nb_channels);
218  int data_size = nb_samples * block_align;
219  int i;
220 
221  dst_offset *= block_align;
222  src_offset *= block_align;
223 
224  if((dst[0] < src[0] ? src[0] - dst[0] : dst[0] - src[0]) >= data_size) {
225  for (i = 0; i < planes; i++)
226  memcpy(dst[i] + dst_offset, src[i] + src_offset, data_size);
227  } else {
228  for (i = 0; i < planes; i++)
229  memmove(dst[i] + dst_offset, src[i] + src_offset, data_size);
230  }
231 
232  return 0;
233 }
234 
235 int av_samples_set_silence(uint8_t **audio_data, int offset, int nb_samples,
236  int nb_channels, enum AVSampleFormat sample_fmt)
237 {
238  int planar = av_sample_fmt_is_planar(sample_fmt);
239  int planes = planar ? nb_channels : 1;
240  int block_align = av_get_bytes_per_sample(sample_fmt) * (planar ? 1 : nb_channels);
241  int data_size = nb_samples * block_align;
242  int fill_char = (sample_fmt == AV_SAMPLE_FMT_U8 ||
243  sample_fmt == AV_SAMPLE_FMT_U8P) ? 0x80 : 0x00;
244  int i;
245 
246  offset *= block_align;
247 
248  for (i = 0; i < planes; i++)
249  memset(audio_data[i] + offset, fill_char, data_size);
250 
251  return 0;
252 }
float, planar
Definition: samplefmt.h:69
#define NULL
Definition: coverity.c:32
Number of sample formats. DO NOT USE if linking dynamically.
Definition: samplefmt.h:72
char * av_get_sample_fmt_string(char *buf, int buf_size, enum AVSampleFormat sample_fmt)
Generate a string corresponding to the sample format with sample_fmt, or a header if sample_fmt is ne...
Definition: samplefmt.c:91
double, planar
Definition: samplefmt.h:70
enum AVSampleFormat altform
planar<->packed alternative form
Definition: samplefmt.c:30
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)
Allocate a data pointers array, samples buffer for nb_samples samples, and fill data pointers and lin...
Definition: samplefmt.c:196
static const SampleFmtInfo sample_fmt_info[AV_SAMPLE_FMT_NB]
this table gives more information about formats
Definition: samplefmt.c:34
uint8_t
#define av_malloc(s)
AV_SAMPLE_FMT_U8
enum AVSampleFormat av_get_planar_sample_fmt(enum AVSampleFormat sample_fmt)
Get the planar alternative form of the given sample format.
Definition: samplefmt.c:82
ptrdiff_t size
Definition: opengl_enc.c:101
signed 32 bits
Definition: samplefmt.h:62
#define FFALIGN(x, a)
Definition: macros.h:48
int av_sample_fmt_is_planar(enum AVSampleFormat sample_fmt)
Check if the sample format is planar.
Definition: samplefmt.c:110
int av_samples_set_silence(uint8_t **audio_data, int offset, int nb_samples, int nb_channels, enum AVSampleFormat sample_fmt)
Fill an audio buffer with silence.
Definition: samplefmt.c:235
#define AVERROR(e)
Definition: error.h:43
const char * av_get_sample_fmt_name(enum AVSampleFormat sample_fmt)
Return the name of sample_fmt, or NULL if sample_fmt is not recognized.
Definition: samplefmt.c:47
static const uint8_t offset[127][2]
Definition: vf_spp.c:92
signed 32 bits, planar
Definition: samplefmt.h:68
unsigned 8 bits, planar
Definition: samplefmt.h:66
#define src
Definition: vp9dsp.c:530
const AVS_VideoInfo int align
Definition: avisynth_c.h:658
int av_samples_alloc(uint8_t **audio_data, int *linesize, int nb_channels, int nb_samples, enum AVSampleFormat sample_fmt, int align)
Allocate a samples buffer for nb_samples samples, and fill data pointers and linesize accordingly...
Definition: samplefmt.c:171
AVSampleFormat
Audio sample formats.
Definition: samplefmt.h:58
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)
Copy samples from src to dst.
Definition: samplefmt.c:211
void * buf
Definition: avisynth_c.h:553
int av_samples_get_buffer_size(int *linesize, int nb_channels, int nb_samples, enum AVSampleFormat sample_fmt, int align)
Get the required buffer size for the given audio parameters.
Definition: samplefmt.c:117
enum AVSampleFormat av_get_sample_fmt(const char *name)
Return a sample format corresponding to name, or AV_SAMPLE_FMT_NONE on error.
Definition: samplefmt.c:54
#define snprintf
Definition: snprintf.h:34
void * av_calloc(size_t nmemb, size_t size)
Allocate a block of nmemb * size bytes with alignment suitable for all memory accesses (including vec...
Definition: mem.c:260
int av_get_bytes_per_sample(enum AVSampleFormat sample_fmt)
Return number of bytes per sample.
Definition: samplefmt.c:104
enum AVSampleFormat av_get_alt_sample_fmt(enum AVSampleFormat sample_fmt, int planar)
Return the planar<->packed alternative form of the given sample format, or AV_SAMPLE_FMT_NONE on erro...
Definition: samplefmt.c:64
common internal and external API header
enum AVSampleFormat av_get_packed_sample_fmt(enum AVSampleFormat sample_fmt)
Get the packed alternative form of the given sample format.
Definition: samplefmt.c:73
signed 16 bits
Definition: samplefmt.h:61
char name[8]
Definition: samplefmt.c:27
int av_samples_fill_arrays(uint8_t **audio_data, int *linesize, const uint8_t *buf, int nb_channels, int nb_samples, enum AVSampleFormat sample_fmt, int align)
Fill plane data pointers and linesize for samples with sample format sample_fmt.
Definition: samplefmt.c:149
#define av_free(p)
#define av_freep(p)
signed 16 bits, planar
Definition: samplefmt.h:67
int nb_channels
const char * name
Definition: opengl_enc.c:103