diff options
| author | James Almer <jamrial@gmail.com> | 2017-04-13 17:31:15 -0300 |
|---|---|---|
| committer | James Almer <jamrial@gmail.com> | 2017-04-13 17:31:15 -0300 |
| commit | 7adfa7cdc6ddb873cacd211f4e18e28b3efbb3aa (patch) | |
| tree | 8c575ca447036c9eecd10e183b268d4b52fa587b /libavutil/stereo3d.h | |
| parent | 7d3bb052c8b9756e6fd40c32a88627dc58b0bc50 (diff) | |
| parent | 075acbb6ff5740b2eea1bb7dd3afbc8e66e2ebf8 (diff) | |
Merge commit '075acbb6ff5740b2eea1bb7dd3afbc8e66e2ebf8'
* commit '075acbb6ff5740b2eea1bb7dd3afbc8e66e2ebf8':
lavu: Add a video section to Doxygen documentation
Merged-by: James Almer <jamrial@gmail.com>
Diffstat (limited to 'libavutil/stereo3d.h')
| -rw-r--r-- | libavutil/stereo3d.h | 39 |
1 files changed, 39 insertions, 0 deletions
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 */ |