Mercurial > hg > x
changeset 5:5f3c32dc6e17
* Adjust comment syntax to permit Doxygen to generate HTML documentation; add Doxyfile
| author | Chris Cannam |
|---|---|
| date | Wed, 06 Oct 2010 15:19:49 +0100 |
| parents | 92ee28024c05 |
| children | fda5b3561a13 |
| files | Doxyfile align8.h arrayalloc.h fft.cpp fft.h hs.cpp hs.h hsedit.cpp hsedit.h hssf.cpp hssf.h matrix.cpp matrix.h multires.cpp multires.h opt.cpp procedures.cpp procedures.h quickspec.cpp quickspec.h sinest.cpp sinest.h sinsyn.cpp sinsyn.h splines.cpp splines.h tstream.h vibrato.cpp vibrato.h wavelet.cpp wavelet.h windowfunctions.cpp windowfunctions.h xcomplex.h |
| diffstat | 34 files changed, 2183 insertions(+), 607 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Doxyfile Wed Oct 06 15:19:49 2010 +0100 @@ -0,0 +1,1551 @@ +# Doxyfile 1.6.3 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project +# +# All text after a hash (#) is considered a comment and will be ignored +# The format is: +# TAG = value [value, ...] +# For lists items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (" ") + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# http://www.gnu.org/software/libiconv for the list of possible encodings. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded +# by quotes) that should identify the project. + +PROJECT_NAME = x + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. +# This could be handy for archiving the generated documentation or +# if some version control system is used. + +PROJECT_NUMBER = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) +# base path where the generated documentation will be put. +# If a relative path is entered, it will be relative to the location +# where doxygen was started. If left blank the current directory will be used. + +OUTPUT_DIRECTORY = doc + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create +# 4096 sub-directories (in 2 levels) under the output directory of each output +# format and will distribute the generated files over these directories. +# Enabling this option can be useful when feeding doxygen a huge amount of +# source files, where putting all generated files in the same directory would +# otherwise cause performance problems for the file system. + +CREATE_SUBDIRS = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# The default language is English, other supported languages are: +# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, +# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, +# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English +# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, +# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, +# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will +# include brief member descriptions after the members that are listed in +# the file and class documentation (similar to JavaDoc). +# Set to NO to disable this. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend +# the brief description of a member or function before the detailed description. +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator +# that is used to form the text in various listings. Each string +# in this list, if found as the leading text of the brief description, will be +# stripped from the text and the result after processing the whole list, is +# used as the annotated text. Otherwise, the brief description is used as-is. +# If left blank, the following values are used ("$name" is automatically +# replaced with the name of the entity): "The $name class" "The $name widget" +# "The $name file" "is" "provides" "specifies" "contains" +# "represents" "a" "an" "the" + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief +# description. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full +# path before files name in the file list and in the header files. If set +# to NO the shortest path that makes the file name unique will be used. + +FULL_PATH_NAMES = YES + +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag +# can be used to strip a user-defined part of the path. Stripping is +# only done if one of the specified strings matches the left-hand part of +# the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the +# path to strip. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of +# the path mentioned in the documentation of a class, which tells +# the reader which header file to include in order to use a class. +# If left blank only the name of the header file containing the class +# definition is used. Otherwise one should specify the include paths that +# are normally passed to the compiler using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter +# (but less readable) file names. This can be useful is your file systems +# doesn't support long names like on DOS, Mac, or CD-ROM. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen +# will interpret the first line (until the first dot) of a JavaDoc-style +# comment as the brief description. If set to NO, the JavaDoc +# comments will behave just like regular Qt-style comments +# (thus requiring an explicit @brief command for a brief description.) + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will +# interpret the first line (until the first dot) of a Qt-style +# comment as the brief description. If set to NO, the comments +# will behave just like regular Qt-style comments (thus requiring +# an explicit \brief command for a brief description.) + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen +# treat a multi-line C++ special comment block (i.e. a block of //! or /// +# comments) as a brief description. This used to be the default behaviour. +# The new default is to treat a multi-line C++ comment block as a detailed +# description. Set this tag to YES if you prefer the old behaviour instead. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented +# member inherits the documentation from any documented member that it +# re-implements. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce +# a new page for each member. If set to NO, the documentation of a member will +# be part of the file/class/namespace that contains it. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. +# Doxygen uses this value to replace tabs by spaces in code fragments. + +TAB_SIZE = 8 + +# This tag can be used to specify a number of aliases that acts +# as commands in the documentation. An alias has the form "name=value". +# For example adding "sideeffect=\par Side Effects:\n" will allow you to +# put the command \sideeffect (or @sideeffect) in the documentation, which +# will result in a user-defined paragraph with heading "Side Effects:". +# You can put \n's in the value part of an alias to insert newlines. + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C +# sources only. Doxygen will then generate output that is more tailored for C. +# For instance, some of the names that are used will be different. The list +# of all members will be omitted, etc. + +OPTIMIZE_OUTPUT_FOR_C = YES + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java +# sources only. Doxygen will then generate output that is more tailored for +# Java. For instance, namespaces will be presented as packages, qualified +# scopes will look different, etc. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources only. Doxygen will then generate output that is more tailored for +# Fortran. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for +# VHDL. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it parses. +# With this tag you can assign which parser to use for a given extension. +# Doxygen has a built-in mapping, but you can override or extend it using this tag. +# The format is ext=language, where ext is a file extension, and language is one of +# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP, +# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat +# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran), +# use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should +# set this tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. +# func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. +# Doxygen will parse them like normal C++ but will assume all classes use public +# instead of private inheritance when no explicit protection keyword is present. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate getter +# and setter methods for a property. Setting this option to YES (the default) +# will make doxygen to replace the get and set methods by a property in the +# documentation. This will only work if the methods are indeed getting or +# setting a simple type. If this is not the case, or you want to show the +# methods anyway, you should set this option to NO. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of +# the same type (for instance a group of public functions) to be put as a +# subgroup of that type (e.g. under the Public Functions section). Set it to +# NO to prevent subgrouping. Alternatively, this can be done per class using +# the \nosubgrouping command. + +SUBGROUPING = YES + +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum +# is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically +# be useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. + +TYPEDEF_HIDES_STRUCT = NO + +# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to +# determine which symbols to keep in memory and which to flush to disk. +# When the cache is full, less often used symbols will be written to disk. +# For small to medium size projects (<1000 input files) the default value is +# probably good enough. For larger projects a too small cache size can cause +# doxygen to be busy swapping symbols to and from disk most of the time +# causing a significant performance penality. +# If the system has enough physical memory increasing the cache will improve the +# performance by keeping more symbols in memory. Note that the value works on +# a logarithmic scale so increasing the size by one will rougly double the +# memory usage. The cache size is given by this formula: +# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, +# corresponding to a cache size of 2^16 = 65536 symbols + +SYMBOL_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. +# Private class members and static file members will be hidden unless +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# will be included in the documentation. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file +# will be included in the documentation. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) +# defined locally in source files will be included in the documentation. +# If set to NO only classes defined in header files are included. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. When set to YES local +# methods, which are defined in the implementation section but not in +# the interface are included in the documentation. +# If set to NO (the default) only methods in the interface are included. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base +# name of the file that contains the anonymous namespace. By default +# anonymous namespace are hidden. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members of documented classes, files or namespaces. +# If set to NO (the default) these members will be included in the +# various overviews, but no documentation section is generated. +# This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. +# If set to NO (the default) these classes will be included in the various +# overviews. This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all +# friend (class|struct|union) declarations. +# If set to NO (the default) these declarations will be included in the +# documentation. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any +# documentation blocks found inside the body of a function. +# If set to NO (the default) these blocks will be appended to the +# function's detailed documentation block. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation +# that is typed after a \internal command is included. If the tag is set +# to NO (the default) then the documentation will be excluded. +# Set it to YES to include the internal documentation. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate +# file names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen +# will show members with their full class and namespace scopes in the +# documentation. If set to YES the scope will be hidden. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen +# will put a list of the files that are included by a file in the documentation +# of that file. + +SHOW_INCLUDE_FILES = YES + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen +# will list include files with double quotes in the documentation +# rather than with sharp brackets. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] +# is inserted in the documentation for inline members. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen +# will sort the (detailed) documentation of file and class members +# alphabetically by member name. If set to NO the members will appear in +# declaration order. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the +# brief documentation of file, namespace and class members alphabetically +# by member name. If set to NO (the default) the members will appear in +# declaration order. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the +# hierarchy of group names into alphabetical order. If set to NO (the default) +# the group names will appear in their defined order. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be +# sorted by fully-qualified names, including namespaces. If set to +# NO (the default), the class list will be sorted only by class name, +# not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the +# alphabetical list. + +SORT_BY_SCOPE_NAME = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or +# disable (NO) the todo list. This list is created by putting \todo +# commands in the documentation. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or +# disable (NO) the test list. This list is created by putting \test +# commands in the documentation. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or +# disable (NO) the bug list. This list is created by putting \bug +# commands in the documentation. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or +# disable (NO) the deprecated list. This list is created by putting +# \deprecated commands in the documentation. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional +# documentation sections, marked by \if sectionname ... \endif. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +# the initial value of a variable or define consists of for it to appear in +# the documentation. If the initializer consists of more lines than specified +# here it will be hidden. Use a value of 0 to hide initializers completely. +# The appearance of the initializer of individual variables and defines in the +# documentation can be controlled using \showinitializer or \hideinitializer +# command in the documentation regardless of this setting. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated +# at the bottom of the documentation of classes and structs. If set to YES the +# list will mention the files that were used to generate the documentation. + +SHOW_USED_FILES = YES + +# If the sources in your project are distributed over multiple directories +# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy +# in the documentation. The default is NO. + +SHOW_DIRECTORIES = NO + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. +# This will remove the Files entry from the Quick Index and from the +# Folder Tree View (if specified). The default is YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the +# Namespaces page. +# This will remove the Namespaces entry from the Quick Index +# and from the Folder Tree View (if specified). The default is YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command <command> <input-file>, where <command> is the value of +# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file +# provided by doxygen. Whatever the program writes to standard output +# is used as the file version. See the manual for examples. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by +# doxygen. The layout file controls the global structure of the generated output files +# in an output format independent way. The create the layout file that represents +# doxygen's defaults, run doxygen with the -l option. You can optionally specify a +# file name after the option, if omitted DoxygenLayout.xml will be used as the name +# of the layout file. + +LAYOUT_FILE = + +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated +# by doxygen. Possible values are YES and NO. If left blank NO is used. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated by doxygen. Possible values are YES and NO. If left blank +# NO is used. + +WARNINGS = YES + +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will +# automatically be disabled. + +WARN_IF_UNDOCUMENTED = YES + +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some +# parameters in a documented function, or documenting parameters that +# don't exist or using markup commands wrongly. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be abled to get warnings for +# functions that are documented, but have no documentation for their parameters +# or return value. If set to NO (the default) doxygen will only warn about +# wrong or incomplete parameter documentation, but not about the absence of +# documentation. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that +# doxygen can produce. The string should contain the $file, $line, and $text +# tags, which will be replaced by the file and line number from which the +# warning originated and the warning text. Optionally the format may contain +# $version, which will be replaced by the version of the file (if it could +# be obtained via FILE_VERSION_FILTER) + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning +# and error messages should be written. If left blank the output is written +# to stderr. + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag can be used to specify the files and/or directories that contain +# documented source files. You may enter file names like "myfile.cpp" or +# directories like "/usr/src/myproject". Separate the files or directories +# with spaces. + +INPUT = + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is +# also the default input encoding. Doxygen uses libiconv (or the iconv built +# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for +# the list of possible encodings. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank the following patterns are tested: +# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx +# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 + +FILE_PATTERNS = *.h *.cpp *.c + +# The RECURSIVE tag can be used to turn specify whether or not subdirectories +# should be searched for input files as well. Possible values are YES and NO. +# If left blank NO is used. + +RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used select whether or not files or +# directories that are symbolic links (a Unix filesystem feature) are excluded +# from the input. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. Note that the wildcards are matched +# against the file with absolute path, so to exclude all test directories +# for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or +# directories that contain example code fragments that are included (see +# the \include command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank all files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude +# commands irrespective of the value of the RECURSIVE tag. +# Possible values are YES and NO. If left blank NO is used. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or +# directories that contain image that are included in the documentation (see +# the \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command <filter> <input-file>, where <filter> +# is the value of the INPUT_FILTER tag, and <input-file> is the name of an +# input file. Doxygen will then use the output that the filter program writes +# to standard output. +# If FILTER_PATTERNS is specified, this tag will be +# ignored. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. +# Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. +# The filters are a list of the form: +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further +# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER +# is applied to all files. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will be used to filter the input files when producing source +# files to browse (i.e. when SOURCE_BROWSER is set to YES). + +FILTER_SOURCE_FILES = NO + +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will +# be generated. Documented entities will be cross-referenced with these sources. +# Note: To get rid of all source code in the generated output, make sure also +# VERBATIM_HEADERS is set to NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body +# of functions and classes directly in the documentation. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct +# doxygen to hide any special comment blocks from generated source code +# fragments. Normal C and C++ comments will always remain visible. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES +# then for each documented function all documented +# functions referencing it will be listed. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES +# then for each documented function all documented entities +# called/used by that function will be listed. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) +# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from +# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will +# link to the source code. +# Otherwise they will link to the documentation. + +REFERENCES_LINK_SOURCE = YES + +# If the USE_HTAGS tag is set to YES then the references to source code +# will point to the HTML generated by the htags(1) tool instead of doxygen +# built-in source browser. The htags tool is part of GNU's global source +# tagging system (see http://www.gnu.org/software/global/global.html). You +# will need version 4.8.6 or higher. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen +# will generate a verbatim copy of the header file for each class for +# which an include is specified. Set to NO to disable this. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index +# of all compounds will be generated. Enable this if the project +# contains a lot of classes, structs, unions or interfaces. + +ALPHABETICAL_INDEX = NO + +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns +# in which this list will be split (can be a number in the range [1..20]) + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all +# classes will be put under the same header in the alphabetical index. +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that +# should be ignored while generating the index headers. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# generate HTML output. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `html' will be used as the default path. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank +# doxygen will generate files with .html extension. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a personal HTML header for +# each generated HTML page. If it is left blank doxygen will generate a +# standard header. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a personal HTML footer for +# each generated HTML page. If it is left blank doxygen will generate a +# standard footer. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading +# style sheet that is used by each HTML page. It can be used to +# fine-tune the look of the HTML output. If the tag is left blank doxygen +# will generate a default style sheet. Note that doxygen will try to copy +# the style sheet file to the HTML output directory, so don't put your own +# stylesheet in the HTML output directory as well, or it will be erased! + +HTML_STYLESHEET = + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting +# this to NO can help when comparing the output of multiple runs. + +HTML_TIMESTAMP = YES + +# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, +# files or namespaces will be aligned in HTML using tables. If set to +# NO a bullet list will be used. + +HTML_ALIGN_MEMBERS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. For this to work a browser that supports +# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox +# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). + +HTML_DYNAMIC_SECTIONS = NO + +# If the GENERATE_DOCSET tag is set to YES, additional index files +# will be generated that can be used as input for Apple's Xcode 3 +# integrated development environment, introduced with OSX 10.5 (Leopard). +# To create a documentation set, doxygen will generate a Makefile in the +# HTML output directory. Running make will produce the docset in that +# directory and running "make install" will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find +# it at startup. +# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information. + +GENERATE_DOCSET = NO + +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the +# feed. A documentation feed provides an umbrella under which multiple +# documentation sets from a single provider (such as a company or product suite) +# can be grouped. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that +# should uniquely identify the documentation set bundle. This should be a +# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen +# will append .docset to the name. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) +# of the generated HTML documentation. + +GENERATE_HTMLHELP = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can +# be used to specify the file name of the resulting .chm file. You +# can add a path in front of the file if the result should not be +# written to the html output directory. + +CHM_FILE = + +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can +# be used to specify the location (absolute path including file name) of +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run +# the HTML help compiler on the generated index.hhp. + +HHC_LOCATION = + +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag +# controls if a separate .chi index file is generated (YES) or that +# it should be included in the master .chm file (NO). + +GENERATE_CHI = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING +# is used to encode HtmlHelp index (hhk), content (hhc) and project file +# content. + +CHM_INDEX_ENCODING = + +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag +# controls whether a binary table of contents is generated (YES) or a +# normal table of contents (NO) in the .chm file. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members +# to the contents of the HTML help documentation and to the tree view. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER +# are set, an additional index file will be generated that can be used as input for +# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated +# HTML documentation. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can +# be used to specify the file name of the resulting .qch file. +# The path specified is relative to the HTML output folder. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#namespace + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#virtual-folders + +QHP_VIRTUAL_FOLDER = doc + +# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. +# For more information please see +# http://doc.trolltech.com/qthelpproject.html#custom-filters + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see +# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's +# filter section matches. +# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>. + +QHP_SECT_FILTER_ATTRS = + +# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can +# be used to specify the location of Qt's qhelpgenerator. +# If non-empty doxygen will try to run qhelpgenerator on the generated +# .qhp file. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files +# will be generated, which together with the HTML files, form an Eclipse help +# plugin. To install this plugin and make it available under the help contents +# menu in Eclipse, the contents of the directory containing the HTML and XML +# files needs to be copied into the plugins directory of eclipse. The name of +# the directory within the plugins directory should be the same as +# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before the help appears. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have +# this name. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# The DISABLE_INDEX tag can be used to turn on/off the condensed index at +# top of each HTML page. The value NO (the default) enables the index and +# the value YES disables it. + +DISABLE_INDEX = NO + +# This tag can be used to set the number of enum values (range [1..20]) +# that doxygen will group on one line in the generated HTML documentation. + +ENUM_VALUES_PER_LINE = 4 + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. +# If the tag value is set to YES, a side panel will be generated +# containing a tree-like index structure (just like the one that +# is generated for HTML Help). For this to work a browser that supports +# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). +# Windows users are probably better off using the HTML help feature. + +GENERATE_TREEVIEW = NO + +# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, +# and Class Hierarchy pages using a tree view instead of an ordered list. + +USE_INLINE_TREES = NO + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be +# used to set the initial width (in pixels) of the frame in which the tree +# is shown. + +TREEVIEW_WIDTH = 250 + +# Use this tag to change the font size of Latex formulas included +# as images in the HTML documentation. The default is 10. Note that +# when you change the font size after a successful doxygen run you need +# to manually remove any form_*.png images from the HTML output directory +# to force them to be regenerated. + +FORMULA_FONTSIZE = 10 + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for the HTML output. The underlying search engine uses javascript +# and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) there is already a search function so this one should +# typically be disabled. For large projects the javascript based search engine +# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. + +SEARCHENGINE = YES + +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be implemented using a PHP enabled web server instead of at the web client using Javascript. Doxygen will generate the search PHP script and index +# file to put on the web server. The advantage of the server based approach is that it scales better to large projects and allows full text search. The disadvances is that it is more difficult to setup +# and does not have live searching capabilities. + +SERVER_BASED_SEARCH = NO + +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- + +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# generate Latex output. + +GENERATE_LATEX = NO + +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `latex' will be used as the default path. + +LATEX_OUTPUT = latex + +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# invoked. If left blank `latex' will be used as the default command name. +# Note that when enabling USE_PDFLATEX this option is only used for +# generating bitmaps for formulas in the HTML output, but not in the +# Makefile that is written to the output directory. + +LATEX_CMD_NAME = latex + +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to +# generate index for LaTeX. If left blank `makeindex' will be used as the +# default command name. + +MAKEINDEX_CMD_NAME = makeindex + +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact +# LaTeX documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_LATEX = NO + +# The PAPER_TYPE tag can be used to set the paper type that is used +# by the printer. Possible values are: a4, a4wide, letter, legal and +# executive. If left blank a4wide will be used. + +PAPER_TYPE = a4wide + +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX +# packages that should be included in the LaTeX output. + +EXTRA_PACKAGES = + +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for +# the generated latex document. The header should contain everything until +# the first chapter. If it is left blank doxygen will generate a +# standard header. Notice: only use this tag if you know what you are doing! + +LATEX_HEADER = + +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated +# is prepared for conversion to pdf (using ps2pdf). The pdf file will +# contain links (just like the HTML output) instead of page references +# This makes the output suitable for online browsing using a pdf viewer. + +PDF_HYPERLINKS = YES + +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of +# plain latex in the generated Makefile. Set this option to YES to get a +# higher quality PDF documentation. + +USE_PDFLATEX = YES + +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. +# command to the generated LaTeX files. This will instruct LaTeX to keep +# running if errors occur, instead of asking the user for help. +# This option is also used when generating formulas in HTML. + +LATEX_BATCHMODE = NO + +# If LATEX_HIDE_INDICES is set to YES then doxygen will not +# include the index chapters (such as File Index, Compound Index, etc.) +# in the output. + +LATEX_HIDE_INDICES = NO + +# If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER. + +LATEX_SOURCE_CODE = NO + +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- + +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output +# The RTF output is optimized for Word 97 and may not look very pretty with +# other RTF readers or editors. + +GENERATE_RTF = NO + +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `rtf' will be used as the default path. + +RTF_OUTPUT = rtf + +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact +# RTF documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_RTF = NO + +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated +# will contain hyperlink fields. The RTF file will +# contain links (just like the HTML output) instead of page references. +# This makes the output suitable for online browsing using WORD or other +# programs which support those fields. +# Note: wordpad (write) and others do not support links. + +RTF_HYPERLINKS = NO + +# Load stylesheet definitions from file. Syntax is similar to doxygen's +# config file, i.e. a series of assignments. You only have to provide +# replacements, missing definitions are set to their default value. + +RTF_STYLESHEET_FILE = + +# Set optional variables used in the generation of an rtf document. +# Syntax is similar to doxygen's config file. + +RTF_EXTENSIONS_FILE = + +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- + +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will +# generate man pages + +GENERATE_MAN = NO + +# The MAN_OUTPUT tag is used to specify where the man pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `man' will be used as the default path. + +MAN_OUTPUT = man + +# The MAN_EXTENSION tag determines the extension that is added to +# the generated man pages (default is the subroutine's section .3) + +MAN_EXTENSION = .3 + +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, +# then it will generate one additional man file for each entity +# documented in the real man page(s). These additional files +# only source the real man page, but without them the man command +# would be unable to find the correct page. The default is NO. + +MAN_LINKS = NO + +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- + +# If the GENERATE_XML tag is set to YES Doxygen will +# generate an XML file that captures the structure of +# the code including all documentation. + +GENERATE_XML = NO + +# The XML_OUTPUT tag is used to specify where the XML pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `xml' will be used as the default path. + +XML_OUTPUT = xml + +# The XML_SCHEMA tag can be used to specify an XML schema, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_SCHEMA = + +# The XML_DTD tag can be used to specify an XML DTD, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_DTD = + +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will +# dump the program listings (including syntax highlighting +# and cross-referencing information) to the XML output. Note that +# enabling this will significantly increase the size of the XML output. + +XML_PROGRAMLISTING = YES + +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will +# generate an AutoGen Definitions (see autogen.sf.net) file +# that captures the structure of the code including all +# documentation. Note that this feature is still experimental +# and incomplete at the moment. + +GENERATE_AUTOGEN_DEF = NO + +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- + +# If the GENERATE_PERLMOD tag is set to YES Doxygen will +# generate a Perl module file that captures the structure of +# the code including all documentation. Note that this +# feature is still experimental and incomplete at the +# moment. + +GENERATE_PERLMOD = NO + +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate +# the necessary Makefile rules, Perl scripts and LaTeX code to be able +# to generate PDF and DVI output from the Perl module output. + +PERLMOD_LATEX = NO + +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be +# nicely formatted so it can be parsed by a human reader. +# This is useful +# if you want to understand what is going on. +# On the other hand, if this +# tag is set to NO the size of the Perl module output will be much smaller +# and Perl will parse it just the same. + +PERLMOD_PRETTY = YES + +# The names of the make variables in the generated doxyrules.make file +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. +# This is useful so different doxyrules.make files included by the same +# Makefile don't overwrite each other's variables. + +PERLMOD_MAKEVAR_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- + +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will +# evaluate all C-preprocessor directives found in the sources and include +# files. + +ENABLE_PREPROCESSING = YES + +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro +# names in the source code. If set to NO (the default) only conditional +# compilation will be performed. Macro expansion can be done in a controlled +# way by setting EXPAND_ONLY_PREDEF to YES. + +MACRO_EXPANSION = NO + +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES +# then the macro expansion is limited to the macros specified with the +# PREDEFINED and EXPAND_AS_DEFINED tags. + +EXPAND_ONLY_PREDEF = NO + +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# in the INCLUDE_PATH (see below) will be search if a #include is found. + +SEARCH_INCLUDES = YES + +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by +# the preprocessor. + +INCLUDE_PATH = + +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will +# be used. + +INCLUDE_FILE_PATTERNS = + +# The PREDEFINED tag can be used to specify one or more macro names that +# are defined before the preprocessor is started (similar to the -D option of +# gcc). The argument of the tag is a list of macros of the form: name +# or name=definition (no spaces). If the definition and the = are +# omitted =1 is assumed. To prevent a macro definition from being +# undefined via #undef or recursively expanded use the := operator +# instead of the = operator. + +PREDEFINED = __fastcall= + +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then +# this tag can be used to specify a list of macro names that should be expanded. +# The macro definition that is found in the sources will be used. +# Use the PREDEFINED tag if you want to use a different macro definition. + +EXPAND_AS_DEFINED = + +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all function-like macros that are alone +# on a line, have an all uppercase name, and do not end with a semicolon. Such +# function macros are typically used for boiler-plate code, and will confuse +# the parser if not removed. + +SKIP_FUNCTION_MACROS = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- + +# The TAGFILES option can be used to specify one or more tagfiles. +# Optionally an initial location of the external documentation +# can be added for each tagfile. The format of a tag file without +# this location is as follows: +# +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where "loc1" and "loc2" can be relative or absolute paths or +# URLs. If a location is present for each tag, the installdox tool +# does not have to be run to correct the links. +# Note that each tag file must have a unique name +# (where the name does NOT include the path) +# If a tag file is not located in the directory in which doxygen +# is run, you must also specify the path to the tagfile here. + +TAGFILES = + +# When a file name is specified after GENERATE_TAGFILE, doxygen will create +# a tag file that is based on the input files it reads. + +GENERATE_TAGFILE = + +# If the ALLEXTERNALS tag is set to YES all external classes will be listed +# in the class index. If set to NO only the inherited external classes +# will be listed. + +ALLEXTERNALS = NO + +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will +# be listed. + +EXTERNAL_GROUPS = YES + +# The PERL_PATH should be the absolute path and name of the perl script +# interpreter (i.e. the result of `which perl'). + +PERL_PATH = /usr/bin/perl + +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- + +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base +# or super classes. Setting the tag to NO turns the diagrams off. Note that +# this option is superseded by the HAVE_DOT option below. This is only a +# fallback. It is recommended to install and use dot, since it yields more +# powerful graphs. + +CLASS_DIAGRAMS = YES + +# You can define message sequence charts within doxygen comments using the \msc +# command. Doxygen will then run the mscgen tool (see +# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the +# documentation. The MSCGEN_PATH tag allows you to specify the directory where +# the mscgen tool resides. If left empty the tool is assumed to be found in the +# default search path. + +MSCGEN_PATH = + +# If set to YES, the inheritance and collaboration graphs will hide +# inheritance and usage relations if the target is undocumented +# or is not a class. + +HIDE_UNDOC_RELATIONS = YES + +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz, a graph visualization +# toolkit from AT&T and Lucent Bell Labs. The other options in this section +# have no effect if this option is set to NO (the default) + +HAVE_DOT = NO + +# By default doxygen will write a font called FreeSans.ttf to the output +# directory and reference it in all dot files that doxygen generates. This +# font does not include all possible unicode characters however, so when you need +# these (or just want a differently looking font) you can specify the font name +# using DOT_FONTNAME. You need need to make sure dot is able to find the font, +# which can be done by putting it in a standard location or by setting the +# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory +# containing the font. + +DOT_FONTNAME = FreeSans + +# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. +# The default size is 10pt. + +DOT_FONTSIZE = 10 + +# By default doxygen will tell dot to use the output directory to look for the +# FreeSans.ttf font (which doxygen will put there itself). If you specify a +# different font using DOT_FONTNAME you can set the path where dot +# can find it using this tag. + +DOT_FONTPATH = + +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect inheritance relations. Setting this tag to YES will force the +# the CLASS_DIAGRAMS tag to NO. + +CLASS_GRAPH = YES + +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect implementation dependencies (inheritance, containment, and +# class references variables) of the class with other documented classes. + +COLLABORATION_GRAPH = YES + +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for groups, showing the direct groups dependencies + +GROUP_GRAPHS = YES + +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling +# Language. + +UML_LOOK = NO + +# If set to YES, the inheritance and collaboration graphs will show the +# relations between templates and their instances. + +TEMPLATE_RELATIONS = NO + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT +# tags are set to YES then doxygen will generate a graph for each documented +# file showing the direct and indirect include dependencies of the file with +# other documented files. + +INCLUDE_GRAPH = YES + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each +# documented header file showing the documented files that directly or +# indirectly include this file. + +INCLUDED_BY_GRAPH = YES + +# If the CALL_GRAPH and HAVE_DOT options are set to YES then +# doxygen will generate a call dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable call graphs +# for selected functions only using the \callgraph command. + +CALL_GRAPH = NO + +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then +# doxygen will generate a caller dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable caller +# graphs for selected functions only using the \callergraph command. + +CALLER_GRAPH = NO + +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# will graphical hierarchy of all classes instead of a textual one. + +GRAPHICAL_HIERARCHY = YES + +# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES +# then doxygen will show the dependencies a directory has on other directories +# in a graphical way. The dependency relations are determined by the #include +# relations between the files in the directories. + +DIRECTORY_GRAPH = YES + +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. Possible values are png, jpg, or gif +# If left blank png will be used. + +DOT_IMAGE_FORMAT = png + +# The tag DOT_PATH can be used to specify the path where the dot tool can be +# found. If left blank, it is assumed the dot tool can be found in the path. + +DOT_PATH = + +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the +# \dotfile command). + +DOTFILE_DIRS = + +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of +# nodes that will be shown in the graph. If the number of nodes in a graph +# becomes larger than this value, doxygen will truncate the graph, which is +# visualized by representing a node as a red box. Note that doxygen if the +# number of direct children of the root node in a graph is already larger than +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note +# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. + +DOT_GRAPH_MAX_NODES = 50 + +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the +# graphs generated by dot. A depth value of 3 means that only nodes reachable +# from the root by following a path via at most 3 edges will be shown. Nodes +# that lay further from the root node will be omitted. Note that setting this +# option to 1 or 2 may greatly reduce the computation time needed for large +# code bases. Also note that the size of a graph can be further restricted by +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. + +MAX_DOT_GRAPH_DEPTH = 0 + +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is disabled by default, because dot on Windows does not +# seem to support this out of the box. Warning: Depending on the platform used, +# enabling this option may lead to badly anti-aliased labels on the edges of +# a graph (i.e. they become hard to read). + +DOT_TRANSPARENT = NO + +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output +# files in one run (i.e. multiple -o and -T options on the command line). This +# makes dot run faster, but since only newer versions of dot (>1.8.10) +# support this, this feature is disabled by default. + +DOT_MULTI_TARGETS = YES + +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will +# generate a legend page explaining the meaning of the various boxes and +# arrows in the dot generated graphs. + +GENERATE_LEGEND = YES + +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will +# remove the intermediate dot files that are used to generate +# the various graphs. + +DOT_CLEANUP = YES
--- a/align8.h Tue Oct 05 17:03:27 2010 +0100 +++ b/align8.h Wed Oct 06 15:19:49 2010 +0100 @@ -3,8 +3,8 @@ #ifndef align8H #define align8H -/* - align8.cpp - 8-byte (64-bit) alignment routines. +/** + \file align8.h - 8-byte (64-bit) alignment routines. This file provides tools for aligning boundaries of arrays, particularly of 64-byte units, e.g. double- precision floating points, to physical addresses divisible by 8, including aligning dynamically
--- a/arrayalloc.h Tue Oct 05 17:03:27 2010 +0100 +++ b/arrayalloc.h Wed Oct 06 15:19:49 2010 +0100 @@ -1,8 +1,8 @@ #ifndef ARRAYALLOC #define ARRAYALLOC -/* - arrayalloc.h - 2D, 3D and 4D array memory allocation routines. +/** + \file arrayalloc.h - 2D, 3D and 4D array memory allocation routines. An x-dimensional array (x=2, 3, 4, ...) is managed as a single memory block hosting all records, plus an index block which is a (x-1)D array itself. Therefore a 2D array is allocated as two 1D arrays, a
--- a/fft.cpp Tue Oct 05 17:03:27 2010 +0100 +++ b/fft.cpp Wed Oct 06 15:19:49 2010 +0100 @@ -4,8 +4,10 @@ #include <stdlib.h> #include "fft.h" +/** \file fft.h */ + //--------------------------------------------------------------------------- -/* +/** function Atan2: (0, 0)-safe atan2 Returns 0 is x=y=0, atan2(x,y) otherwise. @@ -16,7 +18,7 @@ else return atan2(y, x); }//Atan2 -/* +/** function BitInv: inverse bit order of Value within an $Order-bit expression. In: integer Value smaller than 2^Order @@ -35,7 +37,7 @@ return Result; }//BitInv -/* +/** function SetTwiddleFactors: fill w[N/2] with twiddle factors used in N-point complex FFT. In: N @@ -54,7 +56,7 @@ }//SetTwiddleFactors //--------------------------------------------------------------------------- -/* +/** function CFFTCbii: basic complex DIF-FFT module, applied after bit-inversed ordering of inputs In: Order: integer, equals log2(Wid) @@ -93,7 +95,7 @@ } }//CFFTCbii -/* +/** function CFFTC: in-place complex FFT In: Order: integer, equals log2(Wid) @@ -124,7 +126,7 @@ CFFTCbii(Order, W, X); }//CFFTC -/* +/** function CFFTC: complex FFT In: Input[Wid]: complex waveform @@ -149,7 +151,7 @@ }//CFFTC //--------------------------------------------------------------------------- -/* +/** function CIFFTCbii: basic complex IFFT module, applied after bit-inversed ordering of inputs In: Order: integer, equals log2(Wid) @@ -193,7 +195,7 @@ } }//CIFFTCbii -/* +/** function CIFFTC: in-place complex IFFT In: Order: integer, equals log2(Wid) @@ -223,7 +225,7 @@ CIFFTCbii(Order, W, X); }//CIFFTC -/* +/** function CIFFTC: complex IFFT In: Input[Wid]: complex spectrum @@ -243,7 +245,7 @@ }//CIFFTC //--------------------------------------------------------------------------- -/* +/** function CIFFTR: complex-to-real IFFT In: Input[Wid/2+1]: complex spectrum, imaginary parts of Input[0] and Input[Wid/2] are ignored @@ -321,7 +323,7 @@ }//CIFFTR //--------------------------------------------------------------------------- -/* +/** function CreateBitInvTable: creates a table of bit-inversed integers In: Order: interger, equals log2(size of table) @@ -339,7 +341,7 @@ //--------------------------------------------------------------------------- -/* +/** function RFFTC_ual: unaligned real-to-complex FFT In: Input[Wid]: real waveform @@ -427,7 +429,7 @@ }//RFFTC_ual //--------------------------------------------------------------------------- -/* +/** function RFFTCW: real-to-complex FFT with window In: Input[Wid]: real waveform @@ -475,7 +477,7 @@ if (!hbitinv1) free(hbitinv); }//RFFTCW -/* +/** function RFFTCW: real-to-complex FFT with window In: Input[Wid]: real waveform as _int16 array @@ -505,7 +507,7 @@ }//RFFTCW //--------------------------------------------------------------------------- -/* +/** function CFFTCW: complex FFT with window In: Window[Wid]: window function @@ -524,7 +526,7 @@ CFFTC(Order, W, X, bitinv); }//CFFTCW -/* +/** function CFFTCW: complex FFT with window In: Input[Wid]: complex waveform @@ -547,7 +549,7 @@ }//CFFTCW //--------------------------------------------------------------------------- -/* +/** function RDCT1: fast DCT1 implemented using FFT. DCT-I has the time scale 0.5-sample shifted from the DFT. In: Input[Wid]: real waveform @@ -644,7 +646,7 @@ }//RDCT1 //--------------------------------------------------------------------------- -/* +/** function RDCT4: fast DCT4 implemented using FFT. DCT-IV has both the time and frequency scales 0.5-sample or 0.5-bin shifted from DFT. @@ -691,7 +693,7 @@ }//RDCT4 //--------------------------------------------------------------------------- -/* +/** function RIDCT1: fast IDCT1 implemented using FFT. In: Input[Wid]: DCT-I of some real waveform. @@ -801,7 +803,7 @@ }//RIDCT1 //--------------------------------------------------------------------------- -/* +/** function RIDCT4: fast IDCT4 implemented using FFT. In: Input[Wid]: DCT-IV of some real waveform @@ -848,7 +850,7 @@ }//RIDCT4 //--------------------------------------------------------------------------- -/* +/** function RLCT: real local cosine transform of equal frame widths Wid=2^Order In: data[Count]: real waveform @@ -908,7 +910,7 @@ }//RLCT //--------------------------------------------------------------------------- -/* +/** function RILCT: inverse local cosine transform of equal frame widths Wid=2^Order In: spec[Fr][Wid]: the local cosine transform @@ -953,7 +955,7 @@ }//RILCT //--------------------------------------------------------------------------- -/* +/** function CMFTC: radix-2 complex multiresolution Fourier transform In: x[Wid]: complex waveform
--- a/fft.h Tue Oct 05 17:03:27 2010 +0100 +++ b/fft.h Wed Oct 06 15:19:49 2010 +0100 @@ -1,8 +1,8 @@ #ifndef fftH #define fftH -/* - fft.cpp - fast Fourier and cosine transforms +/** + \file fft.h - fast Fourier and cosine transforms Arguments of the function in this unit roughly follow the following rules: Wid : size of transform @@ -24,7 +24,7 @@ #include "align8.h" //--------------------------------------------------------------------------- -/* +/** macro AllocateFFTBuffer: allocates FFT buffers X and W of given length with an extra LDATA buffer the right size for hosting such arrays as the standard-size window function or output amplitude spectrum.
--- a/hs.cpp Tue Oct 05 17:03:27 2010 +0100 +++ b/hs.cpp Wed Oct 06 15:19:49 2010 +0100 @@ -12,10 +12,12 @@ #undef I #endif +/** \file hs.h */ + //--------------------------------------------------------------------------- //stiffcandid methods -/* +/** method stiffcandid::stiffcandid: creates a harmonic atom with minimal info, i.e. fundamantal frequency between 0 and Nyqvist frequency, stiffness coefficient between 0 and STIFF_B_MAX. @@ -36,7 +38,7 @@ f=NULL; }//stiffcandid -/* +/** method stiffcandid::stiffcandid: creates a harmonic atom with a frequency range for the $ap-th partial, without actually taking this partial as "known". @@ -66,7 +68,7 @@ cutcvpoly(N, F, G, -1, -k, g1); }//stiffcandid -/* +/** method stiffcandid::stiffcandid: creates a harmonic atom from one atom. In; Wid: DFT size @@ -577,7 +579,7 @@ //--------------------------------------------------------------------------- //functions -/* +/** function areaandcentroid: calculates the area and centroid of a convex polygon. In: x[N], y[N]: x- and y-coordinates of vertices of a polygon @@ -607,7 +609,7 @@ cy=cy/6/A; }//areaandcentroid -/* +/** function AtomsToPartials: sort a list of atoms as a number of partials. It is assumed that the atoms are simply those from a harmonic sinusoid in arbitrary order with uniform timing and partial index clearly marked, so that it is easy to sort them into a list of partials. However, the sorting process @@ -653,7 +655,7 @@ else M=0, Fr=0; }//AtomsToPartials -/* +/** function conta: a continuity measure between two set of amplitudes In: a1[N], a2[N]: the amplitudes @@ -674,7 +676,7 @@ return 2*e12/(e11+e22); }//conta -/* +/** function cutcvpoly: severs a polygon by a straight line In: x[N], y[N]: x- and y-coordinates of vertices of a polygon, starting from the leftmost (x[0]= @@ -823,7 +825,7 @@ cutcvpoly(R->N, R->X, R->Y, -1, -k, g1, protect); // }//CutR -/* +/** function DeleteByHalf: reduces a list of stiffcandid objects by half, retaining those with higher s and delete the others, freeing their memory. @@ -847,7 +849,7 @@ return k; }//DeleteByHalf -/* +/** function DeleteByHalf: reduces a list of TTempAtom objects by half, retaining those with higher s and delete the others, freeing their memory. @@ -872,7 +874,7 @@ return k; }//DeleteByHalf -/* +/** function ds0: atom score 0 - energy In: a: atom amplitude @@ -885,7 +887,7 @@ else return a*a; }//ds0 -/* +/** function ds2: atom score 1 - cross-correlation coefficient with another HA, e.g. from previous frame In: a: atom amplitude @@ -902,7 +904,7 @@ else return (lparams->s*hs+a*a)/hsaa; }//ds1 -/* +/** function ExBStiff: finds the minimal and maximal values of stiffness coefficient B given a F-G polygon In: F[N], G[N]: vertices of a F-G polygon @@ -922,7 +924,7 @@ } }//ExBStiff -/* +/** function ExFmStiff: finds the minimal and maximal frequecies of partial m given a F-G polygon In: F[N], G[N]: vertices of a F-G polygon @@ -946,7 +948,7 @@ testnn(vmax); Fmax=m*sqrt(vmax); }//ExFmStiff -/* +/** function ExtendR: extends a F-G polygon on the f axis (to allow a larger pitch range) In: R: the F-G polygon @@ -1094,7 +1096,7 @@ } }//ExtendR -/* +/** function FGFrom2: solves the following equation system given m[2], f[2], norm[2]. This is interpreted as searching from (F0, G0) down direction (dF, dG) until the first equation is satisfied, where k[*]=m[*]^2-1. @@ -1179,7 +1181,7 @@ } }//FGFrom2 -/* +/** function FGFrom2: solves the following equation system given m[2], f[2], k[2]. This is interpreted as searching from (F0, G0) down direction (dF, dG) until the first equation is satisfied. Functionally this is the same as the version using norm[2], with m[] anf f[] normalized by norm[] beforehand so @@ -1270,7 +1272,7 @@ } }//FGFrom2 -/* +/** function FGFrom3: solves the following equation system given m[3], f[3], norm[3]. m[0](F+k[0]G)^0.5-f[0] m[1](F+k[1]G)^0.5-f[1] m[2](F+k[2]G)^0.5-f[2] @@ -1358,7 +1360,7 @@ } }//FGFrom3 -/* +/** function FGFrom3: solves the following equation system given m[3], f[3], k[3]. Functionally this is the same as the version using norm[3], with m[] anf f[] normalized by norm[] beforehand so that norm[] is no longer needed. However, k[3] cannot be computed from normalized m[3] so that it must be @@ -1466,7 +1468,7 @@ } }//FGFrom3 -/* +/** function FindNote: harmonic sinusoid tracking from a starting point in time-frequency plane forward and backward. @@ -1521,7 +1523,7 @@ return 0; }//Findnote*/ -/* +/** function FindNoteConst: constant-pitch harmonic sinusoid tracking In: _t, _f: start time and frequency @@ -1658,7 +1660,7 @@ return 1; }//FindNoteConst -/* +/** function FindNoteF: forward harmonic sinusoid tracking starting from a given harmonic atom until an endpoint is detected or a search boundary is reached. @@ -1705,7 +1707,7 @@ return k; }//FindNoteF -/* +/** function FindNoteFB: forward-backward harmonic sinusid tracking. In: frst, fren: index of start and end frames @@ -1858,7 +1860,7 @@ return result; //*/ }//FindNoteFB -/* +/** function GetResultsSingleFr: used by NoteMatchStiff3 to obtain final note match results after harmonic grouping of peaks with rough frequency estimates, including a screening of found peaks based on shape and consistency with other peak frequencies, reestimating sinusoid parameters using LSE, estimating @@ -1974,7 +1976,7 @@ return result; }//GetResultsSingleFr -/* +/** function GetResultsMultiFr: the constant-pitch multi-frame version of GetResultsSingleFr. In: x[Fr][N]: spectrogram @@ -2093,7 +2095,7 @@ return result; }//GetResultsMultiFr -/* +/** function InitailizeR: initializes a F-G polygon with a fundamental frequency range and stiffness coefficient bound In: af, ef: centre and half width of the fundamental frequency range @@ -2113,7 +2115,7 @@ Y[0]=X[0]*maxB, Y[1]=X[1]*maxB, Y[2]=Y[3]=0; }//InitializeR -/* +/** function InitialzeR: initializes a F-G polygon with a frequency range for a given partial and stiffness coefficient bound @@ -2137,7 +2139,7 @@ Y[0]=X[0]*maxB, Y[1]=X[1]*maxB, Y[2]=Y[3]=0; }//InitializeR -/* +/** function maximalminimum: finds the point within a polygon that maximizes its minimal distance to the sides. @@ -2246,7 +2248,7 @@ return dm; }//maximalminimum -/* +/** function minimaxstiff: finds the point in polygon (N; F, G) that minimizes the maximal value of the function @@ -3370,7 +3372,7 @@ return vmax; }//minimaxstiff*/ -/* +/** function NMResultToAtoms: converts the note-match result hosted in a NMResults structure, i.e. parameters of a harmonic atom, to a list of atoms. The process retrieves atom parameters from low partials until a required number of atoms have been retrieved or a non-positive frequency is @@ -3398,7 +3400,7 @@ return M; }//NMResultToAtoms -/* +/** function NMResultToPartials: reads atoms of a harmonic atom in a NMResult structure into HS partials. In: results: the NMResults structure hosting the harmonic atom @@ -3424,7 +3426,7 @@ return M; }//NMResultToPartials -/* +/** function NoteMatchStiff3: finds harmonic atom from spectrum if Fr=1, or constant-pitch harmonic sinusoid from spectrogram if Fr>1. @@ -3695,7 +3697,7 @@ return result; }//NoteMatchStiff3 -/* +/** function NoteMatchStiff3: finds harmonic atom from spectrum if Fr=1, or constant-pitch harmonic sinusoid from spectrogram if Fr>1. This version uses residue-sinusoid ratio ("rsr") that measures how "good" a spectral peak is in terms of its shape. peaks with large rsr[] is likely to be contaminated @@ -4012,7 +4014,7 @@ return result; }//NoteMatchStiff3 -/* +/** function NoteMatchStiff3: wrapper function of the above that does peak picking and HA grouping (or constant-pitch HS finding) in a single call. @@ -4047,7 +4049,7 @@ return result; }//NoteMatchStiff3 -/* +/** function NoteMatchStiff3: finds harmonic atom from spectrum given the pitch as a (partial index, frequency) pair. This is used internally by NoteMatch3FB(). @@ -4185,7 +4187,7 @@ return result; }//NoteMatchStiff3*/ -/* +/** function NoteMatchStiff3FB: does one dynamic programming step in forward-background pitch tracking of harmonic sinusoids. This is used internally by FindNoteFB(). @@ -4294,7 +4296,7 @@ pitchcount=newpc; }//NoteMatchStiff3FB -/* +/** function PeakShapeC: residue-sinusoid-ratio for a given (hypothesis) sinusoid frequency In: x[Fr][N/2+1]: spectrogram @@ -4336,7 +4338,7 @@ return 1-xw2/(xx.x*ww.x); }//PeakShapeC -/* +/** function QuickPeaks: finds rough peaks in the spectrum (peak picking) In: x[N/2+1]: spectrum @@ -4390,7 +4392,7 @@ return p; }//QuickPeaks -/* +/** function QuickPeaks: finds rough peaks in the spectrogram (peak picking) for constant-frequency sinusoids @@ -4516,7 +4518,7 @@ return pc; }//QuickPeaks -/* +/** function ReEstHS1: reestimates a harmonic sinusoid by one multiplicative reestimation using phasor multiplier @@ -4542,7 +4544,7 @@ delete[] fs; }//ReEstHS1 -/* +/** function ReEstHS1: wrapper function. In: HS: a harmonic sinusoid @@ -4556,7 +4558,7 @@ ReEstHS1(HS->M, HS->Fr, 0, HS->Fr, HS->Partials, Data16); }//ReEstHS1 -/* +/** function SortCandid: inserts a candid object into a listed of candid objects sorted first by f, then (for identical f's) by df. @@ -4577,7 +4579,7 @@ return lnN; }//SortCandid -/* +/** function SynthesisHS: synthesizes a harmonic sinusoid without aligning the phases In: partials[M][Fr]: HS partials @@ -4633,7 +4635,7 @@ return xrec; }//SynthesisHS -/* +/** function SynthesisHS: synthesizes a perfectly harmonic sinusoid without aligning the phases. Frequencies of partials above the fundamental are not used in this synthesis process. @@ -4699,7 +4701,7 @@ return xrec; }//SynthesisHS2 -/* +/** function SynthesisHSp: synthesizes a harmonic sinusoid with phase alignment In: partials[pm][pfr]: HS partials @@ -4782,7 +4784,7 @@ return xrec; }//SynthesisHSp -/* +/** function SynthesisHSp: wrapper function. In: HS: a harmonic sinusoid.
--- a/hs.h Tue Oct 05 17:03:27 2010 +0100 +++ b/hs.h Wed Oct 06 15:19:49 2010 +0100 @@ -1,8 +1,8 @@ #ifndef hsH #define hsH -/* - hs.cpp - harmonic sinusoid model +/** + \file hs.h - harmonic sinusoid model Further reading: Wen X. and M. Sandler, "Sinusoid modeling in a harmonic context," in Proc. DAFx'07, Bordeaux, 2007. */ @@ -95,7 +95,7 @@ }; -/* +/** stiffcandid is the harmonic atom class used internally by harmonic grouping and tracking routines. Literally it means "candidate harmonic atoms on a stiff string model". The stiff string is the main harmonic model used by me for describing frequency relations between partials of a harmonic sound. @@ -123,7 +123,7 @@ }; -/* +/** THS is the data structure hosting a harmonic sinusoid representation. Its key members include the number of partials, number of frames, and all its atoms (sinusoid parameters of all partials at measurement points). */ @@ -170,7 +170,7 @@ }; -/* +/** TPolygon is a polygon class. This class itself does not enforce convexness. However, when used for solving the stiff string model, all polygons are convex, as they are the results of current a first convex polygon by straight lines. @@ -192,7 +192,7 @@ }; -/* +/** TTempAtom is an atom class within the stiff-stirng harmonic atom context used internally by harmonic grouping and tracking routines. Literally it means "a temporary atom", and truly it hosts most info one expects of a potential atom. TTempAtom replaces stiffcandid class in harmonic sinusoid group and
--- a/hsedit.cpp Tue Oct 05 17:03:27 2010 +0100 +++ b/hsedit.cpp Wed Oct 06 15:19:49 2010 +0100 @@ -3,9 +3,11 @@ #include "hsedit.h" #include "splines.h" +/** \file hsedit.h */ + //--------------------------------------------------------------------------- -/* +/** function DeFM: frequency de-modulation In: peakfr[npfr]: segmentation into FM cycles, peakfr[0]=0, peakfr[npfr-1]=Fr-1 @@ -34,7 +36,7 @@ delete[] frs; }//DeFM -/* +/** function DFMSeg: segments HS frames into FM cycles In: partials[M][Fr]: HS partials @@ -62,7 +64,7 @@ delete[] frec; }//DFMSeg -/* +/** function HSAM: harmonic sinusoid amplitude modulation In: SrcHS: source harmonic sinusoid @@ -81,7 +83,7 @@ HS->Partials[m][fr].a=SrcHS->Partials[m][fr].a*(1+dep*cos(omg*SrcHS->Partials[m][fr].t+ph)); }//HSAM -/* +/** function HSFM: harmonic sinusoid frequency modulation In: SrcHS: source harmonic sinusoid @@ -100,7 +102,7 @@ HS->Partials[m][fr].f=SrcHS->Partials[m][fr].f*(1+pa*cos(omg*SrcHS->Partials[m][fr].t+ph)); }//HSFM -/* +/** function HSFM_SF: harmonic sinusoid frequency modulation with source-filter model In: SrcHS: source harmonic sinusoid @@ -124,7 +126,7 @@ } }//HSFM_SF -/* +/** function: HSPitchShift: harmonic sinusoid pitch shifting In: SrcHS: source harmonic sinusoid @@ -139,7 +141,7 @@ for (int m=0; m<HS->M; m++) for (int fr=0; fr<HS->Fr; fr++) HS->Partials[m][fr].f=SrcHS->Partials[m][fr].f*pa; }//HSPitchShift -/* +/** function ReFM: frequency re-modulation In: partials[M][Fr]: HS partials
--- a/hsedit.h Tue Oct 05 17:03:27 2010 +0100 +++ b/hsedit.h Wed Oct 06 15:19:49 2010 +0100 @@ -2,8 +2,8 @@ #define hseditH -/* - hsedit.cpp - harmonic sinusoid audio editing routines. +/** + \file hsedit.h - harmonic sinusoid audio editing routines. */ #include "hs.h"
--- a/hssf.cpp Tue Oct 05 17:03:27 2010 +0100 +++ b/hssf.cpp Wed Oct 06 15:19:49 2010 +0100 @@ -1,6 +1,5 @@ //--------------------------------------------------------------------------- - #include <math.h> #include <string.h> #include "hssf.h" @@ -8,6 +7,8 @@ #include "matrix.h" #include "vibrato.h" +/** \file hssf.h */ + //--------------------------------------------------------------------------- //method TSF::TSF: default constructor. TSF::TSF() @@ -26,7 +27,7 @@ free(avgb); }//~TSF -/* +/** method TSF::AllocateL: allocates or reallocates storage space whose size depends on L. This uses an external L value for allocation and updates L itself. */ @@ -37,7 +38,7 @@ F0C=&F0[L+2], F0D=&F0[(L+2)*2], logA0C=&F0[(L+2)*3], logA0=&F0[(L+2)*4], logA0D=&F0[(L+2)*5]; }//AllocateL -/* +/** method TSF::AllocateP: allocates or reallocates storage space whose size depends on P, using the interal P. */ @@ -47,7 +48,7 @@ lp=new double[P+2]; }//AllocateP -/* +/** method TSF::AllocateSF: allocates or reallocates storage space for source-filter coefficients. */ void TSF::AllocateSF() @@ -57,7 +58,7 @@ avgh=(double*)realloc(avgh, sizeof(double)*(k+2)); avgb=(double*)realloc(avgb, sizeof(double)*M); }//AllocateSF -/* +/** method TSF::Duplicate: copies the complete contents from another SF object In: SF: source object @@ -72,7 +73,7 @@ memcpy(avgh, SF.avgh, sizeof(double)*(K+2)); memcpy(avgb, SF.avgb, sizeof(double)*M); }//Duplicate -/* +/** method TSF::LoadFromFileHandle: reads SF object from file */ void TSF::LoadFromFileHandle(FILE* f) @@ -89,7 +90,7 @@ LoadSFFromFileHandle(f); }//LoadFromFileHandle -/* +/** method TSF::LoadSFFromFileHandle: reads SF coefficients from file */ void TSF::LoadSFFromFileHandle(FILE* f) @@ -105,7 +106,7 @@ fread(avgh, sizeof(double), K+2, f); }//LoadSFFromFileHandle -/* +/** method TSF::LogAF: average filter response In: f: frequency @@ -121,7 +122,7 @@ else return avgh[K+1]; }//LogAF -/* +/** method TSF::LogAF: filter response In: f: frequency @@ -140,7 +141,7 @@ else return h[l][K+1]; }//LogAF -/* +/** method TSF::LogAS: source response In: m: partial index @@ -155,7 +156,7 @@ return b[l][m]; }//LogAS -/* +/** method TSF::ReAllocateL: reallocates storage space whose size depends on L, and transfer the contents. This uses an external L value for allocation but does not update L itself. */ @@ -171,7 +172,7 @@ F0=newF0; }//ReAllocateL -/* +/** method TSF::SaveSFToFileHandle: writes SF coefficients to file */ void TSF::SaveSFToFileHandle(FILE* f) @@ -186,7 +187,7 @@ fwrite(avgh, sizeof(double), K+2, f); }//SaveSFToFileHandle -/* +/** method TSF::SaveToFile: save SF object to file In: filename: full path of destination file @@ -200,7 +201,7 @@ } }//SaveToFile -/* +/** method TSF::SaveToFileHandle: writes SF object to file */ void TSF::SaveToFileHandle(FILE* f) @@ -216,7 +217,7 @@ SaveSFToFileHandle(f); }//SaveToFileHandle -/* +/** method TSF::ShiftFilterByDB: adds a given number of dBs to the filter model. In: dB: amount to add. @@ -231,7 +232,7 @@ //functions -/* +/** function AnalyzeSF: wrapper function. In: HS: a harmonic sinusoid @@ -254,7 +255,7 @@ AnalyzeSF_2(HS, SF, cyclefrs, cyclefs, sps, cyclefrcount, SFMode, SFF, SFFScale, SFtheta); }//AnalyzeSF -/* +/** function AnalyzeSF_1: first stage of source-filter model estimation, in which the duration of a HS is segmented into what is equivalent to "cycles" in vibrato analysis. @@ -317,7 +318,7 @@ delete[] peakfr; }//AnalyzeSF_1 -/* +/** function AnalyzeSF_2: second stage of source-filter model estimation, in which the HS is demodulated and its source-filter model is estimated. @@ -387,7 +388,7 @@ } }//AnalyzeSF_2 -/* +/** function I3: integrates the product of 3 linear functions (0, a*)-(T, b*) (*=1, 2 or 3) over (0, T). See "further reading", pp.12 eq.(37). @@ -400,7 +401,7 @@ return T*(a1*(a2*(3*a3+b3)+b2*(a3+b3))+b1*(a2*(a3+b3)+b2*(a3+3*b3)))/12; }//I3 -/* +/** function P_Ax: calculate the 2-D vector Ax for a given x, where A is a matrix hosting the parabolic coefficient of filter coefficients x[L][K+2] towards the totoal variation. See "further reading", pp.8, (29a). @@ -425,7 +426,7 @@ return DelFtr*(1-theta)/F+DelSrc*theta; }//P_Ax -/* +/** function P_Ax_cf: calculate the 2-D vector Ax for a given x, where A is a matrix hosting the parabolic coefficient of time-unvarying filter coefficients x[K+2] towards totoal source variation. @@ -458,7 +459,7 @@ return xAx; }//P_Ax_cf -/* +/** function P1_b: internal procedure P1 of slow-variation SF estimator. See "further reading", pp.8. In: a[L][M], f[L][M]: partial amplitudes and frequencies @@ -488,7 +489,7 @@ Multiply(L, K+2, b, b, theta); }//P1_b -/* +/** function P1_b_cf: internal procedure P1 of slow-variation SF estimator, constant-filter version. In: a[L][M], f[L][M]: partial amplitudes and frequencies @@ -517,7 +518,7 @@ Multiply(K+2, b, b, 2); }//P1_b_cf -/* +/** function P2_DelFtr: internal procedure P2 of slow-variation SF estimator. See "further reading", pp.8. In: x[L][K+2]: filter coefficients @@ -547,7 +548,7 @@ return xAx*F/3; }//P2_DelFtr -/* +/** function P3_DelSec: internal procedure P3 of slow-variation SF estimator. See "further reading", pp.9. In: x[L][K+2]: filter coefficients @@ -579,7 +580,7 @@ return xAx; }//P3_DelSec -/* +/** function S_F_b: computes source coefficients given amplitudes and filter coefficients In: Partials[M][Fr]: HS partials. Fr is not specified but is assumed no less then lp[P-1]. @@ -623,7 +624,7 @@ for (int m=0; m<M; m++){avgb[m]=0; for (int l=0; l<L; l++) avgb[m]+=b[l][m]; avgb[m]/=L;} }//S_F_b -/* +/** function S_F_b: wrapper function In: Partials: HS partials @@ -637,7 +638,7 @@ S_F_b(SF.M, Partials, useA0?SF.logA0:SF.logA0C, SF.lp, SF.P, SF.K, SF.h, SF.b, SF.avgb, SF.F, SF.FScaleMode, SF.Fs); }//S_F_b -/* +/** function S_F_b: filter-bank method for estimating source-filter model. This is a wrapper function of SF_FB() that transfers and scales values, etc. @@ -700,7 +701,7 @@ return 0; }//S_F_b -/* +/** function S_F_SV: slow-variation method for estimating source-filter model. This is a wrapper function of SF_SV() that transfers and scales values, etc. @@ -758,7 +759,7 @@ return 0; }//S_F_SV -/* +/** function S_F_SV_cf: slow-variation method for estimating source-(constant)filter model. This is a wrapper function of SF_SV_cf() that transfers and scales values, as well as converting results to source filter format used by the vibrato class TVo. @@ -847,7 +848,7 @@ return 0; }//S_F_SV_cf -/* +/** function SF_FB: computes filter coefficients with filter-bank method: single frame. See "further reading", pp.12, P5. @@ -972,7 +973,7 @@ return K; }//SF_FB -/* +/** function SF_SV: CG method for estimation source-filter model using slow-variation criterion. See "further reading", pp.9, boxed algorithm P4. @@ -1030,7 +1031,7 @@ return K; }//SF_SV -/* +/** function SF_SV_cf: CG method for estimation source-(constant)filter model by slow-variation criterion. In: a[L][M], f[L][M]: partial amplitudes and frequencies @@ -1075,7 +1076,7 @@ return K; }//SF_SV_cf -/* +/** function SF_SV_cf: CG method for estimation source-(constant)filter model by slow-variation criterion. In: a[L][M], f[L][M]: partial amplitudes and frequencies @@ -1103,7 +1104,7 @@ } }//SF_SV_cf -/* +/** function Sign: sign function In: x: a floating-point number @@ -1117,7 +1118,7 @@ else return -1; }//Sign -/* +/** function SynthesizeSF: synthesizes a harmonic sinusoid representation from a TSF object. In: SF: a TSF object
--- a/hssf.h Tue Oct 05 17:03:27 2010 +0100 +++ b/hssf.h Wed Oct 06 15:19:49 2010 +0100 @@ -1,8 +1,8 @@ #ifndef hssfH #define hssfH -/* - hssf.cpp - source-filter modeling for harmonic sinusoids +/** + \file hssf.h - source-filter modeling for harmonic sinusoids Further reading: Wen X. and M. Sandler, "Source-filter modeling in sinusoid domain," in Proc. AES 126th Convention, Munich, 2009. @@ -17,7 +17,7 @@ const bool useA0=true; //if true, use A0D+A0C instead of A0C in S-F decomposition as pre-normalizer -/* +/** TSF is the class implementing source-filter model for harmonic sinusoids. TSF shares the basic framework of the vibrato description class TVo, but implements a more compact source-filter representation. It does not go into detailed vibrato analysis such as extraction modulator shape. @@ -28,39 +28,39 @@ struct TSF { //basic characteristics - int M; //number of partials - int L; //number of frames - int P; //number of segmentation points - double offst; //hop size - double* F0C; //[0:L-1] pitch carrier - double* F0D; //[0:L-1] pitch modulator - double* logA0C; //[0:L-1] amplitude carreir - double* logA0D; //[0:L-1] amplitude modulator + int M; ///< number of partials + int L; ///< number of frames + int P; ///< number of segmentation points + double offst; ///< hop size + double* F0C; ///< [0:L-1] pitch carrier + double* F0D; ///< [0:L-1] pitch modulator + double* logA0C; ///< [0:L-1] amplitude carreir + double* logA0D; ///< [0:L-1] amplitude modulator - double* lp; //[0:P-1] peak positions + double* lp; ///< [0:P-1] peak positions - double F; //filter: band with (linear or mel) associated to each b[][] - double Fs; //sampling frequency - int FScaleMode; //linear or mel - int K; //number of filter bands - double** b; //[0:L-1][0:M-1] single-frame source, in dB - double** h; //[0:L-1][0:K+1] single-frame filter, in dB - double* avgb; //[0:M-1] average source - double* avgh; //[0:K+1] average filter + double F; ///< filter: band with (linear or mel) associated to each b[][] + double Fs; ///< sampling frequency + int FScaleMode; ///< linear or mel + int K; ///< number of filter bands + double** b; ///< [0:L-1][0:M-1] single-frame source, in dB + double** h; ///< [0:L-1][0:K+1] single-frame filter, in dB + double* avgb; ///< [0:M-1] average source + double* avgh; ///< [0:K+1] average filter //other properties - double rate; //vibrato rate - double regularity;//vibrato regularity - double F0max; //maximal fundamental frequency - double F0min; //minimal fundamental frequency - double F0Cmax; //maximal fundamental carrier frequency - double F0Cmin; //minimal fundamental carrier frequency - double F0Overall; //overall average fundamental frequency - double F0Dmax; //maximal fundamental modulator frequency - double F0Dmin; //minimal fundamental modulator frequency - double* F0; //[0:L-1] fundamental frequency - double* logA0; //[0:L-1] log amplitude + double rate; ///< vibrato rate + double regularity;///< vibrato regularity + double F0max; ///< maximal fundamental frequency + double F0min; ///< minimal fundamental frequency + double F0Cmax; ///< maximal fundamental carrier frequency + double F0Cmin; ///< minimal fundamental carrier frequency + double F0Overall; ///< overall average fundamental frequency + double F0Dmax; ///< maximal fundamental modulator frequency + double F0Dmin; ///< minimal fundamental modulator frequency + double* F0; ///< [0:L-1] fundamental frequency + double* logA0; ///< [0:L-1] log amplitude TSF(); ~TSF();
--- a/matrix.cpp Tue Oct 05 17:03:27 2010 +0100 +++ b/matrix.cpp Wed Oct 06 15:19:49 2010 +0100 @@ -2,8 +2,12 @@ #include <math.h> #include <memory.h> #include "matrix.h" + +/** \file matrix.h */ + //--------------------------------------------------------------------------- -/* + +/** function BalanceSim: applies a similarity transformation to matrix a so that a is "balanced". This is used by various eigenvalue evaluation routines. @@ -60,7 +64,7 @@ }//BalanceSim //--------------------------------------------------------------------------- -/* +/** function Choleski: Choleski factorization A=LL', where L is lower triangular. The symmetric matrix A[N][N] is positive definite iff A can be factored as LL', where L is lower triangular with nonzero diagonl entries. @@ -93,7 +97,7 @@ //--------------------------------------------------------------------------- //matrix duplication routines -/* +/** function Copy: duplicate the matrix A as matrix Z. In: matrix A[M][N] @@ -128,7 +132,7 @@ //--------------------------------------------------------------------------- //vector duplication routines -/* +/** function Copy: duplicating vector a as vector z In: vector a[N] @@ -153,7 +157,7 @@ cdouble* Copy(int N, cdouble* a, MList* List){return Copy(N, 0, a, List);} //--------------------------------------------------------------------------- -/* +/** function det: computes determinant by Gaussian elimination method with column pivoting In: matrix A[N][N] @@ -235,7 +239,7 @@ }//det //--------------------------------------------------------------------------- -/* +/** function EigPower: power method for solving dominant eigenvalue and eigenvector In: matrix A[N][N], initial arbitrary vector x[N]. @@ -268,7 +272,7 @@ }//EigPower //--------------------------------------------------------------------------- -/* +/** function EigPowerA: EigPower with Aitken acceleration In: matrix A[N][N], initial arbitrary vector x[N]. @@ -301,7 +305,7 @@ }//EigPowerA //--------------------------------------------------------------------------- -/* +/** function EigPowerI: Inverse power method for solving the eigenvalue given an approximate non-zero eigenvector. @@ -342,7 +346,7 @@ }//EigPowerI //--------------------------------------------------------------------------- -/* +/** function EigPowerS: symmetric power method for solving the dominant eigenvalue with its eigenvector In: matrix A[N][N], initial arbitrary vector x[N]. @@ -375,7 +379,7 @@ }//EigPowerS //--------------------------------------------------------------------------- -/* +/** function EigPowerWielandt: Wielandt's deflation algorithm for solving a second dominant eigenvalue and eigenvector (m,u) given the dominant eigenvalue and eigenvector (l,v). @@ -415,7 +419,7 @@ //--------------------------------------------------------------------------- //NR versions of eigensystem -/* +/** function EigenValues: solves for eigenvalues of general system In: matrix A[N][N] @@ -430,7 +434,7 @@ return QR(N, A, ev); }//EigenValues -/* +/** function EigSym: Solves real symmetric eigensystem A In: matrix A[N][N] @@ -449,7 +453,7 @@ }//EigSym //--------------------------------------------------------------------------- -/* +/** function GEB: Gaussian elimination with backward substitution for solving linear system Ax=b. In: coefficient matrix A[N][N], vector b[N] @@ -491,7 +495,7 @@ }//GEB //--------------------------------------------------------------------------- -/* +/** function GESCP: Gaussian elimination with scaled column pivoting for solving linear system Ax=b In: matrix A[N][N], vector b[N] @@ -537,7 +541,7 @@ }//GESCP //--------------------------------------------------------------------------- -/* +/** function GExL: solves linear system xL=a, L being lower-triangular. This is used in LU factorization for solving linear systems. @@ -556,7 +560,7 @@ } }//GExL -/* +/** function GExLAdd: solves linear system *L=a, L being lower-triangular, and add the solution * to x[]. In: lower-triangular matrix L[N][N], vector a[N] @@ -572,7 +576,7 @@ delete[] lx; }//GExLAdd -/* +/** function GExL1: solves linear system xL=(0, 0, ..., 0, a)', L being lower-triangular. In: lower-triangular matrix L[N][N], a @@ -591,7 +595,7 @@ } }//GExL1 -/* +/** function GExL1Add: solves linear system *L=(0, 0, ..., 0, a)', L being lower-triangular, and add the solution * to x[]. @@ -609,7 +613,7 @@ }//GExL1Add //--------------------------------------------------------------------------- -/* +/** function GICP: matrix inverse using Gaussian elimination with column pivoting: inv(A)->A. In: matrix A[N][N] @@ -701,7 +705,7 @@ return result; }//GICP -/* +/** function GICP: wrapper function that does not overwrite the input matrix: inv(A)->X. In: matrix A[N][N] @@ -716,7 +720,7 @@ }//GICP //--------------------------------------------------------------------------- -/* +/** function GILT: inv(lower trangular of A)->lower trangular of A In: matrix A[N][N] @@ -742,7 +746,7 @@ return result; }//GILT -/* +/** function GIUT: inv(upper trangular of A)->upper trangular of A In: matrix A[N][N] @@ -769,7 +773,7 @@ }//GIUT //--------------------------------------------------------------------------- -/* +/** function GISCP: matrix inverse using Gaussian elimination w. scaled column pivoting: inv(A)->A. In: matrix A[N][N] @@ -827,7 +831,7 @@ return result; }//GISCP -/* +/** function GISCP: wrapper function that does not overwrite input matrix A: inv(A)->X. In: matrix A[N][N] @@ -842,7 +846,7 @@ }//GISCP //--------------------------------------------------------------------------- -/* +/** function GSI: Gaussian-Seidel iterative algorithm for solving linear system Ax=b. Breaks down if any Aii=0, like the Jocobi method JI(...). @@ -878,7 +882,7 @@ }//GSI //--------------------------------------------------------------------------- -/* +/** function Hessenb: reducing a square matrix A to upper Hessenberg form In: matrix A[N][N] @@ -933,7 +937,7 @@ }//Hessenb //--------------------------------------------------------------------------- -/* +/** function HouseHolder: house holder method converting a symmetric matrix into a tridiagonal symmetric matrix, or a non-symmetric matrix into an upper-Hessenberg matrix, using similarity transformation. @@ -978,7 +982,7 @@ delete[] u; delete[] v; delete[] z; }//HouseHolder -/* +/** function HouseHolder: house holder transformation T=Q'AQ or A=QTQ', where T is tridiagonal and Q is unitary i.e. QQ'=I. @@ -1029,7 +1033,7 @@ delete[] u; delete[] v; delete[] z; }//HouseHolder -/* +/** function HouseHolder: nr version of householder method for transforming symmetric matrix A to QTQ', where T is tridiagonal and Q is orthonormal. @@ -1107,7 +1111,7 @@ }//HouseHolder //--------------------------------------------------------------------------- -/* +/** function Inner: inner product z=y'x In: vectors x[N], y[N] @@ -1146,7 +1150,7 @@ return result; }//Inner -/* +/** function Inner: inner product z=tr(Y'X) In: matrices X[M][N], Y[M][N] @@ -1161,7 +1165,7 @@ }//Inner //--------------------------------------------------------------------------- -/* +/** function JI: Jacobi interative algorithm for solving linear system Ax=b Breaks down if A[i][i]=0 for any i. Reorder A so that this does not happen. @@ -1194,7 +1198,7 @@ }//JI //--------------------------------------------------------------------------- -/* +/** function LDL: LDL' decomposition A=LDL', where L is lower triangular and D is diagonal identical l and a allowed. @@ -1233,7 +1237,7 @@ }//LDL //--------------------------------------------------------------------------- -/* +/** function LQ_GS: LQ decomposition using Gram-Schmidt method In: matrix A[M][N], M<=N @@ -1262,7 +1266,7 @@ }//LQ_GS //--------------------------------------------------------------------------- -/* +/** function LSLinear2: 2-dtage LS solution of A[M][N]x[N][1]=y[M][1], M>=N. Use of this function requires the submatrix A[N][N] be invertible. @@ -1296,7 +1300,7 @@ }//LSLinear2 //--------------------------------------------------------------------------- -/* +/** function LU: LU decomposition A=LU, where L is lower triangular with diagonal entries 1 and U is upper triangular. @@ -1333,7 +1337,7 @@ return result; }//LU -/* +/** function LU: Solving linear system Ax=y by LU factorization In: matrix A[N][N], vector y[N] @@ -1388,7 +1392,7 @@ } //LU_DiagL*/ //--------------------------------------------------------------------------- -/* +/** function LU_Direct: LU factorization A=LU. In: matrix A[N][N], vector diag[N] specifying main diagonal of L or U, according to mode (0=LDiag, @@ -1437,7 +1441,7 @@ }//LU_Direct //--------------------------------------------------------------------------- -/* +/** function LU_PD: LU factorization for pentadiagonal A=LU In: pentadiagonal matrix A[N][N] stored in a compact format, i.e. A[i][j]->b[i-j, j] @@ -1510,7 +1514,7 @@ return 0; }//LU_PD*/ -/* +/** function LU_PD: solve pentadiagonal system Ax=c In: pentadiagonal matrix A[N][N] stored in a compact format in b[-2:2][N], vector c[N] @@ -1537,7 +1541,7 @@ }//LU_PD //--------------------------------------------------------------------------- -/* +/** function LUCP: LU decomposition A=LU with column pivoting In: matrix A[N][N] @@ -1626,7 +1630,7 @@ }//LUCP //--------------------------------------------------------------------------- -/* +/** function maxind: returns the index of the maximal value of data[from:(to-1)]. In: vector data containing at least $to entries. @@ -1686,7 +1690,7 @@ Multiply_vect(MultiplyXcy, cdouble, cdouble*, cfloat, *x[m][n], y[n]) //--------------------------------------------------------------------------- -/* +/** function Norm1: L-1 norm of a square matrix A In: matrix A[N][N] @@ -1706,7 +1710,7 @@ }//Norm1 //--------------------------------------------------------------------------- -/* +/** function QL: QL method for solving tridiagonal symmetric matrix eigenvalue problem. In: A[N][N]: tridiagonal symmetric matrix stored in d[N] and sd[] arranged so that d[0:n-1] contains @@ -1776,7 +1780,7 @@ }//QL //--------------------------------------------------------------------------- -/* +/** function QR: nr version of QR method for solving upper Hessenberg system A. This is compatible with Hessenb method. @@ -1908,7 +1912,7 @@ return 0; }//QR -/* +/** function QR_GS: QR decomposition A=QR using Gram-Schmidt method In: matrix A[M][N], M>=N @@ -1936,7 +1940,7 @@ delete[] u; }//QR_GS -/* +/** function QR_householder: QR decomposition using householder transform In: A[M][N], M>=N @@ -1974,7 +1978,7 @@ }//QR_householder //--------------------------------------------------------------------------- -/* +/** function QU: Unitary decomposition A=QU, where Q is unitary and U is upper triangular In: matrix A[N][N] @@ -2004,7 +2008,7 @@ }//QU //--------------------------------------------------------------------------- -/* +/** function Real: extracts the real part of matrix X In: matrix x[M][N]; @@ -2021,7 +2025,7 @@ double** Real(int M, int N, cdouble** x, MList* List){return Real(M, N, 0, x, List);} //--------------------------------------------------------------------------- -/* +/** function Roots: finds the roots of a polynomial. x^N+p[N-1]x^(N-1)+p[N-2]x^(N-2)...+p[0] In: vector p[N] of polynomial coefficients. @@ -2051,7 +2055,7 @@ }//Roots //--------------------------------------------------------------------------- -/* +/** function SorI: Sor iteration algorithm for solving linear system Ax=b. Sor method is an extension of the Gaussian-Siedel method, with the latter equivalent to the former @@ -2090,7 +2094,7 @@ //--------------------------------------------------------------------------- //Submatrix routines -/* +/** function SetSubMatrix: copy matrix x[Y][X] into matrix z at (Y1, X1). In: matrix x[Y][X], matrix z with dimensions no less than [Y+Y1][X+X1] @@ -2108,7 +2112,7 @@ for (int y=0; y<Y; y++) memcpy(&z[Y1+y][X1], x[y], sizeof(cdouble)*X); }//SetSubMatrix -/* +/** function SubMatrix: extract a submatrix of x at (Y1, X1) to z[Y][X]. In: matrix x of dimensions no less than [Y+Y1][X+X1] @@ -2128,7 +2132,7 @@ return SubMatrix(0, x, Y1, Y, X1, X, List); }//SetSubMatrix -/* +/** function SubVector: extract a subvector of x at X1 to z[X]. In: vector x no shorter than X+X1. @@ -2149,7 +2153,7 @@ }//SubVector //--------------------------------------------------------------------------- -/* +/** function transpose: matrix transpose: A'->A In: matrix a[N][N] @@ -2169,7 +2173,7 @@ for (int i=1; i<N; i++) for (int j=0; j<i; j++) {tmp=a[i][j]; a[i][j]=a[j][i]; a[j][i]=tmp;} }//transpose -/* +/** function transpose: matrix transpose: A'->Z In: matrix a[M][N] @@ -2190,7 +2194,7 @@ }//transpose //--------------------------------------------------------------------------- -/* +/** function Unitary: given x & y s.t. |x|=|y|, find unitary matrix P s.t. Px=y. P is given in closed form as I-(x-y)(x-y)'/(x-y)'x
--- a/matrix.h Tue Oct 05 17:03:27 2010 +0100 +++ b/matrix.h Wed Oct 06 15:19:49 2010 +0100 @@ -1,8 +1,8 @@ #ifndef MatrixH #define MatrixH -/* - Matrix.cpp - matrix operations. +/** + \file matrix.h - matrix operations. Matrices are accessed by double pointers as MATRIX[Y][X], where Y is the row index. */
--- a/multires.cpp Tue Oct 05 17:03:27 2010 +0100 +++ b/multires.cpp Wed Oct 06 15:19:49 2010 +0100 @@ -1,11 +1,12 @@ //--------------------------------------------------------------------------- - #include <math.h> #include "multires.h" #include "arrayalloc.h" #include "procedures.h" +/** \file multires.h */ + //--------------------------------------------------------------------------- //function xlogx(x): returns x*log(x) @@ -20,7 +21,7 @@ // #define NORMAL_(A, a) A=a*a*A; // #define NORMAL_(A, a) A=sqrt(a)*A; -/* +/** function DoCutSpectrogramSquare: find optimal tiling of a square. This is a recursive procedure. In: Specs[0][1][N], Specs[1][2][N/2], ..., Specs[log2(N)][N][1], multiresolution power spectrogram @@ -169,7 +170,7 @@ return result; }//DoCutSpectrogramSquare -/* +/** function DoMixSpectrogramSquare: renders a composite spectrogram on a pixel grid. This is a recursive procedure. @@ -254,7 +255,7 @@ } }//DoMixSpectrogramSquare -/* +/** function DoMixSpectrogramSquare: retrieves a composite spectrogram as a vector. This is a recursive procedure. @@ -334,7 +335,7 @@ }//DoMixSpectrogramSquare //--------------------------------------------------------------------------- -/* +/** function HSplitSpec: split a spectrogram horizontally into lower and upper halves. In: Spec[X][Y]: spectrogram to split @@ -350,7 +351,7 @@ lSpec[i]=Spec[i], uSpec[i]=&Spec[i][Y/2]; }//HSplitSpec -/* +/** function HSplitSpecs: split a multiresolution spectrogram horizontally into lower and upper halves A full spectrogram array is given in log2(N)+1 spectrograms, with the base spec of 1*N, 1st octave of @@ -373,7 +374,7 @@ }//HSplitSpecs //--------------------------------------------------------------------------- -/* +/** function MixSpectrogramSquare: find composite spectrogram from multiresolution spectrogram,output as pixel grid @@ -431,7 +432,7 @@ }//MixSpectrogramSquare //--------------------------------------------------------------------------- -/* +/** function MixSpectrogramSquare: find composite spectrogram from multiresolution spectrogram,output as vectors @@ -484,7 +485,7 @@ }//MixSpectrogramSquare //--------------------------------------------------------------------------- -/* +/** function MixSpectrogramBlock: obtain the composite spectrogram of a waveform block as pixel grid. This method deals with the effective duration of WID/2 samples of a frame of WID samples. The maximal @@ -539,7 +540,7 @@ return result; }//MixSpectrogramBlock -/* +/** function MixSpectrogramBlock: obtain the composite spectrogram of a waveform block as vectors. In: Specs[0][1][WID], Specs[1][2][WID/2], ..., Specs[Res-1][WID/wid][wid], multiresolution spectrogram @@ -581,12 +582,12 @@ //--------------------------------------------------------------------------- -/* - Functions names as ...Block2(...) implement the same functions as the above directly without +/** + functions names as ...Block2(...) implement the same functions as the above directly without explicitly dividing the multiresolution spectrogram into square blocks. */ -/* +/** function DoCutSpectrogramBlock2: find optimal tiling for a block In: Specs[R0][x0:x0+x-1][Y0:Y0+Y-1], [R0+1][2x0:2x0+2x-1][Y0/2:Y0/2+Y/2-1],..., @@ -643,7 +644,7 @@ return ent; }//DoCutSpectrogramBlock2 -/* +/** function DoMixSpectrogramBlock2: sampling multiresolution spectrogram according to given tiling In: Specs[R0][x0:x0+x-1][Y0:Y0+Y-1], [R0+1][2x0:2x0+2x-1][Y0/2:Y0/2+Y/2-1],..., @@ -697,7 +698,7 @@ return 0; }//DoMixSpectrogramBlock2 -/* +/** function MixSpectrogramBlock2: obtain the composite spectrogram of a waveform block as vectors. In: Specs[0][1][WID], Specs[1][2][WID/2], ..., Specs[Res-1][WID/wid][wid], multiresolution spectrogram @@ -739,7 +740,7 @@ }//MixSpectrogramBlock2 //--------------------------------------------------------------------------- -/* +/** function MixSpectrogram: obtain composite spectrogram from multiresolutin spectrogram as pixel grid This method deals with Fr (base) frames of WID samples. Each base frame may be divided into 2 1st- @@ -780,7 +781,7 @@ return 0; }//MixSpectrogram -/* +/** function MixSpectrogram: obtain composite spectrogram from multiresolutin spectrogram as vectors In: Specs[0][Fr][WID], Specs[1][Fr*2][WID/2], ..., Specs[Res-1] [Fr*(WID/wid)][wid], multiresolution @@ -807,7 +808,7 @@ }//MixSpectrogram //--------------------------------------------------------------------------- -/* +/** function VSplitSpec: split a spectrogram vertically into left and right halves. In: Spec[X][Y]: spectrogram to split @@ -823,7 +824,7 @@ lSpec[i]=Spec[i], rSpec[i]=Spec[i+X/2]; }//VSplitSpec -/* +/** function VSplitSpecs: split a multiresolution spectrogram vertically into left and right halves A full spectrogram array is given in log2(N)+1 spectrograms, with the base spec of 1*N, 1st octave of
--- a/multires.h Tue Oct 05 17:03:27 2010 +0100 +++ b/multires.h Wed Oct 06 15:19:49 2010 +0100 @@ -1,8 +1,8 @@ #ifndef multiresH #define multiresH -/* - multires.cpp - composite spectrogram routines +/** + \file multires.h - composite spectrogram routines This unit deals with basis selection from multiresolution Fourier bases set.
--- a/opt.cpp Tue Oct 05 17:03:27 2010 +0100 +++ b/opt.cpp Wed Oct 06 15:19:49 2010 +0100 @@ -1,18 +1,19 @@ //--------------------------------------------------------------------------- - #include <math.h> #include <memory.h> #include <stdlib.h> #include "opt.h" #include "matrix.h" +/** @file opt.h - optimization routines */ + //--------------------------------------------------------------------------- //macro nsign: judges if two double-precision floating pointer numbers have different signs #define nsign(x1, x2) (0x80&(((char*)&x1)[7]^((char*)&x2)[7])) //--------------------------------------------------------------------------- -/* +/** function GradientMax: gradient method maximizing F(x) In: function F(x) and its derivative dF(x) @@ -43,7 +44,7 @@ return G; }//GradientMax -/* +/** function GradientOneMax: gradient method maximizing F(x), which searches $dim dimensions one after another instead of taking the gradient descent direction. @@ -81,7 +82,7 @@ }//GradientOneMax //--------------------------------------------------------------------------- -/* +/** function mindenormaldouble: returns the minimal denormal double-precision floating point number. */ double mindenormaldouble() @@ -91,7 +92,7 @@ return result; }//mindenormaldouble -/* +/** function minnormaldouble: returns the minimal normal double-precision floating point number. */ double minnormaldouble() @@ -116,7 +117,7 @@ return x; }//nextdouble -/* +/** function Newton: Newton method for finding the root of y(x) In: function y(x) and its derivative y'(x) @@ -191,7 +192,7 @@ else return -1; }//Newton -/* +/** function Newton: Newton method for finding the root of y(x), for use when it's more efficient for y' and y to be calculated in one function call @@ -303,7 +304,7 @@ else return -1; }//Newton -/* +/** function init_Newton_1d: finds an initial x and interval (xa, xb) from which to search for an extremum On calling, xa<x0<xb, y(x0)>=y(xa), y(x0)>=y(xb) (or y(x0)<=y(xa), y(x0)<=y(xb)). @@ -368,7 +369,7 @@ return -0; }//init_Newton_1d -/* +/** function init_Newton_1d_max: finds an initial x and interval (xa, xb) from which to search for an maximum. @@ -423,7 +424,7 @@ } }//init_Newton_1d_max -/* +/** function init_Newton_1d_min: finds an initial x and interval (xa, xb) from which to search for an manimum. @@ -478,7 +479,7 @@ } }//init_Newton_1d_min -/* +/** function Newton_1d_max: Newton method for maximizing y(x). On calling y(x0)>=y(xa), y(x0)>=y(xb), y'(xa)>0, y'(xb)<0 @@ -590,7 +591,7 @@ else return -1; }//Newton_1d_max -/* +/** function Newton_1d_max: Newton method for maximizing y(x). On calling y(x0)<=y(xa), y(x0)<=y(xb), y'(xa)<0, y'(xb)>0 @@ -721,7 +722,7 @@ else return -1; }//Newton_1d_min -/* +/** function Newton1dmax: uses init_Newton_1d_max and Newton_1d_max to search for a local maximum of y. By default ddy and dy use the same parameter structure and returns the lower order derivatives at @@ -765,7 +766,7 @@ return ep; }//Newton1dmin -/* +/** function NewtonMax: looks for the maximum of y within [x0, x1] using Newton method. In: function ddy(x) that computes y, y' and y" at x @@ -877,7 +878,7 @@ }//NewtonMax //--------------------------------------------------------------------------- -/* +/** function rootsearchhalf: searches for the root of y(x) in (x1, x2) by half-split method. On calling y(x1) and y(x2) must not have the same sign, or -1 is returned signaling a failure. @@ -931,7 +932,7 @@ }//rootsearchhalf //--------------------------------------------------------------------------- -/* +/** function rootsearchsecant: searches for the root of y(x) in (x1, x2) by secant method. In: function y(x), @@ -992,7 +993,7 @@ return -1; }//rootsearchsecant -/* +/** function rootsearchbisecant: searches for the root of y(x) in (x1, x2) by bi-secant method. On calling given that y(x1) and y(x2) have different signs. The bound interval (x1, x2) converges to 0, as compared to standared secant method. @@ -1094,7 +1095,7 @@ }//rootsearchbisecant //--------------------------------------------------------------------------- -/* +/** function Search1Dmax: 1-dimensional maximum search within interval [inf, sup] using 0.618 method In: function F(x), @@ -1161,7 +1162,7 @@ return result; }//Search1Dmax -/* +/** function Search1DmaxEx: 1-dimensional maximum search using Search1Dmax, but allows setting a $len argument so that a pre-location of the maximum is performed by sampling (inf, sup) at interval $len, so that Search1Dmax will work on an interval no longer than 2*len. @@ -1199,7 +1200,7 @@ } }//Search1DmaxEx -/* +/** function Search1Dmaxfrom: 1-dimensional maximum search from start[] towards start+direct[]. The function tries to locate an interval ("step") for which the 4-point convexity rule confirms the existence of a convex maximum.
--- a/procedures.cpp Tue Oct 05 17:03:27 2010 +0100 +++ b/procedures.cpp Wed Oct 06 15:19:49 2010 +0100 @@ -8,6 +8,8 @@ #include "opt.h" #include "sinest.h" +/** \file procedures.h */ + //--------------------------------------------------------------------------- //TGMM methods @@ -40,7 +42,7 @@ delete[] Items; }//~TTFSpans -/* +/** method Add: add a new span to the list In: ATFSpan: the new span to add @@ -60,7 +62,7 @@ Count++; }//Add -/* +/** method Clear: discard the current content without freeing memory. */ void TTFSpans::Clear() @@ -68,7 +70,7 @@ Count=0; }//Clear -/* +/** method Delete: delete a span from current list In: Index: index to the span to delete @@ -85,7 +87,7 @@ //--------------------------------------------------------------------------- //SpecTrack methods -/* +/** method TSpecTrack::Add: adds a SpecPeak to the track. In: APeak: the SpecPeak to add. @@ -117,7 +119,7 @@ return ind; }//Add -/* +/** method TSpecTrack::TSpecTrack: creates a SpecTrack with an inital capacity. In: ACapacity: initial capacity, i.e. the number SpecPeak's to allocate storage space for. @@ -135,7 +137,7 @@ delete[] Peaks; }//TSpecTrack -/* +/** method InsertPeak: inserts a new SpecPeak into the track at a given index. Internal use only. In: APeak: the SpecPeak to insert. @@ -149,7 +151,7 @@ Count++; }//InsertPeak -/* +/** method TSpecTrack::LocatePeak: looks for a SpecPeak in the track that has the same time (t) as APeak. In: APeak: a SpecPeak @@ -177,7 +179,7 @@ }//LocatePeak //--------------------------------------------------------------------------- -/* +/** function: ACPower: AC power In: data[Count]: a signal @@ -199,7 +201,7 @@ }//ACPower //--------------------------------------------------------------------------- -/* +/** function Add: vector addition In: dest[Count], source[Count]: two vectors @@ -212,7 +214,7 @@ for (int i=0; i<Count; i++) *(dest++)+=*(source++); }//Add -/* +/** function Add: vector addition In: addend[count], adder[count]: two vectors @@ -227,7 +229,7 @@ //--------------------------------------------------------------------------- -/* +/** function ApplyWindow: applies window function to signal buffer. In: Buffer[Size]: signal to be windowed @@ -242,7 +244,7 @@ }//ApplyWindow //--------------------------------------------------------------------------- -/* +/** function Avg: average In: data[Count]: a data array @@ -259,7 +261,7 @@ }//Avg //--------------------------------------------------------------------------- -/* +/** function AvgFilter: get slow-varying wave trace by averaging In: data[Count]: input signal @@ -294,7 +296,7 @@ }//AvgFilter //--------------------------------------------------------------------------- -/* +/** function CalculateSpectrogram: computes the spectrogram of a signal In: data[Count]: the time-domain signal @@ -337,7 +339,7 @@ }//CalculateSpectrogram //--------------------------------------------------------------------------- -/* +/** function Conv: simple convolution In: in1[N1], in2[N2]: two sequences @@ -355,7 +357,7 @@ }//Conv //--------------------------------------------------------------------------- -/* +/** function Correlation: computes correlation coefficient of 2 vectors a & b, equals cos(aOb). In: a[Count], b[Count]: two vectors @@ -375,7 +377,7 @@ }//Correlation //--------------------------------------------------------------------------- -/* +/** function DCAmplitude: DC amplitude In: data[Count]: a signal @@ -395,7 +397,7 @@ return sqrt(2*power); }//DCAmplitude -/* +/** function DCPower: DC power In: data[Count]: a signal @@ -416,7 +418,7 @@ }//DCPower //--------------------------------------------------------------------------- -/* +/** DCT: discrete cosine transform, direct computation. For fast DCT, see fft.cpp. In: input[N]: a signal @@ -439,7 +441,7 @@ } }//DCT -/* +/** function IDCT: inverse discrete cosine transform, direct computation. For fast IDCT, see fft.cpp. In: input[N]: a signal @@ -459,7 +461,7 @@ }//IDCT //--------------------------------------------------------------------------- -/* +/** function DeDC: removes DC component of a signal In: data[Count]: the signal @@ -477,7 +479,7 @@ delete[] data2; }//DeDC -/* +/** function DeDC_static: removes DC component statically In: data[Count]: the signal @@ -492,7 +494,7 @@ }//DeDC_static //--------------------------------------------------------------------------- -/* +/** function DoubleToInt: converts double-precision floating point array to integer array In: in[Count]: the double array @@ -507,7 +509,7 @@ else {__int16* out16=(__int16*)out; for (int k=0; k<Count; k++) *(out16++)=floor(*(in++)+0.5);} }//DoubleToInt -/* +/** function DoubleToIntAdd: adds double-precision floating point array to integer array In: in[Count]: the double array @@ -532,7 +534,7 @@ }//DoubleToIntAdd //--------------------------------------------------------------------------- -/* +/** DPower: in-frame power variation In: data[Count]: a signal @@ -547,8 +549,8 @@ }//DPower //--------------------------------------------------------------------------- -/* - funciton Energy: energy +/** + function Energy: energy In: data[Count]: a signal @@ -562,7 +564,7 @@ }//Energy //--------------------------------------------------------------------------- -/* +/** function ExpOnsetFilter: onset filter with exponential impulse response h(t)=Aexp(-t/Tr)-Bexp(-t/Ta), A=1-exp(-1/Tr), B=1-exp(-1/Ta). @@ -587,7 +589,7 @@ return NormFactor; }//ExpOnsetFilter -/* +/** function ExpOnsetFilter_balanced: exponential onset filter without starting step response. It extends the input signal at the front end by bal*Ta samples by repeating the its value at 0, then applies the onset filter on the extended signal instead. @@ -612,7 +614,7 @@ }//ExpOnsetFilter_balanced //--------------------------------------------------------------------------- -/* +/** function ExtractLinearComponent: Legendre linear component In: data[Count+1]: a signal @@ -632,7 +634,7 @@ }//ExtractLinearComponent //--------------------------------------------------------------------------- -/* +/** function FFTConv: fast convolution of two series by FFT overlap-add. In an overlap-add scheme it is assumed that one of the convolvends is short compared to the other one, which can be potentially infinitely long. The long convolvend is devided into short segments, each of which is convolved with @@ -779,7 +781,7 @@ delete[] hbitinv; }//FFTConv -/* +/** function FFTConv: the simplified version using two output buffers instead of three. This is almost equivalent to setting zero=-size2 in the three-output-buffer version (so that post_buffer no longer exists), except that this version requires size2 (renamed HWid) be a power of 2, and pre_buffer point @@ -881,7 +883,7 @@ delete[] x2; delete[] tmp; delete[] hbitinv; }//FFTConv -/* +/** function FFTConv: fast convolution of two series by FFT overlap-add. Same as the three-output-buffer version above but using integer output buffers as well as integer source1. @@ -1022,7 +1024,7 @@ }//FFTConv //--------------------------------------------------------------------------- -/* +/** function FFTFilter: FFT with cosine-window overlap-add: This FFT filter is not an actural LTI system, but an block processing with overlap-add. In this function the blocks are overlapped by 50% and summed up with Hann windowing. @@ -1089,8 +1091,8 @@ FreeFFTBuffer(ldata); }//FFTFilter -/* - funtion FFTFilterOLA: FFTFilter with overlap-add support. This is a true LTI filter whose impulse +/** + function FFTFilterOLA: FFTFilter with overlap-add support. This is a true LTI filter whose impulse response is constructed using IFFT. The filtering is implemented by fast convolution. In: data[Count]: input data @@ -1123,7 +1125,7 @@ FreeFFTBuffer(spec); }//FFTFilterOLA -/* +/** function FFTFilterOLA: FFT filter with overlap-add support. In: data[Count]: input data @@ -1152,7 +1154,7 @@ FreeFFTBuffer(spec); }//FFTFilterOLA -/* +/** function FFTMask: masks a band of a signal with noise In: data[Count]: input signal @@ -1247,7 +1249,7 @@ }//FFTMask //--------------------------------------------------------------------------- -/* +/** function FindInc: find the element in ordered list data that is closest to value. In: data[Count]: a ordered list @@ -1265,7 +1267,7 @@ }//FindInc //--------------------------------------------------------------------------- -/* +/** function Gaussian: Gaussian function In: Vector[Dim]: a vector @@ -1293,7 +1295,7 @@ //--------------------------------------------------------------------------- -/* +/** function Hamming: calculates the amplitude spectrum of Hamming window at a given frequency In: f: frequency @@ -1333,7 +1335,7 @@ }//Hamming*/ //--------------------------------------------------------------------------- -/* +/** function HannSq: computes the square norm of Hann window spectrum (window-size-normalized) In: x: frequency, in bins @@ -1370,7 +1372,7 @@ return (re*re+im*im)/(N*N); }//HannSq -/* +/** function Hann: computes the Hann window amplitude spectrum (window-size-normalized). In: x: frequency, in bins @@ -1406,7 +1408,7 @@ return result/N; }//HannC -/* +/** function HxPeak2: fine spectral peak detection. This does detection and high-precision LSE estimation in one go. However, since in practise most peaks are spurious, LSE estimation is not necessary on them. Accordingly, HxPeak2 is deprecated in favour of faster but coarser peak picking methods, such as @@ -1513,7 +1515,7 @@ }//HxPeak2 //--------------------------------------------------------------------------- -/* +/** function InsertDec: inserts value into sorted decreasing list In: data[Count]: a sorted decreasing list. @@ -1580,7 +1582,7 @@ return end; }//InsertDec -/* +/** function InsertDec: inserts value and attached integer into sorted decreasing list In: data[Count]: a sorted decreasing list @@ -1622,7 +1624,7 @@ return end; }//InsertDec -/* +/** InsertInc: inserts value into sorted increasing list. In: data[Count]: a sorted increasing list. @@ -1675,7 +1677,7 @@ return PosToInsert; }//InsertInc -/* +/** function InsertInc: inserts value into sorted increasing list In: data[Count]: a sorted increasing list. @@ -1749,7 +1751,7 @@ return end; }//InsertInc -/* +/** function InsertInc: inserts value and attached integer into sorted increasing list In: data[Count]: a sorted increasing list @@ -1821,7 +1823,7 @@ return end; }//InsertInc -/* +/** function InsertIncApp: inserts value into flexible-length sorted increasing list In: data[Count]: a sorted increasing list. @@ -1862,7 +1864,7 @@ }//InsertIncApp //--------------------------------------------------------------------------- -/* +/** function InstantFreq; calculates instantaneous frequency from spectrum, evaluated at bin k In: x[hwid]: spectrum with scale 2hwid @@ -1900,7 +1902,7 @@ return result; }//InstantFreq -/* +/** function InstantFreq; calculates "frequency spectrum", a sequence of frequencies evaluated at DFT bins In: x[hwid]: spectrum with scale 2hwid @@ -1916,7 +1918,7 @@ }//InstantFreq //--------------------------------------------------------------------------- -/* +/** function IntToDouble: copy content of integer array to double array In: in: pointer to integer array @@ -1936,7 +1938,7 @@ }//IntToDouble*/ //--------------------------------------------------------------------------- -/* +/** function IPHannC: inner product with Hann window spectrum In: x[N]: spectrum @@ -1955,7 +1957,7 @@ //--------------------------------------------------------------------------- -/* +/** function lse: linear regression y=ax+b In: x[Count], y[Count]: input points @@ -1978,7 +1980,7 @@ }//lse //-------------------------------------------------------------------------- -/* +/** memdoubleadd: vector addition In: dest[count], source[count]: addends @@ -1992,7 +1994,7 @@ }//memdoubleadd //-------------------------------------------------------------------------- -/* +/** function Mel: converts frequency in Hz to frequency in mel. In: f: frequency, in Hz @@ -2004,7 +2006,7 @@ return 1127.01048*log(1+f/700); }//Mel -/* +/** function InvMel: converts frequency in mel to frequency in Hz. In: f: frequency, in mel. @@ -2016,7 +2018,7 @@ return 700*(exp(mel/1127.01048)-1); }//InvMel -/* +/** function MFCC: calculates MFCC. In: Data[FrameWidth]: data @@ -2063,7 +2065,7 @@ } }//MFCC -/* +/** function MFCCPrepareBands: returns a array of OVERLAPPING bands given in triples, whose 1st and 3rd entries are the start and end of a band, in bins, and the 2nd is a middle frequency. @@ -2094,7 +2096,7 @@ }//MFCCPrepareBands //--------------------------------------------------------------------------- -/* +/** function Multi: vector-constant multiplication In: data[count]: a vector @@ -2108,7 +2110,7 @@ for (int i=0; i<count; i++){*data=*data*mul; data++;} }//Multi -/* +/** function Multi: vector-constant multiplication In: in[count]: a vector @@ -2122,7 +2124,7 @@ for (int i=0; i<count; i++) *(out++)=*(in++)*mul; }//Multi -/* +/** function Multi: vector-constant multiply-addition In: in[count], adder[count]: vectors @@ -2137,7 +2139,7 @@ }//MultiAdd //--------------------------------------------------------------------------- -/* +/** function NearestPeak: finds a peak value in an array that is nearest to a given index In: data[count]: an array @@ -2169,7 +2171,7 @@ }//NearestPeak //--------------------------------------------------------------------------- -/* +/** function NegativeExp: fits the curve y=1-x^lmd. In: x[Count], y[Count]: sample points to fit, x[0]=0, x[Count-1]=1, y[0]=1, y[Count-1]=0 @@ -2214,7 +2216,7 @@ }//NegativeExp //--------------------------------------------------------------------------- -/* +/** function: NL: noise level, calculated on 5% of total frames with least energy In: data[Count]: @@ -2240,7 +2242,7 @@ }//NL //--------------------------------------------------------------------------- -/* +/** function Normalize: normalizes data to [-Maxi, Maxi], without zero shift In: data[Count]: data to be normalized @@ -2267,7 +2269,7 @@ return max; }//Normalize -/* +/** function Normalize2: normalizes data to a specified Euclidian norm In: data[Count]: data to normalize @@ -2287,7 +2289,7 @@ }//Normalize2 //--------------------------------------------------------------------------- -/* +/** function PhaseSpan: computes the unwrapped phase variation across the Nyquist range In: data[Count]: time-domain data @@ -2314,7 +2316,7 @@ }//PhaseSpan //--------------------------------------------------------------------------- -/* +/** function PolyFit: least square polynomial fitting y=sum(i){a[i]*x^i} In: x[N], y[N]: sample points @@ -2344,7 +2346,7 @@ }//PolyFit //--------------------------------------------------------------------------- -/* +/** function Pow: vector power function In: data[Count]: a vector @@ -2360,7 +2362,7 @@ }//Power //--------------------------------------------------------------------------- -/* +/** Rectify: semi-wave rectification In: data[Count]: data to rectify @@ -2381,7 +2383,7 @@ }//Rectify //--------------------------------------------------------------------------- -/* +/** function Res: minimum absolute residue. In: in: a number @@ -2399,7 +2401,7 @@ }//Res //--------------------------------------------------------------------------- -/* +/** function Romberg: Romberg algorithm for numerical integration In: f: function to integrate @@ -2432,7 +2434,7 @@ return h; }//Romberg -/* +/** function Romberg: Romberg algorithm for numerical integration, may return before specified depth on convergence. @@ -2481,7 +2483,7 @@ //analog and digital sinc functions //sinca(0)=1, sincd(0)=N, sinca(1)=sincd(1)=0. -/* +/** function sinca: analog sinc function. In: x: frequency @@ -2494,7 +2496,7 @@ return sin(M_PI*x)/(M_PI*x); }//sinca -/* +/** function sincd_unn: unnormalized discrete sinc function In: x: frequency @@ -2509,7 +2511,7 @@ }//sincd //--------------------------------------------------------------------------- -/* +/** SmoothPhase: phase unwrapping on module mpi*PI, 2PI by default In: Arg[Count]: phase angles to unwrap @@ -2533,7 +2535,7 @@ //--------------------------------------------------------------------------- //the stiff string partial frequency model f[m]=mf[1]*sqrt(1+B(m*m-1)). -/* +/** StiffB: computes stiffness coefficient from fundamental and another partial frequency based on the stiff string partial frequency model f[m]=mf[1]*sqrt(1+B(m*m-1)). @@ -2550,7 +2552,7 @@ }//StiffB //StiffF: partial frequency of a stiff string -/* +/** StiffFm: computes a partial frequency from fundamental frequency and partial index based on the stiff string partial frequency model f[m]=mf[1]*sqrt(1+B(m*m-1)). @@ -2565,7 +2567,7 @@ return m*f0*sqrt(1+B*(m*m-1)); }//StiffFm -/* +/** StiffF0: computes fundamental frequency from another partial frequency and stiffness coefficient based on the stiff string partial frequency model f[m]=mf[1]*sqrt(1+B(m*m-1)). @@ -2580,7 +2582,7 @@ return fm/m/sqrt(1+B*(m*m-1)); }//StiffF0 -/* +/** StiffM: computes 1-based partial index from partial frequency, fundamental frequency and stiffness coefficient based on the stiff string partial frequency model f[m]=mf[1]*sqrt(1+B(m*m-1)). @@ -2603,7 +2605,7 @@ }//StiffMd //--------------------------------------------------------------------------- -/* +/** TFFilter: time-frequency filtering with Hann-windowed overlap-add. In: data[Count]: input data
--- a/procedures.h Tue Oct 05 17:03:27 2010 +0100 +++ b/procedures.h Wed Oct 06 15:19:49 2010 +0100 @@ -1,8 +1,8 @@ #ifndef proceduresH #define proceduresH -/* - procedures.cpp - this file collects miscellaneous structures and functions. Not all of these are +/** + \file procedures.h - this file collects miscellaneous structures and functions. Not all of these are referenced somewhere else. */ @@ -14,7 +14,7 @@ #include "fft.h" #include "windowfunctions.h" -/* +/** macro testnn: non-negative test. This macro throws out an exception if the value of x is negative. */ #ifndef testnn @@ -34,7 +34,7 @@ //--------------------------------------------------------------------------- -/* +/** Tick count tool (stop watch) is made up of a TickClock struct and three macros that uses this structure as augument. @@ -95,7 +95,7 @@ double ph; //phase angle }; -/* +/** TSpecTrack is a class that maintains a list of TSpecPeak objects that form a spectral track. It models a sinusid track in sinusoid modeling. */ @@ -120,7 +120,7 @@ int Add(TSpecPeak& APeak); }; -/* +/** TTFSpans is a class that maintains a list of TFSpans. This is used to mark selected areas in the time- frequency plane for further processing. */
--- a/quickspec.cpp Tue Oct 05 17:03:27 2010 +0100 +++ b/quickspec.cpp Wed Oct 06 15:19:49 2010 +0100 @@ -4,9 +4,10 @@ #include <memory.h> #include "quickspec.h" +/** \file quickspec.h */ //--------------------------------------------------------------------------- -/* +/** method TQuickSpectrogram::TQuickSpectrogram: In: AParent: pointer argument for calling G, if G is specified @@ -39,7 +40,7 @@ }//~TQuickSpectrogram //--------------------------------------------------------------------------- -/* +/** method TQuickSpectrogram::A: accesses amplitude spectrogram by frame In: fr: frame index, 0-based @@ -55,7 +56,7 @@ }//A //--------------------------------------------------------------------------- -/* +/** method TQuickSpectrogram::AddBuffer: increases internal buffer by BufferSize frames. Allocated buffers beyond Capacity frames will not be indexed or used by TQuickSpectrogram. */ @@ -81,7 +82,7 @@ BufferCount++; }//AddBuffer -/* +/** method TQuickSpectrogram::AddBuffer: increase internal buffer by a multiple of BufferSize so that it will be enough to host another AddFrCount frames. */ @@ -91,7 +92,7 @@ }//AddBuffer //--------------------------------------------------------------------------- -/* +/** function IntToDouble: copy content of integer array to double array In: in: pointer to integer array @@ -108,7 +109,7 @@ else {__pint24 in24=(__pint24)in; for (int k=0; k<Count; k++) *(out++)=*(in24++);} }//IntToDouble -/* +/** function CalculateSpectrum: calculate spectrum of a signal in integer format In: Data[Wid]: integer array hosting waveform data @@ -132,7 +133,7 @@ } }//CalculateSpectrum -/* +/** function CalculateSpectrum: calculate spectrum of a signal in integer format, allowing the signal length $eff be shorter than the DFT size Wid. @@ -168,7 +169,7 @@ CalculateSpectrum(Data, BytesPerSample, win, Amp, Arg, Wid, w, x, hbi); }//CalculateSpectrum -/* +/** method TQuickSpectrogram::CalculateSpectrum: computes spectrogram at fr'th frame. In: fr: index to the frame whose spectrum is to be computed. fr must be between 0 and Capacity-1. @@ -229,7 +230,7 @@ }//CalculateSpectrum //--------------------------------------------------------------------------- -/* +/** method TQuickSpectrogram::FreeBuffers: discards all computed spectra and free all internal buffers. This returns the TQuickSpectrogram to its initial state before any frame is accessed. After calling FreeBuffers() all frames will be recomputed when they are accessed. @@ -249,7 +250,7 @@ }//FreeBuffers //--------------------------------------------------------------------------- -/* +/** method TQuickSpectrogram::Invalidate: renders all frames that have overlap with interval [From, To], measured in samples, as invalid. Invalid frames are recomputed when they are accessed again. @@ -271,7 +272,7 @@ }//Invalidate //--------------------------------------------------------------------------- -/* +/** method TQuickSpectrogram::Ph: accesses phase spectrogram by frame In: fr: frame index, 0-based @@ -287,7 +288,7 @@ }//Ph //--------------------------------------------------------------------------- -/* +/** method TQuickSpectrogram::SetFrCapacity: sets the capacity, i.e. the maximal number of frames handled by this TQuickSpectrogram. @@ -331,7 +332,7 @@ }//SetFrCapacity //--------------------------------------------------------------------------- -/* +/** method TQuickSpectrogram::Ph: accesses complex spectrogram by frame In: fr: frame index, 0-based
--- a/quickspec.h Tue Oct 05 17:03:27 2010 +0100 +++ b/quickspec.h Wed Oct 06 15:19:49 2010 +0100 @@ -2,7 +2,7 @@ #define QuickSpecH /* - QuickSpec.cpp - TQuickSpectrogram class + \file quickspec.h - TQuickSpectrogram class TQuickSpectrogram implements a compute-on-request spectrogram class. Every time one frame of the spectrogram is read from this class, it checks if the single-frame spectrogram has been computed @@ -23,7 +23,7 @@ #define QSpec_BufferSize 1024 //default initial buffer size, in frames, of TQuickSpectrogram -/* +/** __int24 is a 24bit signed integer type and __pint24 is its pointer type. Although __int24* will also return a pointer to an __int24 structure, operations based on __int24* may have unspecified results, depending on structure alignments imposed by compiler. It is therefore necessary to have an explicit @@ -72,7 +72,9 @@ }; #endif -/* + +typedef void (*GetBuf)(int Id, cdouble* &w, cdouble* &x, double* &win, int* &hbi, void* Parent); +/** TQuickSpectrogram is a spectrogram class the handles the computation and storage of a spectrogram. Using TQuickSpectrogram: @@ -93,31 +95,29 @@ Call Invalidate() to notify the object of changes of waveform content. Call FreeBuffers() to return the object to the initial state before step 2. */ - -typedef void (*GetBuf)(int Id, cdouble* &w, cdouble* &x, double* &win, int* &hbi, void* Parent); class TQuickSpectrogram { - int BufferCount; //number of buffers in use - int BufferSize; //number of frames each additional buffer holds - int FrCount; //number of allocated frames + int BufferCount; ///< number of buffers in use + int BufferSize; ///< number of frames each additional buffer holds + int FrCount; ///< number of allocated frames //internal storage of spectrogram - QSPEC_FORMAT** fPh; //phase spectrogram, optional - QSPEC_FORMAT** fA; //amplitude spectrogram, compulsory - cmplx<QSPEC_FORMAT>** fSpec; //complete complex spectrogram, optional + QSPEC_FORMAT** fPh; ///< phase spectrogram, optional + QSPEC_FORMAT** fA; ///< amplitude spectrogram, compulsory + cmplx<QSPEC_FORMAT>** fSpec; ///< complete complex spectrogram, optional //internal buffers (optional) for FFT - WindowType fwt; //type of window - int fWid; //size of window - int* fhbi; //half-size bit-inversed integer table - double fwdp; //additional parameter specifying window type - double* fwin; //internal window - cdouble* fw; //FFT twiddle factors - cdouble* fx; //FFT data buffer + WindowType fwt; ///< type of window + int fWid; ///< size of window + int* fhbi; ///< half-size bit-inversed integer table + double fwdp; ///< additional parameter specifying window type + double* fwin; ///< internal window + cdouble* fw; ///< FFT twiddle factors + cdouble* fx; ///< FFT data buffer //x and ph create-time switch - bool usex; //set at create time if complex spectrogram is required - bool useph; //set at create time if phase spectrogram is required + bool usex; ///< set at create time if complex spectrogram is required + bool useph; ///< set at create time if phase spectrogram is required //internal methods void AddBuffer(); @@ -127,32 +127,32 @@ public: //if specified, Parent is responsible to supply FFT buffers through GetFFTBuffers (optional) - int Id; //an identifier given at create time, used as argument for calling GetFFTBuffers() - void* Parent; //a pointer used as argument for calling GetFFTBuffers() - GetBuf GetFFTBuffers; //if specified, this supplies FFT buffers + int Id; ///< an identifier given at create time, used as argument for calling GetFFTBuffers() + void* Parent; ///< a pointer used as argument for calling GetFFTBuffers() + GetBuf GetFFTBuffers; ///< if specified, this supplies FFT buffers //index and validity arrays associated with internal storage - int Capacity; //size of $Frame[] and &Valid[], usually set to the total number of frames of the data - int* Frame; //indices to individual frames in internal storage - int* Valid; //validity tags to individual frames in internal storage + int Capacity; ///< size of $Frame[] and &Valid[], usually set to the total number of frames of the data + int* Frame; ///< indices to individual frames in internal storage + int* Valid; ///< validity tags to individual frames in internal storage - WindowType WinType; //window type for computing spectrogram - double WinParam; //additional parameter specifying certain window types (Gaussian, Kaiser, etc.) + WindowType WinType; ///< window type for computing spectrogram + double WinParam; ///< additional parameter specifying certain window types (Gaussian, Kaiser, etc.) - void* Data; //pointer to waveform audio - int DataLength; //length of waveform audio, in samples - int BytesPerSample; //bytes per sample of waveform audio + void* Data; ///< pointer to waveform audio + int DataLength; ///< length of waveform audio, in samples + int BytesPerSample; ///< bytes per sample of waveform audio - int Offst; //frame offset - int Wid; //frame size, the same as window size + int Offst; ///< frame offset + int Wid; ///< frame size, the same as window size __fastcall TQuickSpectrogram(void* AParent, int AnId, bool Ausex, bool Auseph, GetBuf G); __fastcall ~TQuickSpectrogram(); - QSPEC_FORMAT* __fastcall A(int fr); //accesses amplitude spectrogram at frame fr - void FreeBuffers(); //discards all computed frames and free memory - int Invalidate(int From, int To); //discards computed frames - QSPEC_FORMAT* __fastcall Ph(int fr); //accesses phase spectrogram at frame fr - cmplx<QSPEC_FORMAT>* __fastcall Spec(int fr); //accesses complex spectrogram at frame fr + QSPEC_FORMAT* __fastcall A(int fr); ///< accesses amplitude spectrogram at frame fr + void FreeBuffers(); ///< discards all computed frames and free memory + int Invalidate(int From, int To); ///< discards computed frames + QSPEC_FORMAT* __fastcall Ph(int fr); ///< accesses phase spectrogram at frame fr + cmplx<QSPEC_FORMAT>* __fastcall Spec(int fr); ///< accesses complex spectrogram at frame fr }; #endif
--- a/sinest.cpp Tue Oct 05 17:03:27 2010 +0100 +++ b/sinest.cpp Wed Oct 06 15:19:49 2010 +0100 @@ -8,8 +8,10 @@ #include "splines.h" #include "windowfunctions.h" +/** \file sinest.h */ + //--------------------------------------------------------------------------- -/* +/** function dsincd_unn: derivative of unnormalized discrete sinc function In: x, scale N @@ -38,7 +40,7 @@ return r; }//dsincd_unn -/* +/** function ddsincd_unn: 2nd-order derivative of unnormalized discrete sinc function In: x, scale (equivalently, window size) N @@ -74,7 +76,7 @@ }//ddsincd_unn //--------------------------------------------------------------------------- -/* +/** function Window: calculates the cosine-family-windowed spectrum of a complex sinusoid on [0:N-1] at frequency f bins with zero central phase. @@ -125,7 +127,7 @@ return x; }//Window -/* +/** function dWindow: calculates the cosine-family-windowed spectrum and its derivative of a complex sinusoid on [0:N-1] at frequency f bins with zero central phase. @@ -178,7 +180,7 @@ } }//dWindow -/* +/** function ddWindow: calculates the cosine-family-windowed spectrum and its 1st and 2nd derivatives of a complex sinusoid on [0:N-1] at frequency f bins with zero central phase. @@ -239,7 +241,7 @@ }//ddWindow //--------------------------------------------------------------------------- -/* +/** function IPWindow: computes the truncated inner product of a windowed spectrum with that of a sinusoid at reference frequency f. @@ -267,7 +269,7 @@ return IPWindow(f, p->x, p->N, p->M, p->c, p->iH2, p->k1, p->k2, true); }//IPWindow -/* +/** function ddIPWindow: computes the norm of the truncated inner product of a windowed spectrum with that of a sinusoid at reference frequency f, as well as its 1st and 2nd derivatives. @@ -306,7 +308,7 @@ }//ddIPWindow //--------------------------------------------------------------------------- -/* +/** function IPWindowC: computes the truncated inner product of a windowed spectrum with that of a sinusoid at reference frequency f. @@ -332,7 +334,7 @@ }//IPWindowC //--------------------------------------------------------------------------- -/* +/** function sIPWindow: computes the total energy of truncated inner products between multiple windowed spectra and that of a sinusoid at a reference frequency f. This does not consider phase alignment between the spectra, supposedly measured at a sequence of known instants. @@ -370,7 +372,7 @@ return sIPWindow(f, p->Fr, p->x, p->N, p->M, p->c, p->iH2, p->k1, p->k2, p->lmd); }//sIPWindow -/* +/** function dsIPWindow: computes the total energy of truncated inner products between multiple windowed spectra and that of a sinusoid at a reference frequency f, as well as its derivative. This does not consider phase synchronization between the spectra, supposedly measured at a sequence of known @@ -409,7 +411,7 @@ return dsIPWindow(f, p->Fr, p->x, p->N, p->M, p->c, p->iH2, p->k1, p->k2, p->sip); }//dsIPWindow -/* +/** function dsdIPWindow_unn: computes the energy of unnormalized truncated inner products between a given windowed spectrum and that of a sinusoid at a reference frequency f, as well as its 1st and 2nd derivatives. "Unnormalized" indicates that the inner product cannot be taken as the actual amplitude- @@ -454,7 +456,7 @@ return ddR2; }//ddsIPWindow_unn -/* +/** function ddsIPWindow: computes the total energy of truncated inner products between multiple windowed spectra and that of a sinusoid at a reference frequency f, as well as its 1st and 2nd derivatives. This does not consider phase synchronization between the spectra, supposedly measured at a sequence @@ -494,7 +496,7 @@ }//ddsIPWindow //--------------------------------------------------------------------------- -/* +/** function sIPWindowC: computes the total energy of truncated inner products between multiple frames of a spectrogram and multiple frames of a spectrogram of a sinusoid at a reference frequency f. @@ -546,7 +548,7 @@ return sIPWindowC(f, p->L, p->offst_rel, p->x, p->N, p->M, p->c, p->iH2, p->k1, p->k2); }//sIPWindowC -/* +/** function dsIPWindowC: computes the total energy of truncated inner products between multiple frames of a spectrogram and multiple frames of a spectrogram of a sinusoid at a reference frequency f, together with its derivative. @@ -593,7 +595,7 @@ return dsIPWindowC(f, p->L, p->offst_rel, p->x, p->N, p->M, p->c, p->iH2, p->k1, p->k2, p->sip); }//dsIPWindowC -/* +/** function ddsIPWindowC: computes the total energy of truncated inner products between multiple frames of a spectrogram and multiple frames of a spectrogram of a sinusoid at a reference frequency f, together with its 1st and 2nd derivatives. @@ -657,7 +659,7 @@ Further reading: "Least-square-error estimation of sinusoids.pdf" */ -/* +/** function LSESinusoid: LSE estimation of the predominant stationary sinusoid. In: x[N]: windowed spectrum @@ -727,7 +729,7 @@ pp=IPWindow(f, x, N, M, c, iH2, p.k1, p.k2, false); }//LSESinusoid -/* +/** function LSESinusoid: LSE estimation of stationary sinusoid predominant within [f1, f2]. In: x[N]: windowed spectrum @@ -769,7 +771,7 @@ return f; }//LSESinusoid -/* +/** function LSESinusoid: LSE estimation of stationary sinusoid near a given initial frequency within [f1, f2]. @@ -819,7 +821,7 @@ return result; }//LSESinusoid -/* +/** function LSESinusoidMP: LSE estimation of a stationary sinusoid from multi-frames spectrogram without considering phase-frequency consistency across frames. @@ -855,7 +857,7 @@ return errf; }//LSESinusoidMP -/* +/** function LSESinusoidMP: LSE estimation of a stationary sinusoid from multi-frames spectrogram without considering phase-frequency consistency across frames. @@ -899,7 +901,7 @@ }//LSESinusoidMPC //--------------------------------------------------------------------------- -/* +/** function IPMulti: least square estimation of multiple sinusoids, given their frequencies and an energy suppression index of eps, i.e. the least square error is minimized with an additional eps*||lmd||^2 term. @@ -926,7 +928,7 @@ delete List; }//IPMulti -/* +/** function IPMulti: least square estimation of multiple sinusoids, given their frequencies and an energy suppression index of eps, and optionally returns residue and sensitivity indicators for each sinusoid. @@ -977,7 +979,7 @@ delete List; }//IPMulti -/* +/** function IPMultiSens: computes the sensitivity of the least square estimation of multiple sinusoids given their frequencies . @@ -1009,7 +1011,7 @@ delete List; }//IPMultiSens -/* +/** function IPMulti: least square estimation of multi-sinusoids with GIVEN frequencies. This version operates in groups at least B bins from each other, rather than LSE all frequencies together. @@ -1056,7 +1058,7 @@ return 0; }//IPMulti -/* +/** function IPMulti_Direct: LSE estimation of multiple sinusoids given frequencies AND PHASES (direct method) @@ -1115,7 +1117,7 @@ return result; }//IPMulti_Direct -/* +/** function IPMulti_GS: LSE estimation of multiple sinusoids given frequencies AND PHASES (Gram-Schmidt method) In: x[Wid]: spectrum @@ -1173,7 +1175,7 @@ return result; }//IPMulti_GS -/* +/** function IPMulti: LSE estimation of I sinusoids given frequency and phase and J sinusoids given frequency only @@ -1234,7 +1236,7 @@ Further reading: "LSE estimation for 2 sinusoids with 1 at a fixed frequency.pdf" */ -/* +/** function WindowDuo: calcualtes the square norm of the inner product between windowed spectra of two sinusoids at frequencies f1 and f2, df=f1-f2. @@ -1262,7 +1264,7 @@ return result; }//WindowDuo -/* +/** function ddWindowDuo: calcualtes the square norm of the inner product between windowed spectra of two sinusoids at frequencies f1 and f2, df=f1-f2, with its 1st and 2nd derivatives @@ -1295,7 +1297,7 @@ return ddwindow; }//ddWindowDuo -/* +/** function sIPWindowDuo: calculates the square norm of the orthogonal projection of a windowed spectrum onto the linear span of the windowed spectra of two sinusoids at reference frequencies f1 and f2. @@ -1333,7 +1335,7 @@ return sIPWindowDuo(p->f1, f2, p->x, p->N, p->c, p->d, p->M, p->iH2, p->k1, p->k2, r1, r2); }//sIPWindowDuo -/* +/** function ddsIPWindowDuo: calculates the square norm, and its 1st and 2nd derivatives against f2,, of the orthogonal projection of a windowed spectrum onto the linear span of the windowed spectra of two sinusoids at reference frequencies f1 and f2. @@ -1382,7 +1384,7 @@ return ddsip2[0]; }//ddsIPWindowDuo -/* +/** function LSEDuo: least-square estimation of two sinusoids of which one has a fixed frequency In: x[N]: the windowed spectrum @@ -1427,7 +1429,7 @@ operators,¡± in Proc. ICMC¡¯02. G?teborg. 2002. */ -/* +/** function CDFTW: single-frequency windowed DTFT, centre-aligned In: data[Wid]: waveform data x @@ -1450,7 +1452,7 @@ } }//CDFTW -/* +/** function CuDFTW: single-frequency windowed DTFT of t*data[t], centre-aligned In: data[Wid]: waveform data x @@ -1474,7 +1476,7 @@ } }//CuDFTW -/* +/** function TFReas: time-frequency reassignment In: data[Wid]: waveform data @@ -1507,7 +1509,7 @@ else fslope=0; } //TFReas*/ -/* +/** function TFReas: sinusoid estimation using reassignment method In: data[Wid]: waveform data @@ -1567,7 +1569,7 @@ for the sinusoid modeling of audio," in Proc. EUSIPCO'09, Glasgow, 2009. */ -/* +/** function AdditiveUpdate: additive reestimation of time-varying sinusoid In: x[Count]: waveform data @@ -1643,7 +1645,7 @@ delete[] y; delete[] lf; delete[] ref; }//AdditiveUpdate -/* +/** function AdditiveAnalyzer: sinusoid analyzer with one additive update In: x[Count]: waveform data @@ -1663,7 +1665,7 @@ AdditiveUpdate(fs, as, phs, das, x, Count, Wid, Offst, BasicAnalyzer, reserved, LogA); }//AdditiveAnalyzer -/* +/** function MultiplicativeUpdate: multiplicative reestimation of time-varying sinusoid In: x[Count]: waveform data @@ -1728,7 +1730,7 @@ delete[] y; delete[] lf; delete[] lref; }//MultiplicativeUpdate -/* +/** function MultiplicativeAnalyzer: sinusoid analyzer with one multiplicative update In: x[Count]: waveform data @@ -1806,7 +1808,7 @@ sinusoids by demodulation," in Proc. DAFx'08, Espoo, 2008. */ -/* +/** function ReEstFreq: sinusoid reestimation by demodulating frequency. In: x[Wid+Offst*(FrCount-1)]: waveform data @@ -1896,7 +1898,7 @@ } }//ReEstFreq -/* +/** function ReEstFreq_2: sinusoid reestimation by demodulating frequency. This is that same as ReEstFreq(...) except that it calls Sinusoid(...) to synthesize the phase track used for demodulation and that it does not allow variable window sizes for estimating demodulated sinusoid. @@ -1975,7 +1977,7 @@ } }//ReEstFreq_2 -/* +/** function ReEstFreqAmp: sinusoid reestimation by demodulating frequency and amplitude. In: x[Wid+Offst*(FrCount-1)]: waveform data @@ -2087,7 +2089,7 @@ } }//ReEstFreqAmp -/* +/** function Reestimate2: iterative demodulation method for sinusoid parameter reestimation. In: x[(FrCount-1)*Offst+Wid]: waveform data @@ -2176,7 +2178,7 @@ using derivatives," in Proc. DAFx'09, Como, 2009. */ -/* +/** function Derivative: derivative method for estimating amplitude derivative, frequency, and frequency derivative given signal and its derivatives. @@ -2225,7 +2227,7 @@ FreeFFTBuffer(fft); }//Derivative -/* +/** function Xkw: computes windowed spectrum of x and its derivatives up to order K at angular frequency omg, from x using window w and its derivatives. @@ -2259,7 +2261,7 @@ } }//Xkw -/* +/** function Xkw: computes windowed spectrum of x and its derivatives up to order K at angular frequency omg, from x and its derivatives using window w. @@ -2286,7 +2288,7 @@ } }//Xkw -/* +/** function Derivative: derivative method for estimating the model log(s)=h[M]'r[M], by discarding extra equations @@ -2407,7 +2409,7 @@ DeAlloc2(A); }//Derivative*/ -/* +/** function DerivativeLS: derivative method for estimating the model log(s)=h[M]'r[M], least-square implementation @@ -2497,7 +2499,7 @@ DeAlloc2(A); }//DerivativeLS -/* +/** function DerivativeLS: derivative method for estimating the model log(s)=h[M]'r[M] using Fr measurement points a quarter of Wid apart from each other, implemented by least-square. @@ -2602,7 +2604,7 @@ modeling,¡± in Proc. ICASSP'05, Philadelphia, 2005. */ -/* +/** function RDFTW: windowed DTFT at frequency k bins In: data[Wid]: waveform data @@ -2629,7 +2631,7 @@ } }//RDFTW -/* +/** function TFAS05: the Abe-Smith method 2005 In: data[Wid]: waveform data @@ -2723,7 +2725,7 @@ f=feses/Wid, a=exp(yeses), ph=pheses, fslope=2*beta/2/M_PI, aesp=alf; }//TFAS05 -/* +/** function TFAS05_enh: the Abe-Smith method 2005 enhanced by LSE amplitude and phase estimation In: data[Wid]: waveform data @@ -2757,7 +2759,7 @@ }//TFAS05_enh //--------------------------------------------------------------------------- -/* +/** function DerivativeLSv_AmpPh: estimate the constant-term in the local derivative method. This is used by the local derivative algorithm, whose implementation is found in the header file as templates. @@ -2788,7 +2790,7 @@ sinusoids," under review. */ -/* +/** function setv: computes I test functions v[I] by modulation u[I] to frequency f In: u[I+1][Wid], du[I+1][Wid]: base-band test functions and their derivatives @@ -2816,7 +2818,7 @@ } }//setv -/* +/** function setvhalf: computes I half-size test functions v[I] by modulation u[I] to frequency f. In: u[I][hWid*2], du[I][Wid*2]: base-band test functions and their derivatives @@ -2840,7 +2842,7 @@ //#define ERROR_CHECK -/* +/** function DerivativePiecewise: Piecewise derivative algorithm. In this implementation of the piecewise method the test functions v are constructed from I "basic" (single-frame) test functions, each covering the same period of 2T, by shifting these I functions by steps of T. A total number of (L-1)I @@ -3023,7 +3025,7 @@ delete mlist; }//DerivativePiecewise -/* +/** function DerivativePiecewise2: Piecewise derivative algorithm in which the real and imaginary parts of the exponent are modelled separately. In this implementation of the piecewise method the test functions v are constructed from I "basic" (single-frame) test functions, each covering the same @@ -3278,7 +3280,7 @@ return ene; }//testsv -/* +/** function DerivativePiecewise3: Piecewise derivative algorithm in which the log amplitude and frequeny are modeled separately as piecewise functions. In this implementation of the piecewise method the test functions v are constructed from I "basic" (single-frame) test functions, each covering the same @@ -3444,7 +3446,7 @@ //initialization routines for the piecewise derivative method -/* +/** function seth: set h[M] to a series of power functions. In: M, T. @@ -3463,7 +3465,7 @@ } }//seth -/* +/** function setdh: set dh[M] to the derivative of a series of power functions. In: M, T. @@ -3483,7 +3485,7 @@ } }//setdh -/* +/** function setdih: set dih[M] to the difference of the integral of a series of power functions. In: M, I @@ -3502,7 +3504,7 @@ } }//setdih -/* +/** function sshLinear: sets M and h[M] for the linear spline model In: T @@ -3516,7 +3518,7 @@ for (int t=0; t<T; t++) h[0][t]=1, h[1][t]=t; }//sshLinear -/* +/** function sdihLinear: sets dih[M] for the linear spline model. For testing only. In: T @@ -3530,7 +3532,7 @@ for (int t=0; t<T; t++) dih[0][t]=1, dih[1][t]=t+0.5; }//sdihLinear -/* +/** function sshCubic: sets M and h[M] for cubic spline models. In: T @@ -3544,7 +3546,7 @@ for (int t=0; t<T; t++) h[3][t]=t*t*t, h[2][t]=t*t, h[1][t]=t, h[0][t]=1; }//sshCubic -/* +/** function sdihCubic: sets dih[M] for cubic spline models. In: T @@ -3561,7 +3563,7 @@ } }//sdihCubic*/ -/* +/** function ssALinearSpline: sets N and A[L] for the linear spline model In: L, M, T @@ -3577,7 +3579,7 @@ double iT=1.0/T; for (int l=0; l<L; l++) A[l][0][l]=1, A[l][1][l]=-iT, A[l][1][l+1]=iT; }//ssALinearSpline -/* +/** function ssLinearSpline: sets M, N, h and A for the linear spline model In: L, M, T @@ -3591,7 +3593,7 @@ ssALinearSpline(L, T, M, N, A, mlist); }//ssLinearSpline -/* +/** function ssACubicHermite: sets N and A[L] for cubic Hermite spline model In: L, M, T @@ -3613,7 +3615,7 @@ } }//ssACubicHermite -/* +/** function ssLinearSpline: sets M, N, h and A for the cubic Hermite spline model In: L, M, T @@ -3627,7 +3629,7 @@ ssACubicHermite(L, T, M, N, A, mlist); }//ssCubicHermite -/* +/** function ssACubicSpline: sets N and A[L] for cubic spline model In: L, M, T @@ -3662,7 +3664,7 @@ DeAlloc2(ML); DeAlloc2(MR); DeAlloc2(M42); }//ssACubicSpline -/* +/** function ssLinearSpline: sets M, N, h and A for the cubic spline model In: L, M, T @@ -3676,7 +3678,7 @@ ssACubicSpline(L, T, M, N, A, mlist, mode); }//ssCubicSpline -/* +/** function setu: sets u[I+1] as base-band windowed Fourier atoms, whose frequencies come in the order of 0, 1, -1, 2, -2, 3, -3, 4, etc, in bins. @@ -3707,7 +3709,7 @@ DeAlloc2(wins); }//setu -/* +/** function DerivativePiecewiseI: wrapper for DerivativePiecewise(), doing the initialization ,etc. In: L, T: number and length of pieces @@ -3739,7 +3741,7 @@ delete mlist; }//DerivativePiecewiseI -/* +/** function DerivativePiecewiseII: wrapper for DerivativePiecewise2(), doing the initialization ,etc. This models the derivative of log ampltiude and frequency as separate piecewise polynomials, the first specified by SpecifyA, the second by SpecifyB. @@ -3778,7 +3780,7 @@ delete mlist; }//DerivativePiecewiseII -/* +/** function DerivativePiecewiseIII: wrapper for DerivativePiecewise3(), doing the initialization ,etc. Notice that this time the log amplitude, rather than its derivative, is modeled as a piecewise polynomial specified by SpecifyA. @@ -3826,7 +3828,7 @@ delete mlist; }//DerivativePiecewiseIII -/* +/** function AmpPhCorrectionExpA: model-preserving amplitude and phase correction in piecewise derivative method. @@ -3968,3 +3970,4 @@ delete mlist; return result; }//AmpPhCorrectionExpA +
--- a/sinest.h Tue Oct 05 17:03:27 2010 +0100 +++ b/sinest.h Wed Oct 06 15:19:49 2010 +0100 @@ -1,8 +1,8 @@ #ifndef SinEstH #define SinEstH -/* - SinEst.cpp - sinusoid estimation algorithms +/** + \file sinest.h - sinusoid estimation algorithms */ @@ -118,7 +118,7 @@ double AmpPhCorrectionExpA(cdouble* s2, int N, cdouble* aita, int L, int T, cdouble* sre, int M, double** h, double** dih, double*** A, void (*SpecifyA)(int L, int T, int M, int &N, double*** &A, MList* mlist, int mode), int WinOrder); //--local derivative algorithms - general------------------------------------ -/* +/** template DerivativeLSv: local derivative algorithm for estimating time-varying sinusoids, "v" version, i.e. using tuned test functions. @@ -184,7 +184,7 @@ return result; }//DerivativeLSv -/* +/** template DerivativeLS: local derivative algorithm for estimating time-varying sinusoids, "u" version, i.e. using base-band test functions. @@ -214,7 +214,7 @@ return result; }//DerivativeLS -/* +/** template DerivativeLS_AmpPh: amplitude and phase estimation in the local derivative algorithm, "u" version @@ -238,7 +238,7 @@ return log(sv0/e0); }//DerivativeLS_AmpPh -/* +/** template DerivativeLS_AmpPh: amplitude and phase estimation in the local derivative algorithm, "u" version. @@ -265,7 +265,7 @@ cdouble DerivativeLSv_AmpPh(int, int, double**, cdouble*, cdouble*, cdouble); //the "v" version is implemented as a normal function in SinEst.cpp. -/* +/** template DerivativeLSv: local derivative algorithm for estimating time-varying sinusoids, "v" version. In: s[Wid]: waveform data @@ -282,7 +282,8 @@ lmd[0]=DerivativeLSv_AmpPh(Wid, M, integr_h, lmd, v[0], sv0); }//DerivativeLSv_AmpPh -/*template DerivativeLSv: local derivative algorithm for estimating time-varying sinusoids, "u" version. +/** + template DerivativeLSv: local derivative algorithm for estimating time-varying sinusoids, "u" version. In: s[Wid]: waveform data u[I][Wid], du[I][Wid]: base-band test functions and their derivatives @@ -299,7 +300,7 @@ lmd[0]=DerivativeLS_AmpPh(Wid, M, integr_h, lmd, omg, u[0], s); //sv0); }//DerivativeLSv -/* +/** template CosineWindows: generates the Hann^(K/2) window and its L-1 derivatives as Result[L][Wid+1] In: K, L, Wid
--- a/sinsyn.cpp Tue Oct 05 17:03:27 2010 +0100 +++ b/sinsyn.cpp Wed Oct 06 15:19:49 2010 +0100 @@ -1,12 +1,13 @@ //--------------------------------------------------------------------------- - #include "align8.h" #include "sinsyn.h" #include "splines.h" +/** \file sinsyn.h */ + //--------------------------------------------------------------------------- -/* +/** function Sinuoid: original McAuley-Quatieri synthesizer interpolation between two measurement points. In: T: length from measurement point 1 to measurement point 2 @@ -46,7 +47,7 @@ } }//Sinusoid -/* +/** function Sinuoid: original McAuley-Quatieri synthesizer interpolation between two measurement points, without returning interpolated sinusoid parameters. @@ -79,7 +80,7 @@ }//Sinusoid //--------------------------------------------------------------------------- -/* +/** function Sinusoid_direct: synthesizes sinusoid over [CountSt, CountEn) from tronomial coefficients of amplitude and frequency, direct implementation. @@ -107,7 +108,7 @@ p1=p1+2*M_PI*i*(fd+i*((fc/2)+i*((fb/3)+i*fa/4))); }//Sinusoid -/* +/** function Sinusoid: synthesizes sinusoid over [CountSt, CountEn) from tronomial coefficients of amplitude and frequency, recursive implementation. @@ -175,7 +176,7 @@ ph=p0+CountEn*(p1+CountEn*(p2+CountEn*(p3+CountEn*p4))); } -/* +/** function SinusoidExp: synthesizes complex sinusoid whose derivative log amplitude and frequency are trinomials @@ -210,7 +211,7 @@ ph=p0+CountEn*(p1+CountEn*(p2+CountEn*(p3+CountEn*p4))); }//SinusoidExp -/* +/** function SinusoidExp: synthesizes complex sinusoid piece whose derivative logarithm is h[M]'lamda[M]. This version also synthesizes its derivative. @@ -234,7 +235,7 @@ } }//SinusoidExp -/* +/** function SinusoidExp: synthesizes complex sinusoid piece whose derivative logarithm is h[M]'lamda[M]. This version does not synthesize its derivative. @@ -257,7 +258,7 @@ } }//SinusoidExp -/* +/** function SinusoidExpA: synthesizes complex sinusoid whose log amplitude and frequency are trinomials In: CountSt, CountEn @@ -289,7 +290,7 @@ ph=p0+CountEn*(p1+CountEn*(p2+CountEn*(p3+CountEn*p4))); }//SinusoidExpA -/* +/** function SinusoidExpA: synthesizes complex sinusoid whose log amplitude and frequency are trinomials with phase angle specified at both ends. @@ -327,7 +328,7 @@ } }//SinusoidExpA -/* +/** function SinusoidExpA: synthesizes complex sinusoid piece whose log amplitude is h[M]'p[M] and frequency is h[M]'q[M]. This version also synthesizes its derivative. @@ -351,7 +352,7 @@ } }//SinusoidExpA -/* +/** function SinusoidExpA: synthesizes complex sinusoid piece whose log amplitude is h[M]'p[M] and frequency is h[M]'q[M]. This version does not synthesize its derivative. @@ -374,7 +375,7 @@ } }//SinusoidExpA -/* +/** function SinusoidExpA: synthesizes complex sinusoid piece whose log amplitude is h[M]'p[M] and frequency is h[M]'q[M] with phase angle specified at both ends. This version does not synthesize its derivative. @@ -473,7 +474,7 @@ ph=p0+CountEn*(p1+CountEn*(p2+CountEn*(p3+CountEn*p4))); } //*/ -/* +/** function Sinusoid: recursive cos-sin generator with trinomial frequency In: CountSt, CountEn @@ -518,7 +519,7 @@ ph=p0+CountEn*(p1+CountEn*(p2+CountEn*(p3+CountEn*p4))); }//Sinusoid*/ -/* +/** function Sinusoids: recursive harmonic multi-sinusoid generator In: st, en @@ -604,7 +605,7 @@ free8(a); }//Sinusoids*/ -/* +/** function Sinusoid: synthesizes sinusoid piece from trinomial frequency and amplitude coefficients. In: CountSt, CountEn @@ -633,7 +634,7 @@ } }//Sinusoid -/* +/** function Sinusoid: synthesizes sinusoid piece from trinomial frequency and amplitude coefficients, returning sinusoid coefficients instead of waveform. @@ -671,7 +672,7 @@ } }//Sinusoid -/* +/** function Sinusoid: generates trinomial frequency and phase with phase correction. In: CountSt, CountEn @@ -696,7 +697,7 @@ } }//Sinusoid -/* +/** function SynthesizeSinusoid: synthesizes a time-varying sinusoid from a sequence of frequencies and amplitudes In: xs[Fr]: measurement points, should be integers although *xs has double type. @@ -729,7 +730,7 @@ return xrec; }//SynthesizeSinusoid -/* +/** function ShiftTrinomial: shifts the origin of a trinomial from 0 to T In: a3, a2, a1, a0. @@ -745,7 +746,7 @@ b0=a0+T*(b1-T*(b2-T*b3)); }//ShiftTrinomial -/* +/** function SynthesizeSinusoidP: synthesizes a time-varying sinusoid from a sequence of frequencies, amplitudes and phase angles
--- a/sinsyn.h Tue Oct 05 17:03:27 2010 +0100 +++ b/sinsyn.h Wed Oct 06 15:19:49 2010 +0100 @@ -1,8 +1,8 @@ #ifndef SinSynH #define SinSynH -/* - SinSyn.h - sinusoid synthesis routines for sinusoid modeling cycle. Functions named Sinusoid construct +/** + \file sinsyn.h - sinusoid synthesis routines for sinusoid modeling cycle. Functions named Sinusoid construct sinusoid segments whose amplitude and frequency are modeled as polynomials or linear combinations of basis functions; functions named SinusoidExp construct sinusoid segments whose logarithmic amplitude derivative and frequency are modeled thus; functions named SinusoidExpA construct sinusoid segments
--- a/splines.cpp Tue Oct 05 17:03:27 2010 +0100 +++ b/splines.cpp Wed Oct 06 15:19:49 2010 +0100 @@ -1,10 +1,11 @@ //--------------------------------------------------------------------------- - #include "splines.h" +/** \file splines.h */ + //--------------------------------------------------------------------------- -/* +/** function tridiagonal: solves linear system A[N][N]x[N]=d[N] where A is tridiagonal In: tridiagonal matrix A[N][N] gives as three vectors - lower subdiagonal @@ -27,7 +28,7 @@ d[k]=(d[k]-c[k]*d[k+1])/b[k]; }//tridiagonal -/* +/** function CubicSpline: computing piece-wise trinomial coefficients of a cubic spline In: x[N+1], y[N+1]: knots @@ -118,7 +119,7 @@ } }//CubicSpline -/* +/** function CubicSpline: computing piece-wise trinomial coefficients of a cubic spline with uniformly placed knots In: y[N+1]: spline values at knots (0, h, 2h, ..., Nh) @@ -205,7 +206,7 @@ } }//CubicSpline -/* +/** function Smooth_Interpolate: smoothly interpolate/extrapolate P-piece spline from P-1 values. The interpolation scheme is chosen according to P: P-1=1: constant
--- a/splines.h Tue Oct 05 17:03:27 2010 +0100 +++ b/splines.h Wed Oct 06 15:19:49 2010 +0100 @@ -1,8 +1,8 @@ #ifndef splinesH #define splinesH -/* - splines.cpp - spline interpolation routines +/** + \file splines.h - spline interpolation routines */ //--cubic spline construction routines---------------------------------------
--- a/tstream.h Tue Oct 05 17:03:27 2010 +0100 +++ b/tstream.h Wed Oct 06 15:19:49 2010 +0100 @@ -1,8 +1,8 @@ #ifndef TSTREAM_H #define TSTREAM_H -/* - TStream.h - a stream I/O interface without implementation. +/** + \file tstream.h - a stream I/O interface without implementation. This file is included to allow compiling relevent functions that uses Borland VCL's TStream class for abstract I/O purposes.
--- a/vibrato.cpp Tue Oct 05 17:03:27 2010 +0100 +++ b/vibrato.cpp Wed Oct 06 15:19:49 2010 +0100 @@ -1,6 +1,5 @@ //--------------------------------------------------------------------------- - #include <math.h> #include <string.h> #include "vibrato.h" @@ -10,6 +9,9 @@ #include "matrix.h" #include "splines.h" #include "xcomplex.h" + +/** \file vibrato.h */ + //--------------------------------------------------------------------------- //method TVo::TVo: default constructor TVo::TVo() @@ -29,7 +31,7 @@ if (LogASp) DeAlloc2(LogASp); }//~TVo -/* +/** method TVo::AllocateL: allocates or reallocates storage space whose size depends on L. This uses an external L value for allocation and updates L itself. */ @@ -41,7 +43,7 @@ F0C=&F0[L+2], F0D=&F0[(L+2)*2], A0C=&F0[(L+2)*3]; }//AllocateL -/* +/** method TVo::AllocateP: allocates or reallocates storage space whose size depends on P, using the interal P. */ @@ -54,7 +56,7 @@ if (LogASp) DeAlloc2(LogASp); Allocate2(double, P, M, LogASp); }//AllocateP -/* +/** method TVo::AllocatePK: allocates or reallocates storage space whose size depends on both P and K. */ void TVo::AllocatePK() @@ -66,7 +68,7 @@ Allocate2(double, P, K, fres); }//AllocatePK -/* +/** method TVo::GetOldP: returns the number of "equivalent" cycles of the whole duration. Although P-1 cycles are delineated by lp[P], the parts before lp[0] and after lp[P-1] are also a part of the harmonic sinusoid being modeled and therefore should be taken into account when necessary. @@ -76,7 +78,7 @@ return P-1+lp[0]/(lp[1]-lp[0])+(L-lp[P-1])/(lp[P-1]-lp[P-2]); }//GetOldP -/* +/** methodTVo::LoadFromFileHandle: reads TVo object from a file stream. */ void TVo::LoadFromFileHandle(FILE* file) @@ -99,7 +101,7 @@ fread(LogASp[0], sizeof(double), P*M, file); }//LoadFromFileHandle -/* +/** method TVo::ReAllocateL: reallocates storage space whose size depends on L, and transfer the contents. This uses an external L value for allocation but does not update L itself. */ @@ -115,7 +117,7 @@ F0=newF0; }//ReAllocateL -/* +/** method TVo::SaveToFile: saves a TVo object to a file. In: filename: path to the destination file. @@ -134,7 +136,7 @@ } }//SaveToFile -/* +/** method TVo::SaveToFileHandle: saves a TVo object to an open file stream. */ void TVo::SaveToFileHandle(FILE* file) @@ -160,7 +162,7 @@ //functions -/* +/** function AnalyzeV: calculates all basic and non-basic descriptors of a vibrato from a harmonic sinusoid @@ -333,7 +335,7 @@ } }//AnalyzeV -/* +/** function copeak: measures the similarity of F0 between frst and fren to a cosine cycle 0~2pi. In: F0[peakfr[frst]:peakfr[fren]] @@ -353,7 +355,7 @@ return rfs/sqrt(rff*rss); }//copeak -/* +/** function CorrectFS: time-shifts Fourier series so that maximum is reached at 0. This is done by finding the actual peak numerically then shifting it to 0. @@ -399,7 +401,7 @@ } }//CorrectFS -/* +/** function DeAM: amplitude demodulation based on given segmentation into cycles In: A1[Fr]: original amplitude @@ -449,7 +451,7 @@ delete[] frs; }//DeAM -/* +/** function DeAM: wrapper function using floating-point cycle boundaries In: A1[Fr]: original amplitude @@ -466,7 +468,7 @@ delete[] peakfr; }//DeAM -/* +/** function DeFM: frequency demodulation based on given segmentation into cycles In: f1[Fr], AA[Fr]: original frequency and partial-independent amplitude @@ -540,7 +542,7 @@ if (localf) delete[] f; }//DeFM -/* +/** function DeFM: wrapper function using floating-point cycle boundaries In: f1[Fr], AA[Fr]: original frequency and partial-independent amplitude @@ -561,7 +563,7 @@ delete[] peakfr; }//DeFM -/* +/** function FindPeaks: find modulation peaks of signal F0[] roughly periodical at $periodinframe In: F0[Fr]: modulated signal @@ -669,7 +671,7 @@ if (localpeaky) delete[] peaky; }//FindPeaks -/* +/** function FS: Fourier series decomposition In: data[frst:fren]: signal to decompose @@ -726,7 +728,7 @@ delete[] res; }//FS -/* +/** function FS_QR: Fourier series decomposition with QR orthogonalization. Since the Fourier series is applied on finite-length discrate signal, the Fourier components are no longer orthogonal to each other. A decreasing residue can be guaranteed by applying QR (or any other) orthogonalization process @@ -804,7 +806,7 @@ DeAlloc2(A); DeAlloc2(Q); DeAlloc2(R); }//FS_QR -/* +/** function InterpolateV: adjusts modulation rate to $rate times the current value. Since TVo is based on individual cycles, this operation involves finding new cycle boundaries and recomputing other single- cycle descriptors by interpolation. This is used for time stretching and cycle rate adjustment. @@ -890,7 +892,7 @@ #define MAXMOD 15.0 #define MINMOD 3.0 -/* +/** function RateAndReg: evaluates modulation rate and regularity In: data[frst:fren]: modulated signal, time measured in frames @@ -951,7 +953,7 @@ delete[] lf; }//RateAndReg -/* +/** function RegularizeV: synthesize a regular vibrato from the basic descriptors. In: V: a TVo object hosting vibrato descriptors @@ -995,7 +997,7 @@ delete[] fxr; }//RegularizeV -/* +/** function QIE: computes extremum using quadratic interpolation In: y[-1:1]: three points to interpolate from. It is assumed y[0] is larger (or smaller) than both @@ -1009,7 +1011,7 @@ return y[0]-0.25*b*b/a; }//QIE -/* +/** function QIE: computes extremum using quadratic interpolation In: y[-1:1]: three points to interpolate from. It is assumed y[0] is larger (or smaller) than both @@ -1025,7 +1027,7 @@ return y[0]-0.25*b*b/a; }//QIE -/* +/** function S_F: original source-filter estimation used in AES124. In: afres: filter response resolution @@ -1142,7 +1144,7 @@ return 0; }//S_F -/* +/** function S_F_SV: slow-variation source-filter estimation used in AES126, adapted from TSF to TVo. In: afres: filter response resolution @@ -1216,7 +1218,7 @@ return 0; }//S_F_SV -/* +/** function SynthesizeV: synthesizes a harmonic sinusoid from vibrato descriptors In: V: a TVo object hosting vibrato descriptors
--- a/vibrato.h Tue Oct 05 17:03:27 2010 +0100 +++ b/vibrato.h Wed Oct 06 15:19:49 2010 +0100 @@ -2,8 +2,8 @@ #define vibratoH -/* - vibrato.cpp - vibrato analysis and synthesis using harmonic sinusoids +/** + \file vibrato.h - vibrato analysis and synthesis using harmonic sinusoids Further reading: Wen X. and M. Sandler, "Analysis and synthesis of audio vibrato using harmonic sinusoids," in Proc. AES 124th Convention, Amsterdam, 2008. @@ -13,7 +13,7 @@ #include "hs.h" //--------------------------------------------------------------------------- -/* +/** TVo is the data structure hosting descriptors of a vibrato representation of a harmonic sinusoid. Its basic framework is shared by the TSF object which hosts a more elaborate source-filter model than TVo, but does not look into vibrato-specific features such as modulator shape. @@ -23,40 +23,40 @@ struct TVo { //basic characteristics - int M; //number of partials - int L; //number of frames - int P; //number of F0 peaks - double h; //hop size - double* F0C; //[0:L-1] pitch carrier - double* A0C; //[0:L-1] amplitude carreir - int afres; //filter model bins - double LogAF[4096]; //[0:afres-1] filter model + int M; ///< number of partials + int L; ///< number of frames + int P; ///< number of F0 peaks + double h; ///< hop size + double* F0C; ///< [0:L-1] pitch carrier + double* A0C; ///< [0:L-1] amplitude carreir + int afres; ///< filter model bins + double LogAF[4096]; ///< [0:afres-1] filter model - int* peakfr; //[0:P-1] peak positions, in frames - double* lp; //[0:P-1] peak positions, refined to floating-point values in frames - double* Dp; //[1:P-1] single-cycle rms of F0D - int* Kp; //[1:P-1] order of single-cycle modulator shape descriptor - double** fxr; //[1:P-1][0:2K] single-cycle modulator shape coefficients - cosine, sine, cosine, ... - double** LogASp; //[1:P-1][0:M-1] single-cycle source model + int* peakfr; ///< [0:P-1] peak positions, in frames + double* lp; ///< [0:P-1] peak positions, refined to floating-point values in frames + double* Dp; ///< [1:P-1] single-cycle rms of F0D + int* Kp; ///< [1:P-1] order of single-cycle modulator shape descriptor + double** fxr; ///< [1:P-1][0:2K] single-cycle modulator shape coefficients - cosine, sine, cosine, ... + double** LogASp; ///< [1:P-1][0:M-1] single-cycle source model int K; //other properties - double rate; //vibrato rate - double regularity;//vibrato regularity - double F0max; //maximal fundamental frequency - double F0min; //minimal fundamental frequency - double F0Cmax; //maximal fundamental carrier frequency - double F0Cmin; //minimal fundamental carrier frequency - double F0Overall; //overall average fundamental frequency - double F0Dmax; //maximal fundamental modulator frequency - double F0Dmin; //minimal fundamental modulator frequency - double* F0; //[0:L-1] pitch - double* F0D; //[0:L-1] pitch modulator - double D; //rms of F0D, - double LogAS[100];//[0:M-1] source model - double FXR[100]; //average cycle modulator shape coefficients - double FRes[50]; //average modulator residues - double** fres; //[1:P-1][0:K-1] single-cycle modulator residues + double rate; ///< vibrato rate + double regularity;///< vibrato regularity + double F0max; ///< maximal fundamental frequency + double F0min; ///< minimal fundamental frequency + double F0Cmax; ///< maximal fundamental carrier frequency + double F0Cmin; ///< minimal fundamental carrier frequency + double F0Overall; ///< overall average fundamental frequency + double F0Dmax; ///< maximal fundamental modulator frequency + double F0Dmin; ///< minimal fundamental modulator frequency + double* F0; ///< [0:L-1] pitch + double* F0D; ///< [0:L-1] pitch modulator + double D; ///< rms of F0D, + double LogAS[100];///< [0:M-1] source model + double FXR[100]; ///< average cycle modulator shape coefficients + double FRes[50]; ///< average modulator residues + double** fres; ///< [1:P-1][0:K-1] single-cycle modulator residues TVo(); ~TVo();
--- a/wavelet.cpp Tue Oct 05 17:03:27 2010 +0100 +++ b/wavelet.cpp Wed Oct 06 15:19:49 2010 +0100 @@ -5,8 +5,10 @@ #include "wavelet.h" #include "matrix.h" +/** \file wavelet.h */ + //--------------------------------------------------------------------------- -/* +/** function csqrt: real implementation of complex square root z=sqrt(x) In: xr and xi: real and imaginary parts of x @@ -28,7 +30,7 @@ } }//csqrt -/* +/** function Daubechies: calculates the Daubechies filter of a given order p In: filter order p @@ -103,7 +105,7 @@ found at N/8 points 4, 12, ..., N-4; etc. */ -/* +/** function dwtpqmf: in this implementation h and g are the same as reconstruction qmf filters. In fact the actual filters used are their mirrors and filter origin are aligned to the ends of the real filters, which turn out to be the starts of h and g. @@ -169,7 +171,7 @@ return n; }//dwtpqmf -/* +/** function dwtp: in this implementation h and g can be different from mirrored reconstruction filters, i.e. the biorthogonal transform. h[0] and g[0] are aligned at the ends of the filters, i.e. h[-M+1:0], g[-M+1:0]. @@ -225,7 +227,7 @@ return n; }//dwtp -/* +/** function dwtp: in this implementation h and g can be different size. h[0] and g[0] are aligned at the ends of the filters, i.e. h[-Mh+1:0], g[-Mg+1:0]. @@ -289,7 +291,7 @@ return n; }//dwtp -/* +/** function dwtp: in this implementation h and g can be arbitrarily located: h from $sh to $eh, g from $sg to $eg. @@ -345,7 +347,7 @@ return n; }//dwtp -/* +/** function idwtp: periodic wavelet reconstruction by qmf In: in[Count]: wavelet transform in interleaved format @@ -386,7 +388,7 @@ delete[] tmp; }//idwtp -/* +/** function idwtp: in which h and g can have different length. In: in[Count]: wavelet transform in interleaved format @@ -451,7 +453,7 @@ delete[] tmp; }//idwtp -/* +/** function idwtp: in which h and g can be arbitrarily located: h from $sh to $eh, g from $sg to $eg In: in[Count]: wavelet transform in interleaved format @@ -515,7 +517,7 @@ return c; } -/* +/** function splinewl: computes spline biorthogonal wavelet filters. This version of splinewl calcualtes the positive-time half of h and hm coefficients only. @@ -589,7 +591,7 @@ }//splinewl -/* +/** function splinewl: calculates the analysis and reconstruction filter pairs of spline biorthogonal wavelet (h, g) and (hm, gm). h has the size p1+1, hm has the size p1+2p2-1. @@ -729,7 +731,7 @@ }//splinewl //--------------------------------------------------------------------------- -/* +/** function wavpacqmf: calculate pseudo local cosine transforms using wavelet packet In: data[Count], Count=fr*WID, waveform data @@ -796,7 +798,7 @@ delete[] _data1; }//wavpacqmf -/* +/** function iwavpacqmf: inverse transform of wavpacqmf In: spec[Fr][Wid], Fr>M*2 @@ -853,7 +855,7 @@ delete[] _data1; }//iwavpacqmf -/* +/** function wavpac: calculate pseudo local cosine transforms using wavelet packet, In: data[Count], Count=fr*WID, waveform data @@ -939,7 +941,7 @@ delete[] _data1; }//wavpac -/* +/** function iwavpac: inverse transform of wavpac In: spec[Fr][Wid]
--- a/wavelet.h Tue Oct 05 17:03:27 2010 +0100 +++ b/wavelet.h Wed Oct 06 15:19:49 2010 +0100 @@ -1,8 +1,8 @@ #ifndef waveletH #define waveletH -/* - wavelet.cpp - wavelet routines +/** + \file wavelet.h - wavelet routines */ //--wavelet filter routines--------------------------------------------------
--- a/windowfunctions.cpp Tue Oct 05 17:03:27 2010 +0100 +++ b/windowfunctions.cpp Wed Oct 06 15:19:49 2010 +0100 @@ -5,7 +5,7 @@ #include "align8.h" //--------------------------------------------------------------------------- -/* +/** function I0: Bessel function of order zero Returns the Bessel function of x. @@ -26,7 +26,7 @@ return S; }//I0 -/* +/** function FillWindow: fills a buffer $Result with a window function. In: wt:window type @@ -103,7 +103,7 @@ } }//FillWindow -/* +/** function NewWindow: creates a window function. In: wt: window type @@ -120,7 +120,7 @@ return Result; }//NewWindow -/* +/** function NewWindow8: 8-byte aligned version of NewWindow. In: wt: window type @@ -139,7 +139,7 @@ return Result; }//NewWindow8 -/* +/** function NewdWindow: computes the derivative of a window function. In: wt: window type @@ -205,7 +205,7 @@ return Result; }//NewdWindow -/* +/** function NewddWindow: computes the 2nd-order derivative of a window function. In: wt: window type @@ -273,7 +273,7 @@ return Result; }//NewddWindow -/* +/** function NewdddWindow: computes the 3rd-order derivative of a window function. In: wt: window type Count: window size @@ -336,7 +336,7 @@ }//NewdddWindow //--------------------------------------------------------------------------- -/* +/** function windowspec: computes a few descriptors of a cosine family window. A window function in the cosine window family is the linear combination of a few cosine functions, therefore has a cosine decomposition.
--- a/windowfunctions.h Tue Oct 05 17:03:27 2010 +0100 +++ b/windowfunctions.h Wed Oct 06 15:19:49 2010 +0100 @@ -1,8 +1,8 @@ #ifndef WindowFunctionsH #define WindowFunctionsH -/* - WindowFunctions.cpp - implements a few common window functions. +/** + \file windowfunctions.h - implements a few common window functions. */ enum WindowType
--- a/xcomplex.h Tue Oct 05 17:03:27 2010 +0100 +++ b/xcomplex.h Wed Oct 06 15:19:49 2010 +0100 @@ -2,16 +2,15 @@ #define XCOMPLEX -/* - xcomplex.h - Xue's complex number class. +#include <math.h> + +/** + \file xcomplex.h - Xue's complex number class. This classes is modelled after standard c++ complex class, with a few additional methods. Unused standard member and non-member functions/operators may not have been implemented. */ -#include <math.h> - -//* template <class T> class cmplx { public: