diff options
| author | Luca Barbato <lu_zero@gentoo.org> | 2011-11-20 20:38:24 +0100 |
|---|---|---|
| committer | Luca Barbato <lu_zero@gentoo.org> | 2011-11-22 17:16:02 +0100 |
| commit | 757cd8d876b18c07e00b53fd4e5c01bedc106d2e (patch) | |
| tree | eab216085c5b151ac19d37f0f57df76f9d60031d /libavutil/audioconvert.h | |
| parent | 384bdaceeb9c82d5b64a6f73e5273298b38028e9 (diff) | |
| download | ffmpeg-757cd8d876b18c07e00b53fd4e5c01bedc106d2e.tar.gz | |
doxy: provide a start page and document libavutil
Introduce a basic layout, the subpages are currently left empty.
Split libavutil in multiple groups as example of the structure
Diffstat (limited to 'libavutil/audioconvert.h')
| -rw-r--r-- | libavutil/audioconvert.h | 24 |
1 files changed, 22 insertions, 2 deletions
diff --git a/libavutil/audioconvert.h b/libavutil/audioconvert.h index e37a2e84c1..1c5cfa0a8e 100644 --- a/libavutil/audioconvert.h +++ b/libavutil/audioconvert.h @@ -29,7 +29,15 @@ * audio conversion routines */ -/* Audio channel masks */ +/** + * @addtogroup lavu_audio + * @{ + */ + +/** + * @defgroup channel_masks Audio channel masks + * @{ + */ #define AV_CH_FRONT_LEFT 0x00000001 #define AV_CH_FRONT_RIGHT 0x00000002 #define AV_CH_FRONT_CENTER 0x00000004 @@ -56,7 +64,11 @@ to be the native codec channel order. */ #define AV_CH_LAYOUT_NATIVE 0x8000000000000000LL -/* Audio channel convenience macros */ +/** + * @} + * @defgroup channel_mask_c Audio channel convenience macros + * @{ + * */ #define AV_CH_LAYOUT_MONO (AV_CH_FRONT_CENTER) #define AV_CH_LAYOUT_STEREO (AV_CH_FRONT_LEFT|AV_CH_FRONT_RIGHT) #define AV_CH_LAYOUT_2_1 (AV_CH_LAYOUT_STEREO|AV_CH_BACK_CENTER) @@ -74,6 +86,10 @@ #define AV_CH_LAYOUT_STEREO_DOWNMIX (AV_CH_STEREO_LEFT|AV_CH_STEREO_RIGHT) /** + * @} + */ + +/** * Return a channel layout id that matches name, 0 if no match. */ int64_t av_get_channel_layout(const char *name); @@ -92,4 +108,8 @@ void av_get_channel_layout_string(char *buf, int buf_size, int nb_channels, int6 */ int av_get_channel_layout_nb_channels(int64_t channel_layout); +/** + * @} + */ + #endif /* AVUTIL_AUDIOCONVERT_H */ |