lavu: Add a video section to Doxygen documentation

Fill it with AVStereo3D and AVDisplayMatrix documentation. Apply the necessary changes to make verbatim code look good in doxygen.

Vittorio Giovara committed 10 years ago

Commit 075acbb1 parent 624aa8a3 files · +72 −0Browse files

Unified · Split

3 files

libavutil/avutil.h +6 −0
libavutil/display.h +27 −0
libavutil/stereo3d.h +39 −0

libavutil/avutil.h+6−0

@@ -115,6 +115,12 @@ · 114 unmodified lines
115	115	*
116	116	* @}
117	117	*
	118	+ * @defgroup lavu_video Video related
	119	+ *
	120	+ * @{
	121	+ *
	122	+ * @}
	123	+ *
118	124	* @defgroup lavu_audio Audio related
119	125	*
120	126	* @{

libavutil/display.h+27−0

@@ -18,21 +18,37 @@ · 17 unmodified lines
18	18	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19	19	*/
20	20
	21	+/**
	22	+ * @file
	23	+ * Display matrix
	24	+ */
	25	+
21	26	#ifndef AVUTIL_DISPLAY_H
22	27	#define AVUTIL_DISPLAY_H
23	28
24	29	#include <stdint.h>
25	30
26	31	/**
	32	+ * @addtogroup lavu_video
	33	+ * @{
	34	+ *
	35	+ * @defgroup lavu_video_display Display transformation matrix functions
	36	+ * @{
	37	+ */
	38	+
	39	+/**
	40	+ * @addtogroup lavu_video_display
27	41	* The display transformation matrix specifies an affine transformation that
28	42	* should be applied to video frames for correct presentation. It is compatible
29	43	* with the matrices stored in the ISO/IEC 14496-12 container format.
30	44	*
31	45	* The data is a 3x3 matrix represented as a 9-element array:
32	46	*
	47	+ * @code{.unparsed}
33	48	* \| a b u \|
34	49	* (a, b, u, c, d, v, x, y, w) -> \| c d v \|
35	50	* \| x y w \|
	51	+ * @endcode
36	52	*
37	53	* All numbers are stored in native endianness, as 16.16 fixed-point values,
38	54	* except for u, v and w, which are stored as 2.30 fixed-point values.
@@ -40,15 +56,21 @@ · 1 unmodified line
40	56	* The transformation maps a point (p, q) in the source (pre-transformation)
41	57	* frame to the point (p', q') in the destination (post-transformation) frame as
42	58	* follows:
	59	+ *
	60	+ * @code{.unparsed}
43	61	* \| a b u \|
44	62	* (p, q, 1) . \| c d v \| = z * (p', q', 1)
45	63	* \| x y w \|
	64	+ * @endcode
46	65	*
47	66	* The transformation can also be more explicitly written in components as
48	67	* follows:
	68	+ *
	69	+ * @code{.unparsed}
49	70	* p' = (a * p + c * q + x) / z;
50	71	* q' = (b * p + d * q + y) / z;
51	72	* z = u * p + v * q + w
	73	+ * @endcode
52	74	*/
53	75
54	76	/**
@@ -83,4 +105,9 @@ void av_display_rotation_set(int32_t matrix[9], double angle); · 28 unmodified lines
83	105	*/
84	106	void av_display_matrix_flip(int32_t matrix[9], int hflip, int vflip);
85	107
	108	+/**
	109	+ * @}
	110	+ * @}
	111	+ */
	112	+
86	113	#endif /* AVUTIL_DISPLAY_H */

libavutil/stereo3d.h+39−0

@@ -18,6 +18,11 @@ · 17 unmodified lines
18	18	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19	19	*/
20	20
	21	+/**
	22	+ * @file
	23	+ * Stereoscopic video
	24	+ */
	25	+
21	26	#ifndef AVUTIL_STEREO3D_H
22	27	#define AVUTIL_STEREO3D_H
23	28
@@ -25,6 +30,21 @@ · 1 unmodified line
25	30
26	31	#include "frame.h"
27	32
	33	+/**
	34	+ * @addtogroup lavu_video
	35	+ * @{
	36	+ *
	37	+ * @defgroup lavu_video_stereo3d Stereo3D types and functions
	38	+ * @{
	39	+ */
	40	+
	41	+/**
	42	+ * @addtogroup lavu_video_stereo3d
	43	+ * A stereoscopic video file consists in multiple views embedded in a single
	44	+ * frame, usually describing two views of a scene. This file describes all
	45	+ * possible codec-independent view arrangements.
	46	+ * */
	47	+
28	48	/**
29	49	* List of possible 3D Types
30	50	*/
@@ -37,41 +57,49 @@ enum AVStereo3DType { · 6 unmodified lines
37	57	/**
38	58	* Views are next to each other.
39	59	*
	60	+ * @code{.unparsed}
40	61	* LLLLRRRR
41	62	* LLLLRRRR
42	63	* LLLLRRRR
43	64	* ...
	65	+ * @endcode
44	66	*/
45	67	AV_STEREO3D_SIDEBYSIDE,
46	68
47	69	/**
48	70	* Views are on top of each other.
49	71	*
	72	+ * @code{.unparsed}
50	73	* LLLLLLLL
51	74	* LLLLLLLL
52	75	* RRRRRRRR
53	76	* RRRRRRRR
	77	+ * @endcode
54	78	*/
55	79	AV_STEREO3D_TOPBOTTOM,
56	80
57	81	/**
58	82	* Views are alternated temporally.
59	83	*
	84	+ * @code{.unparsed}
60	85	* frame0 frame1 frame2 ...
61	86	* LLLLLLLL RRRRRRRR LLLLLLLL
62	87	* LLLLLLLL RRRRRRRR LLLLLLLL
63	88	* LLLLLLLL RRRRRRRR LLLLLLLL
64	89	* ... ... ...
	90	+ * @endcode
65	91	*/
66	92	AV_STEREO3D_FRAMESEQUENCE,
67	93
68	94	/**
69	95	* Views are packed in a checkerboard-like structure per pixel.
70	96	*
	97	+ * @code{.unparsed}
71	98	* LRLRLRLR
72	99	* RLRLRLRL
73	100	* LRLRLRLR
74	101	* ...
	102	+ * @endcode
75	103	*/
76	104	AV_STEREO3D_CHECKERBOARD,
77	105
@@ -79,30 +107,36 @@ enum AVStereo3DType { · 1 unmodified line
79	107	* Views are next to each other, but when upscaling
80	108	* apply a checkerboard pattern.
81	109	*
	110	+ * @code{.unparsed}
82	111	* LLLLRRRR L L L L R R R R
83	112	* LLLLRRRR => L L L L R R R R
84	113	* LLLLRRRR L L L L R R R R
85	114	* LLLLRRRR L L L L R R R R
	115	+ * @endcode
86	116	*/
87	117	AV_STEREO3D_SIDEBYSIDE_QUINCUNX,
88	118
89	119	/**
90	120	* Views are packed per line, as if interlaced.
91	121	*
	122	+ * @code{.unparsed}
92	123	* LLLLLLLL
93	124	* RRRRRRRR
94	125	* LLLLLLLL
95	126	* ...
	127	+ * @endcode
96	128	*/
97	129	AV_STEREO3D_LINES,
98	130
99	131	/**
100	132	* Views are packed per column.
101	133	*
	134	+ * @code{.unparsed}
102	135	* LRLRLRLR
103	136	* LRLRLRLR
104	137	* LRLRLRLR
105	138	* ...
	139	+ * @endcode
106	140	*/
107	141	AV_STEREO3D_COLUMNS,
108	142	};
@@ -167,4 +201,9 @@ const char *av_stereo3d_type_name(unsigned int type); · 58 unmodified lines
167	201	*/
168	202	int av_stereo3d_from_name(const char *name);
169	203
	204	+/**
	205	+ * @}
	206	+ * @}
	207	+ */
	208	+
170	209	#endif /* AVUTIL_STEREO3D_H */

lavu: Add a video section to Doxygen documentation

Keyboard shortcuts

General

Issues and pull requests

Issues, pull requests and Inbox

Repository code