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