diff --git a/libswresample/swresample.h b/libswresample/swresample.h index f140abd001..838fb5cd35 100644 --- a/libswresample/swresample.h +++ b/libswresample/swresample.h @@ -192,6 +192,11 @@ typedef struct SwrContext SwrContext; */ const AVClass *swr_get_class(void); +/** + * @name SwrContext constructor functions + * @{ + */ + /** * Allocate SwrContext. * @@ -242,6 +247,13 @@ struct SwrContext *swr_alloc_set_opts(struct SwrContext *s, int64_t in_ch_layout, enum AVSampleFormat in_sample_fmt, int in_sample_rate, int log_offset, void *log_ctx); +/** + * @} + * + * @name SwrContext destructor functions + * @{ + */ + /** * Free the given SwrContext and set the pointer to NULL. */ @@ -258,7 +270,13 @@ void swr_free(struct SwrContext **s); void swr_close(struct SwrContext *s); /** - * Convert audio. + * @} + * + * @name Core conversion functions + * @{ + */ + +/** Convert audio. * * in and in_count can be set to 0 to flush the last few samples out at the * end. @@ -293,6 +311,15 @@ int swr_convert(struct SwrContext *s, uint8_t **out, int out_count, */ int64_t swr_next_pts(struct SwrContext *s, int64_t pts); +/** + * @} + * + * @name Low-level option setting functions + * These functons provide a means to set low-level options that is not possible + * with the AVOption API. + * @{ + */ + /** * Activate resampling compensation. */ @@ -319,6 +346,13 @@ int swr_set_channel_mapping(struct SwrContext *s, const int *channel_map); */ int swr_set_matrix(struct SwrContext *s, const double *matrix, int stride); +/** + * @} + * + * @name Sample handling functions + * @{ + */ + /** * Drops the specified number of output samples. */ @@ -351,6 +385,13 @@ int swr_inject_silence(struct SwrContext *s, int count); */ int64_t swr_get_delay(struct SwrContext *s, int64_t base); +/** + * @} + * + * @name Configuration accessors + * @{ + */ + /** * Return the @ref LIBSWRESAMPLE_VERSION_INT constant. * @@ -376,6 +417,7 @@ const char *swresample_configuration(void); const char *swresample_license(void); /** + * @} * @} */