summaryrefslogtreecommitdiff
path: root/libswresample/swresample.h
diff options
context:
space:
mode:
authorTimothy Gu <timothygu99@gmail.com>2014-07-06 09:53:56 -0700
committerMichael Niedermayer <michaelni@gmx.at>2014-07-06 22:07:15 +0200
commit064945b3aa7c06d998d730e9f7e385bcdedbd86d (patch)
treebf3079cb8d5f132bb6e975318262d8c34f8d5aba /libswresample/swresample.h
parent81f47e272d661cd247498677244dbb216acec35f (diff)
downloadffmpeg-064945b3aa7c06d998d730e9f7e385bcdedbd86d.tar.gz
swresample: organize functions into doxy groups
Signed-off-by: Timothy Gu <timothygu99@gmail.com> Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
Diffstat (limited to 'libswresample/swresample.h')
-rw-r--r--libswresample/swresample.h44
1 files changed, 43 insertions, 1 deletions
diff --git a/libswresample/swresample.h b/libswresample/swresample.h
index f140abd001..838fb5cd35 100644
--- a/libswresample/swresample.h
+++ b/libswresample/swresample.h
@@ -193,6 +193,11 @@ typedef struct SwrContext SwrContext;
const AVClass *swr_get_class(void);
/**
+ * @name SwrContext constructor functions
+ * @{
+ */
+
+/**
* Allocate SwrContext.
*
* If you use this function you will need to set the parameters (manually or
@@ -243,6 +248,13 @@ struct SwrContext *swr_alloc_set_opts(struct SwrContext *s,
int log_offset, void *log_ctx);
/**
+ * @}
+ *
+ * @name SwrContext destructor functions
+ * @{
+ */
+
+/**
* Free the given SwrContext and set the pointer to NULL.
*/
void swr_free(struct SwrContext **s);
@@ -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.
@@ -294,6 +312,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.
*/
int swr_set_compensation(struct SwrContext *s, int sample_delta, int compensation_distance);
@@ -320,6 +347,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.
*/
int swr_drop_output(struct SwrContext *s, int count);
@@ -352,6 +386,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.
*
* This is useful to check if the build-time libswresample has the same version
@@ -377,6 +418,7 @@ const char *swresample_license(void);
/**
* @}
+ * @}
*/
#endif /* SWRESAMPLE_SWRESAMPLE_H */