blob: 49dff7b5b80e76e23569558a9f75cf1274d62b9d [file] [log] [blame]
John Koleszar0ea50ce2010-05-18 11:58:33 -04001/*!\mainpage WebM VP8 Codec SDK
2
3 \section main_contents Page Contents
4 - \ref main_intro
5 - \ref main_startpoints
6 - \ref main_support
7
8 \section main_intro Introduction
9 Welcome to the WebM VP8 Codec SDK. This SDK allows you to integrate your
10 applications with the VP8 video codec, a high quality, royalty free, open
11 source codec deployed on millions of computers and devices worldwide.
12
13 This distribution of the WebM VP8 Codec SDK includes the following support:
John Koleszar94c52e42010-06-18 12:39:21 -040014
John Koleszar0ea50ce2010-05-18 11:58:33 -040015 \if vp8_encoder - \ref vp8_encoder \endif
16 \if vp8_decoder - \ref vp8_decoder \endif
17
18
19 \section main_startpoints Starting Points
20 - Consult the \ref changelog for a complete list of improvements in this
21 release.
22 - The \ref readme contains instructions on recompiling the sample applications.
23 - Read the \ref usage "usage" for a narrative on codec usage.
24 - Read the \ref samples "sample code" for examples of how to interact with the
25 codec.
26 - \ref codec reference
27 \if encoder - \ref encoder reference \endif
28 \if decoder - \ref decoder reference \endif
29
30 \section main_support Support Options & FAQ
31 The WebM project is an open source project supported by its community. For
32 questions about this SDK, please mail the apps-devel@webmproject.org list.
33 To contribute, see http://www.webmproject.org/code/contribute and mail
34 vpx-devel@webmproject.org.
35*/
36
37/*!\page changelog CHANGELOG
38 \verbinclude CHANGELOG
39*/
40
41/*!\page readme README
42 \verbinclude README
43*/
44
45/*!\defgroup codecs Supported Codecs */