mainpage.dox

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