2 * This file is part of FFmpeg.
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.
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.
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
19 #ifndef AVUTIL_SAMPLEFMT_H
20 #define AVUTIL_SAMPLEFMT_H
25 * all in native-endian format
28 AV_SAMPLE_FMT_NONE = -1,
29 AV_SAMPLE_FMT_U8, ///< unsigned 8 bits
30 AV_SAMPLE_FMT_S16, ///< signed 16 bits
31 AV_SAMPLE_FMT_S32, ///< signed 32 bits
32 AV_SAMPLE_FMT_FLT, ///< float
33 AV_SAMPLE_FMT_DBL, ///< double
34 AV_SAMPLE_FMT_NB ///< Number of sample formats. DO NOT USE if linking dynamically
38 * Return the name of sample_fmt, or NULL if sample_fmt is not
41 const char *av_get_sample_fmt_name(enum AVSampleFormat sample_fmt);
44 * Return a sample format corresponding to name, or AV_SAMPLE_FMT_NONE
47 enum AVSampleFormat av_get_sample_fmt(const char *name);
50 * Generate a string corresponding to the sample format with
51 * sample_fmt, or a header if sample_fmt is negative.
53 * @param buf the buffer where to write the string
54 * @param buf_size the size of buf
55 * @param sample_fmt the number of the sample format to print the
56 * corresponding info string, or a negative value to print the
57 * corresponding header.
58 * @return the pointer to the filled buffer or NULL if sample_fmt is
59 * unknown or in case of other errors
61 char *av_get_sample_fmt_string(char *buf, int buf_size, enum AVSampleFormat sample_fmt);
63 #if FF_API_GET_BITS_PER_SAMPLE_FMT
65 * @deprecated Use av_get_bytes_per_sample() instead.
68 int av_get_bits_per_sample_fmt(enum AVSampleFormat sample_fmt);
72 * Return number of bytes per sample.
74 * @param sample_fmt the sample format
75 * @return number of bytes per sample or zero if unknown for the given
78 int av_get_bytes_per_sample(enum AVSampleFormat sample_fmt);
81 * Fill channel data pointers and linesizes for samples with sample
84 * The pointers array is filled with the pointers to the samples data:
85 * for planar, set the start point of each plane's data within the buffer,
86 * for packed, set the start point of the entire buffer only.
88 * The linesize array is filled with the aligned size of each samples
89 * plane, that is linesize[i] will contain the linesize of the plane i,
90 * and will be zero for all the unused planes. All linesize values are
93 * @param pointers array to be filled with the pointer for each plane, may be NULL
94 * @param linesizes array to be filled with the linesize, may be NULL
95 * @param buf the pointer to a buffer containing the samples
96 * @param nb_samples the number of samples in a single channel
97 * @param planar 1 if the samples layout is planar, 0 if it is packed
98 * @param nb_channels the number of channels
99 * @return the total size of the buffer, a negative
100 * error code in case of failure
102 int av_samples_fill_arrays(uint8_t *pointers[8], int linesizes[8],
103 uint8_t *buf, int nb_channels, int nb_samples,
104 enum AVSampleFormat sample_fmt, int planar, int align);
107 * Allocate a samples buffer for nb_samples samples, and
108 * fill pointers and linesizes accordingly.
109 * The allocated samples buffer has to be freed by using
110 * av_freep(&pointers[0]).
112 * @param nb_channels number of audio channels
113 * @param nb_samples number of samples per channel
114 * @param planar 1 if the samples layout is planar, 0 if packed,
115 * @param align the value to use for buffer size alignment
116 * @return the size in bytes required for the samples buffer, a negative
117 * error code in case of failure
118 * @see av_samples_fill_arrays()
120 int av_samples_alloc(uint8_t *pointers[8], int linesizes[8],
121 int nb_channels, int nb_samples,
122 enum AVSampleFormat sample_fmt, int planar,
125 #endif /* AVCORE_SAMPLEFMT_H */