diff options
author | Andreas Rheinhardt <andreas.rheinhardt@gmail.com> | 2019-11-14 17:44:15 +0300 |
---|---|---|
committer | James Almer <jamrial@gmail.com> | 2019-11-14 18:02:41 +0300 |
commit | 41b05b849f215b03eeb9e3608571ba47de64182a (patch) | |
tree | 9da4bff250bade040ce1a9c9866da28bc231d7bc /libavcodec/avcodec.h | |
parent | a7245adee3e98d4b2e2a1bb7ddc0caae898b5193 (diff) |
avcodec/avcodec: Adapt the doc of av_bsf_send_packet to match its actual implementation.
Explicitly allowing empty packets to signal flushing helps getting rid
of special cases. It does not hinder the ability to send i.e.
timing-only packets, because one can send packets with zero size and
pkt->data set.
Signed-off-by: Andreas Rheinhardt <andreas.rheinhardt@gmail.com>
Signed-off-by: James Almer <jamrial@gmail.com>
Diffstat (limited to 'libavcodec/avcodec.h')
-rw-r--r-- | libavcodec/avcodec.h | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h index bcb931f0dd..813a43b72e 100644 --- a/libavcodec/avcodec.h +++ b/libavcodec/avcodec.h @@ -5946,11 +5946,13 @@ int av_bsf_init(AVBSFContext *ctx); * * @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. - * This parameter may be NULL, which signals the end of the stream (i.e. no more - * packets will be sent). That will cause the filter to output any packets it - * may have buffered internally. + * If pkt is empty (i.e. NULL, or pkt->data is NULL and pkt->side_data_elems zero), + * it signals the end of the stream (i.e. no more non-empty packets will be sent; + * sending more empty packets does nothing) and will cause the filter to output + * any packets it may have buffered internally. * - * @return 0 on success, a negative AVERROR on error. + * @return 0 on success, a negative AVERROR on error. This function never fails if + * pkt is empty. */ int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt); |