jackaudio
/
jack1
mirror of https://github.com/jackaudio/jack1
1
0
Fork 0
Code Releases 19 Activity
Browse Source

Formatted jack.h for doxygen. 

git-svn-id: svn+ssh://jackaudio.org/trunk/jack@161 0c269be4-1314-0410-8aa9-9f06e86f4224
tags/0.109.0
trutkin 23 years ago
parent
81da32e158
commit
d546e98e2e
4 changed files with 1191 additions and 155 deletions
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. +3
    -1
      .cvsignore
  2. +1
    -5
      configure.in
  3. +922
    -0
      jack.dox
  4. +265
    -149
      jack/jack.h

+ 3
- 1
.cvsignore View File

@@ -9,14 +9,16 @@ jackd
jack_impulse_grabber
jack_simple_client
jack_monitor_client
jack_fltk_client
jackrec
jack_connect
jack_disconnect
*.la
*.pc
.libs
.deps
Makefile
Makefile.in
jack_fltk_client
configure
*.tar.gz
typescript


+ 1
- 5
configure.in View File

@@ -70,9 +70,5 @@ AC_SUBST(ADDON_DIR)

dnl check for the libraries we need

AC_OUTPUT(Makefile
jack.pc
jack/Makefile)


AC_OUTPUT(Makefile jack.pc jack/Makefile)


+ 922
- 0
jack.dox View File

@@ -0,0 +1,922 @@
# Doxyfile 1.2.14

# 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 (" ")

#---------------------------------------------------------------------------
# General configuration options
#---------------------------------------------------------------------------

# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
# by quotes) that should identify the project.

PROJECT_NAME = Jack

# 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 = 0.20.5

# 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 = reference

# 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:
# Brazilian, Chinese, Croatian, Czech, Danish, Dutch, Finnish, French,
# German, Greek, Hungarian, Italian, Japanese, Korean, Norwegian, Polish,
# Portuguese, Romanian, Russian, Slovak, Slovene, Spanish and Swedish.

OUTPUT_LANGUAGE = English

# 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 = YES

# 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

# 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 class will be included in the various
# overviews. This option has no effect if EXTRACT_ALL is enabled.

HIDE_UNDOC_CLASSES = NO

# 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

# 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 = NO

# 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. It is allowed to use relative paths in the argument list.

STRIP_FROM_PATH =

# 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

# 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 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
# users are adviced to set this option to NO.

CASE_SENSE_NAMES = YES

# 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 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 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

# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
# will put list of the files that are included by a file in the documentation
# of that file.

SHOW_INCLUDE_FILES = YES

# 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 the Qt-style comments (thus requiring an
# explict @brief command for a brief description.

JAVADOC_AUTOBRIEF = 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
# reimplements.

INHERIT_DOCS = YES

# 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 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

# 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

# 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 = NO

# 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 = NO

# 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 = NO

# 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 =

# 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 consist 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 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 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

#---------------------------------------------------------------------------
# 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

# 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.

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 = jack/jack.h

# 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

FILE_PATTERNS =

# 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.

EXCLUDE_PATTERNS =

# 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.

INPUT_FILTER =

# 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.

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.

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

# If the REFERENCED_BY_RELATION tag is set to YES (the default)
# then for each documented function all documented
# functions referencing it will be listed.

REFERENCED_BY_RELATION = YES

# If the REFERENCES_RELATION tag is set to YES (the default)
# then for each documented function all documented entities
# called/used by that function will be listed.

REFERENCES_RELATION = 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

HTML_STYLESHEET =

# 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 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 compressed HTML help file (.chm)
# of the generated HTML documentation.

GENERATE_HTMLHELP = NO

# 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 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

# 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

# If the GENERATE_TREEVIEW tag 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 and frames is required (for instance Mozilla, Netscape 4.0+,
# or Internet explorer 4.0+). Note that for large projects the tree generation
# can take a very long time. In such cases it is better to disable this feature.
# Windows users are probably better off using the HTML help feature.

GENERATE_TREEVIEW = 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

#---------------------------------------------------------------------------
# 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 = YES

# 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

# 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 = letter

# 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 = NO

# 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 = NO

# 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

#---------------------------------------------------------------------------
# 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 optimised 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 assigments. 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. Note that this
# feature is still experimental and incomplete at the
# moment.

GENERATE_XML = NO

#---------------------------------------------------------------------------
# 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 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_PREDEFINED 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.

PREDEFINED =

# If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY 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 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::addtions related to external references
#---------------------------------------------------------------------------

# The TAGFILES tag can be used to specify one or more tagfiles.

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 superceded by the HAVE_DOT option below. This is only a fallback. It is
# recommended to install and use dot, since it yield more powerful graphs.

CLASS_DIAGRAMS = 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

# 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 set to YES, the inheritance and collaboration graphs will show the
# relations between templates and their instances.

TEMPLATE_RELATIONS = YES

# 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 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 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

# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
# generated by dot. Possible values are gif, jpg, and png
# If left blank gif will be used.

DOT_IMAGE_FORMAT = gif

# 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 on 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 MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
# this value, doxygen will try to truncate the graph, so that it fits within
# the specified constraint. Beware that most browsers cannot cope with very
# large images.

MAX_DOT_GRAPH_WIDTH = 1024

# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
# this value, doxygen will try to truncate the graph, so that it fits within
# the specified constraint. Beware that most browsers cannot cope with very
# large images.

MAX_DOT_GRAPH_HEIGHT = 1024

# 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 intermedate dot files that are used to generate
# the various graphs.

DOT_CLEANUP = YES

#---------------------------------------------------------------------------
# Configuration::addtions related to the search engine
#---------------------------------------------------------------------------

# The SEARCHENGINE tag specifies whether or not a search engine should be
# used. If set to NO the values of all tags below this one will be ignored.

SEARCHENGINE = NO

# The CGI_NAME tag should be the name of the CGI script that
# starts the search engine (doxysearch) with the correct parameters.
# A script with this name will be generated by doxygen.

CGI_NAME = search.cgi

# The CGI_URL tag should be the absolute URL to the directory where the
# cgi binaries are located. See the documentation of your http daemon for
# details.

CGI_URL =

# The DOC_URL tag should be the absolute URL to the directory where the
# documentation is located. If left blank the absolute path to the
# documentation, with file:// prepended to it, will be used.

DOC_URL =

# The DOC_ABSPATH tag should be the absolute path to the directory where the
# documentation is located. If left blank the directory on the local machine
# will be used.

DOC_ABSPATH =

# The BIN_ABSPATH tag must point to the directory where the doxysearch binary
# is installed.

BIN_ABSPATH = /usr/local/bin/

# The EXT_DOC_PATHS tag can be used to specify one or more paths to
# documentation generated for other projects. This allows doxysearch to search
# the documentation for these projects as well.

EXT_DOC_PATHS =

+ 265
- 149
jack/jack.h View File

@@ -28,60 +28,81 @@ extern "C" {
#include <jack/types.h>
#include <jack/error.h>

/**
* Attemps to become a client of the Jack server.
*/

jack_client_t *jack_client_new (const char *client_name);

/**
* Disconnects from Jack server.
*/

int jack_client_close (jack_client_t *client);

/* register a function (and argument) to be called if and when the
JACK server shuts down the client thread. the function must
be written as if it were an asynchonrous POSIX signal
handler - use only async-safe functions, and remember that it
is executed from another thread. a typical function might
set a flag or write to a pipe so that the rest of the
application knows that the JACK client thread has shut
down.

NOTE: clients do not need to call this. it exists only
to help more complex clients understand what is going
on. if called, it must be called before jack_client_activate().
/**
* @param client The Jack client structure.
* @param function The jack_shutdown function pointer.
* @param arg The arguments for the jack_shutdown function.
*
* Register a function (and argument) to be called if and when the
* JACK server shuts down the client thread. The function must
* be written as if it were an asynchonrous POSIX signal
* handler --- use only async-safe functions, and remember that it
* is executed from another thread. A typical function might
* set a flag or write to a pipe so that the rest of the
* application knows that the JACK client thread has shut
* down.
*
* NOTE: clients do not need to call this. It exists only
* to help more complex clients understand what is going
* on. If called, it must be called before jack_client_activate().
*/

void jack_on_shutdown (jack_client_t *, void (*function)(void *arg), void *arg);
void jack_on_shutdown (jack_client_t *client, void (*function)(void *arg), void *arg);

/* see simple_client.c to understand what these do.
/**
* Tell the Jack serve to call 'process()' whenever there is work
* be done.
*/

int jack_set_process_callback (jack_client_t *, JackProcessCallback, void *arg);

/**
* Tell the Jack server to call 'bufsize()' whenever the
* maximum number of frames that will be passed to 'process()'
* changes.
*/
int jack_set_buffer_size_callback (jack_client_t *, JackBufferSizeCallback, void *arg);

/**
* Tell the Jack server to call 'srate()' whenver the sample rate of
* the system changes.
*/
int jack_set_sample_rate_callback (jack_client_t *, JackSampleRateCallback, void *arg);

int jack_set_port_registration_callback (jack_client_t *, JackPortRegistrationCallback, void *);
int jack_set_graph_order_callback (jack_client_t *, JackGraphOrderCallback, void *);

/**
* Tell the Jack server that the program is ready to start processing
* audio.
*/

int jack_activate (jack_client_t *client);
int jack_deactivate (jack_client_t *client);

/* this creates a new port for the client.
/**
* Tells the Jack server that the program should be removed from the
* processing graph.
*/

a port is an object used for moving data in or out of the client.
the data may be of any type. ports may be connected to each other
in various ways.
int jack_deactivate (jack_client_t *client);

a port has a short name, which may be any non-NULL and non-zero
length string, and is passed as the first argument. a port's full
name is the name of the client concatenated with a colon (:) and
then its short name.

a port has a type, which may be any non-NULL and non-zero length
string, and is passed as the second argument. for types that are
not built into the jack API (currently just
JACK_DEFAULT_AUDIO_TYPE) the client MUST supply a non-zero size
for the buffer as the fourth argument. for builtin types, the
fourth argument is ignored.

a port has a set of flags, enumerated below and passed as the third
/**
A port has a set of flags, enumerated below and passed as the third
argument in the form of a bitmask created by AND-ing together the
desired flags. the flags "IsInput" and "IsOutput" are mutually
desired flags. The flags "IsInput" and "IsOutput" are mutually
exclusive and it is an error to use them both.

*/

enum JackPortFlags {
@@ -90,7 +111,8 @@ enum JackPortFlags {
JackPortIsOutput = 0x2,
JackPortIsPhysical = 0x4, /* refers to a physical connection */

/* if JackPortCanMonitor is set, then a call to
/**
* if JackPortCanMonitor is set, then a call to
jack_port_request_monitor() makes sense.
Precisely what this means is dependent on the client. A typical
@@ -101,19 +123,19 @@ enum JackPortFlags {
Clients that do not control physical interfaces
should never create ports with this bit set.
*/
*/

JackPortCanMonitor = 0x8,

/* JackPortIsTerminal means:
/**
* JackPortIsTerminal means:

for an input port: the data received by the port
for an input port: the data received by the port
will not be passed on or made
available at any other port

for an output port: the data available at the port
does not originate from any
other port
does not originate from any other port

Audio synthesizers, i/o h/w interface clients, HDR
systems are examples of things that would set this
@@ -124,8 +146,32 @@ enum JackPortFlags {
};

/**
* Used for the flag argument of jack_port_register().
*/

#define JACK_DEFAULT_AUDIO_TYPE "32 bit float mono audio"

/**
* This creates a new port for the client.

A port is an object used for moving data in or out of the client.
the data may be of any type. Ports may be connected to each other
in various ways.

A port has a short name, which may be any non-NULL and non-zero
length string, and is passed as the first argument. A port's full
name is the name of the client concatenated with a colon (:) and
then its short name.

A port has a type, which may be any non-NULL and non-zero length
string, and is passed as the second argument. For types that are
not built into the jack API (currently just
JACK_DEFAULT_AUDIO_TYPE) the client MUST supply a non-zero size
for the buffer as the fourth argument. For builtin types, the
fourth argument is ignored.
*/

jack_port_t *
jack_port_register (jack_client_t *,
const char *port_name,
@@ -133,51 +179,78 @@ jack_port_register (jack_client_t *,
unsigned long flags,
unsigned long buffer_size);

/* this removes the port from the client, disconnecting
any existing connections at the same time.
/**
* This removes the port from the client, disconnecting
* any existing connections at the same time.
*/

int jack_port_unregister (jack_client_t *, jack_port_t *);

/* a port is an opaque type. these help with a few things */

/**
* Returns the name of the jack_port_t.
*/
const char * jack_port_name (const jack_port_t *port);

/**
* Returns the short name of the jack_port_t.
*/
const char * jack_port_short_name (const jack_port_t *port);

/**
* Returns the flags of the jack_port_t.
*/
int jack_port_flags (const jack_port_t *port);

/**
* Returns the type of the jack_port_t.
*/
const char * jack_port_type (const jack_port_t *port);

/**
* Returns 1 if the jack_port_t belongs to the jack_client_t.
*/
int jack_port_is_mine (const jack_client_t *, const jack_port_t *port);

/* this returns TRUE or FALSE to indicate if there are
any connections to/from the port argument.
/**
* This returns TRUE or FALSE to indicate if there are
* any connections to/from the port argument.
*/

int jack_port_connected (const jack_port_t *port);

/* this returns TRUE or FALSE if the port argument is
DIRECTLY connected to the port with the name given in
`portname'
/**
* This returns TRUE or FALSE if the port argument is
* DIRECTLY connected to the port with the name given in 'portname'
*/

int jack_port_connected_to (const jack_port_t *port, const char *portname);

/**
* This returns TRUE or FALSE if the two ports are
* directly connected to each other.
*/

int jack_port_connected_to_port (const jack_port_t *port, const jack_port_t *other_port);

/* this returns a null-terminated array of port names to
which the argument port is connected. if there are no
connections, it returns NULL.
/**
* This returns a null-terminated array of port names to which
* the argument port is connected. if there are no connections, it
* returns NULL.

the caller is responsible for calling free(3) on any
non-NULL returned value.
* The caller is responsible for calling free(3) on any
* non-NULL returned value.
*/

const char ** jack_port_get_connections (const jack_port_t *port);

/* this modifies a port's name, and may be called at any
time.
/**
* This modifies a port's name, and may be called at any time.
*/

int jack_port_set_name (jack_port_t *port, const char *name);

/* This returns a pointer to the memory area associated with the
/**
* This returns a pointer to the memory area associated with the
specified port. For an output port, it will be a memory area
that can be written to; for an input port, it will be an area
containing the data from the port's connection(s), or
@@ -193,96 +266,121 @@ int jack_port_set_name (jack_port_t *port, const char *name);

void *jack_port_get_buffer (jack_port_t *, nframes_t);

/* these two functions establish and disestablish a connection
between two ports. when a connection exists, data written
to the source port will be available to be read at the destination
port.

the types of both ports must be identical to establish a connection.

the flags of the source port must include PortIsOutput.
the flags of the destination port must include PortIsInput.
*/

/**
* Establishes a connection between two ports.
*
* When a connection exists, data written to the source port will
* be available to be read at the destination port.
*
* The types of both ports must be identical to establish a connection.
* The flags of the source port must include PortIsOutput.
* The flags of the destination port must include PortIsInput.
*/
int jack_connect (jack_client_t *,
const char *source_port,
const char *destination_port);

/**
* Removes a connection between two ports.
*
* The types of both ports must be identical to establish a connection.
* The flags of the source port must include PortIsOutput.
* The flags of the destination port must include PortIsInput.
*/
int jack_disconnect (jack_client_t *,
const char *source_port,
const char *destination_port);

/* these two functions perform the exact same function
as the jack_connect() and jack_disconnect(), but they
use port handles rather than names, which avoids
the name lookup inherent in the name-based versions.

it is envisaged that clients (dis)connecting their own
ports will use these two, wherease generic connection
clients (e.g. patchbays) will use the name-based
versions
*/
/**
* Performs the exact same function as jack_connect(), but it uses
* port handles rather than names, which avoids the name lookup inherent
* in the name-based version.
*
* It is envisaged that clients connecting their own ports will use these
* two, whereas generic connection clients (e.g. patchbays) will use the
* name-based versions.
*/

int jack_port_connect (jack_client_t *, jack_port_t *src, jack_port_t *dst);

/**
* Performs the exact same function as jack_disconnect(), but it uses
* port handles rather than names, which avoids the name lookup inherent
* in the name-based version.
*
* It is envisaged that clients disconnecting their own ports will use these
* two, whereas generic connection clients (e.g. patchbays) will use the
* name-based versions.
*/

int jack_port_disconnect (jack_client_t *, jack_port_t *);

/* A client may call this on a pair of its own ports to
semi-permanently wire them together. This means that
a client that wants to direct-wire an input port to
an output port can call this and then no longer
have to worry about moving data between them. Any data
arriving at the input port will appear automatically
at the output port.

The `destination' port must be an output port. The `source'
port must be an input port. Both ports must belong to
the same client. You cannot use this to tie ports between
clients. Thats what a connection is for.
/**
* A client may call this on a pair of its own ports to
* semi-permanently wire them together. This means that
* a client that wants to direct-wire an input port to
* an output port can call this and then no longer
* have to worry about moving data between them. Any data
* arriving at the input port will appear automatically
* at the output port.
*
* The 'destination' port must be an output port. The 'source'
* port must be an input port. Both ports must belong to
* the same client. You cannot use this to tie ports between
* clients. That is what a connection is for.
*/

int jack_port_tie (jack_port_t *src, jack_port_t *dst);

/* This undoes the effect of jack_port_tie(). The port
should be same as the `destination' port passed to
jack_port_tie().
/**
* This undoes the effect of jack_port_tie(). The port
* should be same as the 'destination' port passed to
* jack_port_tie().
*/

int jack_port_untie (jack_port_t *port);

/* a client may call this function to prevent other objects
from changing the connection status of a port. the port
/**
* A client may call this function to prevent other objects
from changing the connection status of a port. The port
must be owned by the calling client.
*/

int jack_port_lock (jack_client_t *, jack_port_t *);
int jack_port_unlock (jack_client_t *, jack_port_t *);

/* returns the time (in frames) between data being available
or delivered at/to a port, and the time at which it
arrived at or is delivered to the "other side" of the port.
/**
* This allows other objects to change the connection status of a port.
*/

e.g. for a physical audio output port, this is the time between
writing to the port and when the audio will be audible.
int jack_port_unlock (jack_client_t *, jack_port_t *);

for a physical audio input port, this is the time between the sound
being audible and the corresponding frames being readable from the
port.
/**
* Returns the time (in frames) between data being available
* or delivered at/to a port, and the time at which it
* arrived at or is delivered to the "other side" of the port.
* E.g. for a physical audio output port, this is the time between
* writing to the port and when the audio will be audible.
* For a physical audio input port, this is the time between the sound
* being audible and the corresponding frames being readable from the
* port.
*/

nframes_t jack_port_get_latency (jack_port_t *port);

/* this returns the maximum of the sum of the latencies in every
connection path that can be drawn between the port and other
ports with the JackPortIsTerminal flag set.
/**
* The maximum of the sum of the latencies in every
* connection path that can be drawn between the port and other
* ports with the JackPortIsTerminal flag set.
*/

nframes_t jack_port_get_total_latency (jack_client_t *, jack_port_t *port);

/* the port latency is zero by default. clients that control
/**
* The port latency is zero by default. Clients that control
physical hardware with non-zero latency should call this
to set the latency to its correct value. note that the value
to set the latency to its correct value. Note that the value
should include any systemic latency present "outside" the
physical hardware controlled by the client. for example,
physical hardware controlled by the client. For example,
for a client controlling a digital audio interface connected
to an external digital converter, the latency setting should
include both buffering by the audio interface *and* the converter.
@@ -290,67 +388,80 @@ nframes_t jack_port_get_total_latency (jack_client_t *, jack_port_t *port);

void jack_port_set_latency (jack_port_t *, nframes_t);

/* if JackPortCanMonitor is set for a port, then these 2 functions will
turn on/off input monitoring for the port. if JackPortCanMonitor
/**
* If JackPortCanMonitor is set for a port, then these 2 functions will
turn on/off input monitoring for the port. If JackPortCanMonitor
is not set, then these functions will have no effect.
*/

int jack_port_request_monitor (jack_port_t *port, int onoff);

/**
* If JackPortCanMonitor is set for a port, then these 2 functions will
turn on/off input monitoring for the port. If JackPortCanMonitor
is not set, then these functions will have no effect.
*/
int jack_port_request_monitor_by_name (jack_client_t *client, const char *port_name, int onoff);

/* if JackPortCanMonitor is set for a port, then this function will
turn on input monitoring if it was off, and will turn it off it
only one request has been made to turn it on. if JackPortCanMonitor
is not set, then this function will do nothing.
/**
* If JackPortCanMonitor is set for a port, then this function will
* turn on input monitoring if it was off, and will turn it off it
* only one request has been made to turn it on. If JackPortCanMonitor
* is not set, then this function will do nothing.
*/

int jack_port_ensure_monitor (jack_port_t *port, int onoff);

/* returns a true or false value depending on whether or not
input monitoring has been requested for `port'.
/**
* Returns a true or false value depending on whether or not
* input monitoring has been requested for 'port'.
*/

int jack_port_monitoring_input (jack_port_t *port);

/* this returns the sample rate of the jack system */
/**
* This returns the sample rate of the jack system
*/

unsigned long jack_get_sample_rate (jack_client_t *);

/* this returns the current maximum size that will
ever be passed to the "process" callback. it should only
be used *before* the client has been activated. after activation,
the client will be notified of buffer size changes if it
registers a buffer_size callback.
/**
* This returns the current maximum size that will
* ever be passed to the "process" callback. It should only
* be used *before* the client has been activated. After activation,
* the client will be notified of buffer size changes if it
* registers a buffer_size callback.
*/

nframes_t jack_get_buffer_size (jack_client_t *);

/* This function returns a NULL-terminated array of ports that match the
specified arguments.
port_name_pattern: a regular expression used to select ports by name.
if NULL or of zero length, no selection based on
name will be carried out.

type_name_pattern: a regular expression used to select ports by type.
if NULL or of zero length, no selection based on
type will be carried out.

flags: a value used to select ports by their flags. if
zero, no selection based on flags will be carried out.

The caller is responsible for calling free(3) any non-NULL returned
value.
/**
* @param port_name_pattern A regular expression used to select
* ports by name. If NULL or of zero length, no selection based
* on name will be carried out.
* @param type_name_pattern A regular expression used to select
* ports by type. If NULL or of zero length, no selection based
* on type will be carried out.
* @param flags A value used to select ports by their flags.
* If zero, no selection based on flags will be carried out.

* This function returns a NULL-terminated array of ports that match
* the specified arguments.
* The caller is responsible for calling free(3) any non-NULL returned value.
*/

const char ** jack_get_ports (jack_client_t *,
const char *port_name_pattern,
const char *type_name_pattern,
unsigned long flags);
const char ** jack_get_ports (jack_client_t *,
const char *port_name_pattern,
const char *type_name_pattern,
unsigned long flags);

/**
* Searchs for and returns the jack_port_t with the name value
* from portname.
*/
jack_port_t *jack_port_by_name (jack_client_t *, const char *portname);

/* If a client is told (by the user) to become the timebase
/**
* If a client is told (by the user) to become the timebase
for the entire system, it calls this function. If it
returns zero, then the client has the responsibility to
call jack_set_transport_info()) at the end of its process()
@@ -358,11 +469,16 @@ jack_port_t *jack_port_by_name (jack_client_t *, const char *portname);
*/

int jack_engine_takeover_timebase (jack_client_t *);

/**
* undocumented
*/
void jack_update_time (jack_client_t *, nframes_t);

/* this estimates the time that has passed since the
start jack server started calling the process()
callbacks of all its clients.
/**
* This estimates the time that has passed since the
* start jack server started calling the process()
* callbacks of all its clients.
*/

nframes_t jack_frames_since_cycle_start (jack_client_t *);


Write Preview
Loading…
Cancel
Save