blob: 10924acbcf111750cdb27f494ed4e201f9184f95 [file] [log] [blame]
Yunqing Wangc8f7a3b2020-05-04 15:23:48 -07001/*!\mainpage AOMedia AV1 Codec
John Koleszar0ea50ce2010-05-18 11:58:33 -04002
Yunqing Wang0fd27732020-05-04 14:48:28 -07003 \tableofcontents
John Koleszar0ea50ce2010-05-18 11:58:33 -04004
Yunqing Wangc8f7a3b2020-05-04 15:23:48 -07005 \section aom_sdk AOMedia Codec SDK
6
7 \subsection main_intro Introduction
Yunqing Wang611502c2020-05-01 15:24:59 -07008 Welcome to the AOMedia Codec SDK. This SDK allows you to integrate your
Yaowu Xuf883b422016-08-30 14:01:10 -07009 applications with the AOM and AV1 video codecs.
John Koleszar0ea50ce2010-05-18 11:58:33 -040010
Yaowu Xuf883b422016-08-30 14:01:10 -070011 This distribution of the AOMedia Codec SDK includes the following support:
John Koleszar94c52e42010-06-18 12:39:21 -040012
Yunqing Wang611502c2020-05-01 15:24:59 -070013 \if av1_encoder
Yaowu Xuf883b422016-08-30 14:01:10 -070014 - \ref aom_encoder
James Zern6b7cf302012-03-15 16:51:51 -070015 \endif
Yunqing Wang611502c2020-05-01 15:24:59 -070016 \if av1_decoder
Yaowu Xuf883b422016-08-30 14:01:10 -070017 - \ref aom_decoder
James Zern6b7cf302012-03-15 16:51:51 -070018 \endif
John Koleszar0ea50ce2010-05-18 11:58:33 -040019
20
Yunqing Wangc8f7a3b2020-05-04 15:23:48 -070021 \subsection main_startpoints Starting Points
John Koleszar0ea50ce2010-05-18 11:58:33 -040022 - Consult the \ref changelog for a complete list of improvements in this
23 release.
Yunqing Wang04caf8b2020-05-11 20:52:17 -070024 \if av1_md_support
Yunqing Wang8d139f12020-05-13 17:00:36 -070025 - [README](\ref LREADME) contains instructions on compiling the sample applications.
Yunqing Wang04caf8b2020-05-11 20:52:17 -070026 \else
Johanne07a6752018-01-10 12:47:44 -080027 - \ref readme contains instructions on compiling the sample applications.
Yunqing Wang04caf8b2020-05-11 20:52:17 -070028 \endif
John Koleszar0ea50ce2010-05-18 11:58:33 -040029 - 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 Xuf5bbe242015-01-15 14:32:42 -080033 \if encoder
34 - \ref encoder reference
35 \endif
36 \if decoder
37 - \ref decoder reference
38 \endif
Yunqing Wangc8f7a3b2020-05-04 15:23:48 -070039 <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 Koleszar0ea50ce2010-05-18 11:58:33 -040051
52 \section main_support Support Options & FAQ
Debargha Mukherjeea7092442020-06-19 06:52:57 -070053 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 Koleszar0ea50ce2010-05-18 11:58:33 -040056*/
57
58/*!\page changelog CHANGELOG
59 \verbinclude CHANGELOG
60*/
61
Yunqing Wang04caf8b2020-05-11 20:52:17 -070062\ifnot av1_md_support
Johanne07a6752018-01-10 12:47:44 -080063/*!\page readme README.md
64 \include README.md
John Koleszar0ea50ce2010-05-18 11:58:33 -040065*/
Yunqing Wang04caf8b2020-05-11 20:52:17 -070066\endif
John Koleszar0ea50ce2010-05-18 11:58:33 -040067
68/*!\defgroup codecs Supported Codecs */