mainpage.dox 1.39 KB
Newer Older
1
/*!\mainpage AMedia Codec SDK
John Koleszar's avatar
John Koleszar committed
2 3 4 5 6 7 8

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

  \section main_intro Introduction
9 10
  Welcome to the AMedia Codec SDK. This SDK allows you to integrate your
  applications with the AOM and AV1 video codecs.
John Koleszar's avatar
John Koleszar committed
11

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

14 15
  \if aom_encoder
  - \ref aom_encoder
16
  \endif
17 18
  \if aom_decoder
  - \ref aom_decoder
19
  \endif
John Koleszar's avatar
John Koleszar committed
20 21 22 23 24


  \section main_startpoints Starting Points
  - Consult the \ref changelog for a complete list of improvements in this
    release.
Johann's avatar
Johann committed
25
  - \ref readme contains instructions on compiling the sample applications.
John Koleszar's avatar
John Koleszar committed
26 27 28 29
  - 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
30 31 32 33 34 35
  \if encoder
  - \ref encoder reference
  \endif
  \if decoder
  - \ref decoder reference
  \endif
John Koleszar's avatar
John Koleszar committed
36 37

  \section main_support Support Options & FAQ
38
  The AOMedia project is an open source project supported by its community. For
John Koleszar's avatar
John Koleszar committed
39 40
  questions about this SDK, please mail the apps-devel@webmproject.org list.
  To contribute, see http://www.webmproject.org/code/contribute and mail
41
  codec-devel@webmproject.org.
John Koleszar's avatar
John Koleszar committed
42 43 44 45 46 47
*/

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

Johann's avatar
Johann committed
48 49
/*!\page readme README.md
   \include README.md
John Koleszar's avatar
John Koleszar committed
50 51 52
*/

/*!\defgroup codecs Supported Codecs */