frame: add a cropping rectangle to AVFrame
authorAnton Khirnov <anton@khirnov.net>
Sun, 18 Dec 2016 11:30:27 +0000 (12:30 +0100)
committerAnton Khirnov <anton@khirnov.net>
Thu, 12 Jan 2017 15:22:44 +0000 (16:22 +0100)
Extend the width/height doxy to clarify that it should store coded
values.

doc/APIchanges
libavutil/frame.c
libavutil/frame.h
libavutil/version.h

index 942337903f178f76497b1adf63da63ed1ad7051f..ba137650b611b77fff9f6cf62d6b40c2a576d84f 100644 (file)
@@ -13,6 +13,10 @@ libavutil:     2015-08-28
 
 API changes, most recent first:
 
+2016-xx-xx - xxxxxxx - lavu 55.30.0 - frame.h
+  Add AVFrame.crop_left/right/top/bottom fields for attaching cropping
+  information to video frames.
+
 2016-xx-xx - xxxxxxx
   Change av_sha_update() and av_md5_sum()/av_md5_update() length
   parameter type to size_t at next major bump.
index 1c14f5f03f0942ade6674039b645afca61302ec4..aafaa57d8b556b190994e1e4b3b624d588b1f75d 100644 (file)
@@ -390,6 +390,10 @@ int av_frame_copy_props(AVFrame *dst, const AVFrame *src)
     dst->key_frame              = src->key_frame;
     dst->pict_type              = src->pict_type;
     dst->sample_aspect_ratio    = src->sample_aspect_ratio;
+    dst->crop_top               = src->crop_top;
+    dst->crop_bottom            = src->crop_bottom;
+    dst->crop_left              = src->crop_left;
+    dst->crop_right             = src->crop_right;
     dst->pts                    = src->pts;
     dst->repeat_pict            = src->repeat_pict;
     dst->interlaced_frame       = src->interlaced_frame;
index 4052199fd3e3eaa2d95c5f827d0e095c89915870..c718f7bd62cc987cd867774adad24282859181bd 100644 (file)
@@ -25,6 +25,7 @@
 #ifndef AVUTIL_FRAME_H
 #define AVUTIL_FRAME_H
 
+#include <stddef.h>
 #include <stdint.h>
 
 #include "avutil.h"
@@ -180,9 +181,18 @@ typedef struct AVFrame {
     uint8_t **extended_data;
 
     /**
-     * width and height of the video frame
+     * @name Video dimensions
+     * Video frames only. The coded dimensions (in pixels) of the video frame,
+     * i.e. the size of the rectangle that contains some well-defined values.
+     *
+     * @note The part of the frame intended for display/presentation is further
+     * restricted by the @ref cropping "Cropping rectangle".
+     * @{
      */
     int width, height;
+    /**
+     * @}
+     */
 
     /**
      * number of audio samples (per channel) described by this frame
@@ -369,6 +379,22 @@ typedef struct AVFrame {
      * AVHWFramesContext describing the frame.
      */
     AVBufferRef *hw_frames_ctx;
+
+    /**
+     * @anchor cropping
+     * @name Cropping
+     * Video frames only. The number of pixels to discard from the the
+     * top/bottom/left/right border of the frame to obtain the sub-rectangle of
+     * the frame intended for presentation.
+     * @{
+     */
+    size_t crop_top;
+    size_t crop_bottom;
+    size_t crop_left;
+    size_t crop_right;
+    /**
+     * @}
+     */
 } AVFrame;
 
 /**
index 3733fea8102241b173b0c1efae1a6b61f70d9142..7856a0acc3f9f2c0061b9f6faab6f0321ede83de 100644 (file)
@@ -54,7 +54,7 @@
  */
 
 #define LIBAVUTIL_VERSION_MAJOR 55
-#define LIBAVUTIL_VERSION_MINOR 29
+#define LIBAVUTIL_VERSION_MINOR 30
 #define LIBAVUTIL_VERSION_MICRO  0
 
 #define LIBAVUTIL_VERSION_INT   AV_VERSION_INT(LIBAVUTIL_VERSION_MAJOR, \