avformat: Add fpsprobesize as an AVOption.
[ffmpeg.git] / libavutil / samplefmt.h
1 /*
2  * This file is part of Libav.
3  *
4  * Libav 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  * Libav 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 Libav; 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 /**
23  * all in native-endian format
24  */
25 enum AVSampleFormat {
26     AV_SAMPLE_FMT_NONE = -1,
27     AV_SAMPLE_FMT_U8,          ///< unsigned 8 bits
28     AV_SAMPLE_FMT_S16,         ///< signed 16 bits
29     AV_SAMPLE_FMT_S32,         ///< signed 32 bits
30     AV_SAMPLE_FMT_FLT,         ///< float
31     AV_SAMPLE_FMT_DBL,         ///< double
32     AV_SAMPLE_FMT_NB           ///< Number of sample formats. DO NOT USE if linking dynamically
33 };
34
35 /**
36  * Return the name of sample_fmt, or NULL if sample_fmt is not
37  * recognized.
38  */
39 const char *av_get_sample_fmt_name(enum AVSampleFormat sample_fmt);
40
41 /**
42  * Return a sample format corresponding to name, or AV_SAMPLE_FMT_NONE
43  * on error.
44  */
45 enum AVSampleFormat av_get_sample_fmt(const char *name);
46
47 /**
48  * Generate a string corresponding to the sample format with
49  * sample_fmt, or a header if sample_fmt is negative.
50  *
51  * @param buf the buffer where to write the string
52  * @param buf_size the size of buf
53  * @param sample_fmt the number of the sample format to print the
54  * corresponding info string, or a negative value to print the
55  * corresponding header.
56  * @return the pointer to the filled buffer or NULL if sample_fmt is
57  * unknown or in case of other errors
58  */
59 char *av_get_sample_fmt_string(char *buf, int buf_size, enum AVSampleFormat sample_fmt);
60
61 /**
62  * Return sample format bits per sample.
63  *
64  * @param sample_fmt the sample format
65  * @return number of bits per sample or zero if unknown for the given
66  * sample format
67  */
68 int av_get_bits_per_sample_fmt(enum AVSampleFormat sample_fmt);
69
70 #endif /* AVUTIL_SAMPLEFMT_H */