virtualenv/FFmpeg
1
0
Fork 0
mirror of https://github.com/FFmpeg/FFmpeg.git synced 2024-12-23 12:43:46 +02:00
Code Issues Releases Activity

samplefmt: Add doxygen categories

Browse Source 
Categorize the enum and functions as "audio-related".

Signed-off-by: Timothy Gu <timothygu99@gmail.com>
Signed-off-by: Diego Biurrun <diego@biurrun.de>
This commit is contained in:
Timothy Gu 2014-07-06 10:53:33 -07:00 committed by Diego Biurrun
parent d6902070c5
commit d69243d39b
1 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
libavutil/samplefmt.h
View File

@ -24,6 +24,17 @@
#include "avutil.h" #include "avutil.h"
#include "attributes.h" #include "attributes.h"
/**
* @addtogroup lavu_audio
* @{
*
* @defgroup lavu_sampfmts Audio sample formats
*
* Audio sample format enumeration and related convenience functions.
* @{
*
*/
/** /**
* Audio Sample Formats * Audio Sample Formats
* *
@ -40,6 +51,7 @@
* The data layout as used in av_samples_fill_arrays() and elsewhere in Libav * The data layout as used in av_samples_fill_arrays() and elsewhere in Libav
* (such as AVFrame in libavcodec) is as follows: * (such as AVFrame in libavcodec) is as follows:
* *
* @par
* For planar sample formats, each audio channel is in a separate data plane, * For planar sample formats, each audio channel is in a separate data plane,
* and linesize is the buffer size, in bytes, for a single plane. All data * and linesize is the buffer size, in bytes, for a single plane. All data
* planes must be the same size. For packed sample formats, only the first data * planes must be the same size. For packed sample formats, only the first data
@ -141,6 +153,15 @@ int av_sample_fmt_is_planar(enum AVSampleFormat sample_fmt);
int av_samples_get_buffer_size(int *linesize, int nb_channels, int nb_samples, int av_samples_get_buffer_size(int *linesize, int nb_channels, int nb_samples,
enum AVSampleFormat sample_fmt, int align); enum AVSampleFormat sample_fmt, int align);
/**
* @}
*
* @defgroup lavu_sampmanip Samples manipulation
*
* Functions that manipulate audio samples
* @{
*/
/** /**
* Fill channel data pointers and linesize for samples with sample * Fill channel data pointers and linesize for samples with sample
* format sample_fmt. * format sample_fmt.
@ -217,4 +238,8 @@ int av_samples_copy(uint8_t **dst, uint8_t * const *src, int dst_offset,
int av_samples_set_silence(uint8_t **audio_data, int offset, int nb_samples, int av_samples_set_silence(uint8_t **audio_data, int offset, int nb_samples,
int nb_channels, enum AVSampleFormat sample_fmt); int nb_channels, enum AVSampleFormat sample_fmt);
/**
* @}
* @}
*/
#endif /* AVUTIL_SAMPLEFMT_H */ #endif /* AVUTIL_SAMPLEFMT_H */