git.sesse.net Git - ffmpeg/blob - 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 #include <stdint.h>
  23
  24 #include "avutil.h"
  25 #include "attributes.h"
  26
  27 /**
  28  * @addtogroup lavu_audio
  29  * @{
  30  *
  31  * @defgroup lavu_sampfmts Audio sample formats
  32  *
  33  * Audio sample format enumeration and related convenience functions.
  34  * @{
  35  */
  36
  37 /**
  38  * Audio Sample Formats
  39  *
  40  * @par
  41  * The data described by the sample format is always in native-endian order.
  42  * Sample values can be expressed by native C types, hence the lack of a signed
  43  * 24-bit sample format even though it is a common raw audio data format.
  44  *
  45  * @par
  46  * The floating-point formats are based on full volume being in the range
  47  * [-1.0, 1.0]. Any values outside this range are beyond full volume level.
  48  *
  49  * @par
  50  * The data layout as used in av_samples_fill_arrays() and elsewhere in Libav
  51  * (such as AVFrame in libavcodec) is as follows:
  52  *
  53  * @par
  54  * For planar sample formats, each audio channel is in a separate data plane,
  55  * and linesize is the buffer size, in bytes, for a single plane. All data
  56  * planes must be the same size. For packed sample formats, only the first data
  57  * plane is used, and samples for each channel are interleaved. In this case,
  58  * linesize is the buffer size, in bytes, for the 1 plane.
  59  */
  60 enum AVSampleFormat {
  61     AV_SAMPLE_FMT_NONE = -1,
  62     AV_SAMPLE_FMT_U8,          ///< unsigned 8 bits
  63     AV_SAMPLE_FMT_S16,         ///< signed 16 bits
  64     AV_SAMPLE_FMT_S32,         ///< signed 32 bits
  65     AV_SAMPLE_FMT_FLT,         ///< float
  66     AV_SAMPLE_FMT_DBL,         ///< double
  67
  68     AV_SAMPLE_FMT_U8P,         ///< unsigned 8 bits, planar
  69     AV_SAMPLE_FMT_S16P,        ///< signed 16 bits, planar
  70     AV_SAMPLE_FMT_S32P,        ///< signed 32 bits, planar
  71     AV_SAMPLE_FMT_FLTP,        ///< float, planar
  72     AV_SAMPLE_FMT_DBLP,        ///< double, planar
  73
  74     AV_SAMPLE_FMT_NB           ///< Number of sample formats. DO NOT USE if linking dynamically
  75 };
  76
  77 /**
  78  * Return the name of sample_fmt, or NULL if sample_fmt is not
  79  * recognized.
  80  */
  81 const char *av_get_sample_fmt_name(enum AVSampleFormat sample_fmt);
  82
  83 /**
  84  * Return a sample format corresponding to name, or AV_SAMPLE_FMT_NONE
  85  * on error.
  86  */
  87 enum AVSampleFormat av_get_sample_fmt(const char *name);
  88
  89 /**
  90  * Get the packed alternative form of the given sample format.
  91  *
  92  * If the passed sample_fmt is already in packed format, the format returned is
  93  * the same as the input.
  94  *
  95  * @return  the packed alternative form of the given sample format or
  96             AV_SAMPLE_FMT_NONE on error.
  97  */
  98 enum AVSampleFormat av_get_packed_sample_fmt(enum AVSampleFormat sample_fmt);
  99
 100 /**
 101  * Get the planar alternative form of the given sample format.
 102  *
 103  * If the passed sample_fmt is already in planar format, the format returned is
 104  * the same as the input.
 105  *
 106  * @return  the planar alternative form of the given sample format or
 107             AV_SAMPLE_FMT_NONE on error.
 108  */
 109 enum AVSampleFormat av_get_planar_sample_fmt(enum AVSampleFormat sample_fmt);
 110
 111 /**
 112  * Generate a string corresponding to the sample format with
 113  * sample_fmt, or a header if sample_fmt is negative.
 114  *
 115  * @param buf the buffer where to write the string
 116  * @param buf_size the size of buf
 117  * @param sample_fmt the number of the sample format to print the
 118  * corresponding info string, or a negative value to print the
 119  * corresponding header.
 120  * @return the pointer to the filled buffer or NULL if sample_fmt is
 121  * unknown or in case of other errors
 122  */
 123 char *av_get_sample_fmt_string(char *buf, int buf_size, enum AVSampleFormat sample_fmt);
 124
 125 /**
 126  * Return number of bytes per sample.
 127  *
 128  * @param sample_fmt the sample format
 129  * @return number of bytes per sample or zero if unknown for the given
 130  * sample format
 131  */
 132 int av_get_bytes_per_sample(enum AVSampleFormat sample_fmt);
 133
 134 /**
 135  * Check if the sample format is planar.
 136  *
 137  * @param sample_fmt the sample format to inspect
 138  * @return 1 if the sample format is planar, 0 if it is interleaved
 139  */
 140 int av_sample_fmt_is_planar(enum AVSampleFormat sample_fmt);
 141
 142 /**
 143  * Get the required buffer size for the given audio parameters.
 144  *
 145  * @param[out] linesize calculated linesize, may be NULL
 146  * @param nb_channels   the number of channels
 147  * @param nb_samples    the number of samples in a single channel
 148  * @param sample_fmt    the sample format
 149  * @param align         buffer size alignment (0 = default, 1 = no alignment)
 150  * @return              required buffer size, or negative error code on failure
 151  */
 152 int av_samples_get_buffer_size(int *linesize, int nb_channels, int nb_samples,
 153                                enum AVSampleFormat sample_fmt, int align);
 154
 155 /**
 156  * @}
 157  *
 158  * @defgroup lavu_sampmanip Samples manipulation
 159  *
 160  * Functions that manipulate audio samples
 161  * @{
 162  */
 163
 164 /**
 165  * Fill channel data pointers and linesize for samples with sample
 166  * format sample_fmt.
 167  *
 168  * The pointers array is filled with the pointers to the samples data:
 169  * for planar, set the start point of each channel's data within the buffer,
 170  * for packed, set the start point of the entire buffer only.
 171  *
 172  * The linesize array is filled with the aligned size of each channel's data
 173  * buffer for planar layout, or the aligned size of the buffer for all channels
 174  * for packed layout.
 175  *
 176  * @see enum AVSampleFormat
 177  * The documentation for AVSampleFormat describes the data layout.
 178  *
 179  * @param[out] audio_data  array to be filled with the pointer for each channel
 180  * @param[out] linesize    calculated linesize, may be NULL
 181  * @param buf              the pointer to a buffer containing the samples
 182  * @param nb_channels      the number of channels
 183  * @param nb_samples       the number of samples in a single channel
 184  * @param sample_fmt       the sample format
 185  * @param align            buffer size alignment (0 = default, 1 = no alignment)
 186  * @return                 0 on success or a negative error code on failure
 187  */
 188 int av_samples_fill_arrays(uint8_t **audio_data, int *linesize,
 189                            const uint8_t *buf,
 190                            int nb_channels, int nb_samples,
 191                            enum AVSampleFormat sample_fmt, int align);
 192
 193 /**
 194  * Allocate a samples buffer for nb_samples samples, and fill data pointers and
 195  * linesize accordingly.
 196  * The allocated samples buffer can be freed by using av_freep(&audio_data[0])
 197  * Allocated data will be initialized to silence.
 198  *
 199  * @see enum AVSampleFormat
 200  * The documentation for AVSampleFormat describes the data layout.
 201  *
 202  * @param[out] audio_data  array to be filled with the pointer for each channel
 203  * @param[out] linesize    aligned size for audio buffer(s), may be NULL
 204  * @param nb_channels      number of audio channels
 205  * @param nb_samples       number of samples per channel
 206  * @param align            buffer size alignment (0 = default, 1 = no alignment)
 207  * @return                 0 on success or a negative error code on failure
 208  * @see av_samples_fill_arrays()
 209  */
 210 int av_samples_alloc(uint8_t **audio_data, int *linesize, int nb_channels,
 211                      int nb_samples, enum AVSampleFormat sample_fmt, int align);
 212
 213 /**
 214  * Copy samples from src to dst.
 215  *
 216  * @param dst destination array of pointers to data planes
 217  * @param src source array of pointers to data planes
 218  * @param dst_offset offset in samples at which the data will be written to dst
 219  * @param src_offset offset in samples at which the data will be read from src
 220  * @param nb_samples number of samples to be copied
 221  * @param nb_channels number of audio channels
 222  * @param sample_fmt audio sample format
 223  */
 224 int av_samples_copy(uint8_t **dst, uint8_t * const *src, int dst_offset,
 225                     int src_offset, int nb_samples, int nb_channels,
 226                     enum AVSampleFormat sample_fmt);
 227
 228 /**
 229  * Fill an audio buffer with silence.
 230  *
 231  * @param audio_data  array of pointers to data planes
 232  * @param offset      offset in samples at which to start filling
 233  * @param nb_samples  number of samples to fill
 234  * @param nb_channels number of audio channels
 235  * @param sample_fmt  audio sample format
 236  */
 237 int av_samples_set_silence(uint8_t **audio_data, int offset, int nb_samples,
 238                            int nb_channels, enum AVSampleFormat sample_fmt);
 239
 240 /**
 241  * @}
 242  * @}
 243  */
 244 #endif /* AVUTIL_SAMPLEFMT_H */