RepoMirrors
/
ffmpeg
mirror of https://git.ffmpeg.org/ffmpeg.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

avcodec/v4l2_buffers: More clear return code documentation 

Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
This commit is contained in:
Michael Niedermayer 2017-09-29 02:28:42 +02:00
parent 64e034da95
commit 4bb8013335
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
libavcodec/v4l2_buffers.h
View File

@ -65,8 +65,8 @@ typedef struct V4L2Buffer {
* @param[in] frame The AVFRame to push the information to
* @param[in] buf The V4L2Buffer to get the information from
*
* @returns 0 in case of success, EINVAL if the number of planes is incorrect,
* ENOMEM if the AVBufferRef cant be created.
* @returns 0 in case of success, AVERROR(EINVAL) if the number of planes is incorrect,
* AVERROR(ENOMEM) if the AVBufferRef cant be created.
*/
int ff_v4l2_buffer_buf_to_avframe(AVFrame *frame, V4L2Buffer *buf);
@ -76,8 +76,8 @@ int ff_v4l2_buffer_buf_to_avframe(AVFrame *frame, V4L2Buffer *buf);
* @param[in] pkt The AVPacket to push the information to
* @param[in] buf The V4L2Buffer to get the information from
*
* @returns 0 in case of success, EINVAL if the number of planes is incorrect,
* ENOMEM if the AVBufferRef cant be created.
* @returns 0 in case of success, AVERROR(EINVAL) if the number of planes is incorrect,
* AVERROR(ENOMEM) if the AVBufferRef cant be created.
*
*/
int ff_v4l2_buffer_buf_to_avpkt(AVPacket *pkt, V4L2Buffer *buf);
@ -88,7 +88,7 @@ int ff_v4l2_buffer_buf_to_avpkt(AVPacket *pkt, V4L2Buffer *buf);
* @param[in] frame AVPacket to get the data from
* @param[in] avbuf V4L2Bfuffer to push the information to
*
* @returns 0 in case of success, negative otherwise
* @returns 0 in case of success, a negative AVERROR code otherwise
*/
int ff_v4l2_buffer_avpkt_to_buf(const AVPacket *pkt, V4L2Buffer *out);
@ -98,7 +98,7 @@ int ff_v4l2_buffer_avpkt_to_buf(const AVPacket *pkt, V4L2Buffer *out);
* @param[in] frame AVFrame to get the data from
* @param[in] avbuf V4L2Bfuffer to push the information to
*
* @returns 0 in case of success, negative otherwise
* @returns 0 in case of success, a negative AVERROR code otherwise
*/
int ff_v4l2_buffer_avframe_to_buf(const AVFrame *frame, V4L2Buffer* out);
@ -108,7 +108,7 @@ int ff_v4l2_buffer_avframe_to_buf(const AVFrame *frame, V4L2Buffer* out);
* @param[in] avbuf V4L2Bfuffer to initialize
* @param[in] index v4l2 buffer id
*
* @returns 0 in case of success, negative otherwise
* @returns 0 in case of success, a negative AVERROR code otherwise
*/
int ff_v4l2_buffer_initialize(V4L2Buffer* avbuf, int index);
@ -117,7 +117,7 @@ int ff_v4l2_buffer_initialize(V4L2Buffer* avbuf, int index);
*
* @param[in] avbuf V4L2Bfuffer to push to the driver
*
* @returns 0 in case of success, negative otherwise
* @returns 0 in case of success, a negative AVERROR code otherwise
*/
int ff_v4l2_buffer_enqueue(V4L2Buffer* avbuf);