samplefmt.h 9.4 KB

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