summaryrefslogtreecommitdiffstats
path: root/media/ffvpx/libavutil/display.h
diff options
context:
space:
mode:
Diffstat (limited to 'media/ffvpx/libavutil/display.h')
-rw-r--r--media/ffvpx/libavutil/display.h27
1 files changed, 27 insertions, 0 deletions
diff --git a/media/ffvpx/libavutil/display.h b/media/ffvpx/libavutil/display.h
index 39c15ee6b..515adad79 100644
--- a/media/ffvpx/libavutil/display.h
+++ b/media/ffvpx/libavutil/display.h
@@ -18,6 +18,11 @@
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
+/**
+ * @file
+ * Display matrix
+ */
+
#ifndef AVUTIL_DISPLAY_H
#define AVUTIL_DISPLAY_H
@@ -25,15 +30,26 @@
#include "common.h"
/**
+ * @addtogroup lavu_video
+ * @{
+ *
+ * @defgroup lavu_video_display Display transformation matrix functions
+ * @{
+ */
+
+/**
+ * @addtogroup lavu_video_display
* The display transformation matrix specifies an affine transformation that
* should be applied to video frames for correct presentation. It is compatible
* with the matrices stored in the ISO/IEC 14496-12 container format.
*
* The data is a 3x3 matrix represented as a 9-element array:
*
+ * @code{.unparsed}
* | a b u |
* (a, b, u, c, d, v, x, y, w) -> | c d v |
* | x y w |
+ * @endcode
*
* All numbers are stored in native endianness, as 16.16 fixed-point values,
* except for u, v and w, which are stored as 2.30 fixed-point values.
@@ -41,15 +57,21 @@
* The transformation maps a point (p, q) in the source (pre-transformation)
* frame to the point (p', q') in the destination (post-transformation) frame as
* follows:
+ *
+ * @code{.unparsed}
* | a b u |
* (p, q, 1) . | c d v | = z * (p', q', 1)
* | x y w |
+ * @endcode
*
* The transformation can also be more explicitly written in components as
* follows:
+ *
+ * @code{.unparsed}
* p' = (a * p + c * q + x) / z;
* q' = (b * p + d * q + y) / z;
* z = u * p + v * q + w
+ * @endcode
*/
/**
@@ -84,4 +106,9 @@ void av_display_rotation_set(int32_t matrix[9], double angle);
*/
void av_display_matrix_flip(int32_t matrix[9], int hflip, int vflip);
+/**
+ * @}
+ * @}
+ */
+
#endif /* AVUTIL_DISPLAY_H */