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
35 AV_SAMPLE_FMT_U8P, ///< unsigned 8 bits, planar
36 AV_SAMPLE_FMT_S16P, ///< signed 16 bits, planar
37 AV_SAMPLE_FMT_S32P, ///< signed 32 bits, planar
38 AV_SAMPLE_FMT_FLTP, ///< float, planar
39 AV_SAMPLE_FMT_DBLP, ///< double, planar
41 AV_SAMPLE_FMT_NB ///< Number of sample formats. DO NOT USE if linking dynamically
45 * Return the name of sample_fmt, or NULL if sample_fmt is not
48 const char *av_get_sample_fmt_name(enum AVSampleFormat sample_fmt);
51 * Return a sample format corresponding to name, or AV_SAMPLE_FMT_NONE
54 enum AVSampleFormat av_get_sample_fmt(const char *name);
57 * Return the planar<->packed alternative form of the given sample format, or
58 * AV_SAMPLE_FMT_NONE on error. If the passed sample_fmt is already in the
59 * requested planar/packed format, the format returned is the same as the
62 enum AVSampleFormat av_get_alt_sample_fmt(enum AVSampleFormat sample_fmt, int planar);
65 * Generate a string corresponding to the sample format with
66 * sample_fmt, or a header if sample_fmt is negative.
68 * @param buf the buffer where to write the string
69 * @param buf_size the size of buf
70 * @param sample_fmt the number of the sample format to print the
71 * corresponding info string, or a negative value to print the
72 * corresponding header.
73 * @return the pointer to the filled buffer or NULL if sample_fmt is
74 * unknown or in case of other errors
76 char *av_get_sample_fmt_string(char *buf, int buf_size, enum AVSampleFormat sample_fmt);
78 #if FF_API_GET_BITS_PER_SAMPLE_FMT
80 * @deprecated Use av_get_bytes_per_sample() instead.
83 int av_get_bits_per_sample_fmt(enum AVSampleFormat sample_fmt);
87 * Return number of bytes per sample.
89 * @param sample_fmt the sample format
90 * @return number of bytes per sample or zero if unknown for the given
93 int av_get_bytes_per_sample(enum AVSampleFormat sample_fmt);
96 * Check if the sample format is planar.
98 * @param sample_fmt the sample format to inspect
99 * @return 1 if the sample format is planar, 0 if it is interleaved
101 int av_sample_fmt_is_planar(enum AVSampleFormat sample_fmt);
104 * Get the required buffer size for the given audio parameters.
106 * @param[out] linesize calculated linesize, may be NULL
107 * @param nb_channels the number of channels
108 * @param nb_samples the number of samples in a single channel
109 * @param sample_fmt the sample format
110 * @return required buffer size, or negative error code on failure
112 int av_samples_get_buffer_size(int *linesize, int nb_channels, int nb_samples,
113 enum AVSampleFormat sample_fmt, int align);
116 * Fill channel data pointers and linesize for samples with sample
119 * The pointers array is filled with the pointers to the samples data:
120 * for planar, set the start point of each channel's data within the buffer,
121 * for packed, set the start point of the entire buffer only.
123 * The linesize array is filled with the aligned size of each channel's data
124 * buffer for planar layout, or the aligned size of the buffer for all channels
127 * @param[out] audio_data array to be filled with the pointer for each channel
128 * @param[out] linesize calculated linesize
129 * @param buf the pointer to a buffer containing the samples
130 * @param nb_channels the number of channels
131 * @param nb_samples the number of samples in a single channel
132 * @param sample_fmt the sample format
133 * @param align buffer size alignment (1 = no alignment required)
134 * @return 0 on success or a negative error code on failure
136 int av_samples_fill_arrays(uint8_t **audio_data, int *linesize, uint8_t *buf,
137 int nb_channels, int nb_samples,
138 enum AVSampleFormat sample_fmt, int align);
141 * Allocate a samples buffer for nb_samples samples, and fill data pointers and
142 * linesize accordingly.
143 * The allocated samples buffer can be freed by using av_freep(&audio_data[0])
145 * @param[out] audio_data array to be filled with the pointer for each channel
146 * @param[out] linesize aligned size for audio buffer(s)
147 * @param nb_channels number of audio channels
148 * @param nb_samples number of samples per channel
149 * @param align buffer size alignment (1 = no alignment required)
150 * @return 0 on success or a negative error code on failure
151 * @see av_samples_fill_arrays()
153 int av_samples_alloc(uint8_t **audio_data, int *linesize, int nb_channels,
154 int nb_samples, enum AVSampleFormat sample_fmt, int align);
156 #endif /* AVUTIL_SAMPLEFMT_H */