xref: /aosp_15_r20/external/libvpx/mainpage.dox (revision fb1b10ab9aebc7c7068eedab379b749d7e3900be)
1*fb1b10abSAndroid Build Coastguard Worker/*!\mainpage WebM Codec SDK
2*fb1b10abSAndroid Build Coastguard Worker
3*fb1b10abSAndroid Build Coastguard Worker  \section main_contents Page Contents
4*fb1b10abSAndroid Build Coastguard Worker  - \ref main_intro
5*fb1b10abSAndroid Build Coastguard Worker  - \ref main_startpoints
6*fb1b10abSAndroid Build Coastguard Worker  - \ref main_support
7*fb1b10abSAndroid Build Coastguard Worker
8*fb1b10abSAndroid Build Coastguard Worker  \section main_intro Introduction
9*fb1b10abSAndroid Build Coastguard Worker  Welcome to the WebM Codec SDK. This SDK allows you to integrate your
10*fb1b10abSAndroid Build Coastguard Worker  applications with the VP8 and VP9 video codecs, high quality, royalty free,
11*fb1b10abSAndroid Build Coastguard Worker  open source codecs deployed on billions of computers and devices worldwide.
12*fb1b10abSAndroid Build Coastguard Worker
13*fb1b10abSAndroid Build Coastguard Worker  This distribution of the WebM Codec SDK includes the following support:
14*fb1b10abSAndroid Build Coastguard Worker
15*fb1b10abSAndroid Build Coastguard Worker  \if vp8_encoder
16*fb1b10abSAndroid Build Coastguard Worker  - \ref vp8_encoder
17*fb1b10abSAndroid Build Coastguard Worker  \endif
18*fb1b10abSAndroid Build Coastguard Worker  \if vp8_decoder
19*fb1b10abSAndroid Build Coastguard Worker  - \ref vp8_decoder
20*fb1b10abSAndroid Build Coastguard Worker  \endif
21*fb1b10abSAndroid Build Coastguard Worker
22*fb1b10abSAndroid Build Coastguard Worker
23*fb1b10abSAndroid Build Coastguard Worker  \section main_startpoints Starting Points
24*fb1b10abSAndroid Build Coastguard Worker  - Consult the \ref changelog for a complete list of improvements in this
25*fb1b10abSAndroid Build Coastguard Worker    release.
26*fb1b10abSAndroid Build Coastguard Worker  - The \ref readme contains instructions on recompiling the sample applications.
27*fb1b10abSAndroid Build Coastguard Worker  - Read the \ref usage "usage" for a narrative on codec usage.
28*fb1b10abSAndroid Build Coastguard Worker  \if samples
29*fb1b10abSAndroid Build Coastguard Worker  - Read the \ref samples "sample code" for examples of how to interact with the
30*fb1b10abSAndroid Build Coastguard Worker    codec.
31*fb1b10abSAndroid Build Coastguard Worker  \endif
32*fb1b10abSAndroid Build Coastguard Worker  - \ref codec reference
33*fb1b10abSAndroid Build Coastguard Worker  \if encoder
34*fb1b10abSAndroid Build Coastguard Worker  - \ref encoder reference
35*fb1b10abSAndroid Build Coastguard Worker  \endif
36*fb1b10abSAndroid Build Coastguard Worker  \if decoder
37*fb1b10abSAndroid Build Coastguard Worker  - \ref decoder reference
38*fb1b10abSAndroid Build Coastguard Worker  \endif
39*fb1b10abSAndroid Build Coastguard Worker
40*fb1b10abSAndroid Build Coastguard Worker  \section main_support Support Options & FAQ
41*fb1b10abSAndroid Build Coastguard Worker  The WebM project is an open source project supported by its community. For
42*fb1b10abSAndroid Build Coastguard Worker  questions about this SDK, please mail the [email protected] list.
43*fb1b10abSAndroid Build Coastguard Worker  To contribute, see http://www.webmproject.org/code/contribute and mail
44*fb1b10abSAndroid Build Coastguard Worker  [email protected].
45*fb1b10abSAndroid Build Coastguard Worker*/
46*fb1b10abSAndroid Build Coastguard Worker
47*fb1b10abSAndroid Build Coastguard Worker/*!\page changelog CHANGELOG
48*fb1b10abSAndroid Build Coastguard Worker   \verbinclude CHANGELOG
49*fb1b10abSAndroid Build Coastguard Worker*/
50*fb1b10abSAndroid Build Coastguard Worker
51*fb1b10abSAndroid Build Coastguard Worker/*!\page readme README
52*fb1b10abSAndroid Build Coastguard Worker   \verbinclude README
53*fb1b10abSAndroid Build Coastguard Worker*/
54*fb1b10abSAndroid Build Coastguard Worker
55*fb1b10abSAndroid Build Coastguard Worker/*!\defgroup codecs Supported Codecs */
56