summaryrefslogtreecommitdiff
path: root/libavcodec
diff options
context:
space:
mode:
authorMarvin Scholz <epirat07@gmail.com>2022-09-25 01:51:12 +0200
committerAnton Khirnov <anton@khirnov.net>2022-10-17 09:56:47 +0200
commit0d341379253a107466a31f0491beec6caefc4220 (patch)
treec052cbc937efb3dee7076eaa1f992c36acd30a1e /libavcodec
parent4aa04c255dfa30e7d6f3a06f81f12701d2a58aec (diff)
avcodec/bsf: document missing arguments
Diffstat (limited to 'libavcodec')
-rw-r--r--libavcodec/bsf.h4
1 files changed, 4 insertions, 0 deletions
diff --git a/libavcodec/bsf.h b/libavcodec/bsf.h
index 69d91a16ab..a09c69f242 100644
--- a/libavcodec/bsf.h
+++ b/libavcodec/bsf.h
@@ -164,6 +164,8 @@ int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
/**
* Prepare the filter for use, after all the parameters and options have been
* set.
+ *
+ * @param ctx a AVBSFContext previously allocated with av_bsf_alloc()
*/
int av_bsf_init(AVBSFContext *ctx);
@@ -174,6 +176,7 @@ int av_bsf_init(AVBSFContext *ctx);
* av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
* AVERROR_EOF.
*
+ * @param ctx an initialized AVBSFContext
* @param pkt the packet to filter. The bitstream filter will take ownership of
* the packet and reset the contents of pkt. pkt is not touched if an error occurs.
* If pkt is empty (i.e. NULL, or pkt->data is NULL and pkt->side_data_elems zero),
@@ -192,6 +195,7 @@ int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
/**
* Retrieve a filtered packet.
*
+ * @param ctx an initialized AVBSFContext
* @param[out] pkt this struct will be filled with the contents of the filtered
* packet. It is owned by the caller and must be freed using
* av_packet_unref() when it is no longer needed.