avcodec/bsf: mention that av_bsf_send_packet() returning EAGAIN is not an error
authorJames Almer <jamrial@gmail.com>
Thu, 9 Apr 2020 23:02:04 +0000 (20:02 -0300)
committerJames Almer <jamrial@gmail.com>
Fri, 22 May 2020 14:16:40 +0000 (11:16 -0300)
commit1e8ed181e389dbc82b4b29afbee44a63dc76ce10
tree1db863b4f4b780751be8d4990d502aa7e4f9a47a
parentbdd6aa25c1f413c66053537e0f98741a8b40f5dd
avcodec/bsf: mention that av_bsf_send_packet() returning EAGAIN is not an error

EAGAIN is returned when input is provided but can't be consumed. The filtering
process is unaffected in this case, and the function will be able to consume
new input after retrieving filtered packets with av_bsf_receive_packet().

Remove the line about empty packets never failing added in
41b05b849f215b03eeb9e3608571ba47de64182a while at it. Even if it's currently
the case, it unnecessarily constrains the API and could be changed in the future
in case it needs to be extended.
The user should always check for errors and never expect a call to never fail.

Reviewed-by: Derek Buitenhuis <derek.buitenhuis@gmail.com>
Signed-off-by: James Almer <jamrial@gmail.com>
libavcodec/bsf.h