mainpage.dox 1.6 KB

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