Yunqing Wang | c8f7a3b | 2020-05-04 15:23:48 -0700 | [diff] [blame] | 1 | /*!\mainpage AOMedia AV1 Codec |
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 | |
Yunqing Wang | c8f7a3b | 2020-05-04 15:23:48 -0700 | [diff] [blame] | 5 | \section aom_sdk AOMedia Codec SDK |
| 6 | |
| 7 | \subsection main_intro Introduction |
Yunqing Wang | 611502c | 2020-05-01 15:24:59 -0700 | [diff] [blame] | 8 | 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] | 9 | applications with the AOM and AV1 video codecs. |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 10 | |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 11 | This distribution of the AOMedia Codec SDK includes the following support: |
John Koleszar | 94c52e4 | 2010-06-18 12:39:21 -0400 | [diff] [blame] | 12 | |
Yunqing Wang | 611502c | 2020-05-01 15:24:59 -0700 | [diff] [blame] | 13 | \if av1_encoder |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 14 | - \ref aom_encoder |
James Zern | 6b7cf30 | 2012-03-15 16:51:51 -0700 | [diff] [blame] | 15 | \endif |
Yunqing Wang | 611502c | 2020-05-01 15:24:59 -0700 | [diff] [blame] | 16 | \if av1_decoder |
Yaowu Xu | f883b42 | 2016-08-30 14:01:10 -0700 | [diff] [blame] | 17 | - \ref aom_decoder |
James Zern | 6b7cf30 | 2012-03-15 16:51:51 -0700 | [diff] [blame] | 18 | \endif |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 19 | |
| 20 | |
Yunqing Wang | c8f7a3b | 2020-05-04 15:23:48 -0700 | [diff] [blame] | 21 | \subsection main_startpoints Starting Points |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 22 | - Consult the \ref changelog for a complete list of improvements in this |
| 23 | release. |
Yunqing Wang | 04caf8b | 2020-05-11 20:52:17 -0700 | [diff] [blame] | 24 | \if av1_md_support |
Yunqing Wang | 8d139f1 | 2020-05-13 17:00:36 -0700 | [diff] [blame] | 25 | - [README](\ref LREADME) contains instructions on compiling the sample applications. |
Yunqing Wang | 04caf8b | 2020-05-11 20:52:17 -0700 | [diff] [blame] | 26 | \else |
Johann | e07a675 | 2018-01-10 12:47:44 -0800 | [diff] [blame] | 27 | - \ref readme contains instructions on compiling the sample applications. |
Yunqing Wang | 04caf8b | 2020-05-11 20:52:17 -0700 | [diff] [blame] | 28 | \endif |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 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 |
Yaowu Xu | f5bbe24 | 2015-01-15 14:32:42 -0800 | [diff] [blame] | 33 | \if encoder |
| 34 | - \ref encoder reference |
| 35 | \endif |
| 36 | \if decoder |
| 37 | - \ref decoder reference |
| 38 | \endif |
Yunqing Wang | c8f7a3b | 2020-05-04 15:23:48 -0700 | [diff] [blame] | 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> |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 51 | |
| 52 | \section main_support Support Options & FAQ |
Debargha Mukherjee | a709244 | 2020-06-19 06:52:57 -0700 | [diff] [blame] | 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. |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 56 | */ |
| 57 | |
| 58 | /*!\page changelog CHANGELOG |
| 59 | \verbinclude CHANGELOG |
| 60 | */ |
| 61 | |
Yunqing Wang | 04caf8b | 2020-05-11 20:52:17 -0700 | [diff] [blame] | 62 | \ifnot av1_md_support |
Johann | e07a675 | 2018-01-10 12:47:44 -0800 | [diff] [blame] | 63 | /*!\page readme README.md |
| 64 | \include README.md |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 65 | */ |
Yunqing Wang | 04caf8b | 2020-05-11 20:52:17 -0700 | [diff] [blame] | 66 | \endif |
John Koleszar | 0ea50ce | 2010-05-18 11:58:33 -0400 | [diff] [blame] | 67 | |
| 68 | /*!\defgroup codecs Supported Codecs */ |