[FFmpeg-devel] lavu/frame: fix typo for ROI (region of interest) documentation

Submitted by Guo, Yejun on May 31, 2019, 8:02 a.m.

Details

Message ID 1559289740-25708-1-git-send-email-yejun.guo@intel.com
State New
Headers show

Commit Message

Guo, Yejun May 31, 2019, 8:02 a.m.
there is already a nice patch set to fix the ROI documentation, but it
is pending, see https://lists.ffmpeg.org/pipermail/ffmpeg-devel/2019-May/244440.html

so just fix this obvious typo that the document does not match the code.

Signed-off-by: Guo, Yejun <yejun.guo@intel.com>
---
 libavutil/frame.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Steven Liu June 1, 2019, 12:28 a.m.
> 在 2019年5月31日,16:02,Guo, Yejun <yejun.guo@intel.com> 写道:
> 
> there is already a nice patch set to fix the ROI documentation, but it
> is pending, see https://lists.ffmpeg.org/pipermail/ffmpeg-devel/2019-May/244440.html
> 
> so just fix this obvious typo that the document does not match the code.
> 
> Signed-off-by: Guo, Yejun <yejun.guo@intel.com>
> ---
> libavutil/frame.h | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/libavutil/frame.h b/libavutil/frame.h
> index 8aa3e88..eebb2c0 100644
> --- a/libavutil/frame.h
> +++ b/libavutil/frame.h
> @@ -212,7 +212,7 @@ typedef struct AVFrameSideData {
>  * self_size specifies the size of this data structure. This value
>  * should be set to sizeof(AVRegionOfInterest). EINVAL is returned if self_size is zero.
>  *
> - * Number of pixels to discard from the top/bottom/left/right border of
> + * Number of pixels to discard from the top-left corner of
>  * the frame to obtain the region of interest of the frame.
>  * They are encoder dependent and will be extended internally
>  * if the codec requires an alignment.
> -- 
> 2.7.4
> 
> _______________________________________________
> ffmpeg-devel mailing list
> ffmpeg-devel@ffmpeg.org
> https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
> 
> To unsubscribe, visit link above, or email
> ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".

LGTM

Thanks
Steven

Patch hide | download patch | download mbox

diff --git a/libavutil/frame.h b/libavutil/frame.h
index 8aa3e88..eebb2c0 100644
--- a/libavutil/frame.h
+++ b/libavutil/frame.h
@@ -212,7 +212,7 @@  typedef struct AVFrameSideData {
  * self_size specifies the size of this data structure. This value
  * should be set to sizeof(AVRegionOfInterest). EINVAL is returned if self_size is zero.
  *
- * Number of pixels to discard from the top/bottom/left/right border of
+ * Number of pixels to discard from the top-left corner of
  * the frame to obtain the region of interest of the frame.
  * They are encoder dependent and will be extended internally
  * if the codec requires an alignment.