summaryrefslogtreecommitdiffstats
path: root/third_party/aom/mainpage.dox
blob: 03a299ae1ab5793a49cadf08f878d941266a10eb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
/*!\mainpage AMedia Codec SDK

  \section main_contents Page Contents
  - \ref main_intro
  - \ref main_startpoints
  - \ref main_support

  \section main_intro Introduction
  Welcome to the AMedia Codec SDK. This SDK allows you to integrate your
  applications with the AOM and AV1 video codecs.

  This distribution of the AOMedia Codec SDK includes the following support:

  \if aom_encoder
  - \ref aom_encoder
  \endif
  \if aom_decoder
  - \ref aom_decoder
  \endif


  \section main_startpoints Starting Points
  - Consult the \ref changelog for a complete list of improvements in this
    release.
  - \ref readme contains instructions on compiling the sample applications.
  - Read the \ref usage "usage" for a narrative on codec usage.
  - Read the \ref samples "sample code" for examples of how to interact with the
    codec.
  - \ref codec reference
  \if encoder
  - \ref encoder reference
  \endif
  \if decoder
  - \ref decoder reference
  \endif

  \section main_support Support Options & FAQ
  The AOMedia project is an open source project supported by its community. For
  questions about this SDK, please mail the apps-devel@webmproject.org list.
  To contribute, see http://www.webmproject.org/code/contribute and mail
  codec-devel@webmproject.org.
*/

/*!\page changelog CHANGELOG
   \verbinclude CHANGELOG
*/

/*!\page readme README.md
   \include README.md
*/

/*!\defgroup codecs Supported Codecs */