summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStephen Warren <swarren@nvidia.com>2010-02-10 14:51:58 -0800
committerAaron Plattner <aplattner@nvidia.com>2010-02-10 14:51:58 -0800
commit7a10510e181fdbc45943debd769c5bc6e963d802 (patch)
treef13a30fd651292a22b76f483a30c1f3bc0dea992
parent74b9e369ab9e3094742595b0f1deabe30f00cefc (diff)
More doc issues pointed out by Xine authors.
* Fix Doxygen warning; it gets confused by quotes. * Add subsection names, so part of the title doesn't get swallowed as the subsection name. * Document data required from MPEG-4 Part 2 & DivX bitstream. Signed-off-by: Aaron Plattner <aplattner@nvidia.com>
-rw-r--r--include/vdpau/vdpau.h13
-rw-r--r--include/vdpau/vdpau_x11.h4
2 files changed, 11 insertions, 6 deletions
diff --git a/include/vdpau/vdpau.h b/include/vdpau/vdpau.h
index e298bc6..022a113 100644
--- a/include/vdpau/vdpau.h
+++ b/include/vdpau/vdpau.h
@@ -372,12 +372,12 @@
* The exact data that should be passed to VDPAU is detailed below for each
* supported format:
*
- * \subsection MPEG-1 and MPEG-2
+ * \subsection bitstream_mpeg1_mpeg2 MPEG-1 and MPEG-2
*
* Include all slices beginning with start codes 0x00000101 through
* 0x000001AF. The slice start code must be included for all slices.
*
- * \subsection H.264
+ * \subsection bitstream_h264 H.264
*
* Include all NALs with nal_unit_type of 1 or 5 (coded slice of non-IDR/IDR
* picture respectively). The complete slice start code (including 0x000001
@@ -391,7 +391,7 @@
* - Multiple bitstream buffer array entries (e.g. one per slice) may point at
* the same physical data storage for the slice start code prefix.
*
- * \subsection VC-1 Simple and Main Profile
+ * \subsection bitstream_vc1_sp_mp VC-1 Simple and Main Profile
*
* VC-1 simple/main profile bitstreams always consist of a single slice per
* picture, and do not use start codes to delimit pictures. Instead, the
@@ -405,7 +405,7 @@
* this header information explicitly must not be included in the bitstream
* data passed to VDPAU for this encoding format.
*
- * \subsection VC-1 Advanced Profile
+ * \subsection bitstream_vc1_ap VC-1 Advanced Profile
*
* Include all slices beginning with start codes 0x0000010D (frame),
* 0x0000010C (field) or 0x0000010B (slice). The slice start code should be
@@ -427,6 +427,11 @@
* prevention bytes present in the original bitstream; do not remove these
* from the bitstream.
*
+ * \subsection bitstream_mpeg4part2 MPEG-4 Part 2 and DivX
+ *
+ * Include all slices beginning with start codes 0x000001B6. The slice start
+ * code must be included for all slices.
+ *
* \section video_mixer_usage Video Mixer Usage
*
* \subsection video_surface_content VdpVideoSurface Content
diff --git a/include/vdpau/vdpau_x11.h b/include/vdpau/vdpau_x11.h
index 5fe0089..ae5a377 100644
--- a/include/vdpau/vdpau_x11.h
+++ b/include/vdpau/vdpau_x11.h
@@ -34,8 +34,8 @@
* \file vdpau_x11.h
* \brief X11 Window System Integration Layer
*
- * This file contains the \ref api_winsys_x11 "X11 Window System
- * Integration Layer".
+ * This file contains the \ref api_winsys_x11 X11 Window System
+ * Integration Layer.
*/
#ifndef _VDPAU_X11_H