[FFmpeg-cvslog] Merge commit '075acbb6ff5740b2eea1bb7dd3afbc8e66e2ebf8'
James Almer
git at videolan.org
Thu Apr 13 23:32:51 EEST 2017
ffmpeg | branch: master | James Almer <jamrial at gmail.com> | Thu Apr 13 17:31:15 2017 -0300| [7adfa7cdc6ddb873cacd211f4e18e28b3efbb3aa] | committer: James Almer
Merge commit '075acbb6ff5740b2eea1bb7dd3afbc8e66e2ebf8'
* commit '075acbb6ff5740b2eea1bb7dd3afbc8e66e2ebf8':
lavu: Add a video section to Doxygen documentation
Merged-by: James Almer <jamrial at gmail.com>
> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=7adfa7cdc6ddb873cacd211f4e18e28b3efbb3aa
---
libavutil/display.h | 27 +++++++++++++++++++++++++++
libavutil/stereo3d.h | 39 +++++++++++++++++++++++++++++++++++++++
2 files changed, 66 insertions(+)
diff --git a/libavutil/display.h b/libavutil/display.h
index 39c15ee6b8..515adad795 100644
--- a/libavutil/display.h
+++ b/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 */
diff --git a/libavutil/stereo3d.h b/libavutil/stereo3d.h
index 2cfe47051b..54f4c4c5c7 100644
--- a/libavutil/stereo3d.h
+++ b/libavutil/stereo3d.h
@@ -18,6 +18,11 @@
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
+/**
+ * @file
+ * Stereoscopic video
+ */
+
#ifndef AVUTIL_STEREO3D_H
#define AVUTIL_STEREO3D_H
@@ -26,6 +31,21 @@
#include "frame.h"
/**
+ * @addtogroup lavu_video
+ * @{
+ *
+ * @defgroup lavu_video_stereo3d Stereo3D types and functions
+ * @{
+ */
+
+/**
+ * @addtogroup lavu_video_stereo3d
+ * A stereoscopic video file consists in multiple views embedded in a single
+ * frame, usually describing two views of a scene. This file describes all
+ * possible codec-independent view arrangements.
+ * */
+
+/**
* List of possible 3D Types
*/
enum AVStereo3DType {
@@ -37,41 +57,49 @@ enum AVStereo3DType {
/**
* Views are next to each other.
*
+ * @code{.unparsed}
* LLLLRRRR
* LLLLRRRR
* LLLLRRRR
* ...
+ * @endcode
*/
AV_STEREO3D_SIDEBYSIDE,
/**
* Views are on top of each other.
*
+ * @code{.unparsed}
* LLLLLLLL
* LLLLLLLL
* RRRRRRRR
* RRRRRRRR
+ * @endcode
*/
AV_STEREO3D_TOPBOTTOM,
/**
* Views are alternated temporally.
*
+ * @code{.unparsed}
* frame0 frame1 frame2 ...
* LLLLLLLL RRRRRRRR LLLLLLLL
* LLLLLLLL RRRRRRRR LLLLLLLL
* LLLLLLLL RRRRRRRR LLLLLLLL
* ... ... ...
+ * @endcode
*/
AV_STEREO3D_FRAMESEQUENCE,
/**
* Views are packed in a checkerboard-like structure per pixel.
*
+ * @code{.unparsed}
* LRLRLRLR
* RLRLRLRL
* LRLRLRLR
* ...
+ * @endcode
*/
AV_STEREO3D_CHECKERBOARD,
@@ -79,30 +107,36 @@ enum AVStereo3DType {
* Views are next to each other, but when upscaling
* apply a checkerboard pattern.
*
+ * @code{.unparsed}
* LLLLRRRR L L L L R R R R
* LLLLRRRR => L L L L R R R R
* LLLLRRRR L L L L R R R R
* LLLLRRRR L L L L R R R R
+ * @endcode
*/
AV_STEREO3D_SIDEBYSIDE_QUINCUNX,
/**
* Views are packed per line, as if interlaced.
*
+ * @code{.unparsed}
* LLLLLLLL
* RRRRRRRR
* LLLLLLLL
* ...
+ * @endcode
*/
AV_STEREO3D_LINES,
/**
* Views are packed per column.
*
+ * @code{.unparsed}
* LRLRLRLR
* LRLRLRLR
* LRLRLRLR
* ...
+ * @endcode
*/
AV_STEREO3D_COLUMNS,
};
@@ -167,4 +201,9 @@ const char *av_stereo3d_type_name(unsigned int type);
*/
int av_stereo3d_from_name(const char *name);
+/**
+ * @}
+ * @}
+ */
+
#endif /* AVUTIL_STEREO3D_H */
======================================================================
diff --cc libavutil/display.h
index 39c15ee6b8,2d869fcd16..515adad795
--- a/libavutil/display.h
+++ b/libavutil/display.h
@@@ -22,9 -27,17 +27,18 @@@
#define AVUTIL_DISPLAY_H
#include <stdint.h>
+#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.
More information about the ffmpeg-cvslog
mailing list