Hi!

Attached patch tries to improve the ROI documentation wording, C
structs cannot return errors.

Please comment, Carl Eugen
From 4abd545e7ab463c97bf816b270544eee25c4755b Mon Sep 17 00:00:00 2001
From: Carl Eugen Hoyos <ceffm...@gmail.com>
Date: Fri, 18 Jan 2019 12:35:44 +0100
Subject: [PATCH] lavu/frame: Try to improve the documentation wording.

C structs cannot return errors.
---
 libavutil/frame.h |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/libavutil/frame.h b/libavutil/frame.h
index 8aa3e88..1990320 100644
--- a/libavutil/frame.h
+++ b/libavutil/frame.h
@@ -218,8 +218,8 @@ typedef struct AVFrameSideData {
  * if the codec requires an alignment.
  * If the regions overlap, the last value in the list will be used.
  *
- * qoffset is quant offset, and base rule here:
- * returns EINVAL if AVRational.den is zero.
+ * qoffset is quantization offset:
+ * Encoders will return EINVAL if qoffset.den is zero.
  * the value (num/den) range is [-1.0, 1.0], clamp to +-1.0 if out of range.
  * 0 means no picture quality change,
  * negative offset asks for better quality (and the best with value -1.0),
-- 
1.7.10.4

_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
http://ffmpeg.org/mailman/listinfo/ffmpeg-devel

Reply via email to