]> granicus.if.org Git - libx264/commitdiff
x264.h: fix documentation
authorFiona Glaser <fiona@x264.com>
Mon, 10 Mar 2014 15:42:50 +0000 (08:42 -0700)
committerFiona Glaser <fiona@x264.com>
Wed, 12 Mar 2014 04:10:22 +0000 (21:10 -0700)
The full details of the return values of encoder_encode and encoder_headers
were mistakenly removed a while ago; re-add them.

x264.h

diff --git a/x264.h b/x264.h
index 6ad6308082a0a3dacbdd8e6d5b809448b71f10c2..b94e4a99cfe2cb70317a4e58cb97d5d25d65295d 100644 (file)
--- a/x264.h
+++ b/x264.h
@@ -884,13 +884,15 @@ void    x264_encoder_parameters( x264_t *, x264_param_t * );
 /* x264_encoder_headers:
  *      return the SPS and PPS that will be used for the whole stream.
  *      *pi_nal is the number of NAL units outputted in pp_nal.
+ *      returns the number of bytes in the returned NALs.
  *      returns negative on error.
  *      the payloads of all output NALs are guaranteed to be sequential in memory. */
 int     x264_encoder_headers( x264_t *, x264_nal_t **pp_nal, int *pi_nal );
 /* x264_encoder_encode:
  *      encode one picture.
  *      *pi_nal is the number of NAL units outputted in pp_nal.
- *      returns negative on error, zero if no NAL units returned.
+ *      returns the number of bytes in the returned NALs.
+ *      returns negative on error and zero if no NAL units returned.
  *      the payloads of all output NALs are guaranteed to be sequential in memory. */
 int     x264_encoder_encode( x264_t *, x264_nal_t **pp_nal, int *pi_nal, x264_picture_t *pic_in, x264_picture_t *pic_out );
 /* x264_encoder_close: