| Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 1 | /*!\mainpage AMedia Codec SDK |
| John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 2 | |
| 3 | \section main_contents Page Contents |
| 4 | - \ref main_intro |
| 5 | - \ref main_startpoints |
| 6 | - \ref main_support |
| 7 | |
| 8 | \section main_intro Introduction |
| Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 9 | Welcome to the AMedia Codec SDK. This SDK allows you to integrate your |
| 10 | applications with the AOM and AV1 video codecs. |
| John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 11 | |
| Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 12 | This distribution of the AOMedia Codec SDK includes the following support: |
| John Koleszar | 94c52e4 | 2010-06-18 12:39:21 -0400 | [diff] [blame] | 13 | |
| Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 14 | \if aom_encoder |
| 15 | - \ref aom_encoder |
| James Zern | 6b7cf30 | 2012-03-15 16:51:51 -0700 | [diff] [blame] | 16 | \endif |
| Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 17 | \if aom_decoder |
| 18 | - \ref aom_decoder |
| James Zern | 6b7cf30 | 2012-03-15 16:51:51 -0700 | [diff] [blame] | 19 | \endif |
| John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 20 | |
| 21 | |
| 22 | \section main_startpoints Starting Points |
| 23 | - Consult the \ref changelog for a complete list of improvements in this |
| 24 | release. |
| Johann | e07a675 | 2018-01-10 12:47:44 -0800 | [diff] [blame] | 25 | - \ref readme contains instructions on compiling the sample applications. |
| John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 26 | - Read the \ref usage "usage" for a narrative on codec usage. |
| 27 | - Read the \ref samples "sample code" for examples of how to interact with the |
| 28 | codec. |
| 29 | - \ref codec reference |
| Yaowu Xu | f5bbe24 | 2015-01-15 14:32:42 -0800 | [diff] [blame] | 30 | \if encoder |
| 31 | - \ref encoder reference |
| 32 | \endif |
| 33 | \if decoder |
| 34 | - \ref decoder reference |
| 35 | \endif |
| John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 36 | |
| 37 | \section main_support Support Options & FAQ |
| Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 38 | The AOMedia project is an open source project supported by its community. For |
| John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 39 | questions about this SDK, please mail the apps-devel@webmproject.org list. |
| 40 | To contribute, see http://www.webmproject.org/code/contribute and mail |
| James Zern | f42d52e | 2011-02-16 17:54:49 -0800 | [diff] [blame] | 41 | codec-devel@webmproject.org. |
| John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 42 | */ |
| 43 | |
| 44 | /*!\page changelog CHANGELOG |
| 45 | \verbinclude CHANGELOG |
| 46 | */ |
| 47 | |
| Johann | e07a675 | 2018-01-10 12:47:44 -0800 | [diff] [blame] | 48 | /*!\page readme README.md |
| 49 | \include README.md |
| John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 50 | */ |
| 51 | |
| 52 | /*!\defgroup codecs Supported Codecs */ |
