samplefmt: switch nb_channels/nb_samples params order in av_samples_alloc()
[ffmpeg.git] / libavutil / samplefmt.h
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 #ifndef AVUTIL_SAMPLEFMT_H
20 #define AVUTIL_SAMPLEFMT_H
21
22 #include "avutil.h"
23
24 /**
25  * all in native-endian format
26  */
27 enum AVSampleFormat {
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
35 };
36
37 /**
38  * Return the name of sample_fmt, or NULL if sample_fmt is not
39  * recognized.
40  */
41 const char *av_get_sample_fmt_name(enum AVSampleFormat sample_fmt);
42
43 /**
44  * Return a sample format corresponding to name, or AV_SAMPLE_FMT_NONE
45  * on error.
46  */
47 enum AVSampleFormat av_get_sample_fmt(const char *name);
48
49 /**
50  * Generate a string corresponding to the sample format with
51  * sample_fmt, or a header if sample_fmt is negative.
52  *
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
60  */
61 char *av_get_sample_fmt_string(char *buf, int buf_size, enum AVSampleFormat sample_fmt);
62
63 /**
64  * Return sample format bits per sample.
65  *
66  * @param sample_fmt the sample format
67  * @return number of bits per sample or zero if unknown for the given
68  * sample format
69  */
70 int av_get_bits_per_sample_fmt(enum AVSampleFormat sample_fmt);
71
72 /**
73  * Fill channel data pointers and linesizes for samples with sample
74  * format sample_fmt.
75  *
76  * The pointers array is filled with the pointers to the samples data:
77  * for planar, set the start point of each plane's data within the buffer,
78  * for packed, set the start point of the entire buffer only.
79  *
80  * The linesize array is filled with the aligned size of each samples
81  * plane, that is linesize[i] will contain the linesize of the plane i,
82  * and will be zero for all the unused planes. All linesize values are
83  * equal.
84  *
85  * @param pointers array to be filled with the pointer for each plane, may be NULL
86  * @param linesizes array to be filled with the linesize, may be NULL
87  * @param buf the pointer to a buffer containing the samples
88  * @param nb_samples the number of samples in a single channel
89  * @param planar 1 if the samples layout is planar, 0 if it is packed
90  * @param nb_channels the number of channels
91  * @return the total size of the buffer, a negative
92  * error code in case of failure
93  */
94 int av_samples_fill_arrays(uint8_t *pointers[8], int linesizes[8],
95                            uint8_t *buf, int nb_channels, int nb_samples,
96                            enum AVSampleFormat sample_fmt, int planar, int align);
97
98 /**
99  * Allocate a samples buffer for nb_samples samples, and
100  * fill pointers and linesizes accordingly.
101  * The allocated samples buffer has to be freed by using
102  * av_freep(&pointers[0]).
103  *
104  * @param nb_channels number of audio channels
105  * @param nb_samples number of samples per channel
106  * @param planar 1 if the samples layout is planar, 0 if packed,
107  * @param align the value to use for buffer size alignment
108  * @return the size in bytes required for the samples buffer, a negative
109  * error code in case of failure
110  * @see av_samples_fill_arrays()
111  */
112 int av_samples_alloc(uint8_t *pointers[8], int linesizes[8],
113                      int nb_channels, int nb_samples,
114                      enum AVSampleFormat sample_fmt, int planar,
115                      int align);
116
117 #endif /* AVCORE_SAMPLEFMT_H */