xref: /aosp_15_r20/external/libaom/mainpage.dox (revision 77c1e3ccc04c968bd2bc212e87364f250e820521)
1*77c1e3ccSAndroid Build Coastguard Worker/*!\mainpage AOMedia AV1 Codec
2*77c1e3ccSAndroid Build Coastguard Worker
3*77c1e3ccSAndroid Build Coastguard Worker  \tableofcontents
4*77c1e3ccSAndroid Build Coastguard Worker
5*77c1e3ccSAndroid Build Coastguard Worker  \section aom_sdk AOMedia Codec SDK
6*77c1e3ccSAndroid Build Coastguard Worker
7*77c1e3ccSAndroid Build Coastguard Worker  \subsection main_intro Introduction
8*77c1e3ccSAndroid Build Coastguard Worker  Welcome to the AOMedia Codec SDK. This SDK allows you to integrate your
9*77c1e3ccSAndroid Build Coastguard Worker  applications with the AOM and AV1 video codecs.
10*77c1e3ccSAndroid Build Coastguard Worker
11*77c1e3ccSAndroid Build Coastguard Worker  This distribution of the AOMedia Codec SDK includes the following support:
12*77c1e3ccSAndroid Build Coastguard Worker
13*77c1e3ccSAndroid Build Coastguard Worker  \if av1_encoder
14*77c1e3ccSAndroid Build Coastguard Worker  - \ref aom_encoder
15*77c1e3ccSAndroid Build Coastguard Worker  \endif
16*77c1e3ccSAndroid Build Coastguard Worker  \if av1_decoder
17*77c1e3ccSAndroid Build Coastguard Worker  - \ref aom_decoder
18*77c1e3ccSAndroid Build Coastguard Worker  \endif
19*77c1e3ccSAndroid Build Coastguard Worker
20*77c1e3ccSAndroid Build Coastguard Worker
21*77c1e3ccSAndroid Build Coastguard Worker  \subsection main_startpoints Starting Points
22*77c1e3ccSAndroid Build Coastguard Worker  - Consult the \ref changelog for a complete list of improvements in this
23*77c1e3ccSAndroid Build Coastguard Worker    release.
24*77c1e3ccSAndroid Build Coastguard Worker  \if av1_md_support
25*77c1e3ccSAndroid Build Coastguard Worker  - [README](\ref LREADME) contains instructions on compiling the sample applications.
26*77c1e3ccSAndroid Build Coastguard Worker  \else
27*77c1e3ccSAndroid Build Coastguard Worker  - \ref readme contains instructions on compiling the sample applications.
28*77c1e3ccSAndroid Build Coastguard Worker  \endif
29*77c1e3ccSAndroid Build Coastguard Worker  - Read the \ref usage "usage" for a narrative on codec usage.
30*77c1e3ccSAndroid Build Coastguard Worker  - Read the \ref samples "sample code" for examples of how to interact with the
31*77c1e3ccSAndroid Build Coastguard Worker    codec.
32*77c1e3ccSAndroid Build Coastguard Worker  - \ref codec reference
33*77c1e3ccSAndroid Build Coastguard Worker  \if encoder
34*77c1e3ccSAndroid Build Coastguard Worker  - \ref encoder reference
35*77c1e3ccSAndroid Build Coastguard Worker  \endif
36*77c1e3ccSAndroid Build Coastguard Worker  \if decoder
37*77c1e3ccSAndroid Build Coastguard Worker  - \ref decoder reference
38*77c1e3ccSAndroid Build Coastguard Worker  \endif
39*77c1e3ccSAndroid Build Coastguard Worker  <br>
40*77c1e3ccSAndroid Build Coastguard Worker
41*77c1e3ccSAndroid Build Coastguard Worker  \section av1_guide AV1 Developer's Guide
42*77c1e3ccSAndroid Build Coastguard Worker
43*77c1e3ccSAndroid Build Coastguard Worker  \if av1_encoder
44*77c1e3ccSAndroid Build Coastguard Worker  - \ref encoder_guide
45*77c1e3ccSAndroid Build Coastguard Worker  \endif
46*77c1e3ccSAndroid Build Coastguard Worker
47*77c1e3ccSAndroid Build Coastguard Worker  \if av1_decoder
48*77c1e3ccSAndroid Build Coastguard Worker  - \ref decoder_guide
49*77c1e3ccSAndroid Build Coastguard Worker  \endif
50*77c1e3ccSAndroid Build Coastguard Worker  <br>
51*77c1e3ccSAndroid Build Coastguard Worker
52*77c1e3ccSAndroid Build Coastguard Worker  \section main_support Support Options & FAQ
53*77c1e3ccSAndroid Build Coastguard Worker  The AOMedia project is an open source project supported by its community.
54*77c1e3ccSAndroid Build Coastguard Worker  For questions about this SDK or for help, please visit http://aomedia.org/
55*77c1e3ccSAndroid Build Coastguard Worker  and email the [email protected] list.
56*77c1e3ccSAndroid Build Coastguard Worker*/
57*77c1e3ccSAndroid Build Coastguard Worker
58*77c1e3ccSAndroid Build Coastguard Worker/*!\page changelog CHANGELOG
59*77c1e3ccSAndroid Build Coastguard Worker   \verbinclude CHANGELOG
60*77c1e3ccSAndroid Build Coastguard Worker*/
61*77c1e3ccSAndroid Build Coastguard Worker
62*77c1e3ccSAndroid Build Coastguard Worker\ifnot av1_md_support
63*77c1e3ccSAndroid Build Coastguard Worker/*!\page readme README.md
64*77c1e3ccSAndroid Build Coastguard Worker   \include README.md
65*77c1e3ccSAndroid Build Coastguard Worker*/
66*77c1e3ccSAndroid Build Coastguard Worker\endif
67*77c1e3ccSAndroid Build Coastguard Worker
68*77c1e3ccSAndroid Build Coastguard Worker/*!\defgroup codecs Supported Codecs */
69