aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorflim <flim@google.com>2016-01-26 14:33:44 +0100
committerflim <flim@google.com>2016-03-04 17:40:32 +0100
commitc91ee5b5642fcc4969150f73d5f6848f88bf1638 (patch)
tree900cb39b975dfed729e37e5810fef61fd92d7a70 /doc
parent1391dbf0ccd121ce7a49d30e2142d36c8d404990 (diff)
downloadlibopus-c91ee5b5642fcc4969150f73d5f6848f88bf1638.tar.gz
Change-Id: I8211751bab026ab236a612c6e0873f8bdbcd6c98
Diffstat (limited to 'doc')
-rw-r--r--doc/Doxyfile.in2
-rw-r--r--doc/Makefile.in136
-rw-r--r--doc/TODO7
-rw-r--r--doc/customdoxygen.css551
-rw-r--r--doc/opus_logo.svg20
-rw-r--r--doc/trivial_example.c6
6 files changed, 394 insertions, 328 deletions
diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in
index 8a63d5e8..0c016f32 100644
--- a/doc/Doxyfile.in
+++ b/doc/Doxyfile.in
@@ -611,7 +611,7 @@ WARN_LOGFILE =
# with spaces.
INPUT = @top_srcdir@/include/opus.h \
- @top_srcdir@/include/opus_types.h \
+ @top_srcdir@/include/opus_types.h \
@top_srcdir@/include/opus_defines.h \
@top_srcdir@/include/opus_multistream.h \
@top_srcdir@/include/opus_custom.h
diff --git a/doc/Makefile.in b/doc/Makefile.in
index 7f76fd63..0e308aaf 100644
--- a/doc/Makefile.in
+++ b/doc/Makefile.in
@@ -1,9 +1,8 @@
-# Makefile.in generated by automake 1.11.6 from Makefile.am.
+# Makefile.in generated by automake 1.15 from Makefile.am.
# @configure_input@
-# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
-# 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 Free Software
-# Foundation, Inc.
+# Copyright (C) 1994-2014 Free Software Foundation, Inc.
+
# This Makefile.in is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
# with or without modifications, as long as this notice is preserved.
@@ -15,23 +14,61 @@
@SET_MAKE@
VPATH = @srcdir@
-am__make_dryrun = \
- { \
- am__dry=no; \
+am__is_gnu_make = { \
+ if test -z '$(MAKELEVEL)'; then \
+ false; \
+ elif test -n '$(MAKE_HOST)'; then \
+ true; \
+ elif test -n '$(MAKE_VERSION)' && test -n '$(CURDIR)'; then \
+ true; \
+ else \
+ false; \
+ fi; \
+}
+am__make_running_with_option = \
+ case $${target_option-} in \
+ ?) ;; \
+ *) echo "am__make_running_with_option: internal error: invalid" \
+ "target option '$${target_option-}' specified" >&2; \
+ exit 1;; \
+ esac; \
+ has_opt=no; \
+ sane_makeflags=$$MAKEFLAGS; \
+ if $(am__is_gnu_make); then \
+ sane_makeflags=$$MFLAGS; \
+ else \
case $$MAKEFLAGS in \
*\\[\ \ ]*) \
- echo 'am--echo: ; @echo "AM" OK' | $(MAKE) -f - 2>/dev/null \
- | grep '^AM OK$$' >/dev/null || am__dry=yes;; \
- *) \
- for am__flg in $$MAKEFLAGS; do \
- case $$am__flg in \
- *=*|--*) ;; \
- *n*) am__dry=yes; break;; \
- esac; \
- done;; \
+ bs=\\; \
+ sane_makeflags=`printf '%s\n' "$$MAKEFLAGS" \
+ | sed "s/$$bs$$bs[$$bs $$bs ]*//g"`;; \
+ esac; \
+ fi; \
+ skip_next=no; \
+ strip_trailopt () \
+ { \
+ flg=`printf '%s\n' "$$flg" | sed "s/$$1.*$$//"`; \
+ }; \
+ for flg in $$sane_makeflags; do \
+ test $$skip_next = yes && { skip_next=no; continue; }; \
+ case $$flg in \
+ *=*|--*) continue;; \
+ -*I) strip_trailopt 'I'; skip_next=yes;; \
+ -*I?*) strip_trailopt 'I';; \
+ -*O) strip_trailopt 'O'; skip_next=yes;; \
+ -*O?*) strip_trailopt 'O';; \
+ -*l) strip_trailopt 'l'; skip_next=yes;; \
+ -*l?*) strip_trailopt 'l';; \
+ -[dEDm]) skip_next=yes;; \
+ -[JT]) skip_next=yes;; \
+ esac; \
+ case $$flg in \
+ *$$target_option*) has_opt=yes; break;; \
esac; \
- test $$am__dry = yes; \
- }
+ done; \
+ test $$has_opt = yes
+am__make_dryrun = (target_option=n; $(am__make_running_with_option))
+am__make_keepgoing = (target_option=k; $(am__make_running_with_option))
pkgdatadir = $(datadir)/@PACKAGE@
pkgincludedir = $(includedir)/@PACKAGE@
pkglibdir = $(libdir)/@PACKAGE@
@@ -51,25 +88,31 @@ POST_UNINSTALL = :
build_triplet = @build@
host_triplet = @host@
subdir = doc
-DIST_COMMON = $(srcdir)/Doxyfile.in $(srcdir)/Makefile.am \
- $(srcdir)/Makefile.in
ACLOCAL_M4 = $(top_srcdir)/aclocal.m4
am__aclocal_m4_deps = $(top_srcdir)/m4/as-gcc-inline-assembly.m4 \
$(top_srcdir)/m4/libtool.m4 $(top_srcdir)/m4/ltoptions.m4 \
$(top_srcdir)/m4/ltsugar.m4 $(top_srcdir)/m4/ltversion.m4 \
- $(top_srcdir)/m4/lt~obsolete.m4 $(top_srcdir)/configure.ac
+ $(top_srcdir)/m4/lt~obsolete.m4 \
+ $(top_srcdir)/m4/opus-intrinsics.m4 $(top_srcdir)/configure.ac
am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \
$(ACLOCAL_M4)
+DIST_COMMON = $(srcdir)/Makefile.am $(am__DIST_COMMON)
mkinstalldirs = $(install_sh) -d
CONFIG_HEADER = $(top_builddir)/config.h
CONFIG_CLEAN_FILES = Doxyfile
CONFIG_CLEAN_VPATH_FILES =
+AM_V_P = $(am__v_P_@AM_V@)
+am__v_P_ = $(am__v_P_@AM_DEFAULT_V@)
+am__v_P_0 = false
+am__v_P_1 = :
AM_V_GEN = $(am__v_GEN_@AM_V@)
am__v_GEN_ = $(am__v_GEN_@AM_DEFAULT_V@)
-am__v_GEN_0 = @echo " GEN " $@;
+am__v_GEN_0 = @echo " GEN " $@;
+am__v_GEN_1 =
AM_V_at = $(am__v_at_@AM_V@)
am__v_at_ = $(am__v_at_@AM_DEFAULT_V@)
am__v_at_0 = @
+am__v_at_1 =
SOURCES =
DIST_SOURCES =
am__can_run_installinfo = \
@@ -77,11 +120,15 @@ am__can_run_installinfo = \
n|no|NO) false;; \
*) (install-info --version) >/dev/null 2>&1;; \
esac
+am__tagged_files = $(HEADERS) $(SOURCES) $(TAGS_FILES) $(LISP)
+am__DIST_COMMON = $(srcdir)/Doxyfile.in $(srcdir)/Makefile.in TODO
DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST)
ACLOCAL = @ACLOCAL@
AMTAR = @AMTAR@
AM_DEFAULT_VERBOSITY = @AM_DEFAULT_VERBOSITY@
AR = @AR@
+ARM2GNU_PARAMS = @ARM2GNU_PARAMS@
+ARM_NEON_INTR_CFLAGS = @ARM_NEON_INTR_CFLAGS@
AUTOCONF = @AUTOCONF@
AUTOHEADER = @AUTOHEADER@
AUTOMAKE = @AUTOMAKE@
@@ -107,6 +154,7 @@ EGREP = @EGREP@
EXEEXT = @EXEEXT@
FGREP = @FGREP@
GREP = @GREP@
+HAVE_ARM_NE10 = @HAVE_ARM_NE10@
HAVE_DOXYGEN = @HAVE_DOXYGEN@
HAVE_PERL = @HAVE_PERL@
INSTALL = @INSTALL@
@@ -127,6 +175,8 @@ MAINT = @MAINT@
MAKEINFO = @MAKEINFO@
MANIFEST_TOOL = @MANIFEST_TOOL@
MKDIR_P = @MKDIR_P@
+NE10_CFLAGS = @NE10_CFLAGS@
+NE10_LIBS = @NE10_LIBS@
NM = @NM@
NMEDIT = @NMEDIT@
OBJDUMP = @OBJDUMP@
@@ -134,10 +184,15 @@ OBJEXT = @OBJEXT@
OPUS_ARM_MAY_HAVE_EDSP = @OPUS_ARM_MAY_HAVE_EDSP@
OPUS_ARM_MAY_HAVE_MEDIA = @OPUS_ARM_MAY_HAVE_MEDIA@
OPUS_ARM_MAY_HAVE_NEON = @OPUS_ARM_MAY_HAVE_NEON@
+OPUS_ARM_NEON_INTR_CFLAGS = @OPUS_ARM_NEON_INTR_CFLAGS@
OPUS_HAVE_RTCD = @OPUS_HAVE_RTCD@
OPUS_LT_AGE = @OPUS_LT_AGE@
OPUS_LT_CURRENT = @OPUS_LT_CURRENT@
OPUS_LT_REVISION = @OPUS_LT_REVISION@
+OPUS_X86_AVX_CFLAGS = @OPUS_X86_AVX_CFLAGS@
+OPUS_X86_SSE2_CFLAGS = @OPUS_X86_SSE2_CFLAGS@
+OPUS_X86_SSE4_1_CFLAGS = @OPUS_X86_SSE4_1_CFLAGS@
+OPUS_X86_SSE_CFLAGS = @OPUS_X86_SSE_CFLAGS@
OTOOL = @OTOOL@
OTOOL64 = @OTOOL64@
PACKAGE = @PACKAGE@
@@ -155,6 +210,10 @@ SET_MAKE = @SET_MAKE@
SHELL = @SHELL@
STRIP = @STRIP@
VERSION = @VERSION@
+X86_AVX_CFLAGS = @X86_AVX_CFLAGS@
+X86_SSE2_CFLAGS = @X86_SSE2_CFLAGS@
+X86_SSE4_1_CFLAGS = @X86_SSE4_1_CFLAGS@
+X86_SSE_CFLAGS = @X86_SSE_CFLAGS@
abs_builddir = @abs_builddir@
abs_srcdir = @abs_srcdir@
abs_top_builddir = @abs_top_builddir@
@@ -234,7 +293,6 @@ $(srcdir)/Makefile.in: @MAINTAINER_MODE_TRUE@ $(srcdir)/Makefile.am $(am__confi
echo ' cd $(top_srcdir) && $(AUTOMAKE) --gnu doc/Makefile'; \
$(am__cd) $(top_srcdir) && \
$(AUTOMAKE) --gnu doc/Makefile
-.PRECIOUS: Makefile
Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status
@case '$?' in \
*config.status*) \
@@ -260,11 +318,11 @@ mostlyclean-libtool:
clean-libtool:
-rm -rf .libs _libs
-tags: TAGS
-TAGS:
+tags TAGS:
-ctags: CTAGS
-CTAGS:
+ctags CTAGS:
+
+cscope cscopelist:
distdir: $(DISTFILES)
@@ -332,9 +390,9 @@ distclean-generic:
maintainer-clean-generic:
@echo "This command is intended for maintainers to use"
@echo "it deletes files that may require special tools to rebuild."
+@HAVE_DOXYGEN_FALSE@clean-local:
@HAVE_DOXYGEN_FALSE@uninstall-local:
@HAVE_DOXYGEN_FALSE@install-data-local:
-@HAVE_DOXYGEN_FALSE@clean-local:
clean: clean-am
clean-am: clean-generic clean-libtool clean-local mostlyclean-am
@@ -404,17 +462,19 @@ uninstall-am: uninstall-local
.MAKE: install-am install-strip
.PHONY: all all-am all-local check check-am clean clean-generic \
- clean-libtool clean-local distclean distclean-generic \
- distclean-libtool distdir dvi dvi-am html html-am info info-am \
- install install-am install-data install-data-am \
- install-data-local install-dvi install-dvi-am install-exec \
- install-exec-am install-html install-html-am install-info \
- install-info-am install-man install-pdf install-pdf-am \
- install-ps install-ps-am install-strip installcheck \
- installcheck-am installdirs maintainer-clean \
+ clean-libtool clean-local cscopelist-am ctags-am distclean \
+ distclean-generic distclean-libtool distdir dvi dvi-am html \
+ html-am info info-am install install-am install-data \
+ install-data-am install-data-local install-dvi install-dvi-am \
+ install-exec install-exec-am install-html install-html-am \
+ install-info install-info-am install-man install-pdf \
+ install-pdf-am install-ps install-ps-am install-strip \
+ installcheck installcheck-am installdirs maintainer-clean \
maintainer-clean-generic mostlyclean mostlyclean-generic \
- mostlyclean-libtool pdf pdf-am ps ps-am uninstall uninstall-am \
- uninstall-local
+ mostlyclean-libtool pdf pdf-am ps ps-am tags-am uninstall \
+ uninstall-am uninstall-local
+
+.PRECIOUS: Makefile
@HAVE_DOXYGEN_TRUE@all-local: doxygen-build.stamp
diff --git a/doc/TODO b/doc/TODO
new file mode 100644
index 00000000..9e1c2d51
--- /dev/null
+++ b/doc/TODO
@@ -0,0 +1,7 @@
+define audio bandwidth as frequency range
+
+repeat padding recommendation
+
+ptime: refer to RFC
+
+Opus does not provide any confidentiality or integrity protection
diff --git a/doc/customdoxygen.css b/doc/customdoxygen.css
index 4bce44db..70047787 100644
--- a/doc/customdoxygen.css
+++ b/doc/customdoxygen.css
@@ -1,62 +1,62 @@
/* The standard CSS for doxygen */
body, table, div, p, dl {
- font-family: Lucida Grande, Verdana, Geneva, Arial, sans-serif;
- font-size: 13px;
- line-height: 1.3;
+ font-family: Lucida Grande, Verdana, Geneva, Arial, sans-serif;
+ font-size: 13px;
+ line-height: 1.3;
}
/* @group Heading Levels */
h1 {
- font-size: 150%;
+ font-size: 150%;
}
.title {
- font-size: 150%;
- font-weight: bold;
- margin: 10px 2px;
+ font-size: 150%;
+ font-weight: bold;
+ margin: 10px 2px;
}
h2 {
- font-size: 120%;
+ font-size: 120%;
}
h3 {
- font-size: 100%;
+ font-size: 100%;
}
dt {
- font-weight: bold;
+ font-weight: bold;
}
div.multicol {
- -moz-column-gap: 1em;
- -webkit-column-gap: 1em;
- -moz-column-count: 3;
- -webkit-column-count: 3;
+ -moz-column-gap: 1em;
+ -webkit-column-gap: 1em;
+ -moz-column-count: 3;
+ -webkit-column-count: 3;
}
p.startli, p.startdd, p.starttd {
- margin-top: 2px;
+ margin-top: 2px;
}
p.endli {
- margin-bottom: 0px;
+ margin-bottom: 0px;
}
p.enddd {
- margin-bottom: 4px;
+ margin-bottom: 4px;
}
p.endtd {
- margin-bottom: 2px;
+ margin-bottom: 2px;
}
/* @end */
caption {
- font-weight: bold;
+ font-weight: bold;
}
span.legend {
@@ -70,45 +70,45 @@ h3.version {
}
div.qindex, div.navtab{
- background-color: #F1F1F1;
- border: 1px solid #BDBDBD;
- text-align: center;
+ background-color: #F1F1F1;
+ border: 1px solid #BDBDBD;
+ text-align: center;
}
div.qindex, div.navpath {
- width: 100%;
- line-height: 140%;
+ width: 100%;
+ line-height: 140%;
}
div.navtab {
- margin-right: 15px;
+ margin-right: 15px;
}
/* @group Link Styling */
a {
- color: #646464;
- font-weight: normal;
- text-decoration: none;
+ color: #646464;
+ font-weight: normal;
+ text-decoration: none;
}
.contents a:visited {
- color: #747474;
+ color: #747474;
}
a:hover {
- text-decoration: underline;
+ text-decoration: underline;
}
a.qindex {
- font-weight: bold;
+ font-weight: bold;
}
a.qindexHL {
- font-weight: bold;
- background-color: #B8B8B8;
- color: #ffffff;
- border: 1px double #A8A8A8;
+ font-weight: bold;
+ background-color: #B8B8B8;
+ color: #ffffff;
+ border: 1px double #A8A8A8;
}
.contents a.qindexHL:visited {
@@ -116,181 +116,181 @@ a.qindexHL {
}
a.el {
- font-weight: bold;
+ font-weight: bold;
}
a.elRef {
}
a.code, a.code:visited {
- color: #4665A2;
+ color: #4665A2;
}
a.codeRef, a.codeRef:visited {
- color: #4665A2;
+ color: #4665A2;
}
/* @end */
dl.el {
- margin-left: -1cm;
+ margin-left: -1cm;
}
.fragment {
- font-family: monospace, fixed;
- font-size: 105%;
+ font-family: monospace, fixed;
+ font-size: 105%;
}
pre.fragment {
- border: 1px solid #D5D5D5;
- background-color: #FCFCFC;
- padding: 4px 6px;
- margin: 4px 8px 4px 2px;
- overflow: auto;
- word-wrap: break-word;
- font-size: 9pt;
- line-height: 125%;
+ border: 1px solid #D5D5D5;
+ background-color: #FCFCFC;
+ padding: 4px 6px;
+ margin: 4px 8px 4px 2px;
+ overflow: auto;
+ word-wrap: break-word;
+ font-size: 9pt;
+ line-height: 125%;
}
div.ah {
- background-color: black;
- font-weight: bold;
- color: #ffffff;
- margin-bottom: 3px;
- margin-top: 3px;
- padding: 0.2em;
- border: solid thin #333;
- border-radius: 0.5em;
- -webkit-border-radius: .5em;
- -moz-border-radius: .5em;
- box-shadow: 2px 2px 3px #999;
- -webkit-box-shadow: 2px 2px 3px #999;
- -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px;
- background-image: -webkit-gradient(linear, left top, left bottom, from(#eee), to(#000),color-stop(0.3, #444));
- background-image: -moz-linear-gradient(center top, #eee 0%, #444 40%, #000);
+ background-color: black;
+ font-weight: bold;
+ color: #ffffff;
+ margin-bottom: 3px;
+ margin-top: 3px;
+ padding: 0.2em;
+ border: solid thin #333;
+ border-radius: 0.5em;
+ -webkit-border-radius: .5em;
+ -moz-border-radius: .5em;
+ box-shadow: 2px 2px 3px #999;
+ -webkit-box-shadow: 2px 2px 3px #999;
+ -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px;
+ background-image: -webkit-gradient(linear, left top, left bottom, from(#eee), to(#000),color-stop(0.3, #444));
+ background-image: -moz-linear-gradient(center top, #eee 0%, #444 40%, #000);
}
div.groupHeader {
- margin-left: 16px;
- margin-top: 12px;
- font-weight: bold;
+ margin-left: 16px;
+ margin-top: 12px;
+ font-weight: bold;
}
div.groupText {
- margin-left: 16px;
- font-style: italic;
+ margin-left: 16px;
+ font-style: italic;
}
body {
- background-color: white;
- color: black;
+ background-color: white;
+ color: black;
margin: 0;
}
div.contents {
- margin-top: 10px;
- margin-left: 8px;
- margin-right: 8px;
+ margin-top: 10px;
+ margin-left: 8px;
+ margin-right: 8px;
}
td.indexkey {
- background-color: #F1F1F1;
- font-weight: bold;
- border: 1px solid #D5D5D5;
- margin: 2px 0px 2px 0;
- padding: 2px 10px;
+ background-color: #F1F1F1;
+ font-weight: bold;
+ border: 1px solid #D5D5D5;
+ margin: 2px 0px 2px 0;
+ padding: 2px 10px;
white-space: nowrap;
vertical-align: top;
}
td.indexvalue {
- background-color: #F1F1F1;
- border: 1px solid #D5D5D5;
- padding: 2px 10px;
- margin: 2px 0px;
+ background-color: #F1F1F1;
+ border: 1px solid #D5D5D5;
+ padding: 2px 10px;
+ margin: 2px 0px;
}
tr.memlist {
- background-color: #F2F2F2;
+ background-color: #F2F2F2;
}
p.formulaDsp {
- text-align: center;
+ text-align: center;
}
img.formulaDsp {
-
+
}
img.formulaInl {
- vertical-align: middle;
+ vertical-align: middle;
}
div.center {
- text-align: center;
+ text-align: center;
margin-top: 0px;
margin-bottom: 0px;
padding: 0px;
}
div.center img {
- border: 0px;
+ border: 0px;
}
address.footer {
- text-align: right;
- padding-right: 12px;
+ text-align: right;
+ padding-right: 12px;
}
img.footer {
- border: 0px;
- vertical-align: middle;
+ border: 0px;
+ vertical-align: middle;
}
/* @group Code Colorization */
span.keyword {
- color: #008000
+ color: #008000
}
span.keywordtype {
- color: #604020
+ color: #604020
}
span.keywordflow {
- color: #e08000
+ color: #e08000
}
span.comment {
- color: #800000
+ color: #800000
}
span.preprocessor {
- color: #806020
+ color: #806020
}
span.stringliteral {
- color: #002080
+ color: #002080
}
span.charliteral {
- color: #008080
+ color: #008080
}
-span.vhdldigit {
- color: #ff00ff
+span.vhdldigit {
+ color: #ff00ff
}
-span.vhdlchar {
- color: #000000
+span.vhdlchar {
+ color: #000000
}
-span.vhdlkeyword {
- color: #700070
+span.vhdlkeyword {
+ color: #700070
}
-span.vhdllogic {
- color: #ff0000
+span.vhdllogic {
+ color: #ff0000
}
blockquote {
@@ -304,71 +304,71 @@ blockquote {
/*
.search {
- color: #003399;
- font-weight: bold;
+ color: #003399;
+ font-weight: bold;
}
form.search {
- margin-bottom: 0px;
- margin-top: 0px;
+ margin-bottom: 0px;
+ margin-top: 0px;
}
input.search {
- font-size: 75%;
- color: #000080;
- font-weight: normal;
- background-color: #e8eef2;
+ font-size: 75%;
+ color: #000080;
+ font-weight: normal;
+ background-color: #e8eef2;
}
*/
td.tiny {
- font-size: 75%;
+ font-size: 75%;
}
.dirtab {
- padding: 4px;
- border-collapse: collapse;
- border: 1px solid #BDBDBD;
+ padding: 4px;
+ border-collapse: collapse;
+ border: 1px solid #BDBDBD;
}
th.dirtab {
- background: #F1F1F1;
- font-weight: bold;
+ background: #F1F1F1;
+ font-weight: bold;
}
hr {
- height: 0px;
- border: none;
- border-top: 1px solid #7A7A7A;
+ height: 0px;
+ border: none;
+ border-top: 1px solid #7A7A7A;
}
hr.footer {
- height: 1px;
+ height: 1px;
}
/* @group Member Descriptions */
table.memberdecls {
- border-spacing: 0px;
- padding: 0px;
+ border-spacing: 0px;
+ padding: 0px;
}
.mdescLeft, .mdescRight,
.memItemLeft, .memItemRight,
.memTemplItemLeft, .memTemplItemRight, .memTemplParams {
- background-color: #FAFAFA;
- border: none;
- margin: 4px;
- padding: 1px 0 0 8px;
+ background-color: #FAFAFA;
+ border: none;
+ margin: 4px;
+ padding: 1px 0 0 8px;
}
.mdescLeft, .mdescRight {
- padding: 0px 8px 4px 8px;
- color: #555;
+ padding: 0px 8px 4px 8px;
+ color: #555;
}
.memItemLeft, .memItemRight, .memTemplParams {
- border-top: 1px solid #D5D5D5;
+ border-top: 1px solid #D5D5D5;
}
.memItemLeft, .memTemplItemLeft {
@@ -376,11 +376,11 @@ table.memberdecls {
}
.memItemRight {
- width: 100%;
+ width: 100%;
}
.memTemplParams {
- color: #747474;
+ color: #747474;
white-space: nowrap;
}
@@ -391,29 +391,29 @@ table.memberdecls {
/* Styles for detailed member documentation */
.memtemplate {
- font-size: 80%;
- color: #747474;
- font-weight: normal;
- margin-left: 9px;
+ font-size: 80%;
+ color: #747474;
+ font-weight: normal;
+ margin-left: 9px;
}
.memnav {
- background-color: #F1F1F1;
- border: 1px solid #BDBDBD;
- text-align: center;
- margin: 2px;
- margin-right: 15px;
- padding: 2px;
+ background-color: #F1F1F1;
+ border: 1px solid #BDBDBD;
+ text-align: center;
+ margin: 2px;
+ margin-right: 15px;
+ padding: 2px;
}
.mempage {
- width: 100%;
+ width: 100%;
}
.memitem {
- padding: 0;
- margin-bottom: 10px;
- margin-right: 5px;
+ padding: 0;
+ margin-bottom: 10px;
+ margin-right: 5px;
}
.memname {
@@ -449,9 +449,9 @@ table.memberdecls {
}
.memdoc, dl.reflist dd {
- border-bottom: 1px solid #C0C0C0;
- border-left: 1px solid #C0C0C0;
- border-right: 1px solid #C0C0C0;
+ border-bottom: 1px solid #C0C0C0;
+ border-left: 1px solid #C0C0C0;
+ border-right: 1px solid #C0C0C0;
padding: 2px 5px;
background-color: #FCFCFC;
border-top-width: 0;
@@ -481,35 +481,35 @@ dl.reflist dd {
}
.paramkey {
- text-align: right;
+ text-align: right;
}
.paramtype {
- white-space: nowrap;
+ white-space: nowrap;
}
.paramname {
- color: #602020;
- white-space: nowrap;
+ color: #602020;
+ white-space: nowrap;
}
.paramname em {
- font-style: normal;
+ font-style: normal;
}
.params, .retval, .exception, .tparams {
border-spacing: 6px 2px;
-}
+}
.params .paramname, .retval .paramname {
font-weight: bold;
vertical-align: top;
}
-
+
.params .paramtype {
font-style: italic;
vertical-align: top;
-}
-
+}
+
.params .paramdir {
font-family: "courier new",courier,monospace;
vertical-align: top;
@@ -525,22 +525,22 @@ dl.reflist dd {
/* for the tree view */
.ftvtree {
- font-family: sans-serif;
- margin: 0px;
+ font-family: sans-serif;
+ margin: 0px;
}
/* these are for tree view when used as main index */
.directory {
- font-size: 9pt;
- font-weight: bold;
- margin: 5px;
+ font-size: 9pt;
+ font-weight: bold;
+ margin: 5px;
}
.directory h3 {
- margin: 0px;
- margin-top: 1em;
- font-size: 11pt;
+ margin: 0px;
+ margin-top: 1em;
+ font-size: 11pt;
}
/*
@@ -552,62 +552,62 @@ proper pixel height of your image.
/*
.directory h3.swap {
- height: 61px;
- background-repeat: no-repeat;
- background-image: url("yourimage.gif");
+ height: 61px;
+ background-repeat: no-repeat;
+ background-image: url("yourimage.gif");
}
.directory h3.swap span {
- display: none;
+ display: none;
}
*/
.directory > h3 {
- margin-top: 0;
+ margin-top: 0;
}
.directory p {
- margin: 0px;
- white-space: nowrap;
+ margin: 0px;
+ white-space: nowrap;
}
.directory div {
- display: none;
- margin: 0px;
+ display: none;
+ margin: 0px;
}
.directory img {
- vertical-align: -30%;
+ vertical-align: -30%;
}
/* these are for tree view when not used as main index */
.directory-alt {
- font-size: 100%;
- font-weight: bold;
+ font-size: 100%;
+ font-weight: bold;
}
.directory-alt h3 {
- margin: 0px;
- margin-top: 1em;
- font-size: 11pt;
+ margin: 0px;
+ margin-top: 1em;
+ font-size: 11pt;
}
.directory-alt > h3 {
- margin-top: 0;
+ margin-top: 0;
}
.directory-alt p {
- margin: 0px;
- white-space: nowrap;
+ margin: 0px;
+ white-space: nowrap;
}
.directory-alt div {
- display: none;
- margin: 0px;
+ display: none;
+ margin: 0px;
}
.directory-alt img {
- vertical-align: -30%;
+ vertical-align: -30%;
}
/* @end */
@@ -617,27 +617,27 @@ div.dynheader {
}
address {
- font-style: normal;
- color: #464646;
+ font-style: normal;
+ color: #464646;
}
table.doxtable {
- border-collapse:collapse;
+ border-collapse:collapse;
margin-top: 4px;
margin-bottom: 4px;
}
table.doxtable td, table.doxtable th {
- border: 1px solid #4A4A4A;
- padding: 3px 7px 2px;
+ border: 1px solid #4A4A4A;
+ padding: 3px 7px 2px;
}
table.doxtable th {
- background-color: #5B5B5B;
- color: #FFFFFF;
- font-size: 110%;
- padding-bottom: 4px;
- padding-top: 5px;
+ background-color: #5B5B5B;
+ color: #FFFFFF;
+ font-size: 110%;
+ padding-bottom: 4px;
+ padding-top: 5px;
}
table.fieldtable {
@@ -693,52 +693,52 @@ table.fieldtable {
.tabsearch {
- top: 0px;
- left: 10px;
- height: 36px;
- background-image: url('tab_b.png');
- z-index: 101;
- overflow: hidden;
- font-size: 13px;
+ top: 0px;
+ left: 10px;
+ height: 36px;
+ background-image: url('tab_b.png');
+ z-index: 101;
+ overflow: hidden;
+ font-size: 13px;
}
.navpath ul
{
- font-size: 11px;
- background-image:url('tab_b.png');
- background-repeat:repeat-x;
- height:30px;
- line-height:30px;
- color:#ABABAB;
- border:solid 1px #D3D3D3;
- overflow:hidden;
- margin:0px;
- padding:0px;
+ font-size: 11px;
+ background-image:url('tab_b.png');
+ background-repeat:repeat-x;
+ height:30px;
+ line-height:30px;
+ color:#ABABAB;
+ border:solid 1px #D3D3D3;
+ overflow:hidden;
+ margin:0px;
+ padding:0px;
}
.navpath li
{
- list-style-type:none;
- float:left;
- padding-left:10px;
- padding-right:15px;
- background-image:url('bc_s.png');
- background-repeat:no-repeat;
- background-position:right;
- color:#595959;
+ list-style-type:none;
+ float:left;
+ padding-left:10px;
+ padding-right:15px;
+ background-image:url('bc_s.png');
+ background-repeat:no-repeat;
+ background-position:right;
+ color:#595959;
}
.navpath li.navelem a
{
- height:32px;
- display:block;
- text-decoration: none;
- outline: none;
+ height:32px;
+ display:block;
+ text-decoration: none;
+ outline: none;
}
.navpath li.navelem a:hover
{
- color:#929292;
+ color:#929292;
}
.navpath li.footer
@@ -757,44 +757,44 @@ table.fieldtable {
div.summary
{
- float: right;
- font-size: 8pt;
- padding-right: 5px;
- width: 50%;
- text-align: right;
-}
+ float: right;
+ font-size: 8pt;
+ padding-right: 5px;
+ width: 50%;
+ text-align: right;
+}
div.summary a
{
- white-space: nowrap;
+ white-space: nowrap;
}
div.ingroups
{
- margin-left: 5px;
- font-size: 8pt;
- padding-left: 5px;
- width: 50%;
- text-align: left;
+ margin-left: 5px;
+ font-size: 8pt;
+ padding-left: 5px;
+ width: 50%;
+ text-align: left;
}
div.ingroups a
{
- white-space: nowrap;
+ white-space: nowrap;
}
div.header
{
background-image:url('nav_h.png');
background-repeat:repeat-x;
- background-color: #FAFAFA;
- margin: 0px;
- border-bottom: 1px solid #D5D5D5;
+ background-color: #FAFAFA;
+ margin: 0px;
+ border-bottom: 1px solid #D5D5D5;
}
div.headertitle
{
- padding: 5px 5px 5px 7px;
+ padding: 5px 5px 5px 7px;
}
dl
@@ -845,49 +845,49 @@ dl.bug
}
dl.section dd {
- margin-bottom: 6px;
+ margin-bottom: 6px;
}
#projectlogo
{
- text-align: center;
- vertical-align: bottom;
- border-collapse: separate;
+ text-align: center;
+ vertical-align: bottom;
+ border-collapse: separate;
}
-
+
#projectlogo img
-{
- border: 0px none;
+{
+ border: 0px none;
}
-
+
#projectname
{
- font: 300% Tahoma, Arial,sans-serif;
- margin: 0px;
- padding: 2px 0px;
+ font: 300% Tahoma, Arial,sans-serif;
+ margin: 0px;
+ padding: 2px 0px;
}
-
+
#projectbrief
{
- font: 120% Tahoma, Arial,sans-serif;
- margin: 0px;
- padding: 0px;
+ font: 120% Tahoma, Arial,sans-serif;
+ margin: 0px;
+ padding: 0px;
}
#projectnumber
{
- font: 100% Tahoma, Arial,sans-serif;
- margin: 0px;
- padding: 0px;
+ font: 100% Tahoma, Arial,sans-serif;
+ margin: 0px;
+ padding: 0px;
}
#titlearea
{
- padding: 0px;
- margin: 0px;
- width: 100%;
- border-bottom: 1px solid #848484;
+ padding: 0px;
+ margin: 0px;
+ width: 100%;
+ border-bottom: 1px solid #848484;
}
.image
@@ -907,12 +907,12 @@ dl.section dd {
.caption
{
- font-weight: bold;
+ font-weight: bold;
}
div.zoom
{
- border: 1px solid #AFAFAF;
+ border: 1px solid #AFAFAF;
}
dl.citelist {
@@ -953,7 +953,7 @@ div.toc li {
div.toc h3 {
font: bold 12px/1.2 Arial,FreeSans,sans-serif;
- color: #747474;
+ color: #747474;
border-bottom: 0 none;
margin: 0;
}
@@ -962,7 +962,7 @@ div.toc ul {
list-style: none outside none;
border: medium none;
padding: 0px;
-}
+}
div.toc li.level1 {
margin-left: 0px;
@@ -1009,4 +1009,3 @@ div.toc li.level4 {
word-wrap: break-word; /* IE 5.5+ */
}
}
-
diff --git a/doc/opus_logo.svg b/doc/opus_logo.svg
index 97112afd..db2879ef 100644
--- a/doc/opus_logo.svg
+++ b/doc/opus_logo.svg
@@ -59,11 +59,11 @@
y1="95.107399"
x2="194.53169"
y2="9.9475983e-14">
- <stop
+ <stop
offset="0.0056"
style="stop-color:#8E8E8E"
id="stop7" />
- <stop
+ <stop
offset="1"
style="stop-color:#B5B5B5"
id="stop9" />
@@ -76,11 +76,11 @@
y1="116.208"
x2="229.61819"
y2="164.46291">
- <stop
+ <stop
offset="0.0056"
style="stop-color:#494748"
id="stop14" />
- <stop
+ <stop
offset="1"
style="stop-color:#000000"
id="stop16" />
@@ -93,11 +93,11 @@
y1="115.4395"
x2="43.9897"
y2="165.2314">
- <stop
+ <stop
offset="0.0056"
style="stop-color:#494748"
id="stop21" />
- <stop
+ <stop
offset="1"
style="stop-color:#000000"
id="stop23" />
@@ -110,11 +110,11 @@
y1="115.7188"
x2="311.2847"
y2="165.2822">
- <stop
+ <stop
offset="0.0056"
style="stop-color:#494748"
id="stop28" />
- <stop
+ <stop
offset="1"
style="stop-color:#000000"
id="stop30" />
@@ -127,11 +127,11 @@
y1="115.5791"
x2="129.1987"
y2="204.4863">
- <stop
+ <stop
offset="0.0056"
style="stop-color:#494748"
id="stop35" />
- <stop
+ <stop
offset="1"
style="stop-color:#000000"
id="stop37" />
diff --git a/doc/trivial_example.c b/doc/trivial_example.c
index 7a0fc56a..c65dfe01 100644
--- a/doc/trivial_example.c
+++ b/doc/trivial_example.c
@@ -88,7 +88,7 @@ int main(int argc, char **argv)
fin = fopen(inFile, "r");
if (fin==NULL)
{
- fprintf(stderr, "failed to open file: %s\n", strerror(errno));
+ fprintf(stderr, "failed to open input file: %s\n", strerror(errno));
return EXIT_FAILURE;
}
@@ -104,7 +104,7 @@ int main(int argc, char **argv)
fout = fopen(outFile, "w");
if (fout==NULL)
{
- fprintf(stderr, "failed to open file: %s\n", strerror(errno));
+ fprintf(stderr, "failed to open output file: %s\n", strerror(errno));
return EXIT_FAILURE;
}
@@ -138,7 +138,7 @@ int main(int argc, char **argv)
frame_size = opus_decode(decoder, cbits, nbBytes, out, MAX_FRAME_SIZE, 0);
if (frame_size<0)
{
- fprintf(stderr, "decoder failed: %s\n", opus_strerror(err));
+ fprintf(stderr, "decoder failed: %s\n", opus_strerror(frame_size));
return EXIT_FAILURE;
}