diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Doxyfile.in | 852 | ||||
| -rw-r--r-- | doc/README.MINGWCROSS | 6 | ||||
| -rw-r--r-- | doc/README.dvb | 2 | ||||
| -rw-r--r-- | doc/README.dxr3 | 46 | ||||
| -rw-r--r-- | doc/README.freebsd | 6 | ||||
| -rw-r--r-- | doc/README.network_dvd | 6 | ||||
| -rw-r--r-- | doc/README.solaris | 14 | ||||
| -rw-r--r-- | doc/faq/faq.docbook | 198 | ||||
| -rw-r--r-- | doc/hackersguide/README | 2 | ||||
| -rw-r--r-- | doc/hackersguide/internals.docbook | 60 | ||||
| -rw-r--r-- | doc/hackersguide/intro.docbook | 2 | ||||
| -rw-r--r-- | doc/hackersguide/library.docbook | 94 | ||||
| -rw-r--r-- | doc/hackersguide/output.docbook | 18 | ||||
| -rw-r--r-- | doc/hackersguide/overview.docbook | 24 | ||||
| -rw-r--r-- | doc/hackersguide/stream.docbook | 8 | ||||
| -rw-r--r-- | doc/internal/HOWTO.release | 8 |
16 files changed, 673 insertions, 673 deletions
diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index 38d9179c3..e291e9a73 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -14,207 +14,207 @@ # Project related configuration options #--------------------------------------------------------------------------- -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded # by quotes) that should identify the project. PROJECT_NAME = @PACKAGE@ -# The PROJECT_NUMBER tag can be used to enter a project or revision number. -# This could be handy for archiving the generated documentation or +# 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 = @VERSION@ -# 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 +# 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 = @abs_top_builddir@/doc/api/ -# 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 +# 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, Finnish, French, German, Greek, Hungarian, -# Italian, Japanese, Japanese-en (Japanese with English messages), Korean, -# Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian, +# 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, Finnish, French, German, Greek, Hungarian, +# Italian, Japanese, Japanese-en (Japanese with English messages), Korean, +# Korean-en, Lithuanian, Norwegian, Polish, Portuguese, Romanian, Russian, # Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. OUTPUT_LANGUAGE = English -# This tag can be used to specify the encoding used in the generated output. -# The encoding is not always determined by the language that is chosen, -# but also whether or not the output is meant for Windows or non-Windows users. -# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES -# forces the Windows encoding (this is the default for the Windows binary), -# whereas setting the tag to NO uses a Unix-style encoding (the default for +# This tag can be used to specify the encoding used in the generated output. +# The encoding is not always determined by the language that is chosen, +# but also whether or not the output is meant for Windows or non-Windows users. +# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES +# forces the Windows encoding (this is the default for the Windows binary), +# whereas setting the tag to NO uses a Unix-style encoding (the default for # all platforms other than Windows). USE_WINDOWS_ENCODING = 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). +# 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 +# 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" +# 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 = +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 +# 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 +# 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 +# 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 +# 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 = @top_srcdir@ -# 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 +# 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 = +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 +# 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 the Qt-style comments (thus requiring an +# 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 # explicit @brief command for a brief description. JAVADOC_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 +# 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 DETAILS_AT_TOP tag is set to YES then Doxygen +# If the DETAILS_AT_TOP tag is set to YES then Doxygen # will output the detailed description near the top, like JavaDoc. -# If set to NO, the detailed description appears after the member +# If set to NO, the detailed description appears after the member # documentation. DETAILS_AT_TOP = 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 +# 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 +# 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. +# 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:". +# 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 = +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 +# 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 +# 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 -# 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 +# 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 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 +# 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 +# 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 @@ -223,275 +223,275 @@ SUBGROUPING = YES # 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 +# 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 +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class # will be included in the documentation. EXTRACT_PRIVATE = YES -# If the EXTRACT_STATIC tag is set to YES all static members of a file +# If the EXTRACT_STATIC tag is set to YES all static members of a file # will be included in the documentation. EXTRACT_STATIC = YES -# 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 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. +# 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 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. +# 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 +# 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 +# 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 +# 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. +# 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 = 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 +# 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 +# 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 +# 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 INLINE_INFO tag is set to YES (the default) then a tag [inline] +# 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 +# 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 +# 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_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. +# 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 +# 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 +# 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 +# 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 +# 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 +# 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 +# The ENABLED_SECTIONS tag can be used to enable conditional # documentation sections, marked by \if sectionname ... \endif. -ENABLED_SECTIONS = +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 +# 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 +# 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 +# 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 -# 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 +# 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 = +FILE_VERSION_FILTER = #--------------------------------------------------------------------------- # configuration options related to warning and progress messages #--------------------------------------------------------------------------- -# The QUIET tag can be used to turn on/off the messages that are generated +# 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 +# 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 +# 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 +# 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 +# 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 +# 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 +# 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 = +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 +# 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 = @abs_top_srcdir@/src @abs_top_builddir@/include -# 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 +# 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 -FILE_PATTERNS = +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. +# 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 = YES -# 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 +# 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 = +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 +# 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 +# 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 = */src/libw32dll/wine/* @@ -501,53 +501,53 @@ EXCLUDE_PATTERNS += */src/input/vcd/libvcd/* EXCLUDE_PATTERNS += */src/libxineadec/nosefart/* EXCLUDE_PATTERNS += */src/libxineadec/gsm610/* -# 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 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 = +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 +# 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 = +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. +# 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_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 = +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 +# 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 = +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 +# 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 = +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 +# 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 @@ -556,32 +556,32 @@ 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 +# 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 +# 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 +# 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 (the default) -# then for each documented function all documented +# 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 +# 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 @@ -593,16 +593,16 @@ REFERENCES_RELATION = YES 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 +# 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 +# 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 @@ -611,102 +611,102 @@ 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 +# 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 +# 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 +# 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 = +IGNORE_PREFIX = #--------------------------------------------------------------------------- # configuration options related to the HTML output #--------------------------------------------------------------------------- -# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# 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 +# 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 = . -# 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 +# 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 +# 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 = +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 +# 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 = +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 +# 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 = +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 +# 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) +# 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 -# 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 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]) +# 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, DHTML, CSS and frames is required (for instance Mozilla 1.0+, -# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are +# 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 (for instance Mozilla 1.0+, +# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). 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 +# 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 @@ -715,7 +715,7 @@ TREEVIEW_WIDTH = 250 # configuration options related to the LaTeX output #--------------------------------------------------------------------------- -# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will # generate Latex output. GENERATE_LATEX = NO @@ -724,316 +724,316 @@ GENERATE_LATEX = NO # configuration options related to the man page output #--------------------------------------------------------------------------- -# If the GENERATE_MAN tag is set to YES (the default) Doxygen will +# 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 +# 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 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 +# 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 preprocessor +# 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 +# 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 +# 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 = YES -# 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 +# 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 +# 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 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 = +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 +# 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 = +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 +# 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 = DOXYGEN XINE_COMPILE PREDEFINED += XINE_PACKED= ATTR_ALIGN(x)= XINE_PROTECTED= PREDEFINED += XINE_MALLOC= -# 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. +# 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 = +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 +# 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 +# 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 +# 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 +# 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 = +TAGFILES = -# When a file name is specified after GENERATE_TAGFILE, doxygen will create +# 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 = +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 +# 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 +# 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 +# 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 +# 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 +# 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 -# If set to YES, the inheritance and collaboration graphs will hide -# inheritance and usage relations if the target is undocumented +# 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 +# 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 +# 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 +# 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 +# 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 +# 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 +# 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 +# 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 +# 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 tags 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 +# If the CALL_GRAPH and HAVE_DOT tags 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 +# 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 +# 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 +# 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 +# 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 +# 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 = +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 +# 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 = +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 +# 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 +# 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 -# 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 a graph may be further truncated if the graph's -# image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH -# and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default), +# 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 a graph may be further truncated if the graph's +# image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH +# and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default), # the graph is not depth-constrained. MAX_DOT_GRAPH_DEPTH = 0 -# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent -# background. This is disabled by default, which results in a white background. -# 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 +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is disabled by default, which results in a white background. +# 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) +# 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 = NO -# 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 +# 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 +# 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 #--------------------------------------------------------------------------- -# Configuration::additions related to the search engine +# Configuration::additions related to the search engine #--------------------------------------------------------------------------- -# The SEARCHENGINE tag specifies whether or not a search engine should be +# 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 diff --git a/doc/README.MINGWCROSS b/doc/README.MINGWCROSS index 87ae57b60..d721ca941 100644 --- a/doc/README.MINGWCROSS +++ b/doc/README.MINGWCROSS @@ -81,7 +81,7 @@ In the following text are used symbols $PREFIX and $USER with this meaning: # # compile and install the compiler # - # if you'll want rerun this step, I recommend delete + # if you'll want rerun this step, I recommend delete # $PREFIX/i386-mingw32/sys-include # tar xzf gcc-core-3.3.1-20030804-1-src.tar.gz @@ -107,7 +107,7 @@ In the following text are used symbols $PREFIX and $USER with this meaning: 4. recompile w32api and mingw-runtime from sources (optional) - + # # installing must be into $PREFIX/i386-mingw32 # @@ -153,7 +153,7 @@ In the following text are used symbols $PREFIX and $USER with this meaning: tar xzf pthreads-w32-2-7-0-release.tar.gz cd pthreads-w32-2-7-0-release/ - make CROSS=i386-mingw32- PTHREAD_DEF=pthreadGC2.def clean GC + make CROSS=i386-mingw32- PTHREAD_DEF=pthreadGC2.def clean GC # # possibility to use pthread library in M$ Visual C (optional) # diff --git a/doc/README.dvb b/doc/README.dvb index 055bc2cfa..21e2a41db 100644 --- a/doc/README.dvb +++ b/doc/README.dvb @@ -130,7 +130,7 @@ file name the recorded stream is being written to. You can select the directory to save to in the xine configuration under the MISC tab, otherwise the plugin will record to your home directory. You can pause the recording at any time by pressing MENU4 (F3 in xine-ui, F4 in gxine). An OSD in the -top left hand corner will notify you of the status of the recording. +top left hand corner will notify you of the status of the recording. Pressing MENU4 again will resume recording. Have fun. diff --git a/doc/README.dxr3 b/doc/README.dxr3 index 41fe9ad74..2800067ff 100644 --- a/doc/README.dxr3 +++ b/doc/README.dxr3 @@ -41,45 +41,45 @@ here: XINE dxr3 plugin ================= -There are two different ways in which xine can make use of the dxr3 +There are two different ways in which xine can make use of the dxr3 card. -1. mpeg-1/mpeg-2 (DVD, VCD, ...) decoding and displaying. +1. mpeg-1/mpeg-2 (DVD, VCD, ...) decoding and displaying. This is the normal use. Instead of doing the mpeg decoding in software, xine sets up the display (TV or overlay) and sends the mpeg data via the kernel driver to the mpeg decoder on the dxr3 card, very much like the Windows player that you problably got with the card. In this mode, you should be using the dxr3 video decoder plugin together -with the dxr3 video out plugin. +with the dxr3 video out plugin. Xine should select the dxr3 video decoder plugin automatically when it encounters an mpeg stream, but it is possible it does not use the dxr3 -video out plugin by default. In that case, start xine with the +video out plugin by default. In that case, start xine with the "-V dxr3" argument to specify the dxr3 video out plugin. If you use another video out driver, such as Xv or XShm, xine won't be able to use the mpeg decoding capability of the dxr3 hardware and will -use libmpeg2 instead. +use libmpeg2 instead. Here's a short overview what happens when you play a dvd with xine using the dxr3 video out driver: -DVD -> split mpeg video and audio and audio streams +DVD -> split mpeg video and audio and audio streams -> send mpeg video to dxr3 -> image appears on screen -2. displaying non-mpeg video on dxr3 hardware. +2. displaying non-mpeg video on dxr3 hardware. -Non-mpeg video may be AVI, quicktime, windows media files or whatever -else xine can decode. +Non-mpeg video may be AVI, quicktime, windows media files or whatever +else xine can decode. -This option must be compiled in and requires a supported mpeg encoder. +This option must be compiled in and requires a supported mpeg encoder. At the moment there are three: - libavcodec from xine-lib's ffmpeg plugin (good quality, quite fast) - libfame from fame.sourceforge.net (very fast, good quality) (currently the 0.9 versions of libfame don't work, use the 0.8 versions) - librte (version 0.4) from zapping.sourceforge.net (fast, very good quality) If configure finds one or both it will compile in encoding support into -the dxr3 driver. +the dxr3 driver. In order to use this driver for output instead of, say, Xv, just start xine with the command line option "-V dxr3", for example @@ -102,7 +102,7 @@ system with at least 128 MB of RAM and a P-III/Athlon at 800 MHz. Here's an overview what happens when you play an AVI this way (compare this with the previous overview!) --> split video and audio streams -> decode video stream +-> split video and audio streams -> decode video stream -> encode video as mpeg-1 -> send mpeg-1 stream to dxr3 -> image appears on screen @@ -146,16 +146,16 @@ engine.decoder_priorities.dxr3-mpeg2: Zooming Feature (TVout Only) ============================ -Pressing the 'z' key enables another tv-only mode which zooms into the -centre of a 16:9 video to display much smaller (or none) black bars -top & bottom. It crops the video on the left and right sides to +Pressing the 'z' key enables another tv-only mode which zooms into the +centre of a 16:9 video to display much smaller (or none) black bars +top & bottom. It crops the video on the left and right sides to maintain the correct aspect ratio. Use SHIFT-z to disable. TV mode Cycling Feature ====================== -Pressing CTRL-o repeatedly will allow you to cycle between tv modes PAL, -PAL60, & NTSC. The format selected will only remain valid for the +Pressing CTRL-o repeatedly will allow you to cycle between tv modes PAL, +PAL60, & NTSC. The format selected will only remain valid for the current xine session, on startup the tv mode will revert to the default in .xine/config @@ -166,7 +166,7 @@ VGA overlay feature In previous versions of xine support, one had to use dxr3view in order to use the em8300 overlay mechanism. Now, since the xine 0.5 version, it is possible to output the em8300 overlay directly in the video -out window. +out window. In order to activate it, "dxr3.output.mode" must be set to "overlay". But it won't work until the old dxr3view works too (just a check). Before @@ -174,11 +174,11 @@ a first use, "autocal" has to be run. This will store the right overlay parameters in "~/.overlay". For more information, please consult the dxr3 howto too. -As of version 0.9.5, you can now switch between overlay and tv-out modes -on-the-fly, simply by hiding the video_out window ('h' key by default, -see the README file). If you want to start xine with video on the tv, -you can run xine with the -H option to auto-hide the vo window, instead -of changing the configuration (although you can still do that instead if you +As of version 0.9.5, you can now switch between overlay and tv-out modes +on-the-fly, simply by hiding the video_out window ('h' key by default, +see the README file). If you want to start xine with video on the tv, +you can run xine with the -H option to auto-hide the vo window, instead +of changing the configuration (although you can still do that instead if you prefer, of course). Have a look at the previous explained configuration options dxr3.output.keycolor diff --git a/doc/README.freebsd b/doc/README.freebsd index 900f60aa1..68dd5d84b 100644 --- a/doc/README.freebsd +++ b/doc/README.freebsd @@ -87,12 +87,12 @@ the file you have to patch is /sys/dev/ata/atapi-cd.c: ! case 2048: ! ccb[0] = ATAPI_READ_BIG; ! break; -! -! case 2352: +! +! case 2352: ! ccb[0] = ATAPI_READ_CD; ! ccb[9] = 0xf8; ! break; -! +! ! default: ! ccb[0] = ATAPI_READ_CD; ! ccb[9] = 0x10; diff --git a/doc/README.network_dvd b/doc/README.network_dvd index 4798b79f8..41c7750ff 100644 --- a/doc/README.network_dvd +++ b/doc/README.network_dvd @@ -86,7 +86,7 @@ installation for dvds (don't forget the trailing slash) - + protocol details ---------------- @@ -110,13 +110,13 @@ cdda commands: cdda_read <start_frame> <num_frames> <error code> <n> <n bytes (frames)> - + cdda_tochdr <error code> 0 <first_track> <last_track> cdda_tocentry <error code> 0 <track_mode> <first_frame_min> <first_frame_sec> <first_frame_frame> - + dvd commands: dvd_open diff --git a/doc/README.solaris b/doc/README.solaris index 9e78287a9..fb1fb408e 100644 --- a/doc/README.solaris +++ b/doc/README.solaris @@ -23,19 +23,19 @@ building xine on solaris GNU C compiler and as a standalone assembler command. A quick workaround when using the GCC from Sun's - "Software Companion" CD is to replace /usr/ccs/bin/as with a + "Software Companion" CD is to replace /usr/ccs/bin/as with a link to GNU as, for example like this: cd /usr/ccs/bin ln -s /opt/sfw/bin/gas gnu-as mv as sun-as ln -s gnu-as as - + (Use "ln -s gnu-as as" or "ln -s sun-as as" to switch between the two assemblers) -* To get VIS accelerated video decoding and colour space conversion +* To get VIS accelerated video decoding and colour space conversion on Solaris SPARC with an UltraSPARC cpu, download and install Sun's mediaLib 2.0 before compiling xine. mediaLib is available here: @@ -101,15 +101,15 @@ Known Problems If you have the solaris 8 companion CD installed, an Imlib package is already installed on your system, but it uses the "prefix" /opt/sfw. - + To work around the problem: - + - install a symbolic link /etc/imrc, pointing to /opt/sfw/etc/imrc (needs root permission) # ln -s /opt/sfw/etc/imrc /etc - or + or - install an ".imrc" file in your home directory, with the following contents: @@ -123,7 +123,7 @@ Known Problems block >4GB on a device using a logical blocksize != DEV_BSIZE (i.e. CDROM and DVD media). Due to a 32bit int overflow, a disk address modulo 4GB is accessed. - + There's no workaround available. See the following message for more details about this bug: diff --git a/doc/faq/faq.docbook b/doc/faq/faq.docbook index 641cd1c08..bffd955e3 100644 --- a/doc/faq/faq.docbook +++ b/doc/faq/faq.docbook @@ -19,7 +19,7 @@ <sect2 id="about"> <title>What is the xine engine?</title> - <para> + <para> The xine engine is a free media player engine. It comes in the form of a shared libarary and is typically used by media player frontends and other multimedia applications for playback of multimedia streams @@ -66,7 +66,7 @@ may have installed on your system. </para> </sect2> - + <sect2 id="pronounce"> <title>How do I pronounce "xine"?</title> <para> @@ -105,7 +105,7 @@ </para> <para> Other modules in CVS are: <filename>xine-plugin</filename> a mozilla browser plugin - for streaming media playback using xine, + for streaming media playback using xine, <filename>xine_www</filename> the xine project website sources. </para> @@ -217,8 +217,8 @@ <sect2 id="buildrequirements"> <title>What do I need to compile everything properly?</title> <para> - First of all an official and stable release of gcc. Also be aware - that patched gcc versions may break parts of xine and are therefore + First of all an official and stable release of gcc. Also be aware + that patched gcc versions may break parts of xine and are therefore not supported by the xine project. </para> <para> @@ -271,7 +271,7 @@ <command>make install</command></screen> </para> <para> - Make sure your <filename>/etc/ld.so.conf</filename> contains + Make sure your <filename>/etc/ld.so.conf</filename> contains <filename>/usr/local/lib</filename> and continue with: <screen> <command>ldconfig</command></screen> </para> @@ -281,7 +281,7 @@ <command>./configure</command> <command>make install</command></screen> </para> - </sect3> + </sect3> <sect3 id="completebuildinstr"> <title>Complete build instructions</title> <para> @@ -311,7 +311,7 @@ <command>make</command> <command>make install</command></screen> </para> - </sect3> + </sect3> </sect2> <sect2 id="rpmbuild"> @@ -456,7 +456,7 @@ <title>The Xv video-out plugin fails to compile!</title> <para> If you want to have Xv support compiled in, make sure you either have - a shared Xv library on your system, e.g. + a shared Xv library on your system, e.g. <command>ls /usr/X11R6/lib/libXv*</command> should give you some .so libs, like this: <screen> @@ -465,7 +465,7 @@ /usr/X11R6/lib/libXv.so.1</screen> </para> <para> - Alternatively you need to have libtool 1.4 or newer installed, then + Alternatively you need to have libtool 1.4 or newer installed, then libXv.a is sufficient. Otherwise you can create the shared versions yourself: <screen> <command>ld --whole-archive -shared -o libXv.so.1 libXv.a</command> @@ -483,7 +483,7 @@ <sect3 id="xinelibnotfound"> <title>I have installed xine-lib but the frontend complains about not finding it!</title> <para> - First of all take a closer look at the compilation instructions above again. + First of all take a closer look at the compilation instructions above again. You will probably find your answer there right away. </para> <para> @@ -513,7 +513,7 @@ <command>export LD_LIBRARY_PATH="$HOME/xine/lib:$LD_LIBRARY_PATH"</command></screen> </para> <para> - Now you can unpack tarballs e.g. in <filename>~/xine/src</filename> + Now you can unpack tarballs e.g. in <filename>~/xine/src</filename> (<command>mkdir ~/xine/src</command> if necessary) and do a <screen> <command>./configure --prefix=$HOME/xine</command> @@ -566,7 +566,7 @@ <filename>/dev/scd1</filename>, … in that case). Also make sure you (as a user) have sufficient (read and write) permissions on your DVD drive. This could mean you either have to change the device - permissions or add your user to a special group + permissions or add your user to a special group (e.g. <command>addgroup cdrom username</command>), depending on your setup and/or distribution. </para> @@ -576,7 +576,7 @@ smooth video output). Use a command like <command>hdparm -d 1 <device></command> on your DVD device. Please note that even if you're using ide-scsi - you will have to set the dma flag on the ide device node (e.g. + you will have to set the dma flag on the ide device node (e.g. <filename>/dev/hdc</filename>), not the mapped <filename>/dev/scd</filename> scsi device. </para> @@ -614,7 +614,7 @@ Once you have everything set up, try something like <command>gxine dvd:/</command> or <command>xine -p dvd:/</command> to start dvd playback. Some frontend also offer so-called autoplay - buttons or menu entries that start dvd playback immediately. + buttons or menu entries that start dvd playback immediately. </para> <para> Important: do not try to mount the DVD. Just insert it and hit the DVD autoplay @@ -645,7 +645,7 @@ drives is limited (usually about 5 times), after that your drive will stay locked to the region you last set it up for. </para> - </sect3> + </sect3> <sect3 id="regionset"> <title>I have problems setting up my RPC-2 drive for the right region!</title> <para> @@ -659,7 +659,7 @@ drives is limited (usually about 5 times), after that your drive will stay locked to the region you last set it up for. </para> - </sect3> + </sect3> </sect2> <sect2 id="vcdsupport"> @@ -720,7 +720,7 @@ <filename>test_svcd_pal.bin</filename>. Run xine with the MRL <!-- FIXME: This MRL needs to be changed --> <filename>vcd:/test_svcd_pal.cue:E0</filename>. - If you see something playing then this is a hardware problem. + If you see something playing then this is a hardware problem. You might also want to try starting playback-control with <!-- FIXME: This MRL needs to be changed --> <filename>vcd:/test_svcd_pal.cue:P1</filename>. @@ -784,7 +784,7 @@ If you have the VideoCD from the last step, then run the MRL <!-- FIXME: This MRL needs to be changed --> <filename>vcd:/test_svcd_pal.cue:P1</filename> - If this shows a still frame, but it just does not show when you + If this shows a still frame, but it just does not show when you hit either the "VCD" autoscan button or give a MRL without the P1 at the end then go to the next step. </para> @@ -799,7 +799,7 @@ </listitem> <listitem> <para> - You have a VideoCD with menu at beginning and can see it using an MRL + You have a VideoCD with menu at beginning and can see it using an MRL with P1 at the end, but you want to see it by hitting the "VCD" autoscan button as well? Check to see that you have the configuration entry <parameter>media.vcd.autoplay</parameter> set to <parameter>playlist</parameter>. @@ -835,7 +835,7 @@ <sect2 id="quicktime"> <title>Can I watch Quicktime (.mov, .mp4) files using xine?</title> <para> - Quicktime is just a system layer (container format) which can contain various + Quicktime is just a system layer (container format) which can contain various different audio and video formats. The system layer itself is fully supported in xine. However, some quicktime audio/video codecs are not natively supported yet. Luckily, if you are using a x86 compatible machine (any recent PC hardware should do) @@ -854,7 +854,7 @@ have to set <parameter>decoder.external.win32_codecs_path</parameter> in your xine config file accordingly). Restart xine then and you should be able to watch Quicktime trailers. - </para> + </para> </sect2> <sect2> @@ -1015,7 +1015,7 @@ Try to use the Xv driver, it greatly improves performance and quality because your graphics card does image scaling and colourspace conversion. The <link linkend="video">video section</link> contains important information - about several Xv drivers. + about several Xv drivers. </para> <para> If Xv cannot be used for some reason, make sure your display is set up @@ -1087,13 +1087,13 @@ Have your X-server (usually X.org or XFree86) running with higher priority. Most recent linux distributions (like RedHat 8.0 or Mandrake 9.0) should do that for you, improving not only xine but desktop responsiveness - in general. + in general. </para> <para> Use the "top" utility and verify under the "NI" column if the X process has a negative value, this indicates a higher priority. - See "The X Window User HOWTO – Performance considerations" for - further instructions + See "The X Window User HOWTO – Performance considerations" for + further instructions <ulink url="http://www.tldp.org/HOWTO/XWindow-User-HOWTO/performance.html"> http://www.tldp.org/HOWTO/XWindow-User-HOWTO/performance.html </ulink>. @@ -1117,7 +1117,7 @@ <listitem> <para> xine needs high speed memory access which depends on your chip set. - Make sure you enable all speed-improving options. + Make sure you enable all speed-improving options. </para> <para> Especially the via apollo pro chipset is known to be quite weird, @@ -1130,7 +1130,7 @@ </para> <para> This website centers around a windows-tool to tweak the chipset, you - can do the same on FreeBSD with <command>pciconf</command>. + can do the same on FreeBSD with <command>pciconf</command>. On some linux distributions there are similar tools. </para> </listitem> @@ -1179,7 +1179,7 @@ <parameter>engine.buffers.video_num_buffers:500</parameter> to a higher value (e.g. 1000 or 2500). </para> - </listitem> + </listitem> </itemizedlist> </para> </sect2> @@ -1231,7 +1231,7 @@ To use it make sure you have aalib installed correctly before you configure/build xine-lib and xine-ui. In addition to the <command>xine</command> binary a binary named <command>aaxine</command> should get built and installed. You can then use - something like: + something like: <screen> <command>aaxine foo.mpg</command></screen> to use aalib video output. </para> @@ -1258,7 +1258,7 @@ <title>What audio drivers does xine support? OSS? Alsa? Arts? Esd?</title> <para> Currently xine support audio output via OSS (Linux 2.4 and most - *BSD audio drivers), + *BSD audio drivers), ALSA 0.9 and 1.0 (ALSA 0.5.x is no longer supported), aRTs (KDE 3's sound daemon), ESounD (esd, gnome's sound daemon not recommended because it has serious issues with a/v sync), JACK, @@ -1279,7 +1279,7 @@ <para> You can enable xine's audio compressor. Most frontends have a settings window and in that you'll find a slider for the - compressor setting. The values are percent values, so a + compressor setting. The values are percent values, so a slider setting of 200 means that xine will double the volume of silent parts of the movie (loud parts stay the same). </para> @@ -1306,7 +1306,7 @@ <para> If this happens with any video, first try a different audio driver (<command>gxine -A oss</command>, <command>gxine -A arts</command>, - <command>xine -A alsa</command> …). + <command>xine -A alsa</command> …). </para> <para> If this problem only occurs with one specific stream, maybe switching to @@ -1316,8 +1316,8 @@ <para> If all this doesn't help, maybe you're missing an audio codec or you found a bug. If you decide to post your problem on the xine-user mailing list, - make sure to include all console output xine produced and also clearly - state what type of stream you tried to play back or, even better, make + make sure to include all console output xine produced and also clearly + state what type of stream you tried to play back or, even better, make a test stream available somewhere for developers to download and try. </para> </sect2> @@ -1356,8 +1356,8 @@ <sect2 id="sblivespdif"> <title>Getting SPDIF output from a SBLive 5.1 using OSS drivers</title> <para> - The following explains how to get the above configuration - going with xine. Some parts of it may applicable to other + The following explains how to get the above configuration + going with xine. Some parts of it may applicable to other configurations (cards that use the EMU10k1 chip) as well. </para> <sect3> @@ -1386,24 +1386,24 @@ <para> The OSS driver is maintained by creative and can be downloaded at <ulink url="http://opensource.creative.com/">http://opensource.creative.com/</ulink>. - The driver package contains documentation on how to install it. + The driver package contains documentation on how to install it. Besides that I'd like to add the following notes. </para> <para> In order to compile and install these drivers, you need a valid kernel configuration file. For RedHat Linux's pre-compiled kernels these - configuration files can be found in + configuration files can be found in <filename>/usr/src/linux/configs</filename>. After you've located the correct config file for your kernel, you need to copy it to <filename>/usr/src/linux/.config</filename> For example, when you run the 2.4.18-i686 kernel do : <screen> <command>cp /usr/src/linux/configs/kernel-2.4.18-i686.config /usr/src/linux/.config</command></screen> - Make sure that the emu10k1 module that is currently installed is + Make sure that the emu10k1 module that is currently installed is not loaded. To unload the modules: <screen> <command>/sbin/modprobe -rv emu10k1.o ac97_codec.o</command></screen> - If this mentions that the device is busy, some program is - using the driver. Some example could be a mixer application - or sound daemon like artsd. You'll need to close down the + If this mentions that the device is busy, some program is + using the driver. Some example could be a mixer application + or sound daemon like artsd. You'll need to close down the applications before continuing. At success it should print something like: <screen> @@ -1412,15 +1412,15 @@ # delete soundcore</screen> Run make in the directory where you unpacked the driver and follow the instructions printed at the end of each step. - The last step should be: + The last step should be: <screen> <command>make install-tools</command></screen> - As the README of the driver package mentions the SPDIF AC3 - output doesn't work by default. In the directory + As the README of the driver package mentions the SPDIF AC3 + output doesn't work by default. In the directory <filename>utils/scripts</filename> an <filename>emu10k1.conf</filename> file can be found which need to be placed in the default - installation directory (<filename>/usr/local/etc</filename>). + installation directory (<filename>/usr/local/etc</filename>). After this the <filename>emu10k1.conf</filename> needs to be modified. - The following settings worked fine for me (I don't use the analog + The following settings worked fine for me (I don't use the analog outputs of the card): <programlisting> CARD_IS_5_1=yes @@ -1434,20 +1434,20 @@ ANALOG_FRONT_BOOST=no SURROUND=no PROLOGIC=no - ENABLE_CD_Spdif=yes - ENABLE_OPTICAL_SPDIF=no - ENABLE_LINE2_MIC2=no - ENABLE_RCA_SPDIF=no + ENABLE_CD_Spdif=yes + ENABLE_OPTICAL_SPDIF=no + ENABLE_LINE2_MIC2=no + ENABLE_RCA_SPDIF=no ENABLE_RCA_AUX=no</programlisting> - After modifying the <filename>emu10k1.conf</filename>, + After modifying the <filename>emu10k1.conf</filename>, you need to modify your <filename>/etc/modules.conf</filename> and make sure the following lines are in there. <programlisting> alias sound-slot-0 emu10k1 post-install emu10k1 /usr/local/etc/emu-script</programlisting> - After saving the changes to <filename>modules.conf</filename>, run + After saving the changes to <filename>modules.conf</filename>, run <screen> <command>/sbin/depmod -a</command></screen> - Now, you're ready to load the new modules and set the correct + Now, you're ready to load the new modules and set the correct options for it. To load the modules run: <screen> <command>/sbin/modprobe emu10k1</command></screen> </para> @@ -1463,7 +1463,7 @@ </sect3> <sect3> <title> - The cable used for the SBLive can easily be self-made + The cable used for the SBLive can easily be self-made or buy a stereo 3.5mm jack to dual RCA cable. </title> <para> @@ -1480,10 +1480,10 @@ </para> <para> In order to test it use a DVD with AC3 or DTS track - start xine and select the right audio track - from user interface or start xine as: + start xine and select the right audio track + from user interface or start xine as: <screen> <command>xine dvd:/1 -a 0</command></screen> - The external decoder should display something like + The external decoder should display something like "Dolby Digital" in case the selected audio track contains AC3 data or "DTS" in case the selected audio track contains DTS data. Of course stereo audio also goes @@ -1504,7 +1504,7 @@ <para> Note that recently we added support to "simulate" volume in aRts by changing sample values on-the-fly before delivering them to the driver. - Not as good as having access to sound card's mixer but at least users + Not as good as having access to sound card's mixer but at least users will not complain about lacking of volume bar anymore! :) </para> </sect2> @@ -1513,7 +1513,7 @@ <title>Audio is stuttering and i see a lot of "metronom: fixing sound card drift by -2115 pts" on the console output</title> <para> Might be a soundcard problem, if it only comes in longer intervals. - Your soundcard does not keep it's sampling frequency accurately + Your soundcard does not keep it's sampling frequency accurately enough, which results in audio and video getting out of sync and xine has to compensate. If you see the message only from time to time, you might remedy it by using the resampling sync @@ -1534,7 +1534,7 @@ </para> <para> Occasional messages of "fixing sound card drift" may happen on start and - when playing a long stream (like a movie). This is normal behaviour, + when playing a long stream (like a movie). This is normal behaviour, nothing to worry about. </para> </sect2> @@ -1578,7 +1578,7 @@ questions. </para> </sect2> - + <sect2 id="bluescreen"> <title>I only see a blue (or green or black) video image most of the time.</title> <para> @@ -1592,7 +1592,7 @@ <filename>/etc/X11/xorg.conf</filename> or <filename>/etc/X11/XF86Config</filename>). </para> </sect2> - + <sect2 id="buggyxv"> <title>The image looks strange, it is shifted, cropped or shows weird lines!</title> <para> @@ -1637,18 +1637,18 @@ hardware. Here are some hints for individual gfx chips: <itemizedlist> <listitem> - <para> + <para> 3Dfx: if all you get is a solid black window, upgrade to X.org or XFree 4.1.0 or later. </para> </listitem> <listitem> - <para> + <para> ATI: if you only get "half a picture", try lowering your resolution - or bit depth, disable DRI (looks like you ran out of video RAM) + or bit depth, disable DRI (looks like you ran out of video RAM) </para> </listitem> <listitem> - <para> + <para> Trident card: If you see vertical bands jumbled, upgrade to the latest xfree/experimental trident drivers (for the CyberBlade XP a driver exists here: @@ -1656,61 +1656,61 @@ </para> </listitem> <listitem> - <para> + <para> nVidia: With newer GeForce cards, Xv should work with XFree 4.2.0 or newer, for older RivaTNT cards use the binary drivers from nvidia (of course the binary drivers work as well for GeForce cards) </para> </listitem> <listitem> - <para> + <para> Mach64/Rage3D (not Rage128/Radeon) cards/chips get no XVideo with - standard drivers, try + standard drivers, try <ulink url="http://gatos.sourceforge.net/">GATOS drivers </ulink> instead </para> </listitem> <listitem> - <para> + <para> intel: i815 has Xv support in XFree 4.x, others unknown </para> </listitem> <listitem> - <para> + <para> Permedia 2/3 has Xv support in XFree 4.x </para> </listitem> <listitem> - <para> + <para> Savage: at least some older drivers tend to lock up the whole machine, - try the drivers available from + try the drivers available from <ulink url="http://www.probo.com/timr/savage40.html"> http://www.probo.com/timr/savage40.html </ulink>. </para> </listitem> <listitem> - <para> + <para> SIS: certain controllers (more info needed!) have Xv support in XFree 4.x </para> </listitem> <listitem> - <para> + <para> Chips and Tech 6555x, 68554, 69000, 69030 have Xv support in XFree 4.x </para> </listitem> <listitem> - <para> + <para> NeoMagic: certain controllers (more info needed!) have Xv support in Xfree 4.x </para> </listitem> <listitem> - <para> + <para> SiliconMotion: certain controllers (more info needed!) have Xv support in Xfree 4.x </para> </listitem> <listitem> - <para> + <para> Matrox: G200 or newer (but not Parhelia) have Xv support in XFree 4.x. For Parhelia, use the binary only drivers available from matrox' website. </para> @@ -1768,12 +1768,12 @@ <para> Usually xine discovers the screen aspect ratio by querying the X-server and then adjusts the video automatically - to make it look right. However, if that doesn't work try + to make it look right. However, if that doesn't work try pressing "a" to manually change the aspect ratio. </para> <para> If you have a wide screen monitor, make sure the X-server - is correctly configured. The X-server must know the physical + is correctly configured. The X-server must know the physical size of the screen, which is independent of the resolution being used. </para> @@ -1792,7 +1792,7 @@ For XFree86, the filename is normally <filename>/etc/X11/XF86Config</filename>. </para> <para> - Where <parameter>DisplaySize</parameter> specifies, + Where <parameter>DisplaySize</parameter> specifies, in millimeters, the physical size of the monitor's picture area. </para> </sect2> @@ -1806,7 +1806,7 @@ <para> The difference between these counters is a little subtle for the non developer. There are two threads running in order to display video: - the decoder thread will deliver frames to the video output thread. + the decoder thread will deliver frames to the video output thread. The latter is responsible for scheduling the frames to be displayed at the right time. </para> @@ -1843,7 +1843,7 @@ </para> <para> Please note that some frontends save these settings in their config file - so when you have found a working combination, make sure you exit + so when you have found a working combination, make sure you exit xine cleanly so the values are saved. </para> </sect2> @@ -1862,13 +1862,13 @@ Xv by default. </para> <para> - However some users may want to explore better the available hardware + However some users may want to explore better the available hardware capabilities (eg. syncing frame drawing with monitor refresh). Also some Xv drivers contain slow copies and accessing the video card directly may yield performance gains. </para> <para> - Drivers that access hardware directly includes VIDIX (warning: requires + Drivers that access hardware directly includes VIDIX (warning: requires root priviledges or kernel helper). User may try one of those, but should be warned that with root access they can cause the system to crash hard. The support is also limited to @@ -1908,7 +1908,7 @@ altogether. </para> <para> - Unscaled OSD usage by subtitles and xine-ui is controlled by + Unscaled OSD usage by subtitles and xine-ui is controlled by the following settings (<filename>~/.xine/config</filename> or <filename>~/.config/gxine/config</filename>): <programlisting> gui.osd_use_unscaled:0</programlisting> @@ -1920,17 +1920,17 @@ <title>I can't see the OSD or it leaves a black box over the image!</title> <para> If you are using xine-lib version 1-rc3 or newer, this is probably - due buggy XV drivers that do not support + due buggy XV drivers that do not support <link linkend="unscaledosd">unscaled OSD</link> (the XShape - extension) properly. + extension) properly. </para> <para> - There have being reports of some ATI drivers that don't allow + There have being reports of some ATI drivers that don't allow displaying anything over the video. The VIA Epia binary drivers is reported to leave a black box where the OSD was displayed. </para> <para> - The problem may be fixed by either updating the video driver, + The problem may be fixed by either updating the video driver, or disabling xine unscaled OSD support. </para> </sect2> @@ -1955,7 +1955,7 @@ <title>Why external subtitles look so ugly?</title> <para> You are probably using a xine-lib version older than 1-rc3. - Try upgrading your copy and read the + Try upgrading your copy and read the <link linkend="unscaledosd">section about unscaled osd</link>. </para> </sect2> @@ -1985,7 +1985,7 @@ </para> <para> Also notice that DVD overlays (including subtitles) are meant to - be displayed in a fixed position, this is how the DVD menu + be displayed in a fixed position, this is how the DVD menu highlighting works. xine does not support moving them. </para> </sect2> @@ -2074,7 +2074,7 @@ <sect2 id="subencoding"> <title>Encoding of external subtitles is bad. What is wrong?</title> <para> - The encoding of the external subtitles is expected to be iso-8859-1 by + The encoding of the external subtitles is expected to be iso-8859-1 by default. You need to set an appropriate encoding in the config option <parameter>subtitles.separate.src_encoding</parameter>. Note that you also need a font which contains all characters from the given encoding. @@ -2160,7 +2160,7 @@ for more information. </para> </sect2> - + <sect2 id="status0x51"> <title>My drive doesn't work and the kernel says "status=0x51 { DriveReady SeekComplete Error }"</title> <para> @@ -2204,7 +2204,7 @@ have two possibilities. Either deactivate ESD (temporarily) by right clicking on the sound monitor applet and selecting "Place Esound in standby" or just kill it. Then xine will use OSS audio output. The other - method is to make xine use ESD for audio output with: + method is to make xine use ESD for audio output with: <screen> <command>gxine -A esd</command></screen> This may result in worse playback – exact syncronization is not possible with esd, so using oss should be preferred. @@ -2274,7 +2274,7 @@ <listitem> <para> Can you reproduce the bug? (e.g. do you remember what you - did and when you do it again it crashes again?) + did and when you do it again it crashes again?) </para> </listitem> <listitem> @@ -2294,7 +2294,7 @@ Your X server just froze on you? unfortunately that's a known problem with some chipsets and drivers (most commonly Savage chipsets) when using Xv. You might want to try running <command>gxine -V XShm</command> - to see if the problem is related to the Xv driver. This will unfortunately + to see if the problem is related to the Xv driver. This will unfortunately be much slower, as lots of things are now done in software instead of hardware scaling/colour space conversion. </para> diff --git a/doc/hackersguide/README b/doc/hackersguide/README index c0c0d944a..ef0ac825a 100644 --- a/doc/hackersguide/README +++ b/doc/hackersguide/README @@ -27,7 +27,7 @@ installed TeX system (for example teTeX). sgmltools-lite examples: ------------------------ -to generate html +to generate html $ sgmltools -b onehtml hackersguide.sgml diff --git a/doc/hackersguide/internals.docbook b/doc/hackersguide/internals.docbook index dacbadd51..d31a6eff5 100644 --- a/doc/hackersguide/internals.docbook +++ b/doc/hackersguide/internals.docbook @@ -15,15 +15,15 @@ </caption> </mediaobject> <para> - Media streams usually consist of audio and video data multiplexed + Media streams usually consist of audio and video data multiplexed into one bitstream in the so-called system-layer (e.g. AVI, Quicktime or MPEG). A demuxer plugin is used to parse the system layer and extract audio and video packages. The demuxer uses an input plugin to read the data and stores it - in pre-allocated buffers from the global buffer pool. + in pre-allocated buffers from the global buffer pool. The buffers are then added to the audio or video stream fifo. </para> <para> - From the other end of these fifos the audio and video decoder threads + From the other end of these fifos the audio and video decoder threads consume the buffers and hand them over to the current audio or video decoder plugin for decompression. These plugins then send the decoded data to the output layer. The buffer holding the encoded @@ -188,7 +188,7 @@ This plugin list is held in an array named <varname>xine_plugin_info</varname>": <programlisting> plugin_info_t xine_plugin_info[] = { - /* type, API, "name", version, special_info, init_function */ + /* type, API, "name", version, special_info, init_function */ { PLUGIN_DEMUX, 20, "flac", XINE_VERSION_CODE, NULL, demux_flac_init_class }, { PLUGIN_AUDIO_DECODER, 13, "flacdec", XINE_VERSION_CODE, &dec_info_audio, init_plugin }, { PLUGIN_NONE, 0, "", 0, NULL, NULL } @@ -236,7 +236,7 @@ same plugin are possible. </para> <para> - If you think this is pretty much an object-oriented aproach, + If you think this is pretty much an object-oriented aproach, then you're right. </para> <para> @@ -278,7 +278,7 @@ <para> Many plugins will need some additional "private" data fields. These should be simply added at the end of the plugin structure. - For example a demuxer plugin called "foo" with two private + For example a demuxer plugin called "foo" with two private fields "xine" and "count" may have a plugin structure declared in the following way: <programlisting> @@ -325,13 +325,13 @@ <para> Metronom serves two purposes: <itemizedlist> - <listitem> + <listitem> <para> Generate vpts (virtual presentation time stamps) from pts (presentation time stamps) for a/v output and synchronization. </para> </listitem> - <listitem> + <listitem> <para> Provide a master clock (system clock reference, scr), possibly provided by external scr plugins (this can be used if some hardware decoder or network @@ -352,7 +352,7 @@ The heuristics used in metronom have always been a field of research. Current metronom's implementation <emphasis>tries</emphasis> to stick to pts values as reported from demuxers, that is, vpts may be obtained by a simple operation of vpts = pts + <varname>vpts_offset</varname>, - where <varname>vpts_offset</varname> takes into account any wraps. Whenever pts is zero, + where <varname>vpts_offset</varname> takes into account any wraps. Whenever pts is zero, metronom will estimate vpts based on previous values. If a difference is found between the estimated and calculated vpts values by above formula, it will be smoothed by using a "drift correction". @@ -369,11 +369,11 @@ delivered for drawing. Unfortunately the same isn't true for audio: all sound systems implement some amount of buffering (or fifo), any data being send to it <emphasis>now</emphasis> will only get played some time in future. audio_out thread - must take this into account for making perfect A-V sync by asking the sound latency + must take this into account for making perfect A-V sync by asking the sound latency to audio driver. </para> <para> - Some audio drivers can't tell the current delay introduced in playback. This is + Some audio drivers can't tell the current delay introduced in playback. This is especially true for most sound servers like ESD or aRts and explain why in such cases the sync is far from perfect. </para> @@ -388,11 +388,11 @@ <itemizedlist> <listitem> <para> - The small sound card errors are feedbacked to metronom. The details + The small sound card errors are feedbacked to metronom. The details are given by <filename>audio_out.c</filename> comments: <programlisting> /* By adding gap errors (difference between reported and expected - * sound card clock) into metronom's vpts_offset we can use its + * sound card clock) into metronom's vpts_offset we can use its * smoothing algorithms to correct sound card clock drifts. * obs: previously this error was added to xine scr. * @@ -438,7 +438,7 @@ <sect1 id="osd"> <title>Overlays and OSD</title> <para> - The roots of xine overlay capabilities are DVD subpictures and subtitles support + The roots of xine overlay capabilities are DVD subpictures and subtitles support (also known as 'spu'). The DVD subtitles are encoded in a RLE (Run Length Encoding - the most simple compressing technique) format, with a palette of colors and transparency levels. You probably thought that subtitles were just simple text saved into DVDs, right? @@ -446,7 +446,7 @@ </para> <para> In order to optimize to the most common case, xine's internal format for screen overlays - is a similar representation to the 'spu' data. This brings not only performance + is a similar representation to the 'spu' data. This brings not only performance benefit (since blending functions may skip large image areas due to RLE) but also compatibility: it's possible to re-encode any xine overlay to the original spu format for displaying with mpeg hardware decoders like DXR3. @@ -456,14 +456,14 @@ is done using the same kind of pts/vpts stuff of a-v sync code. DVD subtitles, for example, may request: show this spu at pts1 and hide it at pts2. This brings the concept of the 'video overlay manager', that is a event-driven module for managing - overlay's showing and hiding. + overlay's showing and hiding. </para> <para> The drawback of using internal RLE format is the difficulty in manipulating it as graphic. To overcome that we created the 'OSD renderer', where OSD stands - for On Screen Display just like in TV sets. The osd renderer is a module + for On Screen Display just like in TV sets. The osd renderer is a module providing simple graphic primitives (lines, rectagles, draw text etc) over - a "virtual" bitmap area. Everytime we want to show that bitmap it will + a "virtual" bitmap area. Everytime we want to show that bitmap it will be RLE encoded and sent to the overlay manager for displaying. </para> <mediaobject> @@ -496,13 +496,13 @@ event.object.overlay->width = 100; event.object.overlay->height = 100; - /* clipping region is mostly used by dvd menus for highlighting buttons */ + /* clipping region is mostly used by dvd menus for highlighting buttons */ event.object.overlay->clip_top = 0; event.object.overlay->clip_bottom = image_height; event.object.overlay->clip_left = 0; event.object.overlay->clip_right = image_width; - /* the hard part: provide a RLE image */ + /* the hard part: provide a RLE image */ event.object.overlay->rle = your_rle; event.object.overlay->data_size = your_size; event.object.overlay->num_rle = your_rle_count; @@ -512,7 +512,7 @@ /* this table contains transparency levels for each color index. 0 = completely transparent, 15 - completely opaque */ - memcpy(event.object.overlay->clip_trans, trans, sizeof(trans)); + memcpy(event.object.overlay->clip_trans, trans, sizeof(trans)); /* set the event type and time for displaying */ event.event_type = EVENT_SHOW_SPU; @@ -527,9 +527,9 @@ to xine plugins and to frontends. </para> <para> - The first thing you need is to allocate a OSD object for drawing from the + The first thing you need is to allocate a OSD object for drawing from the renderer. The code below allocates a 300x200 area. This size can't be changed - during the lifetime of a OSD object, but it's possible to place it anywhere + during the lifetime of a OSD object, but it's possible to place it anywhere over the image. </para> <programlisting> @@ -561,7 +561,7 @@ <programlisting> osd_renderer->render_text(osd, 0, 0, "white text, black border", OSD_TEXT1); osd_renderer->render_text(osd, 0, 30, "white text, no border", OSD_TEXT2); - + osd_renderer->show(osd, 0); /* 0 stands for 'now' */</programlisting> </para> <para> @@ -592,7 +592,7 @@ defined a small convention: </para> <programlisting> - /* + /* Palette entries as used by osd fonts: 0: not used by font, always transparent @@ -603,13 +603,13 @@ 6: font border. if the font is to be displayed without border this will probably be adjusted to font background or near. 7-9: transition between border and foreground - 10: font color (foreground) + 10: font color (foreground) */</programlisting> <para> The so called 'transitions' are used to implement font anti-aliasing. That convention requires that any font file must use only the colors from 1 to 10. When we use the set_text_palette() function we are just copying 11 palette - entries to the specified base index. + entries to the specified base index. </para> <para> That base index is the same we pass to render_text() function to use the @@ -623,7 +623,7 @@ /* draws a box using font background color (translucid) */ renderer->filled_rect(osd, x1, y1, x1+width, y1+height, OSD_TEXT2 + 1); - /* render text */ + /* render text */ renderer->render_text(osd, x1, y1, text, OSD_TEXT2);</programlisting> </sect3> <sect3> @@ -669,8 +669,8 @@ <para> A: osd objects have no shadows by itself, but fonts use 11 colors to produce an anti-aliased effect. - if you set a "text palette" with entries 0-9 being transparent - and 10 being foreground you will get rid of any borders or + if you set a "text palette" with entries 0-9 being transparent + and 10 being foreground you will get rid of any borders or anti-aliasing. </para> </sect3> diff --git a/doc/hackersguide/intro.docbook b/doc/hackersguide/intro.docbook index 4e96d2de1..cd163e2ee 100644 --- a/doc/hackersguide/intro.docbook +++ b/doc/hackersguide/intro.docbook @@ -4,7 +4,7 @@ <sect1> <title>Where am I?</title> <para> - You are currently looking at a piece of documentation for xine. + You are currently looking at a piece of documentation for xine. xine is a free video player. It lives on <ulink url="http://www.xine-project.org/">http://www.xine-project.org/</ulink>. Specifically this document goes under the moniker of the "xine Hackers' Guide". diff --git a/doc/hackersguide/library.docbook b/doc/hackersguide/library.docbook index 03a863c39..01412e362 100644 --- a/doc/hackersguide/library.docbook +++ b/doc/hackersguide/library.docbook @@ -32,7 +32,7 @@ Details on the OSD feature can be found in the <link linkend="osd">OSD section</link>. </para> </sect1> - + <sect1> <title>Writing a new frontend to xine</title> <para> @@ -51,21 +51,21 @@ <programlisting> /* ** Copyright (C) 2003 Daniel Caujolle-Bert <segfault@club-internet.fr> -** +** ** This program is free software; you can redistribute it and/or modify ** it under the terms of the GNU General Public License as published by ** the Free Software Foundation; either version 2 of the License, or ** (at your option) any later version. -** +** ** This program is distributed in the hope that it will be useful, ** but WITHOUT ANY WARRANTY; without even the implied warranty of ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ** GNU General Public License for more details. -** +** ** You should have received a copy of the GNU General Public License ** along with this program; if not, write to the Free Software ** Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -** +** */ /* @@ -127,7 +127,7 @@ static void dest_size_cb(void *data, int video_width, int video_height, double v /* this will be called by xine when it's about to draw the frame */ static void frame_output_cb(void *data, int video_width, int video_height, double video_pixel_aspect, int *dest_x, int *dest_y, - int *dest_width, int *dest_height, + int *dest_width, int *dest_height, double *dest_pixel_aspect, int *win_x, int *win_y) { *dest_x = 0; *dest_y = 0; @@ -139,7 +139,7 @@ static void frame_output_cb(void *data, int video_width, int video_height, } static void event_listener(void *user_data, const xine_event_t *event) { - switch(event->type) { + switch(event->type) { case XINE_EVENT_UI_PLAYBACK_FINISHED: running = 0; break; @@ -147,11 +147,11 @@ static void event_listener(void *user_data, const xine_event_t *event) { case XINE_EVENT_PROGRESS: { xine_progress_data_t *pevent = (xine_progress_data_t *) event->data; - + printf("%s [%d%%]\n", pevent->description, pevent->percent); } break; - + /* you can handle a lot of other interesting events here */ } } @@ -175,7 +175,7 @@ int main(int argc, char **argv) { else if (strcmp(argv[i], "-ao") == 0) { ao_driver = argv[++i]; } - else + else mrl = argv[i]; } @@ -195,7 +195,7 @@ int main(int argc, char **argv) { snprintf(configfile, sizeof(configfile), "%s%s", xine_get_homedir(), "/.xine/config"); xine_config_load(xine, configfile); xine_init(xine); - + display = XOpenDisplay(NULL); screen = XDefaultScreen(display); xpos = 0; @@ -212,7 +212,7 @@ int main(int argc, char **argv) { window[1] = XCreateSimpleWindow(display, XDefaultRootWindow(display), 0, 0, (DisplayWidth(display, screen)), (DisplayHeight(display, screen)), 0, 0, 0); - + XSelectInput(display, window[0], INPUT_MOTION); XSelectInput(display, window[1], INPUT_MOTION); @@ -223,14 +223,14 @@ int main(int argc, char **argv) { XChangeProperty(display, window[1], XA_NO_BORDER, XA_NO_BORDER, 32, PropModeReplace, (unsigned char *) &mwmhints, PROP_MWM_HINTS_ELEMENTS); - + XMapRaised(display, window[fullscreen]); - + res_h = (DisplayWidth(display, screen) * 1000 / DisplayWidthMM(display, screen)); res_v = (DisplayHeight(display, screen) * 1000 / DisplayHeightMM(display, screen)); XSync(display, False); XUnlockDisplay(display); - + /* filling in the xine visual struct */ vis.display = display; vis.screen = screen; @@ -239,7 +239,7 @@ int main(int argc, char **argv) { vis.frame_output_cb = frame_output_cb; vis.user_data = NULL; pixel_aspect = res_v / res_h; - + /* opening xine output ports */ vo_port = xine_open_video_driver(xine, vo_driver, XINE_VISUAL_TYPE_X11, (void *)&vis); ao_port = xine_open_audio_driver(xine , ao_driver, NULL); @@ -249,11 +249,11 @@ int main(int argc, char **argv) { /* hook our event handler into the streams events */ event_queue = xine_event_new_queue(stream); xine_event_create_listener_thread(event_queue, event_listener, NULL); - + /* make the video window visible to xine */ xine_port_send_gui_data(vo_port, XINE_GUI_SEND_DRAWABLE_CHANGED, (void *) window[fullscreen]); xine_port_send_gui_data(vo_port, XINE_GUI_SEND_VIDEOWIN_VISIBLE, (void *) 1); - + /* start playback */ if (!xine_open(stream, mrl) || !xine_play(stream, 0, 0)) { printf("Unable to open mrl '%s'\n", mrl); @@ -269,12 +269,12 @@ int main(int argc, char **argv) { if( got_event ) XNextEvent(display, &xevent); XUnlockDisplay(display); - + if( !got_event ) { xine_usec_sleep(20000); continue; } - + switch(xevent.type) { case KeyPress: @@ -283,27 +283,27 @@ int main(int argc, char **argv) { KeySym ksym; char kbuf[256]; int len; - + kevent = xevent.xkey; - + XLockDisplay(display); len = XLookupString(&kevent, kbuf, sizeof(kbuf), &ksym, NULL); XUnlockDisplay(display); - + switch (ksym) { - + case XK_q: case XK_Q: /* user pressed q => quit */ running = 0; break; - + case XK_f: case XK_F: { /* user pressed f => toggle fullscreen */ Window tmp_win; - + XLockDisplay(display); XUnmapWindow(display, window[fullscreen]); fullscreen = !fullscreen; @@ -313,36 +313,36 @@ int main(int argc, char **argv) { DefaultRootWindow(display), 0, 0, &xpos, &ypos, &tmp_win); XUnlockDisplay(display); - - xine_port_send_gui_data(vo_port, XINE_GUI_SEND_DRAWABLE_CHANGED, + + xine_port_send_gui_data(vo_port, XINE_GUI_SEND_DRAWABLE_CHANGED, (void*) window[fullscreen]); } break; - + case XK_Up: /* cursor up => increase volume */ xine_set_param(stream, XINE_PARAM_AUDIO_VOLUME, (xine_get_param(stream, XINE_PARAM_AUDIO_VOLUME) + 1)); break; - + case XK_Down: /* cursor down => decrease volume */ xine_set_param(stream, XINE_PARAM_AUDIO_VOLUME, (xine_get_param(stream, XINE_PARAM_AUDIO_VOLUME) - 1)); break; - + case XK_plus: /* plus => next audio channel */ - xine_set_param(stream, XINE_PARAM_AUDIO_CHANNEL_LOGICAL, + xine_set_param(stream, XINE_PARAM_AUDIO_CHANNEL_LOGICAL, (xine_get_param(stream, XINE_PARAM_AUDIO_CHANNEL_LOGICAL) + 1)); break; - + case XK_minus: /* minus => previous audio channel */ - xine_set_param(stream, XINE_PARAM_AUDIO_CHANNEL_LOGICAL, + xine_set_param(stream, XINE_PARAM_AUDIO_CHANNEL_LOGICAL, (xine_get_param(stream, XINE_PARAM_AUDIO_CHANNEL_LOGICAL) - 1)); break; - + case XK_space: /* space => toggle pause mode */ if (xine_get_param(stream, XINE_PARAM_SPEED) != XINE_SPEED_PAUSE) @@ -350,26 +350,26 @@ int main(int argc, char **argv) { else xine_set_param(stream, XINE_PARAM_SPEED, XINE_SPEED_NORMAL); break; - + } } break; - + case Expose: /* this handles (partial) occlusion of our video window */ if (xevent.xexpose.count != 0) break; xine_port_send_gui_data(vo_port, XINE_GUI_SEND_EXPOSE_EVENT, &xevent); break; - + case ConfigureNotify: { XConfigureEvent *cev = (XConfigureEvent *) &xevent; Window tmp_win; - + width = cev->width; height = cev->height; - + if ((cev->x == 0) && (cev->y == 0)) { XLockDisplay(display); XTranslateCoordinates(display, cev->window, @@ -382,26 +382,26 @@ int main(int argc, char **argv) { } } break; - + } } - + /* cleanup */ xine_close(stream); xine_event_dispose_queue(event_queue); xine_dispose(stream); - xine_close_audio_driver(xine, ao_port); - xine_close_video_driver(xine, vo_port); + xine_close_audio_driver(xine, ao_port); + xine_close_video_driver(xine, vo_port); xine_exit(xine); - + XLockDisplay(display); XUnmapWindow(display, window[fullscreen]); XDestroyWindow(display, window[0]); XDestroyWindow(display, window[1]); XUnlockDisplay(display); - + XCloseDisplay (display); - + return 0; }</programlisting> </sect2> diff --git a/doc/hackersguide/output.docbook b/doc/hackersguide/output.docbook index 32e1d7db3..dc254641d 100644 --- a/doc/hackersguide/output.docbook +++ b/doc/hackersguide/output.docbook @@ -116,7 +116,7 @@ <programlisting> if (_x_post_dispose(this)) really_free(this);</programlisting> - <function>_x_post_dispose()</function> frees any ressources allocated by any of the + <function>_x_post_dispose()</function> frees any ressources allocated by any of the post plugin helper functions and returns boolean true, if the plugin is not needed any more. </para> @@ -434,7 +434,7 @@ <listitem> <para> This function can only be called by the xine engine, plugins do not have access to it. - It ends ticket revocation and hands out new tickets to all threads that applied with a + It ends ticket revocation and hands out new tickets to all threads that applied with a <function>acquire()</function> or <function>renew()</function>. If you revoked the tickets atomic, you have to issue them atomic. </para> @@ -499,7 +499,7 @@ <function>_x_post_rewire()</function> should be used in prominent locations where it is safe to be suspended. Candidates for such locations are at the beginning of the port's <function>open()</function> and - <function>get_frame()</function>/<function>get_buffer()</function> functions. + <function>get_frame()</function>/<function>get_buffer()</function> functions. The default pass through implementations for intercepted ports already do this. </para> <para> @@ -515,7 +515,7 @@ </sect3> </sect2> </sect1> - + <sect1> <title>Video output</title> <para> @@ -539,13 +539,13 @@ </listitem> <listitem> <para> - Most important, the ability to render/copy a given + Most important, the ability to render/copy a given frame to the output device. </para> </listitem> <listitem> <para> - Optionally the copying of the frame from a file dependant + Optionally the copying of the frame from a file dependant colour-space and depth into the frame structure. This is to allow for on-the fly colour-space conversion and scaling if required (e.g. the XShm ouput plugin uses this mechanism). @@ -569,7 +569,7 @@ The <varname>visual_type</varname> field is used by xine to determine if the GUI used by the client is supported by the plugin (e.g. X11 output plugins require the GUI to be running under the - X Windowing system) and also to determine the type of information passed to the + X Windowing system) and also to determine the type of information passed to the <function>open_plugin()</function> function as its <varname>visual</varname> parameter. </para> <para> @@ -590,7 +590,7 @@ The <varname>visual</varname> is a pointer to a visual-dependant structure/variable. For example, if you had previously claimed your plugin was of the VISUAL_TYPE_X11 type, this would be a pointer - to a <type>x11_visual_t</type>, which amongst other things hold the + to a <type>x11_visual_t</type>, which amongst other things hold the <type>Display</type> variable associated with the X-server xine should display to. See plugin source-code for other VISUAL_TYPE_* constants and associated structures. Note that this @@ -609,7 +609,7 @@ int get_property(vo_driver_t *self, int property); int set_property(vo_driver_t *self, int property, int value); void get_property_min_max(vo_driver_t *self, int property, int *min, int *max);</programlisting> - Handle the getting, setting of properties and define their bounds. + Handle the getting, setting of properties and define their bounds. Valid property IDs can be found in the <filename>video_out.h</filename> header file. </para> diff --git a/doc/hackersguide/overview.docbook b/doc/hackersguide/overview.docbook index eb62e5bd3..18cc40396 100644 --- a/doc/hackersguide/overview.docbook +++ b/doc/hackersguide/overview.docbook @@ -201,7 +201,7 @@ <term><filename>libmad</filename> (imported)</term> <listitem> <para> - Mpeg audio decoder plugin (i.e. mp2 and mp3 decoding). + Mpeg audio decoder plugin (i.e. mp2 and mp3 decoding). ISO/IEC compliant decoder using fixed point math. </para> <para></para> @@ -529,7 +529,7 @@ <sect1> <title>Object oriented programming in C</title> <para> - xine uses a lot of design principles normally found in + xine uses a lot of design principles normally found in object oriented designs. As xine is written in C, a few basic principles shall be explained here on how xine is object oriented anyway. @@ -561,7 +561,7 @@ my_stack_t stack; /* public part */ /* private part follows here */ - int values[MAX_STACK_SIZE]; + int values[MAX_STACK_SIZE]; int stack_size; } intstack_t;</programlisting> Each method is implemented as a static method (static to prevent @@ -646,7 +646,7 @@ </para> </sect2> </sect1> - + <sect1> <title>Coding style and guidelines</title> <para> @@ -655,35 +655,35 @@ Contributions will not be rejected if they do not meet these rules but they will be even more appreciated if they do. <itemizedlist> - <listitem> + <listitem> <para> Comment your interfaces directly in the header files. No doxygen comments, ordinary C comments will do. </para> </listitem> - <listitem> + <listitem> <para> Use C-style comments (/* */), not C++-style (//). </para> </listitem> - <listitem> + <listitem> <para> When in doubt, use lower case. BTW: This thing is called xine, never Xine. </para> </listitem> - <listitem> + <listitem> <para> Use expressive variable and function identifiers on all public interfaces. Use underscores to seperate words in identifiers, not uppercase letters (my_function_name is ok, myFunctionName is not ok). </para> </listitem> - <listitem> + <listitem> <para> Avoid macros unless they are really useful. Avoid gotos. </para> </listitem> - <listitem> + <listitem> <para> use something like <programlisting> printf("module: ..."[,…]);</programlisting> @@ -692,7 +692,7 @@ output (see example above). </para> </listitem> - <listitem> + <listitem> <para> Refer to emac's C-mode for all questions of proper indentiation. That first of all means: indent with two spaces. @@ -701,7 +701,7 @@ </itemizedlist> </para> </sect1> - + <sect1> <title>The xine logging system</title> <para> diff --git a/doc/hackersguide/stream.docbook b/doc/hackersguide/stream.docbook index d9a5471bd..b9690d9fe 100644 --- a/doc/hackersguide/stream.docbook +++ b/doc/hackersguide/stream.docbook @@ -1,11 +1,11 @@ <chapter id="stream"> <title>xine's stream layer</title> - + <sect1> <title>Input layer</title> <para> Many media players expect streams to be stored within files on - some local medium. In actual fact, media may be streamed over a + some local medium. In actual fact, media may be streamed over a network (e.g. via HTTP or RTP), encoded onto a specialized medium (e.g. DVD), etc. To allow you to access all this media, xine supports the concept of an "input plugin". The tasks performed by an @@ -156,7 +156,7 @@ <para> xine's demuxer layer is responsible for taking apart multimedia files or streams so that the engine can decode them and present them to the user. - "Demuxer" is short for demultiplexor, which is the opposite of + "Demuxer" is short for demultiplexor, which is the opposite of multiplexing. This refers to the process of combining 2 or more things into one. Multimedia streams usually, at a minimum, multiplex an audio stream and a video stream together into one stream. Sometimes, there are @@ -329,7 +329,7 @@ <programlisting> void demux_send_headers(demux_plugin_t *this_gen);</programlisting> This function generally reads the headers of the stream, does whatever it has to do to figure out what audio and video codecs are used in the file, - and asks the xine engine to initialize the correct decoders with the + and asks the xine engine to initialize the correct decoders with the proper parameters (like width and height for video, sample rate and channels for audio). </para> diff --git a/doc/internal/HOWTO.release b/doc/internal/HOWTO.release index 38532aac0..2e2adff94 100644 --- a/doc/internal/HOWTO.release +++ b/doc/internal/HOWTO.release @@ -59,7 +59,7 @@ Currently, best practice to get a release out looks like this: which the subminor releases like 1.0.1, 1.0.2,... are made and an unstable branch in CVS head, which is going to become the next minor (1.1) or major (2.0) xine-lib version. - + Make sure you know - what the new release should be called (the "marketing version" part of the tarball name, for example) @@ -88,11 +88,11 @@ Currently, best practice to get a release out looks like this: - does it have the right name? - does it unpack, compile and install correctly? note: make sure to build with as many features as possible - on a Debian box, "apt-get build-dep xine-lib" and + on a Debian box, "apt-get build-dep xine-lib" and "dpkg-buildpackage -rfakeroot" are a good way to do that - test the candidate (and make sure you are running exactly the new version!) This should at least cover the [standard test parcours] - + If you find any errors: fix them (get help on xine-devel or #xine) and go back to step 4) @@ -129,7 +129,7 @@ hands. 12) write the announcement for xine-project.org: You need to have an account on alioth.debian.org and a checked-out copy - of ssh://hg.debian.org//hg/xine-lib/xine-project-www/ (using Mercurial). + of ssh://hg.debian.org//hg/xine-lib/xine-project-www/ (using Mercurial). Add the new news item near the top of pages/news/items.xml (use the provided template), run update.sh (requires xsltproc; if this fails, re-edit), check that it looks fine in a convenient browser, then commit |