<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
<!ENTITY kwave "<application>Kwave</application>">
<!ENTITY % English "INCLUDE"> <!-- change language only here -->
<!ENTITY % addindex "IGNORE">
<!ENTITY version "0.9.3">
<!ENTITY version_tag "0_9_3">
<!ENTITY version_year "2017">
<!ENTITY % ents PUBLIC "-//KDE//ENTITIES Application-Variable Entities V2.0//EN" "entities/kde-prologue.entities">
<!ENTITY url_cc_by_sa_4 "https://creativecommons.org/licenses/by-sa/4.0/">
<!ENTITY url_devel_building_rpm_from_git "http://kwave.sourceforge.net/doc/devel/building_rpm_from_git.html">
<!ENTITY url_devel_requirements "http://kwave.sourceforge.net/doc/devel/requirements.html">
<!ENTITY url_git_web_kde "http://commits.kde.org/kwave">
<!ENTITY url_prefix_gitweb "&url_git_web_kde;?path=">
<!ENTITY url_authors "&url_prefix_gitweb;AUTHORS">
<!ENTITY url_changelog "&url_prefix_gitweb;CHANGES">
<!ENTITY url_debian "http://www.debian.org">
<!ENTITY url_flac "http://flac.sourceforge.net/">
<!ENTITY url_homepage "http://kwave.sourceforge.net/">
<!ENTITY url_id3lib "http://id3lib.sourceforge.net/">
<!ENTITY url_isrc "http://http://isrc.ifpi.org/">
<!ENTITY url_k3b "http://www.k3b.org/">
<!ENTITY url_lame "http://lame.sourceforge.net/">
<!ENTITY url_levelmeter "https://web.archive.org/web/*/http://www.rikkus.info/esound-level-meter/">
<!ENTITY url_libaudiofile "http://www.68k.org/~michael/audiofile/">
<!ENTITY url_libmad "http://www.underbit.com/products/mad/">
<!ENTITY url_libsndfile "http://www.mega-nerd.com/libsndfile/">
<!ENTITY url_licenses "&url_prefix_gitweb;LICENSES">
<!ENTITY url_mailinglist "https://lists.sourceforge.net/lists/listinfo/kwave-devel">
<!ENTITY url_ogg_vorbis "http://www.xiph.org">
<!ENTITY url_rfc2361 "http://www.ietf.org/rfc/rfc2361.txt">
<!ENTITY url_sourceforge "http://sourceforge.net">
<!ENTITY url_sox "http://sox.sourceforge.net/">
<!ENTITY url_git_web_sf "http://sourceforge.net/p/kwave/code/commit_browser">
<!ENTITY i18n-cmd_syntax "Syntax: ">
<!ENTITY i18n-plugin_lbl_internal_name "Internal Name:">
<!ENTITY i18n-plugin_lbl_type "Plugin Type:">
<!ENTITY i18n-plugin_lbl_commands "Commands:">
<!ENTITY i18n-plugin_lbl_description "Description:">
<!ENTITY i18n-plugin_lbl_parameters "Parameters:">
<!ENTITY i18n-plugin_lbl_file_types "Supported File Types:">
<!ENTITY i18n-plugin-lbl_file_type_description "Description:">
<!ENTITY i18n-plugin-lbl_file_type_extensions "File Extensions:">
<!ENTITY i18n-plugin-lbl_file_type_mime_types "Mime Types:">
<!ENTITY i18n-plugin_lbl_meta_data "Supported Meta Data:">
<!ENTITY no-i18n-tag "">
<!-- @COMMAND_ENTITIES_START@ -->
<!ENTITY no-i18n-cmd_about_kde "about_kde">
<!ENTITY no-i18n-cmd_add_track "add_track">
<!ENTITY no-i18n-cmd_clipboard_flush "clipboard_flush">
<!ENTITY no-i18n-cmd_close "close">
<!ENTITY no-i18n-cmd_continue "continue">
<!ENTITY no-i18n-cmd_copy "copy">
<!ENTITY no-i18n-cmd_crop "crop">
<!ENTITY no-i18n-cmd_cut "cut">
<!ENTITY no-i18n-cmd_delayed "delayed">
<!ENTITY no-i18n-cmd_delete "delete">
<!ENTITY no-i18n-cmd_delete_track "delete_track">
<!ENTITY no-i18n-cmd_dump_metadata "dump_metadata">
<!ENTITY no-i18n-cmd_expandtolabel "expandtolabel">
<!ENTITY no-i18n-cmd_fileinfo "fileinfo">
<!ENTITY no-i18n-cmd_forward "forward">
<!ENTITY no-i18n-cmd_goto "goto">
<!ENTITY no-i18n-cmd_insert_at "insert_at">
<!ENTITY no-i18n-cmd_insert_track "insert_track">
<!ENTITY no-i18n-cmd_label_add "label:add">
<!ENTITY no-i18n-cmd_label_delete "label:delete">
<!ENTITY no-i18n-cmd_label_edit "label:edit">
<!ENTITY no-i18n-cmd_loadbatch "loadbatch">
<!ENTITY no-i18n-cmd_loop "loop">
<!ENTITY no-i18n-cmd_menu "menu">
<!ENTITY no-i18n-cmd_msgbox "msgbox">
<!ENTITY no-i18n-cmd_newsignal "newsignal">
<!ENTITY no-i18n-cmd_next "next">
<!ENTITY no-i18n-cmd_open "open">
<!ENTITY no-i18n-cmd_openrecent "openrecent">
<!ENTITY no-i18n-cmd_paste "paste">
<!ENTITY no-i18n-cmd_pause "pause">
<!ENTITY no-i18n-cmd_playback_start "playback_start">
<!ENTITY no-i18n-cmd_plugin "plugin">
<!ENTITY no-i18n-cmd_plugin_execute "plugin:execute">
<!ENTITY no-i18n-cmd_plugin_setup "plugin:setup">
<!ENTITY no-i18n-cmd_prev "prev">
<!ENTITY no-i18n-cmd_quit "quit">
<!ENTITY no-i18n-cmd_redo "redo">
<!ENTITY no-i18n-cmd_redo_all "redo_all">
<!ENTITY no-i18n-cmd_reenable_dna "reenable_dna">
<!ENTITY no-i18n-cmd_reset_toolbars "reset_toolbars">
<!ENTITY no-i18n-cmd_revert "revert">
<!ENTITY no-i18n-cmd_rewind "rewind">
<!ENTITY no-i18n-cmd_save "save">
<!ENTITY no-i18n-cmd_saveas "saveas">
<!ENTITY no-i18n-cmd_saveselect "saveselect">
<!ENTITY no-i18n-cmd_select_gui_type "select_gui_type">
<!ENTITY no-i18n-cmd_select_track_all "select_track:all">
<!ENTITY no-i18n-cmd_select_track_invert "select_track:invert">
<!ENTITY no-i18n-cmd_select_track_none "select_track:none">
<!ENTITY no-i18n-cmd_select_track_off "select_track:off">
<!ENTITY no-i18n-cmd_select_track_on "select_track:on">
<!ENTITY no-i18n-cmd_select_track_toggle "select_track:toggle">
<!ENTITY no-i18n-cmd_selectall "selectall">
<!ENTITY no-i18n-cmd_selectnext "selectnext">
<!ENTITY no-i18n-cmd_selectnextlabels "selectnextlabels">
<!ENTITY no-i18n-cmd_selectnone "selectnone">
<!ENTITY no-i18n-cmd_selectprev "selectprev">
<!ENTITY no-i18n-cmd_selectprevlabels "selectprevlabels">
<!ENTITY no-i18n-cmd_selecttoleft "selecttoleft">
<!ENTITY no-i18n-cmd_selecttoright "selecttoright">
<!ENTITY no-i18n-cmd_selectvisible "selectvisible">
<!ENTITY no-i18n-cmd_start "start">
<!ENTITY no-i18n-cmd_stop "stop">
<!ENTITY no-i18n-cmd_sync "sync">
<!ENTITY no-i18n-cmd_undo "undo">
<!ENTITY no-i18n-cmd_undo_all "undo_all">
<!ENTITY no-i18n-cmd_view_scroll_end "view:scroll_end">
<!ENTITY no-i18n-cmd_view_scroll_left "view:scroll_left">
<!ENTITY no-i18n-cmd_view_scroll_next "view:scroll_next">
<!ENTITY no-i18n-cmd_view_scroll_next_label "view:scroll_next_label">
<!ENTITY no-i18n-cmd_view_scroll_prev "view:scroll_prev">
<!ENTITY no-i18n-cmd_view_scroll_prev_label "view:scroll_prev_label">
<!ENTITY no-i18n-cmd_view_scroll_right "view:scroll_right">
<!ENTITY no-i18n-cmd_view_scroll_start "view:scroll_start">
<!ENTITY no-i18n-cmd_view_zoom_all "view:zoom_all">
<!ENTITY no-i18n-cmd_view_zoom_in "view:zoom_in">
<!ENTITY no-i18n-cmd_view_zoom_normal "view:zoom_normal">
<!ENTITY no-i18n-cmd_view_zoom_out "view:zoom_out">
<!ENTITY no-i18n-cmd_view_zoom_selection "view:zoom_selection">
<!ENTITY no-i18n-cmd_window_activate "window:activate">
<!ENTITY no-i18n-cmd_window_cascade "window:cascade">
<!ENTITY no-i18n-cmd_window_click "window:click">
<!ENTITY no-i18n-cmd_window_close "window:close">
<!ENTITY no-i18n-cmd_window_minimize "window:minimize">
<!ENTITY no-i18n-cmd_window_mousemove "window:mousemove">
<!ENTITY no-i18n-cmd_window_next_sub "window:next_sub">
<!ENTITY no-i18n-cmd_window_prev_sub "window:prev_sub">
<!ENTITY no-i18n-cmd_window_resize "window:resize">
<!ENTITY no-i18n-cmd_window_screenshot "window:screenshot">
<!ENTITY no-i18n-cmd_window_sendkey "window:sendkey">
<!ENTITY no-i18n-cmd_window_tile "window:tile">
<!ENTITY no-i18n-cmd_window_tile_vertical "window:tile_vertical">
<!-- @COMMAND_ENTITIES_END@ -->
<!-- @PLUGIN_ENTITIES_START@ -->
<!ENTITY no-i18n-plugin_about "about">
<!ENTITY no-i18n-plugin_amplifyfree "amplifyfree">
<!ENTITY no-i18n-plugin_band_pass "band_pass">
<!ENTITY no-i18n-plugin_codec_ascii "codec_ascii">
<!ENTITY no-i18n-plugin_codec_audiofile "codec_audiofile">
<!ENTITY no-i18n-plugin_codec_flac "codec_flac">
<!ENTITY no-i18n-plugin_codec_mp3 "codec_mp3">
<!ENTITY no-i18n-plugin_codec_ogg "codec_ogg">
<!ENTITY no-i18n-plugin_codec_wav "codec_wav">
<!ENTITY no-i18n-plugin_debug "debug">
<!ENTITY no-i18n-plugin_export_k3b "export_k3b">
<!ENTITY no-i18n-plugin_fileinfo "fileinfo">
<!ENTITY no-i18n-plugin_goto "goto">
<!ENTITY no-i18n-plugin_insert_at "insert_at">
<!ENTITY no-i18n-plugin_lowpass "lowpass">
<!ENTITY no-i18n-plugin_memory "memory">
<!ENTITY no-i18n-plugin_newsignal "newsignal">
<!ENTITY no-i18n-plugin_noise "noise">
<!ENTITY no-i18n-plugin_normalize "normalize">
<!ENTITY no-i18n-plugin_notch_filter "notch_filter">
<!ENTITY no-i18n-plugin_pitch_shift "pitch_shift">
<!ENTITY no-i18n-plugin_playback "playback">
<!ENTITY no-i18n-plugin_record "record">
<!ENTITY no-i18n-plugin_reverse "reverse">
<!ENTITY no-i18n-plugin_samplerate "samplerate">
<!ENTITY no-i18n-plugin_saveblocks "saveblocks">
<!ENTITY no-i18n-plugin_selectrange "selectrange">
<!ENTITY no-i18n-plugin_sonagram "sonagram">
<!ENTITY no-i18n-plugin_stringenter "stringenter">
<!ENTITY no-i18n-plugin_volume "volume">
<!ENTITY no-i18n-plugin_zero "zero">
<!-- @PLUGIN_ENTITIES_END@ -->
<!-- unicode characters, before URL encoding -->
<!ENTITY no-i18n-unicode-0x0020 " ">
<!ENTITY no-i18n-unicode-0x0021 "!">
<!ENTITY no-i18n-unicode-0x0022 """>
<!ENTITY no-i18n-unicode-0x0023 "#">
<!ENTITY no-i18n-unicode-0x0024 "$">
<!ENTITY no-i18n-unicode-0x0025 "%">
<!ENTITY no-i18n-unicode-0x0026 "&">
<!ENTITY no-i18n-unicode-0x0027 "'">
<!ENTITY no-i18n-unicode-0x0028 "(">
<!ENTITY no-i18n-unicode-0x0029 ")">
<!ENTITY no-i18n-unicode-0x002A "*">
<!ENTITY no-i18n-unicode-0x002B "+">
<!ENTITY no-i18n-unicode-0x002C ",">
<!ENTITY no-i18n-unicode-0x002D "-">
<!ENTITY no-i18n-unicode-0x002E ".">
<!ENTITY no-i18n-unicode-0x002F "/">
<!ENTITY no-i18n-unicode-0x003A ":">
<!ENTITY no-i18n-unicode-0x003B ";">
<!ENTITY no-i18n-unicode-0x003C "<">
<!ENTITY no-i18n-unicode-0x003D "=">
<!ENTITY no-i18n-unicode-0x003E ">">
<!ENTITY no-i18n-unicode-0x003F "?">
<!ENTITY no-i18n-unicode-0x0040 "@">
<!ENTITY no-i18n-unicode-0x005B "[">
<!ENTITY no-i18n-unicode-0x005C "\">
<!ENTITY no-i18n-unicode-0x005D "]">
<!ENTITY no-i18n-unicode-0x005E "^">
<!ENTITY no-i18n-unicode-0x005F "_">
<!ENTITY no-i18n-unicode-0x0060 "`">
<!ENTITY no-i18n-unicode-0x007B "{">
<!ENTITY no-i18n-unicode-0x007C "|">
<!ENTITY no-i18n-unicode-0x007D "}">
<!ENTITY no-i18n-unicode-0x007E "~">
<!-- URL encoded ASCII characters -->
<!ENTITY no-i18n-urlenc-20 "%20">
<!ENTITY no-i18n-urlenc-21 "%21">
<!ENTITY no-i18n-urlenc-22 "%22">
<!ENTITY no-i18n-urlenc-23 "%23">
<!ENTITY no-i18n-urlenc-24 "%24">
<!ENTITY no-i18n-urlenc-25 "%25">
<!ENTITY no-i18n-urlenc-26 "%26">
<!ENTITY no-i18n-urlenc-27 "%27">
<!ENTITY no-i18n-urlenc-28 "%28">
<!ENTITY no-i18n-urlenc-29 "%29">
<!ENTITY no-i18n-urlenc-2A "%2A">
<!ENTITY no-i18n-urlenc-2B "%2B">
<!ENTITY no-i18n-urlenc-2C "%2C">
<!ENTITY no-i18n-urlenc-2D "%2D">
<!ENTITY no-i18n-urlenc-2F "%2F">
<!ENTITY no-i18n-urlenc-3A "%3A">
<!ENTITY no-i18n-urlenc-3B "%3B">
<!ENTITY no-i18n-urlenc-3C "%3C">
<!ENTITY no-i18n-urlenc-3D "%3D">
<!ENTITY no-i18n-urlenc-3E "%3E">
<!ENTITY no-i18n-urlenc-3F "%3F">
<!ENTITY no-i18n-urlenc-40 "%40">
<!ENTITY no-i18n-urlenc-5B "%5B">
<!ENTITY no-i18n-urlenc-5C "%5C">
<!ENTITY no-i18n-urlenc-5D "%5D">
<!ENTITY no-i18n-urlenc-5E "%5E">
<!ENTITY no-i18n-urlenc-5F "%5F">
<!ENTITY no-i18n-urlenc-60 "%60">
<!ENTITY no-i18n-urlenc-7B "%7B">
<!ENTITY no-i18n-urlenc-7C "%7C">
<!ENTITY no-i18n-urlenc-7D "%7D">
<!ENTITY no-i18n-urlenc-7E "%7E">
<!-- @FILEINFO_ENTITIES_START@ -->
<!ENTITY i18n-INF_ALBUM "Album">
<!ENTITY i18n-INF_ANNOTATION "Annotation">
<!ENTITY i18n-INF_ARCHIVAL "Archival location">
<!ENTITY i18n-INF_AUTHOR "Author">
<!ENTITY i18n-INF_BITRATE_LOWER "Lower Bitrate">
<!ENTITY i18n-INF_BITRATE_MODE "Bitrate Mode">
<!ENTITY i18n-INF_BITRATE_NOMINAL "Bitrate">
<!ENTITY i18n-INF_BITRATE_UPPER "Upper Bitrate">
<!ENTITY i18n-INF_BITS_PER_SAMPLE "Bits per Sample">
<!ENTITY i18n-INF_CD "CD">
<!ENTITY i18n-INF_CDS "CDS">
<!ENTITY i18n-INF_COMMISSIONED "Commissioned">
<!ENTITY i18n-INF_COMMENTS "Comments">
<!ENTITY i18n-INF_COMPRESSION "Compression">
<!ENTITY i18n-INF_CONTACT "Contact">
<!ENTITY i18n-INF_COPYRIGHT "Copyright">
<!ENTITY i18n-INF_COPYRIGHTED "Copyrighted">
<!ENTITY i18n-INF_CREATION_DATE "Date">
<!ENTITY i18n-INF_ENGINEER "Engineer">
<!ENTITY i18n-INF_ESTIMATED_LENGTH "Estimated Length">
<!ENTITY i18n-INF_FILENAME "Filename">
<!ENTITY i18n-INF_FILESIZE "File Size">
<!ENTITY i18n-INF_GENRE "Genre">
<!ENTITY i18n-INF_ISRC "ISRC">
<!ENTITY i18n-INF_KEYWORDS "Keywords">
<!ENTITY i18n-INF_LABELS "Labels">
<!ENTITY i18n-INF_LENGTH "Length">
<!ENTITY i18n-INF_LICENSE "License">
<!ENTITY i18n-INF_MEDIUM "Medium">
<!ENTITY i18n-INF_MIMETYPE "Mime Type">
<!ENTITY i18n-INF_MPEG_EMPHASIS "Emphasis">
<!ENTITY i18n-INF_MPEG_LAYER "Layer">
<!ENTITY i18n-INF_MPEG_MODEEXT "Mode Extension">
<!ENTITY i18n-INF_MPEG_VERSION "Version">
<!ENTITY i18n-INF_NAME "Name">
<!ENTITY i18n-INF_OPUS_FRAME_LEN "Opus Frame Length">
<!ENTITY i18n-INF_ORGANIZATION "Organization">
<!ENTITY i18n-INF_ORIGINAL "Original">
<!ENTITY i18n-INF_PERFORMER "Performer">
<!ENTITY i18n-INF_PRIVATE "Private">
<!ENTITY i18n-INF_PRODUCT "Product">
<!ENTITY i18n-INF_SAMPLE_FORMAT "Sample Format">
<!ENTITY i18n-INF_SAMPLE_RATE "Sample Rate">
<!ENTITY i18n-INF_SOFTWARE "Software">
<!ENTITY i18n-INF_SOURCE "Source">
<!ENTITY i18n-INF_SOURCE_FORM "Source form">
<!ENTITY i18n-INF_SUBJECT "Subject">
<!ENTITY i18n-INF_TECHNICAN "Technician">
<!ENTITY i18n-INF_TRACK "Track">
<!ENTITY i18n-INF_TRACKS "Tracks">
<!ENTITY i18n-INF_CHANNELS "Channels">
<!ENTITY i18n-INF_VBR_QUALITY "Base Quality">
<!ENTITY i18n-INF_VERSION "Version">
<!-- @FILEINFO_ENTITIES_END@ -->
]>
<book lang="&language;">
<bookinfo>
<title>The &kwave; Handbook</title>
<authorgroup>
<author>
<firstname>Thomas</firstname>
<surname>Eschenbacher</surname>
<affiliation>
<address><email>thomas.eschenbacher@gmx.de</email></address>
</affiliation>
</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
<copyright><year>1998-2000</year><holder>Martin Wilz</holder></copyright>
<copyright><year>&version_year;</year><holder>Thomas Eschenbacher</holder></copyright>
<legalnotice>&FDLNotice;</legalnotice>
<date>2017-01-29</date>
<releaseinfo>0.9.3 (Applications 16.12)</releaseinfo>
<abstract><para>&kwave; is a simple sound editor built on &kf5-full;.</para></abstract>
<keywordset>
<keyword>KDE</keyword>
<keyword>KF5</keyword>
<keyword>multimedia</keyword>
<keyword>sound</keyword>
<keyword>audio</keyword>
<keyword>Kwave</keyword>
<keyword>wav</keyword>
<keyword>editor</keyword>
<keyword>record</keyword>
<keyword>playback</keyword>
<keyword>sonagram</keyword>
<keyword>FFT</keyword>
<keyword>Linux</keyword>
</keywordset>
</bookinfo>
<!-- ###################################################################### -->
<!-- ### Chapter: Introduction ### -->
<!-- ###################################################################### -->
<chapter id="introduction"><title>Introduction</title>
<para>
This is "&kwave;", a simple sound editor built on &kf5-full;.
Its features include:
<itemizedlist>
<listitem><para>
a user interface that can be switched to SDI, MDI or Tab mode
</para></listitem>
<listitem><para>
simple cut, copy and paste functions
</para></listitem>
<listitem><para>
multi-level undo/redo
</para></listitem>
<!-- @TODO@ <listitem><para>
simple filter design tools
</para></listitem> -->
<!-- @TODO@ <listitem><para>
a small editor for additive synthesis
</para></listitem> -->
<listitem><para>
labeling of signals
</para></listitem>
<listitem><para>
Recording functionality, including pre-recording
</para></listitem>
<listitem><para>
Playback via Qt, PulseAudio, ALSA and OSS
</para></listitem>
<listitem><para>
Recording via PulseAudio, ALSA and OSS
</para></listitem>
<listitem><para>
MP3 import/export
</para></listitem>
<listitem><para>
Ogg/Vorbis and Opus import/export
</para></listitem>
<listitem><para>
FLAC import/export
</para></listitem>
<listitem><para>
some analysis functions such as Sonagram <!-- or Fourier Transformation -->
</para></listitem>
<listitem><para>
internally uses 24 bit fixed precision for sample data
</para></listitem>
<listitem><para>
free selectable sample rates
</para></listitem>
<listitem><para>
support for editing of multi channel files
</para></listitem>
<listitem><para>
playback of multi channel audio files (audio output will be
mixed down to mono or stereo if needed)
</para></listitem>
<listitem><para>
extendible through an easy-to-use plugin interface
</para></listitem>
<listitem><para>
import/export of other audio formats through
<ulink url="&url_libaudiofile;">audiofile</ulink>
</para></listitem>
</itemizedlist>
</para>
<para>
If you are interested what has been done and what has still to be
done, then look at the files <filename>CHANGES</filename> and
<filename>TODO</filename> included in the
source package. Help and constructive critics are always welcome.
</para>
<!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<!-- +++ Section: Kwave Resources +++ -->
<!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<sect1 id="resources">
<title>&kwave; Resources</title>
<para>
So if you want to get in contact with the developers, need some
further help on using &kwave;, submit patches, bug reports or other
stuff, the following resources might be of interest for you:
</para>
<itemizedlist>
<listitem><para>
Project Homepage<anchor id="project-homepage"/></para><para>
For information about new up-to-date releases or some other
information about this project, take a look at
the <ulink url="&url_homepage;">&kwave; homepage</ulink>
</para></listitem>
<listitem><para>
Mailing List<anchor id="mailing-list"/></para><para>
If you need some help on using &kwave; or want to get involved
in the development, join the Kwave developer mailing list
by visiting
<ulink url="&url_mailinglist;"> "&url_mailinglist;"</ulink>.
</para></listitem>
<listitem><para>
GIT Repository<anchor id="git-repository"/>
</para>
<para>
There also is a new GIT repository hosted on KDE servers, and a
mirror repository hosted by
<ulink url="&url_sourceforge;">SourceForge</ulink> where
you can get the sources of the latest development version.
For instructions on how to get access to the repository, read
in the chapter about
<ulink url="&url_devel_building_rpm_from_git;">building from GIT</ulink>
in the developer documentation.
There also is a GIT web interface on <ulink url="&url_git_web_kde;">KDE</ulink>
and on <ulink url="&url_git_web_sf;">SourceForge</ulink> where
you can use to browse through the sources.
</para></listitem>
</itemizedlist>
</sect1>
<!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<!-- +++ Section: Revision History +++ -->
<!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<sect1 id="changes">
<title>&kwave; Revision History</title>
<para>
This project has been started by Martin Wilz in summer 1998
and has been developed and improved by him and some other
people. In November 1999 Thomas Eschenbacher has started
to fix some little bugs here and there and stepped into
the source code of the program deeper and deeper. Up to
today he has extended, rewritten or revised nearly every
component of the program and spent much time on improving it.
</para>
<para>
Since &kwave; v0.8.0 the changelog is no longer included in this
manual. So if you are interested in a complete list of changes,
you can find the full history here:
<ulink url="&url_changelog;"> &url_changelog;</ulink> or browse
through the sources on your own through the
<ulink url="&url_git_web_kde;">GIT web interface</ulink>.
</para>
<para>
&kwave; version v0.9.0 is the first version hosted on KDE (kdereview)
and SourceForge servers, followed by v0.9.1, the first version for
&kf5-full;.
</para>
<!-- changelog cut out, this gives a smaller online help
and *much* less work for the translators... -->
</sect1>
</chapter>
<!-- ###################################################################### -->
<!-- ### Chapter: Basics about digital audio ### -->
<!-- ###################################################################### -->
<chapter id="digital-audio-basics"><title>Basics about digital audio</title>
<para>
This chapter should give a short introduction about the basics of
digital audio processing, without going too much into details.
Of course this might be a bit incomplete, but if you have questions,
you can ask at the &kwave; mailing list or consult some further
literature.
</para>
<sect1 id="the-analogue-world"><title>The analogue world</title>
<para>
First of all, one must know that the
world is <emphasis>analogue</emphasis> - but computers work
<emphasis>digitally</emphasis>. So there are
several ways to convert analogue audio to digital audio and back
again. As the way from digital to analogue normally is the
reversion of the way from analogue to digital, we only describe
the way from analogue to digital.
</para>
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="audio-1.png" format="PNG"/>
</imageobject>
<textobject> <phrase>Conversion from sound to bits</phrase> </textobject>
</inlinemediaobject>
</para>
<para>Conversion from sound to bits</para>
<para>
Before continuing, analogue audio has to be transformed
into electronic signals in order to find its way into a computer.
One common way to do this is by using a microphone and an
amplifier. This combination gets sound (changes of air pressure) at
its input and a voltage at its output. Higher
amplitude of the pressure changes will be represented by higher voltages
at the amplifier's output. This output is also called a
<emphasis>'signal'</emphasis>. Instead of a microphone you can of course
also imagine other sources of audio. And the "amplifier" can be the one
that is integrated into your sound card, where you normally cannot see it.
</para>
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="audio2signal.png" format="PNG"/>
</imageobject>
<textobject> <phrase>Conversion to electronic signal</phrase> </textobject>
</inlinemediaobject>
</para>
<para>Conversion to electronic signal</para>
<para>
At this stage, the electrical signal has three limitations that one should
keep in mind:
<orderedlist>
<listitem><para>
The <emphasis>amplitude</emphasis> (volume) is limited to
some maximum level.
This is a consequence of the electronic (amplifiers) that are
only able to handle voltages within some specific range.
That's no problem as long as sounds are not too loud. In that
case the signal would be <emphasis>clipped</emphasis>, which
means that the electrical signal will run against its margins
and the result will be disturbed.
</para></listitem>
<listitem><para>
The <emphasis>frequency range</emphasis> is also limited.
Due to the mechanical
constrains of microphones and the limited frequency range of
amplifiers, a signal's frequency range is limited. There
are no hard borders besides which the sound abruptly disappears,
but below some low and above some higher frequency the amplitude
of the signal starts to decrease more and more. The existence of
a maximum frequency can be easily understood as a limited speed
of the electrical signal to rise and fall. By using high quality
amplifiers and microphones, the limits can be spread into ranges
where the human ear is no longer able to hear their results and
thus get out of interest. The human ear normally is not able to
hear sound above 20 kHz.
</para></listitem>
<listitem><para>
The signal contains <emphasis>noise</emphasis>.
Noise is the most ugly enemy of everyone who has to handle audio
signals in any way. Noise is a typical analogue effect, that makes
the audio signal "unsharp" and disturbed, it is always present
and cannot be avoided. One can only try to use high quality
components that produce as low noise as possible, so that one
cannot hear it.
Normally noise has a certain volume, so that the interesting sound
should be much louder in comparison to the noise. This is called the
<emphasis>signal to noise ratio (SNR)</emphasis>, the higher it is
the better the sound's quality will be. Sounds that have
lower volume than the noise cannot be heart.
</para></listitem>
</orderedlist>
</para>
</sect1>
<sect1 id="digitalization"><title>Digitalization</title>
<para>
When we want to store and play audio in a computer, we must convert
the analogue sound into digital data first. This process is called
<emphasis>digitalization</emphasis>. It converts an electronic
signal into a sequence of digital values.
</para>
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="signal2digital.png" format="PNG"/>
</imageobject>
<textobject> <phrase>Digitalization of the electronic signal</phrase> </textobject>
</inlinemediaobject>
</para>
<para>Digitalization of the electronic signal</para>
<para>
The conversion can be understood as a repetitive measurement of the
electronic signal's value at certain time, thus taking a
<emphasis>sample</emphasis> of the signal. The result is then encoded
as a digital value.
</para>
<para>
The sampling could be done in arbitrary distances or in constant
intervals. The later method is much easier to handle, and thus it
is normally used, with a constant rate - the so-called
<emphasis>sample rate</emphasis>. Usual sample rates are 8000,
11025, 22050, and 44100 samples per second. In practice sample
rates are also given as frequencies, in Hz or kHz.
</para>
<para>
The sample rate limits the
highest frequency a digitized signal can represent. Due to
Shannon's theorem the highest usable frequency is half of the sample
rate, so with 44.1 kHz sample rate you cannot sample signals with
more than 22 kHz. To avoid a violation of that half-sample rate
rule, your soundcard already has built-in filters that filter away
frequencies that are higher than half of the used sample rate.
</para>
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="sinus2samples.png" format="PNG"/>
</imageobject>
<textobject> <phrase>Sampled signal</phrase> </textobject>
</inlinemediaobject>
</para>
<para>Sampled signal</para>
</sect1>
<sect1 id="sample-encoding"><title>Sample Encoding</title>
<para>
The result of the digital sampling process is a sequence of single
<emphasis>samples</emphasis>. One sample is a digital representation
of a signal's value at a certain time.
</para>
<para>
The value of a sample can be interpreted and encoded in several ways.
The simplest one is <emphasis>linear</emphasis> encoding. This means
that each sample's value directly represents the analogue signal's
value multiplied with a constant factor.
This is easy to handle, but has the disadvantage that
noise will be audible especially on low amplitudes, where it disturbs
most, and less audible on high amplitudes, where it is less audible.
</para>
<para>
One way to reduce the influence of noise is <emphasis>non-linear</emphasis>
encoding. This means that lower amplitudes are amplified before processing.
As lower amplitudes are amplified,
their distance from noise increases and the quality improves. The most
common methods for this are <emphasis>A-Law</emphasis> and
<emphasis>U-Law</emphasis> encoding - some standardized logarithmic
amplification curves, used in digital telephony (ITU G.711 standard).
</para>
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="nonlinear.png" format="PNG"/>
</imageobject>
<textobject> <phrase>Nonlinear Encoding</phrase> </textobject>
</inlinemediaobject>
</para>
<para>Nonlinear Encoding</para>
</sect1>
<sect1 id="sample-formats"><title>Sample Formats</title>
<para>
Samples can be stored in different formats and precisions. The most common
ones are integer (fixed-point) formats, that store values with
<emphasis>fixed quantisations</emphasis>.
Depending on where the zero line is defined, it
has to be destinguished between <emphasis>unsigned</emphasis> (only positive
values, "zero line" is at half of the numeric range)
and <emphasis>signed</emphasis> (positive and negative values)
integer formats.
</para>
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="signed.png" format="PNG"/>
</imageobject>
<textobject> <phrase>Signed Format</phrase> </textobject>
</inlinemediaobject>
</para>
<para>Signed Format</para>
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="unsigned.png" format="PNG"/>
</imageobject>
<textobject> <phrase>Unsigned Format</phrase> </textobject>
</inlinemediaobject>
</para>
<para>Unsigned Format</para>
<para>
As the
quantisation loses some accuracy, it produces noise, the so-called
<emphasis>quantisation noise</emphasis>. That kind of noise has more effect
on low amplitudes, so this method of storing samples is not optimal, but
quite easy and very fast to handle (computers are fast in calculating with
fixed point numbers).
</para>
<para>
The second way of encoding samples is with <emphasis>floating point</emphasis>
numbers. With floating point numbers, noise is spread nearly equal over
all ranges of amplitudes and has advantages especially on low amplitudes.
However, this format is much slower when used for processing (computers are
much slower on calculating with floating point values in comparison to
fixed point numbers).
</para>
<note><para>
&kwave; internally uses <emphasis>signed integer</emphasis> format with
24 bit precision, stored in 32 bit integers. This has the disadvantage
of higher memory consumption when processing files with lower precision
(⪚ 8 bits), but processing 32 bit numbers is very fast and also
leaves some reserves for internal calculations, as only 24 bits are
normally used.
</para></note>
</sect1>
<!-- TODO: some chapter about audio compression codecs and so on -->
</chapter>
<!-- ###################################################################### -->
<!-- ### Chapter: Using Kwave ### -->
<!-- ###################################################################### -->
<chapter id="using-kwave"><title>Using &kwave;</title>
<para>
Here is a little screenshot of the &kwave; main window, so that you
get an impression what &kwave; looks like...
</para>
<para>
<screenshot>
<screeninfo>
Here's a screenshot of &kwave;
</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kwave-main.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Screenshot of the Main Window</phrase>
</textobject>
</mediaobject>
</screenshot>
</para>
<!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<!-- +++ Section: User Interface Selection +++ -->
<!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<sect1 id="gui_mode"><title>User Interface Mode</title>
<para>
Depending on your personal preferences or use cases you can configure
how &kwave; handles multiple open files. You can switch this setting
on the fly through the menu
<menuchoice>
<guimenu>Settings</guimenu><guimenuitem>Show Files in...</guimenuitem>
</menuchoice>.
</para>
<para>
The three possible settings are:
<itemizedlist>
<listitem>
<anchor id="gui_sdi"/>
<para><guimenuitem>Separate Windows (SDI)</guimenuitem>:
When using the <emphasis>Single Document Interface</emphasis>
(SDI), each file will be shown in a separate main window.
<screenshot>
<screeninfo>
screenshot of &kwave; in SDI mode
</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kwave-gui-sdi.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Screenshot of SDI mode</phrase>
</textobject>
</mediaobject>
</screenshot>
</para>
</listitem>
<listitem>
<anchor id="gui_mdi"/>
<para><guimenuitem>Same Window (MDI)</guimenuitem>:
When using the <emphasis>Multi Document Interface</emphasis>
(MDI), there is only one &kwave; main window, but within this
window you have an area which shows sub windows, which
can be resized, moved, tiled, cascaded or minimized.
</para>
<para>
You can select a window from the <guimenu>Windows</guimenu>
menu or cycle through the sub windows with
<keycombo>&Ctrl;<keysym>Tab</keysym></keycombo>.
<screenshot>
<screeninfo>
screenshot of &kwave; in MDI mode
</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kwave-gui-mdi.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Screenshot of MDI mode</phrase>
</textobject>
</mediaobject>
</screenshot>
</para>
</listitem>
<listitem>
<anchor id="gui_tab"/>
<para><guimenuitem>Tabs</guimenuitem>:
This is a variant of the MDI interface, where files are
shown within separate tabs. You may know this mode from
some popular Internet browsers.
</para>
<para>
You can activate a tab via the <guimenu>Windows</guimenu>
menu or cycle through the tabs with
<keycombo>&Ctrl;<keysym>Tab</keysym></keycombo>.
<screenshot>
<screeninfo>
screenshot of &kwave; in TAB mode
</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kwave-gui-tab.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Screenshot of TAB mode</phrase>
</textobject>
</mediaobject>
</screenshot>
</para>
</listitem>
</itemizedlist>
</para>
</sect1>
<!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<!-- +++ Section: Memory Setup +++ -->
<!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<sect1 id="memory-setup"><title id="sect_title_memory-setup">Memory Setup</title>
<para>
When using &kwave; for the first time, you should go to the memory
setup dialog and modify the settings to be suitable for your needs
and the installed memory of your computer. You can reach it under
<menuchoice>
<guimenu>Settings</guimenu><guimenuitem>Memory...</guimenuitem>
</menuchoice>.
</para>
<para>
<screenshot>
<screeninfo>
Here's a screenshot of &kwave;'s memory setup dialog
</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kwave-plugin-memory.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Screenshot of the Memory Setup Dialog</phrase>
</textobject>
</mediaobject>
</screenshot>
</para>
<para>
&kwave; is able to use two types of memory: <emphasis>physical</emphasis>
and <emphasis>virtual</emphasis> memory.
</para>
<para>
<emphasis>Physical memory</emphasis> is the memory (RAM) that is
installed in your computer.
You should limit the usage of physical memory to some reasonable
size, as a rule of thumb, half of the installed memory should be ok.
If you set the limit too high, Linux will take memory from other
applications, which means that it swaps out memory of other programs
to the hard disk (swap), which is rather slow. If you set the limit
too low, you might lose some performance when working with big files,
because you use less of the fast physical memory than you could.
</para>
<para>
If you enable <emphasis>virtual memory</emphasis>, &kwave; is able to
load and process files
that are bigger than the amount of real installed physical memory.
&kwave; does this by using temporary files in a configurable directory,
which is much faster and more cooperative to other applications than
using the operating system's swapping. The directory that you
configure should be on your local hard disk.
</para>
</sect1>
<!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<!-- +++ Section: Command Line +++ -->
<!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<sect1 id="command_line"><title>Command Line</title>
<sect2><title>List of Files or Commands</title>
<para>
If you start &kwave; from the command line, you can specify a list
of files that should be opened. The first specified file will be opened
first, then the other files. Each file will be opened in an own new
window or sub window of the same &kwave; instance. If you specify
wildcards, you can open a large number of files at once.
</para>
<para>
For example, the following command starts a &kwave; and opens all sounds
provided by the freedesktop XDG sound theme, each in a new window or sub window:
<screen><prompt>% </prompt><command>kwave <filename>/usr/share/sounds/freedesktop/stereo/*.ogg</filename></command></screen>
</para>
<para>
It is also possible to pass &kwave; text commands, encoded as a
special <abbrev>URI</abbrev><footnote><para>universal resource identifier</para></footnote>,
this will be described in a <link linkend="kwave_uri">later section</link>.
</para>
</sect2>
<sect2><title>GUI Type</title>
<para>
The parameter <literal>--gui=<replaceable>SDI</replaceable>|<replaceable>MDI</replaceable>|<replaceable>TAB</replaceable></literal>
lets &kwave; start in one of the three possible
<abbrev>GUI</abbrev> modes:
<link linkend="gui_sdi"><abbrev>SDI</abbrev></link>,
<link linkend="gui_mdi"><abbrev>MDI</abbrev></link> or
<link linkend="gui_tab"><abbrev>TAB</abbrev></link>.
</para>
</sect2>
<sect2><title>Qt Toolkit options</title>
<para>
In addition to a list of files, you can specify a list of
<emphasis>Qt toolkit</emphasis> options like <literal>-qwindowgeometry</literal>
for specifying the size and/or position of the first opened &kwave;
window and/or <literal>-display</literal> for starting the &kwave; on a
different display.
</para>
<para>
For example, the following command starts a &kwave; window with an initial
width of 600 pixels and a height of 400 pixels, with the right border
positioned 30 pixels away from the right and 0 pixels away from the top
of the screen.
<screen><prompt>% </prompt><command>kwave <parameter>--disable-splashscreen</parameter> <parameter>-qwindowgeometry 600x400-30+0</parameter></command></screen>
</para>
</sect2>
<sect2><title>Startup Options</title>
<para>
With the option <literal>--disable-splashscreen</literal> you can disable
the splash screen that comes up when starting &kwave;. This might be useful
when you start &kwave; from a script.
</para>
<para>
The command line option <literal>--iconic</literal> lets &kwave;
start up minimized (iconified). This might be useful when you want to
start &kwave; without GUI interaction, ⪚ when running from a script.
This option also implicitly disables the splash screen!
</para>
<para>
By using the command line option <literal>--logfile=<replaceable>kwave.log</replaceable></literal>
you can log the sequence of actions of a &kwave; session into a file.
This is useful for debugging, you might be asked for such a logfile when
reporting an error.
</para>
</sect2>
</sect1>
<!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<!-- +++ Section: Opening and Saving files +++ -->
<!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<sect1 id="open_and_save"><title>Opening and Saving files</title>
<para>
Opening files with &kwave; works like in most other applications, you
can
<itemizedlist>
<listitem><para>specify a list of files on the
<link linkend="command_line">command line</link> when starting &kwave;,</para></listitem>
<listitem><para>open an empty &kwave; window (for example with
<menuchoice>
<shortcut><keycombo>&Ctrl;<keycap>W</keycap></keycombo></shortcut>
<guimenu>File</guimenu><guimenuitem>New...</guimenuitem>
</menuchoice>
) and put a file into it via
<link linkend="drag_and_drop">drag and drop</link>,
or you can </para></listitem>
<listitem><para>open a file through the menu with
<menuchoice>
<shortcut><keycombo>&Ctrl;<keycap>O</keycap></keycombo></shortcut>
<guimenu>File</guimenu><guimenuitem>Open</guimenuitem>
</menuchoice>
</para></listitem>
<listitem><para>
or one of the last recently opened files under
<menuchoice>
<guimenu>File</guimenu><guimenuitem>Open Recent</guimenuitem>
</menuchoice>
</para></listitem>
<listitem><para>
save the current file with
<menuchoice>
<shortcut><keycombo>&Ctrl;<keycap>S</keycap></keycombo></shortcut>
<guimenu>File</guimenu><guimenuitem>Save</guimenuitem>
</menuchoice>,
</para></listitem>
<listitem><para>
save under a different name with
<menuchoice>
<shortcut><keycombo>&Shift;&Ctrl;<keycap>S</keycap></keycombo></shortcut>
<guimenu>File</guimenu><guimenuitem>Save</guimenuitem><guimenuitem>As...</guimenuitem>
</menuchoice>
</para></listitem>
<listitem><para>
save all areas that are separated by markers, each one to an own
file, with
<menuchoice>
<guimenu>File</guimenu><guimenuitem>Save</guimenuitem><guimenuitem>Blocks...</guimenuitem>
</menuchoice>
</para></listitem>
<listitem><para>
or only the current selection with
<menuchoice>
<guimenu>File</guimenu><guimenuitem>Save</guimenuitem><guimenuitem>Selection...</guimenuitem>
</menuchoice>
</para></listitem>
</itemizedlist>
</para>
<sect2 id="file_formats"><title>Supported File formats</title>
<para>
&kwave; supports the following file formats:
</para>
<para>
<itemizedlist>
<listitem><para>
The favourite file format of &kwave; is (like you can guess from the
name) <filename>.wav</filename>. This format is very common to other
"operating systems" and also is commonly used within the KDE environment.
</para></listitem>
<listitem><para>
The second format that &kwave; supports is "ASCII". You can export to
and also import from ASCII. Please be aware that storing in this format
might produce very large files! The file format will be described
<link linkend="ascii_format">below</link>.
</para></listitem>
<listitem><para>
<filename>.mp3</filename> and <filename>.mp2</filename> import
is available through
<ulink url="&url_libmad;">libmad</ulink>
for the MP3 decoding in combination with
<ulink url="&url_id3lib;">id3lib</ulink> for decoding
ID3 tags and
<ulink url="&url_lame;">lame</ulink> for encoding.
</para></listitem>
<listitem><para>
Ogg/Vorbis (<filename>*.ogg</filename>) import and export.
See <ulink url="&url_ogg_vorbis;">&url_ogg_vorbis;</ulink> for details.
</para></listitem>
<listitem><para>
FLAC (<filename>*.flac</filename>) import and export.
See <ulink url="&url_flac;">&url_flac;</ulink> for details.
</para></listitem>
<listitem><para>
Additionally you can import file formats like
<filename>*.8svx</filename> (Amiga IFF/8SVX Sound File Format),
<filename>*.au</filename> (NeXT, Sun Audio),
<filename>*.aiff</filename> (Audio Interchange Format),
<filename>*.avr</filename> (Audio Visual Research File Format),
<filename>*.caf</filename> (Core Audio Format),
<filename>*.nist</filename> (NIST SPHERE Audio File Format),
<filename>*.sf</filename> (Berkeley, IRCAM, Carl Sound Format),
<filename>*.smp</filename> (Sample Vision Format),
<filename>*.snd</filename> (NeXT, Sun Audio),
<filename>*.voc</filename> (Creative Voice)
and others through the <ulink url="&url_libaudiofile;">audiofile</ulink>
plugin.
</para></listitem>
</itemizedlist>
</para>
</sect2>
<sect2 id="converting_to_and_from_wav">
<title>Converting to and from .wav</title>
<para>
The best way to work with formats other than those supported by
&kwave; is to use an external converter program.
A good set of tools for this is in the
<ulink url="&url_sox;">SoX</ulink>
package, they have also some nice documentation!
</para>
<para>
The plans for future include support for import and also export filters
for more formats and maybe some filter that uses a user-definable script
with a call to an external filter, so that even formats not supported
by <literal>SoX</literal> can be read and/or written.
</para>
</sect2>
<sect2 id="ascii_format"><title>Format of ASCII files</title>
<para>
The ASCII format is quite useful for scientific and educational
purposes.
Due to it's simple format, you can either write simple
files on your own with a text editor or you can use the output
of some other application and convert it into ASCII. As the format is
<emphasis>really</emphasis> simple, you
should not have big problems in writing a converter and most scientific
applications use to have some kind of their own ASCII format for
export.
</para>
<para>
The format of an ASCII file is quite simple and has the following rules:
<orderedlist>
<listitem><para>
At the start of the file comes a block of properties, with one
property per line.
</para></listitem>
<listitem><para>
Each property line starts with <literal>##</literal>.
</para></listitem>
<listitem><para>
After the properties comes a list of samples, with one sample per line.
When using multiple channels, the samples are separated by commas.
</para></listitem>
<listitem><para>
Lines might end with a carriage return and/or a line feed
character (so DOS files are supported too). But when saving,
files will always be saved with line feed character as the
end of the line.
</para></listitem>
<listitem><para>
Empty lines and characters after a <literal>#</literal>
are treated as comments and are ignored.
</para></listitem>
<listitem><para>
Values have to be given in signed integer format with a
24 bit range, which is the internal storage format of &kwave;.
</para></listitem>
<listitem><para>
Everything after a <literal>#</literal> (except property lines,
see above) will be treated as comment and will be ignored.
Empty lines will also be ignored.
</para></listitem>
</orderedlist>
</para>
<para>
Here is an example of a simple ASCII file that represents a
sine wave with eleven samples:
<example>
<title>content of an ASCII file with a single sine wave</title>
<screen>
## 'rate'=44100
## 'tracks'=2
## 'bits'=16
## 'length'=11
## 'Date'='2013-11-09'
## 'Software'='Kwave-0.8.11 for KDE 4.11.3'
5930496, 5930496 # 0
0, 8388352 # 1
-5930752, 5930496 # 2
-8388608, 0 # 3
-5930752, -5930752 # 4
0, -8388608 # 5
5930496, -5930752 # 6
8388352, 0 # 7
5930496, 5930496 # 8
0, 8388352 # 9
-5930752, 5930496 # 10
# EOF
</screen>
</example>
</para>
</sect2>
</sect1>
<!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<!-- +++ Section: New File +++ -->
<!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<sect1 id="newsignal"><title id="sect_title_newsignal">Creating a New File</title>
<para>
You can create a new and empty file menu under
<menuchoice>
<guimenu>File</guimenu><guimenuitem>New...</guimenuitem>
</menuchoice>.
</para>
<para>
<screenshot>
<screeninfo>
Here's a screenshot of &kwave;'s new file dialog
</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kwave-plugin-newsignal.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Screenshot of the File New Dialog</phrase>
</textobject>
</mediaobject>
</screenshot>
</para>
<para>
You can select the sample rate, resolution in bits per sample and
the number of tracks. Per default the file format will be ".wav",
but it can still be changed at the time when the file is saved.
</para>
<para>
The length of the new signal can be set by time (hours, minutes,
seconds) or by the number of samples. Additionally you can select
it relative to the highest possible length, which is limited by
the available memory and &kwave;'s internal limit (2 GB).
</para>
</sect1>
<!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<!-- +++ Section: Recording +++ -->
<!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<sect1 id="recording"><title id="sect_title_recording">Recording</title>
<para>
&kwave; is able to record audio data from various sources, with all
sample rates, sample formats and other modes that your sound
hardware supports. Currently &kwave; records through the old OSS
sound interface, and since v0.7.4 also the newer and more powerful
ALSA interface that is the preferred choice for linux kernel 2.6.
</para>
<para>
The recording can be reached from the menu under
<menuchoice>
<guimenu>File</guimenu><guimenuitem>Record</guimenuitem>
</menuchoice>.
</para>
<para>
Here is a screenshot of the &kwave; record dialog, showing the first
page with the recording controls during a running recording session.
Like in most dialogs of &kwave; you can get some help or see tooltips
on the controls.
</para>
<para>
<screenshot>
<screeninfo>
Here's a screenshot of &kwave;'s record dialog
</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kwave-plugin-record.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Screenshot of the Record Dialog</phrase>
</textobject>
</mediaobject>
</screenshot>
</para>
<para>
Here you have the following controls:
<itemizedlist>
<listitem><para>
<guilabel>Pre-Record:</guilabel> If the pre-recording feature of
&kwave; is enabled and the recording is started, &kwave; records
into an internal buffer which is some seconds long. If you
press the <guibutton>Record</guibutton> (
<inlinemediaobject>
<imageobject>
<imagedata fileref="krec_record.png" format="PNG"/>
</imageobject>
<textobject> <phrase>record button</phrase> </textobject>
</inlinemediaobject>
) button again, then the recording really starts, and also
keeps the already pre-recorded
data.
This is useful for example if you want to record your favorite
song from radio, but you recognize too late that the song has
started. In this case you can still press the record button and
get the start of the song from what &kwave; has already pre-recorded
before, so that you will no longer miss a start.
</para></listitem>
<listitem><para>
<guilabel>Record Time:</guilabel> If the length of the recording
should be limited to some time, you can activate this setting and
select a time in hours, minutes, seconds for your recording. If
this option is not enabled, the recording runs until you press
the <guibutton>Stop</guibutton> (<inlinemediaobject><imageobject>
<imagedata fileref="record_stop.png" format="PNG"/>
</imageobject><textobject><phrase>stop button</phrase></textobject>
</inlinemediaobject>) button.
</para></listitem>
<listitem><para>
<guilabel>Start At:</guilabel> If this setting is activated, you
can set a date and time when the recording will be started. Please
keep in mind that if the configured time is in the past, the
recording will start immediately.
</para></listitem>
<listitem><para>
<guilabel>Record Trigger:</guilabel> If enabled, the recording
starts only if the volume of the input goes over a certain limit,
which can be defined from 0 to 100% of the highest possible
input volume. This is useful if you do not want to record
leading silence.
(Hint: combine this with the prerecording feature mentioned above
to catch also some seconds before reaching the trigger, so that
you don't miss any silent fade-ins.)
</para></listitem>
<listitem><para>
The <guibutton>New</guibutton> (<inlinemediaobject><imageobject>
<imagedata fileref="record_new.png" format="PNG"/>
</imageobject><textobject><phrase>new button</phrase></textobject>
</inlinemediaobject>) button is active when the recording is not
running or is finished, to discard the current file content and
start again.
</para></listitem>
<listitem><para>
The <guibutton>Stop</guibutton> (<inlinemediaobject><imageobject>
<imagedata fileref="record_stop.png" format="PNG"/>
</imageobject><textobject><phrase>stop button</phrase></textobject>
</inlinemediaobject>) button is active when the recording or pre-recording
is running or &kwave; is waiting for the trigger. If pressed, the
current progress will be stopped.
</para></listitem>
<listitem><para>
The <guibutton>Pause</guibutton> (<inlinemediaobject><imageobject>
<imagedata fileref="record_pause.png" format="PNG"/>
</imageobject><textobject><phrase>pause button</phrase></textobject>
</inlinemediaobject>) button is active when the recording or pre-recording
is running. The first time you press it, the recording will be halted and
the button starts blinking. When you press it again the button will
stop blinking and recording will continue immediately, without waiting
for a trigger.
</para></listitem>
<listitem><para>
The <guibutton>Record</guibutton> (<inlinemediaobject><imageobject>
<imagedata fileref="krec_record.png" format="PNG"/>
</imageobject><textobject><phrase>record button</phrase></textobject>
</inlinemediaobject>) button starts the recording and/or prerecording,
depending on the features enabled above:
<orderedlist>
<listitem><para>
If neither prerecording nor trigger level are
used, the recording starts as soon as you press
the record button.
</para></listitem>
<listitem><para>
If prerecording is not used and a trigger level is set, the
first press will let &kwave; wait for the trigger level to be
reached. While waiting for a trigger, you can force the
recording to start immediately by pressing the record button again,
otherwise the recording will start automatically when the trigger
level has been reached.
</para></listitem>
<listitem><para>
If prerecording is enabled, the first press starts only the
prerecording and the second press really starts the recording.
</para></listitem>
</orderedlist>
</para></listitem>
</itemizedlist>
</para>
</sect1>
<!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<!-- +++ Section: Playback +++ -->
<!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<sect1 id="playback"><title id="sect_title_playback">Playback</title>
<para>
Depending on the compilation options &kwave; is able to play sounds
trough one of the following playback methods:
</para>
<para><itemizedlist>
<listitem><para>
ALSA (Advanced Linux Sound Architecture):
Supercedes OSS, supports more features and more hardware. Might
collide with other sound applications like OSS does, but has a
plugin called "dmix" as a way out. Newer versions of ALSA use a
dmix like plugin per default, so this should the best choice
for you!
</para></listitem>
<listitem><para>
OSS (Open Sound System):
The oldest linux implementation, capable of mono and stereo output.
Deprecated since linux kernel 2.6, but still wide spread.
Might collide with other sound applications, only
one application at a time can use OSS playback !
</para></listitem>
</itemizedlist></para>
<para>
Before trying to play sounds, you should take a look on the
playback configuration dialog:
</para>
<para>
<screenshot>
<screeninfo>
Here's a screenshot of &kwave;'s playback setup dialog
</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kwave-plugin-playback.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Screenshot of the Playback Setup Dialog</phrase>
</textobject>
</mediaobject>
</screenshot>
</para>
<para>
Currently &kwave; supports only 8 and 16 bit playback, with mono or
stereo output through the OSS interface, but many also
all modes your sound hardware supports through the ALSA interface.
</para>
<para>
If your sound file uses more or less channels than the
playback allows, all channels will be mixed together during playback.
For example if you have a file with three channels and you use
stereo playback, the left channel will play channel 0 (upper)
and half of channel 1 (middle), the right channel will play
the half of channel 1 (middle) and channel 2 (lower).
</para>
<para>
For getting a smooth playback without interruptions, you should also
set the buffer size to an appropriate value. If you encounter
problems with interrupted playback, you should increase the buffer
size here. But the bigger you set the buffer, the bigger is the
latency between the audible sound and the display of the playback
position in the signal display.
</para>
<para>
The playback settings dialog also provides a button for playing a
simple test sound. You should hear a 440Hz tone that wanders over all
speakers, from one to the next.
</para>
<para>
Once you have configured playback, you can use the playback controls
of the &kwave; main window or through the
<menuchoice><guimenu>Play</guimenu></menuchoice> menu or with
keyboard shortcuts:
<itemizedlist>
<listitem><para>
<menuchoice>
<shortcut><keycombo><keycap>P</keycap></keycombo></shortcut>
<guimenu>Play</guimenu><guimenuitem>Start</guimenuitem>
</menuchoice>: Start playback of the current selection from its
beginning or the whole file from the current cursor position
if nothing was selected. Play only once.
</para></listitem>
<listitem><para>
<menuchoice>
<guimenu>Play</guimenu><guimenuitem>Loop</guimenuitem>
</menuchoice>: Like before, but repeat in a loop.
</para></listitem>
<listitem><para>
<menuchoice>
<shortcut><keycombo><keycap>Space</keycap></keycombo></shortcut>
<guimenu>Play</guimenu><guimenuitem>Pause</guimenuitem>
</menuchoice>: Pause the playback at the current position. Only
available when the playback is running.
</para></listitem>
<listitem><para>
<menuchoice>
<shortcut><keycombo><keycap>Space</keycap></keycombo></shortcut>
<guimenu>Play</guimenu><guimenuitem>Continue</guimenuitem>
</menuchoice>: Continue the playback from the position where it
has been paused. Only available if the playback is paused.
</para></listitem>
<listitem><para>
<menuchoice>
<shortcut><keycombo><keycap>Esc</keycap></keycombo></shortcut>
<guimenu>Play</guimenu><guimenuitem>Stop</guimenuitem>
</menuchoice>: Stop the playback, go back to the start of the
selection.
</para></listitem>
</itemizedlist>
</para>
</sect1>
<!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<!-- +++ Section: File Properties +++ -->
<!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<sect1 id="fileinfo"><title id="title_fileinfo">File Properties</title>
<para>
&kwave; is able to handle several meta information that is stored
within an audio file. It tries to import and export as much of
that information as possible. For example, if you import an
MP3 file with ID3 tags, you can keep that information when
exporting to a Wave file. If &kwave; would lose meta information
when saving, it shows a warning.
</para>
<para>
You can view and modify the meta information under
<menuchoice>
<guimenu>Edit</guimenu><guimenuitem>File Properties...</guimenuitem>
</menuchoice>. There you can also change things like sample format,
resolution and compression.
</para>
<para>
<screenshot>
<screeninfo>
Here's a screenshot of &kwave;'s file properties dialog
</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kwave-plugin-fileinfo.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Screenshot of the File Properties Dialog</phrase>
</textobject>
</mediaobject>
</screenshot>
</para>
</sect1>
<!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<!-- +++ Section: How to zoom and navigate +++ -->
<!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<sect1 id="navigation"><title>Zooming and navigating</title>
<para>
&kwave; provides several ways to zoom and navigate, using keyboard
shortcuts, menu commands, toolbar buttons and by using the mouse.
The following sections should give an overview on how to use all
of these functions.
</para>
<sect2 id="zooming"><title>Zooming in and out</title>
<para>
<itemizedlist>
<!-- zoom to all -->
<listitem><para>
<emphasis>zoom to whole signal:</emphasis>
selects a zoom factor that makes the whole signal visible in the
current window.
<itemizedlist>
<listitem><para>
menu entry:
<menuchoice>
<guimenu>View</guimenu><guimenuitem>Zoom to whole signal</guimenuitem>
</menuchoice>
</para></listitem>
<listitem><para>
toolbar button: <inlinemediaobject><imageobject>
<imagedata fileref="toolbar_kwave_viewmagfit.png" format="PNG"/>
</imageobject><textobject><phrase>zoom all button</phrase></textobject>
</inlinemediaobject>
</para></listitem>
</itemizedlist>
</para></listitem>
<!-- zoom to 100% -->
<listitem><para>
<emphasis>zoom to 100%:</emphasis>
zooms in up to a scale where on sample is represented by on pixel
on the screen.
<itemizedlist>
<listitem><para>
menu entry:
<menuchoice>
<guimenu>View</guimenu><guimenuitem>Zoom to 100%</guimenuitem>
</menuchoice>
</para></listitem>
<listitem><para>
toolbar button: <inlinemediaobject><imageobject>
<imagedata fileref="toolbar_kwave_zoom_original.png" format="PNG"/>
</imageobject><textobject><phrase>zoom to 100% button</phrase></textobject>
</inlinemediaobject>
</para></listitem>
</itemizedlist>
</para></listitem>
<!-- zoom in -->
<listitem><para>
<emphasis>zoom in:</emphasis>
zooms in to see more details, magnifies by factor 3.
<itemizedlist>
<listitem><para>
menu entry / keyboard shortcut:
<menuchoice>
<shortcut><keycombo>&Ctrl;<keycap>+</keycap></keycombo></shortcut>
<guimenu>View</guimenu><guimenuitem>Zoom In</guimenuitem>
</menuchoice>
</para></listitem>
<listitem><para>
toolbar button: <inlinemediaobject><imageobject>
<imagedata fileref="toolbar_kwave_zoom_in.png" format="PNG"/>
</imageobject><textobject><phrase>zoom in button</phrase></textobject>
</inlinemediaobject>
</para></listitem>
</itemizedlist>
</para></listitem>
<!-- zoom out -->
<listitem><para>
<emphasis>zoom out:</emphasis>
zooms in to see less details, shrinks by factor 3.
<itemizedlist>
<listitem><para>
menu entry / keyboard shortcut:
<menuchoice>
<shortcut><keycombo>&Ctrl;<keycap>-</keycap></keycombo></shortcut>
<guimenu>View</guimenu><guimenuitem>Zoom Out</guimenuitem>
</menuchoice>
</para></listitem>
<listitem><para>
toolbar button: <inlinemediaobject><imageobject>
<imagedata fileref="toolbar_kwave_zoom_out.png" format="PNG"/>
</imageobject><textobject><phrase>zoom out button</phrase></textobject>
</inlinemediaobject>
</para></listitem>
</itemizedlist>
</para></listitem>
<!-- zoom selection -->
<listitem><para>
<emphasis>zoom selection:</emphasis>
zooms to a factor where the current selection is completely
visible in the current view.
<itemizedlist>
<listitem><para>
menu entry / keyboard shortcut:
<menuchoice>
<shortcut><keycombo>&Ctrl;<keycap>Space</keycap></keycombo></shortcut>
<guimenu>View</guimenu><guimenuitem>Zoom to Selection</guimenuitem>
</menuchoice>
</para></listitem>
<listitem><para>
toolbar button: <inlinemediaobject><imageobject>
<imagedata fileref="toolbar_kwave_viewmag.png" format="PNG"/>
</imageobject><textobject><phrase>zoom to selection button</phrase></textobject>
</inlinemediaobject>
</para></listitem>
</itemizedlist>
</para></listitem>
<!-- zoom predefined time range -->
<listitem><para>
<emphasis>select predefined zoom:</emphasis>
select a zoom factor from the zoom combo box
in the toolbar.
</para></listitem>
</itemizedlist>
</para>
</sect2>
<sect2 id="scrolling"><title>Scrolling left and right</title>
<para>
<itemizedlist>
<!-- scroll left -->
<listitem><para>
<emphasis>scroll left:</emphasis>
scrolls to the start of the signal by 1/3 of the current view.
</para>
<para>
menu entry / keyboard shortcut:
<menuchoice>
<shortcut><keycombo><keycap>cursor Left</keycap></keycombo></shortcut>
<guimenu>View</guimenu><guimenuitem>Scroll left</guimenuitem>
</menuchoice>
</para>
<para>
toolbar button: <inlinemediaobject><imageobject>
<imagedata fileref="toolbar_kwave_player_rew.png" format="PNG"/>
</imageobject><textobject><phrase>scroll left button</phrase></textobject>
</inlinemediaobject>
</para>
</listitem>
<!-- scroll right -->
<listitem><para>
<emphasis>scroll right:</emphasis>
scrolls to the end of the signal by 1/3 of the current view.
</para>
<para>
menu entry / keyboard shortcut:
<menuchoice>
<shortcut><keycombo><keycap>cursor right</keycap></keycombo></shortcut>
<guimenu>View</guimenu><guimenuitem>Scroll right</guimenuitem>
</menuchoice>
</para>
<para>
toolbar button: <inlinemediaobject><imageobject>
<imagedata fileref="toolbar_kwave_player_fwd.png" format="PNG"/>
</imageobject><textobject><phrase>scroll right button</phrase></textobject>
</inlinemediaobject>
</para>
</listitem>
<!-- previous page -->
<listitem><para>
<emphasis>previous page:</emphasis>
scrolls to the position right before the current view (left).
</para>
<para>
menu entry / keyboard shortcut:
<menuchoice>
<shortcut><keycombo><keycap>Page up</keycap></keycombo></shortcut>
<guimenu>View</guimenu><guimenuitem>Previous Page</guimenuitem>
</menuchoice>
</para>
<para>
toolbar button: <inlinemediaobject><imageobject>
<imagedata fileref="toolbar_kwave_player_start.png" format="PNG"/>
</imageobject><textobject><phrase>previous page button</phrase></textobject>
</inlinemediaobject>
</para>
</listitem>
<!-- next page -->
<listitem><para>
<emphasis>next page:</emphasis>
scrolls to the position right after the current view (right).
</para>
<para>
menu entry / keyboard shortcut:
<menuchoice>
<shortcut><keycombo><keycap>Page down</keycap></keycombo></shortcut>
<guimenu>View</guimenu><guimenuitem>Next Page</guimenuitem>
</menuchoice>
</para>
<para>
toolbar button: <inlinemediaobject><imageobject>
<imagedata fileref="toolbar_kwave_player_end.png" format="PNG"/>
</imageobject><textobject><phrase>next page button</phrase></textobject>
</inlinemediaobject>
</para>
</listitem>
<!-- to begin -->
<listitem><para>
<emphasis>to begin:</emphasis>
scrolls the current view so that it starts
at the beginning of the signal.
</para>
<para>
menu entry / keyboard shortcut:
<menuchoice>
<shortcut><keycombo>&Ctrl;<keycap>Home</keycap></keycombo></shortcut>
<guimenu>View</guimenu><guimenuitem>Begin</guimenuitem>
</menuchoice>
</para>
</listitem>
<!-- to end -->
<listitem><para>
<emphasis>to end:</emphasis>
scrolls the current view so that it ends at the end of the signal.
</para>
<para>
menu entry / keyboard shortcut:
<menuchoice>
<shortcut><keycombo>&Ctrl;<keycap>End</keycap></keycombo></shortcut>
<guimenu>View</guimenu><guimenuitem>End</guimenuitem>
</menuchoice>
</para>
</listitem>
</itemizedlist>
</para>
</sect2>
<sect2 id="navigation_overview"><title>Using the overview</title>
<para>
The main screen of &kwave; shows a small <emphasis>overview</emphasis>
of the whole signal above the horizontal scroll bar of the main
window. This overview also provides some functionality for navigating:
<itemizedlist>
<!-- <left click> on overview widget -->
<listitem><para>
<emphasis>single click with left mouse button</emphasis>:
directly move the current view to the clicked position.
</para></listitem>
<!-- <double click left> on overview widget -->
<listitem><para>
<emphasis>double click with left mouse button</emphasis>:
directly move the current view to the clicked position
and additionally zoom in.
</para></listitem>
<!-- <shift> + <double click left> on overview widget -->
<listitem><para>
<emphasis>double click with left mouse button, with
&Shift; pressed</emphasis>:
directly move the current view to the clicked position
and additionally zoom out.
</para></listitem>
</itemizedlist>
</para>
</sect2>
<sect2 id="vertical_zoom"><title>Vertical zoom</title>
<para>
You can zoom the current view vertically by pressing the
<keycap>Alt</keycap> key and scrolling with the mouse wheel.
</para>
</sect2>
</sect1>
<!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<!-- +++ Section: How to select +++ -->
<!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<sect1 id="selecting"><title>How to select</title>
<para>
&kwave; allows you to select a continuous range of samples as well as any
combination of channels (if you edit a multi-channel file). By selecting
a range of samples (time scope) all following commands will be limited to
that range and by de-selecting a channel its content will not be changed.
</para>
<sect2 id="selecting_channels"><title>Selecting channels</title>
<para>
Selecting or de-selecting a channel is quite simple. Just click on the
lamp symbol on the left side of the signal to toggle its state:
</para>
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="light_on.png" format="PNG"/>
</imageobject>
<textobject> <phrase>green lamp</phrase> </textobject>
</inlinemediaobject>
a green lamp means "enabled", whereas
</para>
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="light_off.png" format="PNG"/>
</imageobject>
<textobject> <phrase>red lamp</phrase> </textobject>
</inlinemediaobject>
a red lamp means "disabled".
</para>
<note><para>
Note: If a channel is de-selected it will also not be audible for playback!
</para></note>
</sect2>
<sect2 id="selecting_samples"><title>Selecting samples</title>
<para>
If you select a range of samples in &kwave;, that range will be
<emphasis>inclusive</emphasis>. That means that the first and the last
selected sample both belong to the selection and will be used for the
following actions. So even if you not selected a <emphasis>range</emphasis>
but only a single sample, the selection will never be really "empty". So for
example if you see no selected range, the "delete" function applies to that
single sample.
</para>
<para>
The easiest way of selecting a range of samples is just to do that
with mouse. It works like you are used from other applications: just press
the left mouse button at the point you want to let the selection start
and release the button where you want it to end.
</para>
<para>
If you want to adjust or move the selection's start or end, you can move the
mouse cursor near to the start or the end of the selection until it changes
from the standard arrow cursor into the left-right arrow cursor and then
press the left mouse button and adjust.
</para>
<para>
You can also extend or shrink the selection to a specific point by holding
down the &Shift; key while clicking with the left mouse button. Depending
on which border is nearer, the left or right border of the selection will
be set to a new position.
</para>
<para>
There are also some functions available via the menu and of course some
keyboard shortcuts:
<itemizedlist>
<listitem><para>
select the whole signal:
<menuchoice>
<shortcut><keycombo>&Ctrl;<keycap>A</keycap></keycombo></shortcut>
<guimenu>Edit</guimenu><guimenuitem>Selection</guimenuitem><guimenuitem>All</guimenuitem>
</menuchoice>
</para></listitem>
<listitem><para>
remove any selection and select "nothing":
<menuchoice>
<shortcut><keycombo><keycap>N</keycap></keycombo></shortcut>
<guimenu>Edit</guimenu><guimenuitem>Selection</guimenuitem><guimenuitem>Nothing</guimenuitem>
</menuchoice>
</para></listitem>
<listitem><para>
the currently visible area:
<menuchoice>
<shortcut><keycombo><keycap>V</keycap></keycombo></shortcut>
<guimenu>Edit</guimenu><guimenuitem>Selection</guimenuitem><guimenuitem>Visible</guimenuitem>
</menuchoice>
</para></listitem>
<listitem><para>
the next block of samples, starting one sample after the end of the current
selection and with the same length:
<menuchoice>
<shortcut><keycombo>&Shift;<keycap>+</keycap></keycombo></shortcut>
<guimenu>Edit</guimenu><guimenuitem>Selection</guimenuitem><guimenuitem>Next</guimenuitem>
</menuchoice>
</para>
<para>
(Hint: use the "<keycap>+</keycap>" key from the numeric keypad!)
</para></listitem>
<listitem><para>
the previous block of samples, ending one sample before the start of the current
selection and with the same length:
<menuchoice>
<shortcut><keycombo>&Shift;<keycap>-</keycap></keycombo></shortcut>
<guimenu>Edit</guimenu><guimenuitem>Selection</guimenuitem><guimenuitem>Previous</guimenuitem>
</menuchoice>
</para>
<para>
(Hint: use the "<keycap>-</keycap>" key from the numeric keypad!)
</para></listitem>
<listitem><para>
expand the selection to the start of the signal (first sample):
<menuchoice>
<shortcut><keycombo>&Shift;<keycap>Home</keycap></keycombo></shortcut>
<guimenu>Edit</guimenu><guimenuitem>Selection</guimenuitem><guimenuitem>to start</guimenuitem>
</menuchoice>
</para></listitem>
<listitem><para>
expand the selection to the end of the signal (last sample):
<menuchoice>
<shortcut><keycombo>&Shift;<keycap>End</keycap></keycombo></shortcut>
<guimenu>Edit</guimenu><guimenuitem>Selection</guimenuitem><guimenuitem>to end</guimenuitem>
</menuchoice>
</para></listitem>
<!-- expand to labels -->
<listitem><para>
expand the current selection left and right up to the next label
(or start/end of the signal if there is none), starting at the
current cursor position:
<menuchoice>
<shortcut><keycombo><keycap>E</keycap></keycombo></shortcut>
<guimenu>Edit</guimenu><guimenuitem>Selection</guimenuitem><guimenuitem>Expand to labels</guimenuitem>
</menuchoice>
</para></listitem>
<!-- no next/previous block -->
<listitem><para>
select the area between the next two labels that are right from the
current selection or up to the end of the signal:
<menuchoice>
<shortcut><keycombo>&Shift;&Ctrl;<keycap>N</keycap></keycombo></shortcut>
<guimenu>Edit</guimenu><guimenuitem>Selection</guimenuitem><guimenuitem>to next labels</guimenuitem>
</menuchoice>
</para></listitem>
<listitem><para>
select the area between the previous two labels that are left from the
current selection or up to the start of the signal:
<menuchoice>
<shortcut><keycombo>&Shift;&Ctrl;<keycap>P</keycap></keycombo></shortcut>
<guimenu>Edit</guimenu><guimenuitem>Selection</guimenuitem><guimenuitem>to previous labels</guimenuitem>
</menuchoice>
</para></listitem>
</itemizedlist>
</para>
</sect2>
</sect1>
<!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<!-- +++ Section: Clipboard +++ -->
<!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<sect1 id="clipboard"><title>Clipboard</title>
<para>
&kwave; uses the clipboard of &plasma;. This way it
is possible to exchange audio data between different &kwave; windows.
It might be possible as well to exchange data between &kwave; and other
audio applications, depending on their ability to use the &plasma;
clipboard.
</para>
<para>
When copying data to the clipboard through the <literal>copy</literal>
function &kwave; uses the mime type
<literal>audio/vnd.wave</literal> as data format, conforming to
<ulink url="&url_rfc2361;">RFC 2361</ulink>
which is the same as the well known <literal>wav</literal> format.
When pasting from the clipboard into &kwave; all data formats that are
available as file import formats are supported, like for example
Ogg/Vorbis, FLAC and so on.
</para>
</sect1>
<!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<!-- +++ Section: Drag and Drop +++ -->
<!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<sect1 id="drag_and_drop"><title>Drag and Drop</title>
<para>
&kwave; supports the KDE Drag and Drop protocol. This enables you
to open files just by picking them up in a &dolphin; or &konqueror;
window or the Desktop and let them drop into a window of &kwave;.
</para>
<para>
Please note that if you drop a file into a &kwave; window that already
contains an opened file, the currently opened file will be closed first
and then the file you dropped will be opened in it. If you don't want that,
you should open a new empty &kwave; window first.
</para>
<para>
You can also select a range of samples and drag or drop them into
a &kwave; window. Per default the drag operation is done in
<emphasis>move</emphasis> mode where the selected range is deleted
from the original place and inserted at the drop position.
By pressing the <keycap moreinfo="none">Ctrl</keycap> key you can
modify this and drag in <emphasis>copy</emphasis> mode instead.
</para>
</sect1>
</chapter>
<!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<!-- +++ Section: The main Kwave window +++ -->
<!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<!-- @@@ still to be done ... @@@
<sect1 id="kwave-mainwindow"><title>The main &kwave; window</title>
<para></para>
<sect2><title>The File Menu</title>
<para>
<variablelist>
<varlistentry>
<term>
<menuchoice moreinfo="none">
<shortcut moreinfo="none">
<keycombo moreinfo="none">
<keycap moreinfo="none">Ctrl</keycap>
<keycap moreinfo="none">n</keycap>
</keycombo>
</shortcut>
<guimenu moreinfo="none">File</guimenu>
<guimenuitem moreinfo="none">New</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action moreinfo="none">Creates a new document</action>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice moreinfo="none">
<shortcut moreinfo="none">
<keycombo moreinfo="none">
<keycap moreinfo="none">Ctrl</keycap>
<keycap moreinfo="none">s</keycap>
</keycombo>
</shortcut>
<guimenu moreinfo="none">File</guimenu>
<guimenuitem moreinfo="none">Save</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action moreinfo="none">Saves the document</action>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice moreinfo="none">
<shortcut moreinfo="none">
<keycombo moreinfo="none">
<keycap moreinfo="none">Ctrl</keycap>
<keycap moreinfo="none">q</keycap>
</keycombo>
</shortcut>
<guimenu moreinfo="none">File</guimenu>
<guimenuitem moreinfo="none">Quit</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action moreinfo="none">Quits</action> &kwave;
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</sect2>
</sect1>
</chapter>
-->
<!-- ###################################################################### -->
<!-- ### Chapter: Automization and scripting with Kwave ### -->
<!-- ###################################################################### -->
<chapter id="automization"><title>Automization and Scripting with &kwave;</title>
<para>
&kwave; since its first version uses an internal text command language.
This command language is used internally for menu handling, GUI control,
builtin effects and plugin invocations. The commands will be described
later in the section
<link linkend="kwave_commands" endterm="title_kwave_commands" />.
</para>
<sect1><title>General Syntax</title>
<para>
<itemizedlist>
<listitem><para>
All commands consist of a <emphasis>command name</emphasis> and
an optional <emphasis>parameter list</emphasis> in round
brackets, depending on the command.
</para></listitem>
<listitem><para>
Allowed characters for command names are <emphasis>letters</emphasis>,
<emphasis>digits</emphasis> and <emphasis>colon</emphasis>.
Commands are case sensitive and are always in lower case.
</para></listitem>
<listitem><para>
Parameters within a parameter list are separated by
<emphasis>comma</emphasis>.
</para></listitem>
<listitem><para>
Numerical parameters can be given as fixed point numbers or
as floating point numbers, using a dot as decimal separator.
</para></listitem>
<listitem><para>
String parameters are automatically trimmed (all white space
at the start and at the end is removed). If that is not wanted,
they can be surrounded by double quotes (<token>"</token>).
If a string parameter contains special characters (like
<quote><token>,</token></quote>,
<quote><token>;</token></quote>,
<quote><token>#</token></quote> or a
<quote><token>\</token></quote> itself), these special
characters have to be escaped by preceding a
<quote><token>\</token></quote>.
</para></listitem>
<listitem><para>
Multiple commands can be concatenated to a <emphasis>command
list</emphasis> by using a <quote>;</quote> as separator.
</para></listitem>
</itemizedlist>
Example:
<screen><command>fileinfo(<parameter>Comments</parameter><token>,</token><parameter>"This is an \"example\" comment."</parameter>)</command></screen>
This example consists of the command
<quote><command>fileinfo</command></quote> and has two
parameters: the keyword <parameter>Comments</parameter> and the text
<quote><parameter>"This is an \"example\" comment."</parameter></quote>.
(These parameters are explained in the corresponding section in the command reference).
</para>
</sect1>
<!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<!-- +++ Section: Using the Command Line +++ -->
<!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<sect1 id="kwave_uri"><title>Using the Command Line</title>
<para>
In addition to the command line options listed in the section
<link linkend="command_line">Command Line</link> which are used
to start &kwave; in iconified mode or without splash screen,
you can pass text commands on the command line, encoded in a
special URI format:
</para>
<para>
<literal>kwave:<replaceable>command</replaceable>[?<replaceable>parameter</replaceable>[,<replaceable>parameter</replaceable> ...] ]</literal>
</para>
<para>
The rules for transforming a &kwave; text command into a valid URI
are as follows:
<itemizedlist>
<listitem><para>
The URI starts with the word <literal>kwave</literal>, followed
by a <quote><token>:</token></quote> and the command name.
</para></listitem>
<listitem><para>
If the command has parameters, they have to be appended after
the command name, using a <quote><token>?</token></quote> as separator.
</para></listitem>
<listitem><para>
Multiple parameters can be appended by using a <quote><token>,</token></quote>
as separator.
</para></listitem>
<listitem><para>
All special characters in command name and parameters have to
be URL encoded. Here a list of the translations:
<table frame='all'><title>URL Encoding Translation Table</title>
<tgroup cols='11' align='center' colsep='1' rowsep='1'>
<colspec colname='c1'/>
<colspec/>
<colspec colname='c2' colnum='4'/>
<colspec/>
<colspec colname='c3' colnum='7'/>
<colspec/>
<colspec colname='c4' colnum='10'/>
<colspec/>
<thead>
<row>
<entry colname='c1'>original</entry><entry>encoded</entry><entry>&no-i18n-unicode-0x0020;</entry>
<entry colname='c2'>original</entry><entry>encoded</entry><entry>&no-i18n-unicode-0x0020;</entry>
<entry colname='c3'>original</entry><entry>encoded</entry><entry>&no-i18n-unicode-0x0020;</entry>
<entry colname='c4'>original</entry><entry>encoded</entry>
</row>
</thead>
<tbody>
<row>
<entry colname='c1'>(space)</entry><entry><literal>&no-i18n-urlenc-20;</literal></entry>
<entry colname='c2'>&no-i18n-unicode-0x0028;</entry><entry><literal>&no-i18n-urlenc-28;</literal></entry>
<entry colname='c3'>&no-i18n-unicode-0x003A;</entry><entry><literal>&no-i18n-urlenc-3A;</literal></entry>
<entry colname='c4'>&no-i18n-unicode-0x005C;</entry><entry><literal>&no-i18n-urlenc-5C;</literal></entry>
</row>
<row>
<entry colname='c1'>&no-i18n-unicode-0x0021;</entry><entry><literal>&no-i18n-urlenc-21;</literal></entry>
<entry colname='c2'>&no-i18n-unicode-0x0029;</entry><entry><literal>&no-i18n-urlenc-29;</literal></entry>
<entry colname='c3'>&no-i18n-unicode-0x003B;</entry><entry><literal>&no-i18n-urlenc-3B;</literal></entry>
<entry colname='c4'>&no-i18n-unicode-0x005D;</entry><entry><literal>&no-i18n-urlenc-5D;</literal></entry>
</row>
<row>
<entry colname='c1'>&no-i18n-unicode-0x0022;</entry><entry><literal>&no-i18n-urlenc-22;</literal></entry>
<entry colname='c2'>&no-i18n-unicode-0x002A;</entry><entry><literal>&no-i18n-urlenc-2A;</literal></entry>
<entry colname='c3'>&no-i18n-unicode-0x003C;</entry><entry><literal>&no-i18n-urlenc-3C;</literal></entry>
<entry colname='c4'>&no-i18n-unicode-0x005E;</entry><entry><literal>&no-i18n-urlenc-5E;</literal></entry>
</row>
<row>
<entry colname='c1'>&no-i18n-unicode-0x0023;</entry><entry><literal>&no-i18n-urlenc-23;</literal></entry>
<entry colname='c2'>&no-i18n-unicode-0x002B;</entry><entry><literal>&no-i18n-urlenc-2B;</literal></entry>
<entry colname='c3'>&no-i18n-unicode-0x003D;</entry><entry><literal>&no-i18n-urlenc-3D;</literal></entry>
<entry colname='c4'>&no-i18n-unicode-0x005F;</entry><entry><literal>&no-i18n-urlenc-5F;</literal></entry>
</row>
<row>
<entry colname='c1'>&no-i18n-unicode-0x0024;</entry><entry><literal>&no-i18n-urlenc-24;</literal></entry>
<entry colname='c2'>&no-i18n-unicode-0x002C;</entry><entry><literal>&no-i18n-urlenc-2C;</literal></entry>
<entry colname='c3'>&no-i18n-unicode-0x003E;</entry><entry><literal>&no-i18n-urlenc-3E;</literal></entry>
<entry colname='c4'>&no-i18n-unicode-0x0060;</entry><entry><literal>&no-i18n-urlenc-60;</literal></entry>
</row>
<row>
<entry colname='c1'>&no-i18n-unicode-0x0025;</entry><entry><literal>&no-i18n-urlenc-25;</literal></entry>
<entry colname='c2'>&no-i18n-unicode-0x002D;</entry><entry><literal>&no-i18n-urlenc-2D;</literal></entry>
<entry colname='c3'>&no-i18n-unicode-0x003F;</entry><entry><literal>&no-i18n-urlenc-3F;</literal></entry>
<entry colname='c4'>&no-i18n-unicode-0x007B;</entry><entry><literal>&no-i18n-urlenc-7B;</literal></entry>
</row>
<row>
<entry colname='c1'>&no-i18n-unicode-0x0026;</entry><entry><literal>&no-i18n-urlenc-26;</literal></entry>
<entry colname='c2'>&no-i18n-unicode-0x002E;</entry><entry><literal>&no-i18n-urlenc-3E;</literal></entry>
<entry colname='c3'>&no-i18n-unicode-0x0040;</entry><entry><literal>&no-i18n-urlenc-40;</literal></entry>
<entry colname='c4'>&no-i18n-unicode-0x007C;</entry><entry><literal>&no-i18n-urlenc-7C;</literal></entry>
</row>
<row>
<entry colname='c1'>&no-i18n-unicode-0x0027;</entry><entry><literal>&no-i18n-urlenc-27;</literal></entry>
<entry colname='c2'>&no-i18n-unicode-0x002F;</entry><entry><literal>&no-i18n-urlenc-2F;</literal></entry>
<entry colname='c3'>&no-i18n-unicode-0x005B;</entry><entry><literal>&no-i18n-urlenc-5B;</literal></entry>
<entry colname='c4'>&no-i18n-unicode-0x007D;</entry><entry><literal>&no-i18n-urlenc-7D;</literal></entry>
</row>
<row>
<entry colname='c4'>&no-i18n-unicode-0x007E;</entry><entry><literal>&no-i18n-urlenc-7E;</literal></entry>
</row>
</tbody>
</tgroup>
</table>
</para></listitem>
</itemizedlist>
</para>
</sect1>
<!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<!-- +++ Section: Kwave Script Files +++ -->
<!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<sect1 id="kwave_scripts"><title>&kwave; Script Files</title>
<sect2><title>General Structure</title>
<para>
A &kwave; <emphasis>script</emphasis> consists of a list of
lines, where each line can be:
<itemizedlist>
<listitem>
<para>a single <emphasis>command</emphasis>,</para>
</listitem>
<listitem>
<para>a <emphasis>command list</emphasis>, with two
or more commands concatenated by
a <quote><token>;</token></quote>.
</para>
</listitem>
<listitem>
<para>a <emphasis>comment</emphasis>,</para>
</listitem>
<listitem>
<para>a <emphasis>label</emphasis></para>
</listitem>
<listitem>
<para>or an <emphasis>empty line</emphasis>,
that contains white space only</para>
</listitem>
</itemizedlist>
</para>
</sect2>
<sect2><title>Comments and Empty Lines</title>
<para>
All characters that follow a <quote><token>#</token></quote>
(except when used in quotes or when escaped) are treated as
comments, they will be silently ignored.
</para>
<para>
Lines that contain only white space or comments are ignored as
well.
</para>
</sect2>
<sect2><title>Termination</title>
<para>
A &kwave; script terminates either when all commands have been
executed successfully without an error or when a command has returned
an error code. There is no special command for aborting the execution
of a script. If you want to implement a possibility for the user to
end a script, you can use the
command <quote><link linkend="cmd_sect_msgbox"><command>msgbox</command></link>(<parameter><replaceable>text</replaceable></parameter>)</quote>.
This shows a message box with the two
buttons <quote><guibutton>OK</guibutton></quote> (which lets the script
continue) and <quote><guibutton>Cancel</guibutton></quote> (which
returns an error code and stops the script).
</para>
</sect2>
<sect2><title>Labels</title>
<para>
Lines that consist only of an identifier, followed by a <quote><token>:</token></quote>
are treated <emphasis>labels</emphasis>. They can be referenced
later in the script by the special keyword <quote><command>GOTO</command></quote>
<footnote><para>Note:
Please don't mix up the keyword <quote><command>GOTO</command></quote>
with the text command
<quote><link linkend="cmd_sect_goto"><command>goto</command></link>
(<parameter><replaceable>position</replaceable></parameter>)</quote> !
</para></footnote>
, which makes the execution of the script continue at the location of
that label (see example below).
</para>
<para>
A line that contains a label must not contain any other content
(except comments or white space) after the <quote><token>:</token></quote>.
</para>
<para>
Example:
<screen>
<replaceable>start:</replaceable><literal> # <= this is a label</literal>
<literal> # do something...</literal>
<literal> </literal><command>msgbox</command>(<parameter>once again?</parameter>)
<literal> </literal><command>GOTO <parameter>start</parameter></command>
</screen>
</para>
</sect2>
</sect1>
<!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<!-- +++ Section: Command Reference +++ -->
<!-- ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<sect1 id="kwave_commands"><title id="title_kwave_commands">Command Reference</title>
<index><title>Alphabetical Index</title>
&no-i18n-tag;
<!-- @COMMAND_INDEX_START@ -->
<indexdiv><title>a</title>
<indexentry><primaryie><link linkend="cmd_sect_about_kde" endterm="cmd_title_about_kde"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_add_track" endterm="cmd_title_add_track"/></primaryie></indexentry>
</indexdiv>
<indexdiv><title>c</title>
<indexentry><primaryie><link linkend="cmd_sect_clipboard_flush" endterm="cmd_title_clipboard_flush"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_close" endterm="cmd_title_close"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_continue" endterm="cmd_title_continue"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_copy" endterm="cmd_title_copy"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_crop" endterm="cmd_title_crop"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_cut" endterm="cmd_title_cut"/></primaryie></indexentry>
</indexdiv>
<indexdiv><title>d</title>
<indexentry><primaryie><link linkend="cmd_sect_delayed" endterm="cmd_title_delayed"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_delete" endterm="cmd_title_delete"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_delete_track" endterm="cmd_title_delete_track"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_dump_metadata" endterm="cmd_title_dump_metadata"/></primaryie></indexentry>
</indexdiv>
<indexdiv><title>e</title>
<indexentry><primaryie><link linkend="cmd_sect_label_edit" endterm="cmd_title_label_edit"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_expandtolabel" endterm="cmd_title_expandtolabel"/></primaryie></indexentry>
</indexdiv>
<indexdiv><title>f</title>
<indexentry><primaryie><link linkend="cmd_sect_fileinfo" endterm="cmd_title_fileinfo"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_forward" endterm="cmd_title_forward"/></primaryie></indexentry>
</indexdiv>
<indexdiv><title>g</title>
<indexentry><primaryie><link linkend="cmd_sect_goto" endterm="cmd_title_goto"/></primaryie></indexentry>
</indexdiv>
<indexdiv><title>i</title>
<indexentry><primaryie><link linkend="cmd_sect_insert_at" endterm="cmd_title_insert_at"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_insert_track" endterm="cmd_title_insert_track"/></primaryie></indexentry>
</indexdiv>
<indexdiv><title>l</title>
<indexentry><primaryie><link linkend="cmd_sect_label_add" endterm="cmd_title_label_add"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_label_delete" endterm="cmd_title_label_delete"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_loadbatch" endterm="cmd_title_loadbatch"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_loop" endterm="cmd_title_loop"/></primaryie></indexentry>
</indexdiv>
<indexdiv><title>m</title>
<indexentry><primaryie><link linkend="cmd_sect_menu" endterm="cmd_title_menu"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_msgbox" endterm="cmd_title_msgbox"/></primaryie></indexentry>
</indexdiv>
<indexdiv><title>n</title>
<indexentry><primaryie><link linkend="cmd_sect_newsignal" endterm="cmd_title_newsignal"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_next" endterm="cmd_title_next"/></primaryie></indexentry>
</indexdiv>
<indexdiv><title>o</title>
<indexentry><primaryie><link linkend="cmd_sect_open" endterm="cmd_title_open"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_openrecent" endterm="cmd_title_openrecent"/></primaryie></indexentry>
</indexdiv>
<indexdiv><title>p</title>
<indexentry><primaryie><link linkend="cmd_sect_paste" endterm="cmd_title_paste"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_pause" endterm="cmd_title_pause"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_playback_start" endterm="cmd_title_playback_start"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_plugin" endterm="cmd_title_plugin"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_plugin_execute" endterm="cmd_title_plugin_execute"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_plugin_setup" endterm="cmd_title_plugin_setup"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_prev" endterm="cmd_title_prev"/></primaryie></indexentry>
</indexdiv>
<indexdiv><title>q</title>
<indexentry><primaryie><link linkend="cmd_sect_quit" endterm="cmd_title_quit"/></primaryie></indexentry>
</indexdiv>
<indexdiv><title>r</title>
<indexentry><primaryie><link linkend="cmd_sect_redo" endterm="cmd_title_redo"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_redo_all" endterm="cmd_title_redo_all"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_reenable_dna" endterm="cmd_title_reenable_dna"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_reset_toolbars" endterm="cmd_title_reset_toolbars"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_revert" endterm="cmd_title_revert"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_rewind" endterm="cmd_title_rewind"/></primaryie></indexentry>
</indexdiv>
<indexdiv><title>s</title>
<indexentry><primaryie><link linkend="cmd_sect_save" endterm="cmd_title_save"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_saveas" endterm="cmd_title_saveas"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_saveselect" endterm="cmd_title_saveselect"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_select_gui_type" endterm="cmd_title_select_gui_type"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_select_track_all" endterm="cmd_title_select_track_all"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_select_track_invert" endterm="cmd_title_select_track_invert"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_select_track_none" endterm="cmd_title_select_track_none"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_select_track_off" endterm="cmd_title_select_track_off"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_select_track_on" endterm="cmd_title_select_track_on"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_select_track_toggle" endterm="cmd_title_select_track_toggle"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_selectall" endterm="cmd_title_selectall"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_selectnext" endterm="cmd_title_selectnext"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_selectnextlabels" endterm="cmd_title_selectnextlabels"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_selectnone" endterm="cmd_title_selectnone"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_selectprev" endterm="cmd_title_selectprev"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_selectprevlabels" endterm="cmd_title_selectprevlabels"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_selecttoleft" endterm="cmd_title_selecttoleft"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_selecttoright" endterm="cmd_title_selecttoright"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_selectvisible" endterm="cmd_title_selectvisible"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_start" endterm="cmd_title_start"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_stop" endterm="cmd_title_stop"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_sync" endterm="cmd_title_sync"/></primaryie></indexentry>
</indexdiv>
<indexdiv><title>u</title>
<indexentry><primaryie><link linkend="cmd_sect_undo" endterm="cmd_title_undo"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_undo_all" endterm="cmd_title_undo_all"/></primaryie></indexentry>
</indexdiv>
<indexdiv><title>v</title>
<indexentry><primaryie><link linkend="cmd_sect_view_scroll_end" endterm="cmd_title_view_scroll_end"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_view_scroll_left" endterm="cmd_title_view_scroll_left"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_view_scroll_next" endterm="cmd_title_view_scroll_next"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_view_scroll_next_label" endterm="cmd_title_view_scroll_next_label"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_view_scroll_prev" endterm="cmd_title_view_scroll_prev"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_view_scroll_prev_label" endterm="cmd_title_view_scroll_prev_label"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_view_scroll_right" endterm="cmd_title_view_scroll_right"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_view_scroll_start" endterm="cmd_title_view_scroll_start"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_view_zoom_all" endterm="cmd_title_view_zoom_all"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_view_zoom_in" endterm="cmd_title_view_zoom_in"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_view_zoom_normal" endterm="cmd_title_view_zoom_normal"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_view_zoom_out" endterm="cmd_title_view_zoom_out"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_view_zoom_selection" endterm="cmd_title_view_zoom_selection"/></primaryie></indexentry>
</indexdiv>
<indexdiv><title>w</title>
<indexentry><primaryie><link linkend="cmd_sect_window_activate" endterm="cmd_title_window_activate"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_window_cascade" endterm="cmd_title_window_cascade"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_window_click" endterm="cmd_title_window_click"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_window_close" endterm="cmd_title_window_close"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_window_minimize" endterm="cmd_title_window_minimize"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_window_mousemove" endterm="cmd_title_window_mousemove"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_window_next_sub" endterm="cmd_title_window_next_sub"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_window_prev_sub" endterm="cmd_title_window_prev_sub"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_window_resize" endterm="cmd_title_window_resize"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_window_screenshot" endterm="cmd_title_window_screenshot"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_window_sendkey" endterm="cmd_title_window_sendkey"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_window_tile" endterm="cmd_title_window_tile"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="cmd_sect_window_tile_vertical" endterm="cmd_title_window_tile_vertical"/></primaryie></indexentry>
</indexdiv>
<!-- @COMMAND_INDEX_END@ -->
</index>
<para><literal> </literal></para>
</sect1>
<sect1 id="commands_a"><title>&no-i18n-tag;a</title>
<!-- @COMMAND@ about_kde() -->
<sect2 id="cmd_sect_about_kde"><title id="cmd_title_about_kde">&no-i18n-cmd_about_kde;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_about_kde;</command>()</title>
<para>
Shows a dialog window with information about the KDE community.
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ add_track() -->
<sect2 id="cmd_sect_add_track"><title id="cmd_title_add_track">&no-i18n-cmd_add_track;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_add_track;</command>()</title>
<para>
Adds a new track after all existing tracks.
</para>
</simplesect>
<simplesect><title>See also</title>
<para>
<link linkend="cmd_sect_insert_track"><command>&no-i18n-tag;&no-i18n-cmd_insert_track;</command>()</link>
</para>
</simplesect>
</sect2>
</sect1>
<sect1 id="commands_c"><title>&no-i18n-tag;c</title>
<!-- @COMMAND@ clipboard_flush() -->
<sect2 id="cmd_sect_clipboard_flush"><title id="cmd_title_clipboard_flush">&no-i18n-cmd_clipboard_flush;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_clipboard_flush;</command>()</title>
<para>
Discards the current content of the clipboard
(might free some memory).
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ close() -->
<sect2 id="cmd_sect_close"><title id="cmd_title_close">&no-i18n-cmd_close;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_close;</command>()</title>
<para>
Closes the current file. If the GUI is configured to MDI or Tab mode,
this also closes the corresponding sub window.
</para>
</simplesect>
<simplesect><title>See also</title>
<para>
<link linkend="cmd_sect_open"><command>&no-i18n-tag;&no-i18n-cmd_open;</command>(<replaceable>filename</replaceable>)</link>,
<link linkend="cmd_sect_quit"><command>&no-i18n-tag;&no-i18n-cmd_quit;</command>()</link>
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ continue() -->
<sect2 id="cmd_sect_continue"><title id="cmd_title_continue">&no-i18n-cmd_continue;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_continue;</command>()</title>
<para>
Corresponds to the <guibutton>Continue</guibutton> toolbar
button and lets the playback continue if it is paused.
</para>
</simplesect>
<simplesect><title>See also</title>
<para>
<link linkend="cmd_sect_pause"><command>&no-i18n-tag;&no-i18n-cmd_pause;</command>()</link>
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ copy() -->
<sect2 id="cmd_sect_copy"><title id="cmd_title_copy">&no-i18n-cmd_copy;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_copy;</command>()</title>
<para>
Copies the content of the current selection to the clipboard. If the
selection is empty, this command does nothing and the content
of the clipboard remains unchanged.
Only the content of the currently selected tracks is copied
to the clipboard!
</para>
</simplesect>
<simplesect><title>See also</title>
<para>
<link linkend="cmd_sect_paste"><command>&no-i18n-tag;&no-i18n-cmd_paste;</command>()</link>
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ crop() -->
<sect2 id="cmd_sect_crop"><title id="cmd_title_crop">&no-i18n-cmd_crop;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_crop;</command>()</title>
<para>
Crops the signal to the current selection by deleting everything
that is after and before the current selection. Affects all tracks.
If nothing is selected this command does nothing.
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ cut() -->
<sect2 id="cmd_sect_cut"><title id="cmd_title_cut">&no-i18n-cmd_cut;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_cut;</command>()</title>
<para>
Copies the content of the current selection to the clipboard and
removes it from the signal. If the selection is empty, this
command does nothing and the content of the clipboard remains unchanged.
Only the content of the currently selected tracks is copied to
the clipboard, but the selected range is deleted from all tracks.
</para>
</simplesect>
</sect2>
</sect1>
<sect1 id="commands_d"><title>&no-i18n-tag;d</title>
<!-- @COMMAND@ delayed(milliseconds,command) -->
<sect2 id="cmd_sect_delayed"><title id="cmd_title_delayed">&no-i18n-cmd_delayed;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-cmd_delayed;</command>(
<replaceable>milliseconds</replaceable>,
<replaceable>command</replaceable>
)</title>
<para>
Executes a <replaceable>command</replaceable> after a given delay.
Please note that the command is executed asynchronously after the
given time has elapsed. Multiple commands can be queued, where the
delays are relative to the last queued command. This command is
intended to be used for queuing commands when taking screenshots
for documentation purposes.
</para>
</simplesect>
<simplesect><title>Parameters</title><informaltable frame='none'><tgroup cols='2'><tbody>
<row><entry><parameter>milliseconds</parameter>:</entry>
<entry>number of whole milliseconds to wait before executing the command</entry></row>
<row><entry><parameter>command</parameter>:</entry>
<entry>a command, including parameters to be executed after
the given delay</entry></row>
</tbody></tgroup></informaltable></simplesect>
<simplesect><title>See also</title>
<para>
<link linkend="cmd_sect_sync"><command>&no-i18n-tag;&no-i18n-cmd_sync;</command>()</link>,
<link linkend="cmd_sect_window_resize"><command>&no-i18n-tag;&no-i18n-cmd_window_resize;</command>()</link>,
<link linkend="cmd_sect_window_click"><command>&no-i18n-tag;&no-i18n-cmd_window_click;</command>()</link>,
<link linkend="cmd_sect_window_sendkey"><command>&no-i18n-tag;&no-i18n-cmd_window_sendkey;</command>()</link>,
<link linkend="cmd_sect_window_close"><command>&no-i18n-tag;&no-i18n-cmd_window_close;</command>()</link>,
<link linkend="cmd_sect_window_screenshot"><command>&no-i18n-tag;&no-i18n-cmd_window_screenshot;</command>()</link>
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ delete() -->
<sect2 id="cmd_sect_delete"><title id="cmd_title_delete">&no-i18n-cmd_delete;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_delete;</command>()</title>
<para>
Deletes the currently selected range of samples.
If the selection is empty, this command does nothing.
Affects all tracks.
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ delete_track(index) -->
<sect2 id="cmd_sect_delete_track"><title id="cmd_title_delete_track">&no-i18n-cmd_delete_track;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-cmd_delete_track;</command>(<replaceable>index</replaceable>)</title>
<para>
Deletes a track, identified by its index (starting from zero).
If no track with the given index exists, this command exits with an error.
</para>
</simplesect>
<simplesect><title>Parameters</title><informaltable frame='none'><tgroup cols='2'><tbody>
<row><entry><parameter>index</parameter>:</entry><entry>index of the track to delete, starting with 0</entry></row>
</tbody></tgroup></informaltable></simplesect>
</sect2>
<!-- @COMMAND@ dump_metadata() -->
<sect2 id="cmd_sect_dump_metadata"><title id="cmd_title_dump_metadata">&no-i18n-cmd_dump_metadata;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_dump_metadata;</command>()</title>
<para>
Prints a list of all meta data entries to the console, for diagnostic purposes.
(Only available when &kwave; has been compiled with the option
<literal>WITH_DEBUG</literal> switched on).
</para>
</simplesect>
</sect2>
</sect1>
<sect1 id="commands_e"><title>&no-i18n-tag;e</title>
<!-- @COMMAND@ expandtolabel() -->
<sect2 id="cmd_sect_expandtolabel"><title id="cmd_title_expandtolabel">&no-i18n-cmd_expandtolabel;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_expandtolabel;</command>()</title>
<para>
Expands the current selection to the labels left and right from
the current selection borders. If the border of selection already
is on a label, it stays unchanged. If there is no label left
or right of the current selection, it will be expanded to the
start or end of the file.
</para>
</simplesect>
</sect2>
</sect1>
<sect1 id="commands_f"><title>&no-i18n-tag;f</title>
<!-- @COMMAND@ fileinfo() -->
<sect2 id="cmd_sect_fileinfo"><title id="cmd_title_fileinfo">&no-i18n-cmd_fileinfo;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-cmd_fileinfo;</command>(<replaceable>index</replaceable>)</title>
<para>
Set a file info entry to a new value.
</para>
</simplesect>
<simplesect><title>Parameters</title><informaltable frame='none'><tgroup cols='2'><tbody>
<row><entry><parameter>keyword</parameter>:</entry><entry>keyword of the entry</entry></row>
<row><entry><parameter>value</parameter>:</entry><entry>value of the entry</entry></row>
</tbody></tgroup></informaltable></simplesect>
</sect2>
<!-- @COMMAND@ forward() -->
<sect2 id="cmd_sect_forward"><title id="cmd_title_forward">&no-i18n-cmd_forward;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_forward;</command>()</title>
<para>
Corresponds to the <guibutton>Forward</guibutton> toolbar
button. If the playback is currently running, it skips forward
by 1/10 of the visible range. If the playback is not running,
this does the same as the command
<command>&no-i18n-cmd_view_scroll_right;</command>.
</para>
</simplesect>
<simplesect><title>See also</title>
<para>
<link linkend="cmd_sect_view_scroll_right"><command>&no-i18n-tag;&no-i18n-cmd_view_scroll_right;</command>()</link>,
<link linkend="cmd_sect_rewind"><command>&no-i18n-tag;&no-i18n-cmd_rewind;</command>()</link>
</para>
</simplesect>
</sect2>
</sect1>
<sect1 id="commands_g"><title>&no-i18n-tag;g</title>
<!-- @COMMAND@ goto() -->
<sect2 id="cmd_sect_goto"><title id="cmd_title_goto">&no-i18n-cmd_goto;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-cmd_goto;</command>(<replaceable>pos</replaceable>)</title>
<para>
Sets the cursor to the given position and makes it visible in
current view. After this the selection has zero length.
</para>
</simplesect>
<simplesect><title>Parameters</title><informaltable frame='none'><tgroup cols='2'><tbody>
<row><entry><parameter>pos</parameter>:</entry><entry>position in samples where to go to</entry></row>
</tbody></tgroup></informaltable></simplesect>
</sect2>
</sect1>
<sect1 id="commands_i"><title>&no-i18n-tag;i</title>
<!-- @COMMAND@ insert_at(pos) -->
<sect2 id="cmd_sect_insert_at"><title id="cmd_title_insert_at">&no-i18n-cmd_insert_at;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-cmd_insert_at;</command>(<replaceable>pos</replaceable>)</title>
<para>
Inserts the content of the clipboard at the given position,
like the command <command>&no-i18n-cmd_paste;()</command>().
If the clipboard is currently empty, this function does nothing.
</para>
</simplesect>
<simplesect><title>Parameters</title><informaltable frame='none'><tgroup cols='2'><tbody>
<row><entry><parameter>pos</parameter>:</entry><entry>position in samples where to insert</entry></row>
</tbody></tgroup></informaltable></simplesect>
<simplesect><title>See also</title>
<para><link linkend="cmd_sect_paste"><command>&no-i18n-tag;&no-i18n-cmd_paste;</command>()</link></para>
</simplesect>
</sect2>
<!-- @COMMAND@ insert_track(index) -->
<sect2 id="cmd_sect_insert_track"><title id="cmd_title_insert_track">&no-i18n-cmd_insert_track;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-cmd_insert_track;</command>(<replaceable>index</replaceable>)</title>
<para>
Inserts a new track at the given index, using the current length
and sample rate settings of the signal. If the index is
higher than or equal to the current number of tracks, it will
be appended as the last track, same as by the command
<command>&no-i18n-cmd_add_track;()</command>.
The index of all existing tracks at and after the given
index will be incremented by one.
</para>
</simplesect>
<simplesect><title>Parameters</title><informaltable frame='none'><tgroup cols='2'><tbody>
<row><entry><parameter>index</parameter>:</entry><entry>index of the track to insert, starting with 0</entry></row>
</tbody></tgroup></informaltable></simplesect>
<simplesect><title>See also</title>
<para>
<link linkend="cmd_sect_add_track"><command>&no-i18n-tag;&no-i18n-cmd_add_track;</command>()</link>
</para>
</simplesect>
</sect2>
</sect1>
<sect1 id="commands_l"><title>&no-i18n-tag;l</title>
<!-- @COMMAND@ label:add(pos,[text]) -->
<sect2 id="cmd_sect_label_add"><title id="cmd_title_label_add">&no-i18n-cmd_label_add;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-cmd_label_add;</command>(<replaceable>pos</replaceable>[,<replaceable>text</replaceable>])</title>
<para>
Add a new label at a given position. If the given position already
contains a label, then this command does nothing. The label can
be given an optional description.
</para>
</simplesect>
<simplesect><title>Parameters</title><informaltable frame='none'><tgroup cols='2'><tbody>
<row><entry><parameter>pos</parameter>:</entry><entry>position in samples where to insert the label</entry></row>
<row><entry><parameter>text</parameter>:</entry><entry>some descriptive text (optional)</entry></row>
</tbody></tgroup></informaltable></simplesect>
</sect2>
<!-- @COMMAND@ label:delete(index) -->
<sect2 id="cmd_sect_label_delete"><title id="cmd_title_label_delete">&no-i18n-cmd_label_delete;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-cmd_label_delete;</command>(<replaceable>index</replaceable>)</title>
<para>
Deletes a label, identified by its index (starting from zero), or all
labels when using the special value -1 as index.
If no label with the given index exists, this command does nothing.
</para>
</simplesect>
<simplesect><title>Parameters</title><informaltable frame='none'><tgroup cols='2'><tbody>
<row><entry><parameter>index</parameter>:</entry><entry>index of the label to delete,
starting with 0 or -1 to delete all labels</entry></row>
</tbody></tgroup></informaltable></simplesect>
</sect2>
<!-- @COMMAND@ label:edit(index) -->
<sect2 id="cmd_sect_label_edit"><title id="cmd_title_label_edit">&no-i18n-cmd_label_edit;</title>
<screenshot>
<screeninfo>Screenshot</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kwave-edit-label.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Screenshot of the label editing dialog</phrase>
</textobject>
</mediaobject>
</screenshot>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-cmd_label_edit;</command>(<replaceable>index</replaceable>)</title>
<para>
Opens a window in which the user can edit the position and the
description of a label, which is identified by its index
(starting from zero). If no label with the given index exists,
this command does nothing.
</para>
</simplesect>
<simplesect><title>Parameters</title><informaltable frame='none'><tgroup cols='2'><tbody>
<row><entry><parameter>index</parameter>:</entry><entry>index of the label to edit, starting with 0</entry></row>
</tbody></tgroup></informaltable></simplesect>
</sect2>
<!-- @COMMAND@ loadbatch(filename) -->
<sect2 id="cmd_sect_loadbatch"><title id="cmd_title_loadbatch">&no-i18n-cmd_loadbatch;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-cmd_loadbatch;</command>(<replaceable>filename</replaceable>)</title>
<para>
Opens a &kwave; script file and processes the commands in it.
Uses the context of the currently opened file or the current
main window if no file is loaded.
</para>
</simplesect>
<simplesect><title>Parameters</title><informaltable frame='none'><tgroup cols='2'><tbody>
<row><entry><parameter>filename</parameter>:</entry>
<entry>name of the kwave script file including path and extension</entry></row>
</tbody></tgroup></informaltable></simplesect>
</sect2>
<!-- @COMMAND@ loop() -->
<sect2 id="cmd_sect_loop"><title id="cmd_title_loop">&no-i18n-cmd_loop;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_loop;</command>()</title>
<para>
Corresponds to the <guibutton>Loop</guibutton> toolbar
button. Starts the playback (if it is not already running) and
lets it play in a loop.
</para>
</simplesect>
<simplesect><title>See also</title>
<para>
<link linkend="cmd_sect_playback_start"><command>&no-i18n-tag;&no-i18n-cmd_playback_start;</command>()</link>
</para>
</simplesect>
</sect2>
</sect1>
<sect1 id="commands_m"><title>&no-i18n-tag;m</title>
<!-- @COMMAND@ menu(command,path,hotkey,id) -->
<sect2 id="cmd_sect_menu"><title id="cmd_title_menu">&no-i18n-cmd_menu;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-cmd_menu;</command>
(<replaceable>command</replaceable>,
<replaceable>path</replaceable>,
[<replaceable>hotkey</replaceable>],
[<replaceable>id</replaceable>])
</title>
<para>
This is a very powerful command, which is used to add a new
entry to the menu or to modify an existing entry. It determines
which <emphasis>command</emphasis> is executed when the menu
entry is activated, which <emphasis>icon</emphasis> is shown
in the menu and which <emphasis>hotkey</emphasis> is used.
Each menu entry can be <emphasis>disabled</emphasis> or
<emphasis>hidden</emphasis>, can be assigned
a unique <emphasis>id</emphasis> and can also join
a <emphasis>menu group</emphasis>.
</para>
<para>
You normally do not need this command within a &kwave; script!
</para>
</simplesect>
<simplesect><title>Parameters</title><informaltable frame='none'><tgroup cols='2'><tbody>
<row valign="top">
<entry><parameter>command</parameter>:</entry>
<entry>
A text command (including parameters) or a command list
that will be executed when the menu entry gets activated.
If a menu entry does not have a corresponding command
(for example if it is a sub menu and not menu entry),
you should use the special
command <command>ignore()</command>.
</entry>
</row>
<row valign="top">
<entry><parameter>path</parameter>:</entry>
<entry>
The path within the menu, using a <quote><token>/</token></quote>
as separator. The last part of the path can be a <emphasis>sub
command</emphasis> which modifies some property of the menu
entry (see <link linkend="menu_sub_commands">below</link>).
The last portion of the path (that is not a sub
command) produces a menu entry, the parts before produce
the main menu entry or sub menus that lead to it.
Main menu entries or sub menus are automatically created
when a menu entry is created, you do not need them manually.
</entry>
</row>
<row valign="top">
<entry><parameter>hotkey</parameter>:</entry>
<entry id="cmd_menu_param_hotkey">
A bitmask that consists of a combination of predefined
<emphasis>keys</emphasis> and <emphasis>modifiers</emphasis>,
concatenated with a <quote><token>+</token></quote>.
The <emphasis>key</emphasis> can be either a digit, an
upper case letter, a function
key (<quote>F1</quote> ... <quote>F12</quote>) or any other
key name understood by the Qt class
<quote><literal>QKeySequence</literal></quote>, including
key names for predefined actions (like for example
<quote><literal>::Copy</literal></quote>).
Typical <emphasis>modifiers</emphasis> are
<quote><literal>SHIFT</literal></quote>,
<quote><literal>ALT</literal></quote> and
<quote><literal>CTRL</literal></quote>.
</entry>
</row>
<row valign="top">
<entry><parameter>id</parameter>:</entry>
<entry>
A unique id that can be internally used to identify this
menu entry or menu / sub menu. Only uppercase letters, digits
and <quote><literal>_</literal></quote> should be used and
it should start with <quote><literal>ID_</literal></quote>.
It is in your own responsibility to make sure that the same
id is not used twice.
</entry>
</row>
</tbody></tgroup></informaltable></simplesect>
<simplesect><title id="menu_sub_commands">Sub Commands</title>
<informaltable frame='none'><tgroup cols='2'><tbody>
<row valign="top"><entry><command>&no-i18n-tag;#checkable</command>:</entry>
<entry>
Makes a menu entry <emphasis>checkable</emphasis>, so that
it can be switched on or off.
</entry>
</row>
<row valign="top"><entry><command>&no-i18n-tag;#disabled</command>:</entry>
<entry>
Lets the menu entry or menu/sub menu be
<emphasis>disabled</emphasis>.
</entry>
</row>
<row valign="top"><entry><command>&no-i18n-tag;#enabled</command>:</entry>
<entry>
Makes a menu entry or menu/sub menu that has been previously
disabled <emphasis>enabled</emphasis> again.
</entry>
</row>
<row valign="top"><entry><command>#exclusive</command>(<replaceable>group</replaceable>):</entry>
<entry>
Makes a menu entry be part of an <emphasis>exclusive</emphasis>
<emphasis><replaceable>group</replaceable></emphasis> (one
of many selection). The group that is given as parameter
should not be used for any other purpose. Only one entry
within that group can be selected at a time.
</entry>
</row>
<row valign="top"><entry><command>#group</command>(<replaceable>list</replaceable>):</entry>
<entry><para>
Adds the menu entry or menu/sub menu to one or more
a <emphasis>groups</emphasis>, so that the application can
enable/disable a bunch of menu entries without need to know
all their unique ids. Multiple groups can be passed as a
list with a <quote><literal>,</literal></quote> as
separator. Group names have to start
with a <quote><literal>@</literal></quote>.
The following groups predefined:
<variablelist>
<varlistentry>
<term><command>&no-i18n-tag;@CLIPBOARD</command>:</term>
<listitem>
<para>
Only enabled when the clipboard is not empty.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&no-i18n-tag;@LABELS</command>:</term>
<listitem>
<para>
Only enabled when the current signal contains
at least one label.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&no-i18n-tag;@NOT_CLOSED</command>:</term>
<listitem>
<para>
Enabled when the current signal is not closed
(the signal might be empty or zero length).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&no-i18n-tag;@SELECTION</command>:</term>
<listitem>
<para>
Enabled when the selection is not empty (more than
one sample is selected).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>&no-i18n-tag;@SIGNAL</command>:</term>
<listitem>
<para>
Enabled when there is some signal loaded and it
is not empty or zero length.
</para>
</listitem>
</varlistentry>
</variablelist>
</para></entry>
</row>
<row valign="top"><entry><command>&no-i18n-tag;#hidden</command>:</entry>
<entry>
<emphasis>Hides</emphasis> the menu entry or menu/sub menu.
</entry></row>
<row valign="top"><entry><command>#icon</command>(<replaceable>name</replaceable>):</entry>
<entry>
Assigns an <emphasis>icon</emphasis> to a menu entry. The
icon <emphasis><replaceable>name</replaceable></emphasis>
should correspond to an icon file (without
path and file extension) that is installed on the system or
with &kwave;.
</entry>
</row>
<row valign="top"><entry><command>#listmenu</command>(<replaceable>id</replaceable>,<replaceable>command</replaceable>):</entry>
<entry>
Inserts a placeholder for a list of menu entries into a
sub menu.
The unique <emphasis><replaceable>id</replaceable></emphasis>
specified in this sub command is used
to add/remove or clear the list of menu entries.
The <emphasis><replaceable>command</replaceable></emphasis>
parameter has to contain <quote><literal>%1</literal></quote>
as parameter, which will be replaced with the text of the
menu entry when it is activated.
(This sub command is internally used for the list of
recent files, list of tracks and window list).
</entry>
</row>
<row valign="top"><entry><command>&no-i18n-tag;#separator</command>:</entry>
<entry>
Inserts a separator into a sub menu.
</entry>
</row>
</tbody></tgroup></informaltable>
</simplesect>
</sect2>
<!-- @COMMAND@ msgbox(text) -->
<sect2 id="cmd_sect_msgbox"><title id="cmd_title_msgbox">&no-i18n-cmd_msgbox;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-cmd_msgbox;</command>(<replaceable>text</replaceable>)</title>
<para>
Shows a message box with some <emphasis><replaceable>text</replaceable></emphasis>
and the two buttons <quote><guibutton>OK</guibutton></quote>
(returns without error code) and
<quote><guibutton>Cancel</guibutton></quote> (returns and error
code). You can use this command to give the user a possibility
to abort a running script.
</para>
</simplesect>
<simplesect><title>Parameters</title><informaltable frame='none'><tgroup cols='2'><tbody>
<row><entry><parameter>text</parameter>:</entry>
<entry>A message that will be shown in the message box, should
contain a question that can be answered with <quote>OK</quote>
or <quote>Cancel</quote>
</entry>
</row>
</tbody></tgroup></informaltable></simplesect>
</sect2>
</sect1>
<sect1 id="commands_n"><title>&no-i18n-tag;n</title>
<!-- @COMMAND@ newsignal(samples,rate,bits,tracks) -->
<sect2 id="cmd_sect_newsignal"><title id="cmd_title_newsignal">&no-i18n-cmd_newsignal;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-cmd_newsignal;</command>(
<replaceable>samples</replaceable>,
<replaceable>rate</replaceable>,
<replaceable>bits</replaceable>,
<replaceable>tracks</replaceable>)
</title>
<para>
Creates a new signal, with a given length in
<emphasis><replaceable>samples</replaceable></emphasis>, a
<emphasis><replaceable>rate</replaceable></emphasis> in samples
per second (floating point number), a number of
<emphasis><replaceable>bits</replaceable></emphasis> per sample
and number of <emphasis><replaceable>tracks</replaceable></emphasis>.
You can calculate the length in samples by multiplying the desired
length in seconds with the sample rate.
</para>
</simplesect>
<simplesect><title>Parameters</title><informaltable frame='none'><tgroup cols='2'><tbody>
<row><entry><parameter>samples</parameter>:</entry>
<entry>Length of the signal in samples.</entry></row>
<row><entry><parameter>rate</parameter>:</entry>
<entry>Sample rate in samples per second.</entry></row>
<row><entry><parameter>bits</parameter>:</entry>
<entry>Number of bits per sample, must not be zero, should be
a number from 8...32.</entry></row>
<row><entry><parameter>tracks</parameter>:</entry>
<entry>Number of tracks.</entry></row>
</tbody></tgroup></informaltable></simplesect>
</sect2>
<!-- @COMMAND@ next() -->
<sect2 id="cmd_sect_next"><title id="cmd_title_next">&no-i18n-cmd_next;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_next;</command>()</title>
<para>
Corresponds to the <guibutton>Next</guibutton> toolbar
button. If the playback is currently running, it skips forward
to the next label. If the playback is not running,
this does the same as the command
<command>&no-i18n-cmd_view_scroll_next_label;</command>.
</para>
</simplesect>
<simplesect><title>See also</title>
<para>
<link linkend="cmd_sect_view_scroll_next_label"><command>&no-i18n-tag;&no-i18n-cmd_view_scroll_next_label;</command>()</link>,
<link linkend="cmd_sect_prev"><command>&no-i18n-tag;&no-i18n-cmd_prev;</command>()</link>
</para>
</simplesect>
</sect2>
</sect1>
<sect1 id="commands_o"><title>&no-i18n-tag;o</title>
<!-- @COMMAND@ open(filename) -->
<sect2 id="cmd_sect_open"><title id="cmd_title_open">&no-i18n-cmd_open;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-cmd_open;</command>([<replaceable>filename</replaceable>])</title>
<para>
Opens a file, which can be either a sound file or a &kwave; script.
If no file name is passed, then a dialog window will be opened that
allows to select an existing file. Depending on the GUI mode the
file will be opened in the context of a new sub window (MDI and
tab) or in a new main window (SDI, if there was already something
loaded).
</para>
</simplesect>
<simplesect><title>Parameters</title><informaltable frame='none'><tgroup cols='2'><tbody>
<row><entry><parameter>filename</parameter>:</entry>
<entry>name of a file including path and extension</entry></row>
</tbody></tgroup></informaltable></simplesect>
<simplesect><title>See also</title>
<para>
<link linkend="cmd_sect_close"><command>&no-i18n-tag;&no-i18n-cmd_close;</command>()</link>
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ openrecent(filename) -->
<sect2 id="cmd_sect_openrecent"><title id="cmd_title_openrecent">&no-i18n-cmd_openrecent;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-cmd_openrecent;</command>(<replaceable>filename</replaceable>)</title>
<para>
Practically the same as the command
<command>&no-i18n-cmd_open;</command>, but intended to be used
internally for the list of recently opened files in the menu
<menuchoice>
<guimenu>File</guimenu><guimenu>Open Recent</guimenu>
</menuchoice>.
In this command the parameter <replaceable>filename</replaceable> is
not optional.
</para>
</simplesect>
<simplesect><title>Parameters</title><informaltable frame='none'><tgroup cols='2'><tbody>
<row><entry><parameter>filename</parameter>:</entry>
<entry>entry of the list of recently opened files</entry></row>
</tbody></tgroup></informaltable></simplesect>
<simplesect><title>See also</title>
<para>
<link linkend="cmd_sect_open"><command>&no-i18n-tag;&no-i18n-cmd_open;</command></link>
</para>
</simplesect>
</sect2>
</sect1>
<sect1 id="commands_p"><title>&no-i18n-tag;p</title>
<!-- @COMMAND@ paste() -->
<sect2 id="cmd_sect_paste"><title id="cmd_title_paste">&no-i18n-cmd_paste;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_paste;</command>()</title>
<para>
Replaces the current selection with the content of the clipboard.
If the clipboard is empty, this command does nothing.
The sample rate of the inserted data is adjusted to match the
sample rate of the current signal if necessary.
Only enabled tracks are affected, disabled tracks remain
unchanged. Please be aware that this might produce a time shift
between enabled and disabled tracks!
If the number of tracks of the clipboard data differs
from the number of enabled tracks, then the data is mixed to
be spread equally over all selected tracks.
</para>
</simplesect>
<simplesect><title>See also</title>
<para>
<link linkend="cmd_sect_copy"><command>&no-i18n-tag;&no-i18n-cmd_copy;</command>()</link>
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ pause() -->
<sect2 id="cmd_sect_pause"><title id="cmd_title_pause">&no-i18n-cmd_pause;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_continue;</command>()</title>
<para>
Corresponds to the <guibutton>Pause</guibutton> toolbar
button and lets the playback pause if it is currently running,
or continue if it is currently paused.
</para>
</simplesect>
<simplesect><title>See also</title>
<para>
<link linkend="cmd_sect_continue"><command>&no-i18n-tag;&no-i18n-cmd_continue;</command>()</link>
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ playback_start() -->
<sect2 id="cmd_sect_playback_start"><title id="cmd_title_playback_start">&no-i18n-cmd_playback_start;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_playback_start;</command>()</title>
<para>
Corresponds to the <guibutton>Start</guibutton> toolbar
button and lets the playback start if it is currently paused.
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ plugin(name,[parameter,...]) -->
<sect2 id="cmd_sect_plugin"><title id="cmd_title_plugin">&no-i18n-cmd_plugin;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-cmd_plugin;</command>(<replaceable>name</replaceable>, [<replaceable>parameter</replaceable> ...])</title>
<para>
Executes a plugin, with an optional list of parameters. If no
parameter list is given, then the setup function of the plugin
will be called, using the parameters of the previous
invocation or default parameters as input (normally shows a
setup dialog, depending on the plugin).
Please refer to the chapter about <link linkend="plugins">plugins</link>
for a description of the various plugins.
</para>
</simplesect>
<simplesect><title>Parameters</title><informaltable frame='none'><tgroup cols='2'><tbody>
<row><entry><parameter>name</parameter>:</entry>
<entry>the (internal) name of a &kwave; plugin</entry></row>
<row><entry><parameter>parameter</parameter>:</entry>
<entry>a list of parameters understood by the plugin (optional)</entry></row>
</tbody></tgroup></informaltable></simplesect>
<simplesect><title>See also</title>
<para>
<link linkend="cmd_sect_plugin_execute"><command>&no-i18n-tag;&no-i18n-cmd_plugin_execute;</command>()</link>,
<link linkend="cmd_sect_plugin_setup"><command>&no-i18n-tag;&no-i18n-cmd_plugin_setup;</command>()</link>
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ plugin:execute(name,[parameter,...]) -->
<sect2 id="cmd_sect_plugin_execute"><title id="cmd_title_plugin_execute">&no-i18n-cmd_plugin_execute;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-cmd_plugin_execute;</command>(<replaceable>name</replaceable>, [<replaceable>parameter</replaceable> ...])</title>
<para>
Similar to the command <quote><command>&no-i18n-cmd_plugin;</command>()</quote>,
but without calling the setup function of the plugin if no parameters
were passed.
</para>
</simplesect>
<simplesect><title>Parameters</title><informaltable frame='none'><tgroup cols='2'><tbody>
<row><entry><parameter>name</parameter>:</entry>
<entry>the (internal) name of a &kwave; plugin</entry></row>
<row><entry><parameter>parameter</parameter>:</entry>
<entry>a list of parameters understood by the plugin</entry></row>
</tbody></tgroup></informaltable></simplesect>
</sect2>
<!-- @COMMAND@ plugin:setup(name,[parameter,...]) -->
<sect2 id="cmd_sect_plugin_setup"><title id="cmd_title_plugin_setup">&no-i18n-cmd_plugin_setup;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-cmd_plugin_setup;</command>(<replaceable>name</replaceable>, [<replaceable>parameter</replaceable> ...])</title>
<para>
Calls the <emphasis>setup</emphasis> function of a plugin, with
an optional list of parameters. If no parameter list is given,
the parameters of the previous invocation or default parameters
will be used as input. This normally shows a setup dialog,
depending on the plugin.
Please refer to the chapter about <link linkend="plugins">plugins</link>
for a description of the various plugins.
</para>
</simplesect>
<simplesect><title>Parameters</title><informaltable frame='none'><tgroup cols='2'><tbody>
<row><entry><parameter>name</parameter>:</entry>
<entry>the (internal) name of a &kwave; plugin</entry></row>
<row><entry><parameter>parameter</parameter>:</entry>
<entry>a list of parameters understood by the plugin (optional)</entry></row>
</tbody></tgroup></informaltable></simplesect>
</sect2>
<!-- @COMMAND@ prev() -->
<sect2 id="cmd_sect_prev"><title id="cmd_title_prev">&no-i18n-cmd_prev;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_prev;</command>()</title>
<para>
Corresponds to the <guibutton>Previous</guibutton> toolbar
button. If the playback is currently running, it skips back
to the previous label or start of the selection. If the playback
is not running, this does the same as the command
<command>&no-i18n-cmd_view_scroll_prev_label;</command>.
</para>
</simplesect>
<simplesect><title>See also</title>
<para>
<link linkend="cmd_sect_view_scroll_next_label"><command>&no-i18n-tag;&no-i18n-cmd_view_scroll_prev_label;</command>()</link>,
<link linkend="cmd_sect_next"><command>&no-i18n-tag;&no-i18n-cmd_next;</command>()</link>
</para>
</simplesect>
</sect2>
</sect1>
<sect1 id="commands_q"><title>&no-i18n-tag;q</title>
<!-- @COMMAND@ quit() -->
<sect2 id="cmd_sect_quit"><title id="cmd_title_quit">&no-i18n-cmd_quit;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_quit;</command>()</title>
<para>
Closes the current main window, including all sub windows.
In SDI mode this is the same as the command
<quote><command>&no-i18n-cmd_close;</command>()</quote>.
</para>
</simplesect>
<simplesect><title>See also</title>
<para>
<link linkend="cmd_sect_close"><command>&no-i18n-tag;&no-i18n-cmd_close;</command>()</link>
</para>
</simplesect>
</sect2>
</sect1>
<sect1 id="commands_r"><title>&no-i18n-tag;r</title>
<!-- @COMMAND@ redo() -->
<sect2 id="cmd_sect_redo"><title id="cmd_title_redo">&no-i18n-cmd_redo;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_redo;</command>()</title>
<para>
Corresponds to the <guibutton>Redo</guibutton> toolbar
button and repeats one operation that has been reverted with
<command>&no-i18n-cmd_undo;</command>.
</para>
</simplesect>
<simplesect><title>See also</title>
<para>
<link linkend="cmd_sect_undo"><command>&no-i18n-tag;&no-i18n-cmd_undo;</command>()</link>
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ redo_all() -->
<sect2 id="cmd_sect_redo_all"><title id="cmd_title_redo_all">&no-i18n-cmd_redo_all;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_redo_all;</command>()</title>
<para>
Similar to <command>&no-i18n-cmd_redo;</command>, but re-does
as many operations as possible.
</para>
</simplesect>
<simplesect><title>See also</title>
<para>
<link linkend="cmd_sect_undo"><command>&no-i18n-tag;&no-i18n-cmd_undo;</command>()</link>
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ reenable_dna() -->
<sect2 id="cmd_sect_reenable_dna"><title id="cmd_title_reenable_dna">&no-i18n-cmd_reenable_dna;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_reenable_dna;</command>()</title>
<para>
Some message boxes offer the possibility to prevent them from
appearing again (<quote>do not ask again</quote>). This command
makes all of them appear again.
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ reset_toolbars() -->
<sect2 id="cmd_sect_reset_toolbars"><title id="cmd_title_reset_toolbars">&no-i18n-cmd_reset_toolbars;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_reset_toolbars;</command>()</title>
<para>
Resets all toolbar settings, like location, icon size and text
location back to defaults.
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ revert() -->
<sect2 id="cmd_sect_revert"><title id="cmd_title_revert">&no-i18n-cmd_revert;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_revert;</command>()</title>
<para>
Reverts the currently loaded file back to the last saved state,
discarding all changes that are not saved.
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ rewind() -->
<sect2 id="cmd_sect_rewind"><title id="cmd_title_rewind">&no-i18n-cmd_rewind;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_rewind;</command>()</title>
<para>
Corresponds to the <guibutton>Rewind</guibutton> toolbar
button. If the playback is currently running, it skips backward
by 1/10 of the visible range. If the playback is not running,
this does the same as the command
<command>&no-i18n-cmd_view_scroll_left;</command>.
</para>
</simplesect>
<simplesect><title>See also</title>
<para>
<link linkend="cmd_sect_view_scroll_left"><command>&no-i18n-tag;&no-i18n-cmd_view_scroll_left;</command>()</link>,
<link linkend="cmd_sect_forward"><command>&no-i18n-tag;&no-i18n-cmd_forward;</command>()</link>
</para>
</simplesect>
</sect2>
</sect1>
<sect1 id="commands_s"><title>&no-i18n-tag;s</title>
<!-- @COMMAND@ save() -->
<sect2 id="cmd_sect_save"><title id="cmd_title_save">&no-i18n-cmd_save;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_save;</command>()</title>
<para>
Corresponds to the <guibutton>Save</guibutton> toolbar
button. Saves the current file if it has modifications.
If the file does not already have a name (⪚ a file that has
just been created and does not yet have a file name), this
command does the same as <command>&no-i18n-cmd_saveas;</command>.
</para>
</simplesect>
<simplesect><title>See also</title>
<para>
<link linkend="cmd_sect_saveas"><command>&no-i18n-tag;&no-i18n-cmd_saveas;</command>()</link>
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ saveas(filename) -->
<sect2 id="cmd_sect_saveas"><title id="cmd_title_saveas">&no-i18n-cmd_saveas;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-cmd_saveas;</command>([<replaceable>filename</replaceable>])</title>
<para>
Saves the currently opened file under a given file name. If no
file name is given as parameter, a dialog will be shown to
select the directory and to enter a file name.
</para>
</simplesect>
<simplesect><title>Parameters</title><informaltable frame='none'><tgroup cols='2'><tbody>
<row><entry><parameter>filename</parameter>:</entry>
<entry>file name for saving (optional)</entry></row>
</tbody></tgroup></informaltable></simplesect>
</sect2>
<!-- @COMMAND@ saveselect() -->
<sect2 id="cmd_sect_saveselect"><title id="cmd_title_saveselect">&no-i18n-cmd_saveselect;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_saveselect;</command>()</title>
<para>
This command does the same as <command>&no-i18n-cmd_save;</command>,
but saves only the currently selected range and the activated
tracks instead of the whole file.
</para>
</simplesect>
<simplesect><title>See also</title>
<para>
<link linkend="cmd_sect_save"><command>&no-i18n-tag;&no-i18n-cmd_save;</command>()</link>
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ select_gui_type(mode) -->
<sect2 id="cmd_sect_select_gui_type"><title id="cmd_title_select_gui_type">&no-i18n-cmd_select_gui_type;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-cmd_select_gui_type;</command>(mode)</title>
<para>
Select a GUI mode, which can be either SDI, MDI or Tab mode.
Please be aware that this changes will immediately take
effect!
</para>
</simplesect>
<simplesect><title>Parameters</title><informaltable frame='none'><tgroup cols='2'><tbody>
<row><entry><parameter>filename</parameter>:</entry>
<entry>
name of the mode, must be either <quote>SDI</quote>,
<quote>MDI</quote> or <quote>TAB</quote>.
</entry></row>
</tbody></tgroup></informaltable></simplesect>
</sect2>
<!-- @COMMAND@ select_track:all() -->
<sect2 id="cmd_sect_select_track_all"><title id="cmd_title_select_track_all">&no-i18n-cmd_select_track_all;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_select_track_all;</command>()</title>
<para>
Mark all tracks <quote>enabled</quote>. This is the same as
calling the command <quote><command>&no-i18n-tag;&no-i18n-cmd_select_track_on;</command>()</quote>
for all existing tracks.
</para>
</simplesect>
<simplesect><title>See also</title>
<para>
<link linkend="cmd_sect_select_track_on"><command>&no-i18n-tag;&no-i18n-cmd_select_track_on;</command>()</link>
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ select_track:invert() -->
<sect2 id="cmd_sect_select_track_invert"><title id="cmd_title_select_track_invert">&no-i18n-cmd_select_track_invert;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_select_track_all;</command>()</title>
<para>
Invert the <quote>enabled</quote> state of all tracks.
This is the same as calling the command
<quote><command>&no-i18n-cmd_select_track_toggle;</command>()</quote>
for all existing tracks.
</para>
</simplesect>
<simplesect><title>See also</title>
<para>
<link linkend="cmd_sect_select_track_toggle"><command>&no-i18n-tag;&no-i18n-cmd_select_track_toggle;</command>()</link>
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ select_track:none() -->
<sect2 id="cmd_sect_select_track_none"><title id="cmd_title_select_track_none">&no-i18n-cmd_select_track_none;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_select_track_none;</command>()</title>
<para>
Mark all tracks <quote>disabled</quote>. This is the same as
calling the command <quote><command>&no-i18n-cmd_select_track_off;</command>()</quote>
for all existing tracks.
</para>
</simplesect>
<simplesect><title>See also</title>
<para>
<link linkend="cmd_sect_select_track_off"><command>&no-i18n-tag;&no-i18n-cmd_select_track_off;</command>()</link>
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ select_track:off(index) -->
<sect2 id="cmd_sect_select_track_off"><title id="cmd_title_select_track_off">&no-i18n-cmd_select_track_off;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-cmd_select_track_off;</command>(index)</title>
<para>
Disables a single track, so that it does not get affected by
most operations.
</para>
</simplesect>
<simplesect><title>Parameters</title><informaltable frame='none'><tgroup cols='2'><tbody>
<row><entry><parameter>index</parameter>:</entry>
<entry>index of the track, starting with zero</entry></row>
</tbody></tgroup></informaltable></simplesect>
</sect2>
<!-- @COMMAND@ select_track:on(index) -->
<sect2 id="cmd_sect_select_track_on"><title id="cmd_title_select_track_on">&no-i18n-cmd_select_track_on;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-cmd_select_track_on;</command>(index)</title>
<para>
Enables a single track, so that it gets affected by all operations.
</para>
</simplesect>
<simplesect><title>Parameters</title><informaltable frame='none'><tgroup cols='2'><tbody>
<row><entry><parameter>index</parameter>:</entry>
<entry>index of the track, starting with zero</entry></row>
</tbody></tgroup></informaltable></simplesect>
</sect2>
<!-- @COMMAND@ select_track:toggle(index) -->
<sect2 id="cmd_sect_select_track_toggle"><title id="cmd_title_select_track_toggle">&no-i18n-cmd_select_track_toggle;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-cmd_select_track_toggle;</command>(index)</title>
<para>
Enables a track if it is currently disabled, or disables it if
it is currently enabled.
</para>
</simplesect>
<simplesect><title>Parameters</title><informaltable frame='none'><tgroup cols='2'><tbody>
<row><entry><parameter>index</parameter>:</entry>
<entry>index of the track, starting with zero</entry></row>
</tbody></tgroup></informaltable></simplesect>
</sect2>
<!-- @COMMAND@ selectall() -->
<sect2 id="cmd_sect_selectall"><title id="cmd_title_selectall">&no-i18n-cmd_selectall;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_selectall;</command>()</title>
<para>
Selects the range of the whole signal, from the first to the
last sample.
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ selectnext() -->
<sect2 id="cmd_sect_selectnext"><title id="cmd_title_selectnext">&no-i18n-cmd_selectnext;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_selectnext;</command>()</title>
<para>
Selects a range of samples that starts right after the current
selection, using the same length as the current selection.
The selection is automatically clipped to the end of the signal.
For example: if you have selected samples 1000 ... 1019, then
the result will be a selection from sample 1020 ... 1039.
</para>
</simplesect>
<simplesect><title>See also</title>
<para>
<link linkend="cmd_sect_selectprev"><command>&no-i18n-tag;&no-i18n-cmd_selectprev;</command>()</link>
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ selectnextlabels() -->
<sect2 id="cmd_sect_selectnextlabels"><title id="cmd_title_selectnextlabels">&no-i18n-cmd_selectnextlabels;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_selectnextlabels;</command>()</title>
<para>
Selects a range of samples between the next two labels after the
current selection. If nothing is selected, it selects from the
start of the signal up to the first label. Otherwise the left
border of the new selection will be the position of first label
after the selection (or the last label if there are no more
labels right from the selection), and the right border of the
new selection will be the first label after the left border of
the new selection (or the end of the signal if there is none).
This command returns an error when there are no labels at all.
</para>
</simplesect>
<simplesect><title>See also</title>
<para>
<link linkend="cmd_sect_selectprevlabels"><command>&no-i18n-tag;&no-i18n-cmd_selectprevlabels;</command>()</link>
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ selectnone() -->
<sect2 id="cmd_sect_selectnone"><title id="cmd_title_selectnone">&no-i18n-cmd_selectnone;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_selectnone;</command>()</title>
<para>
Resets the selection to zero length.
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ selectprev() -->
<sect2 id="cmd_sect_selectprev"><title id="cmd_title_selectprev">&no-i18n-cmd_selectprev;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_selectprev;</command>()</title>
<para>
Selects a range of samples that starts left from the current
selection, using the same length as the current selection.
The selection is automatically clipped to the start of the signal.
For example: if you have selected samples 1000 ... 1019, then
the result will be a selection from sample 980 ... 999.
</para>
</simplesect>
<simplesect><title>See also</title>
<para>
<link linkend="cmd_sect_selectprev"><command>&no-i18n-tag;&no-i18n-cmd_selectnext;</command>()</link>
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ selectprevlabels() -->
<sect2 id="cmd_sect_selectprevlabels"><title id="cmd_title_selectprevlabels">&no-i18n-cmd_selectprevlabels;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_selectprevlabels;</command>()</title>
<para>
Selects a range of samples between the previous two labels before the
current selection. If nothing is selected, it selects from the
start of the signal up to the first label. Otherwise the right
border of the new selection will be the position of first label
before the selection (or the first label if there are no more
labels left from the selection), and the left border of the
new selection will be the first label before the right border of
the new selection (or the start of the signal if there is none).
This command returns an error when there are no labels at all.
</para>
</simplesect>
<simplesect><title>See also</title>
<para>
<link linkend="cmd_sect_selectnextlabels"><command>&no-i18n-tag;&no-i18n-cmd_selectnextlabels;</command>()</link>
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ selecttoleft() -->
<sect2 id="cmd_sect_selecttoleft"><title id="cmd_title_selecttoleft">&no-i18n-cmd_selecttoleft;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_selecttoleft;</command>()</title>
<para>
Sets the start of the selection to the start of the signal, the
end of the current selection stays unchanged.
</para>
</simplesect>
<simplesect><title>See also</title>
<para>
<link linkend="cmd_sect_selecttoright"><command>&no-i18n-tag;&no-i18n-cmd_selecttoright;</command>()</link>
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ selecttoright() -->
<sect2 id="cmd_sect_selecttoright"><title id="cmd_title_selecttoright">&no-i18n-cmd_selecttoright;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_selecttoright;</command>()</title>
<para>
Sets the end of the selection to the end of the signal, the
start of the current selection stays unchanged.
</para>
</simplesect>
<simplesect><title>See also</title>
<para>
<link linkend="cmd_sect_selecttoleft"><command>&no-i18n-tag;&no-i18n-cmd_selecttoleft;</command>()</link>
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ selectvisible() -->
<sect2 id="cmd_sect_selectvisible"><title id="cmd_title_selectvisible">&no-i18n-cmd_selectvisible;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_selectvisible;</command>()</title>
<para>
Selects the range of samples that is visible in the current
window.
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ start() -->
<sect2 id="cmd_sect_start"><title id="cmd_title_start">&no-i18n-cmd_start;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_start;</command>()</title>
<para>
Corresponds to the <guibutton>Start</guibutton> toolbar
button and lets the playback start from the beginning of the
selection or continue if it is currently paused.
</para>
</simplesect>
<simplesect><title>See also</title>
<para>
<link linkend="cmd_sect_stop"><command>&no-i18n-tag;&no-i18n-cmd_stop;</command>()</link>
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ stop() -->
<sect2 id="cmd_sect_stop"><title id="cmd_title_stop">&no-i18n-cmd_stop;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_stop;</command>()</title>
<para>
Corresponds to the <guibutton>Stop</guibutton> toolbar
button and lets the playback stop if it is currently running.
</para>
</simplesect>
<simplesect><title>See also</title>
<para>
<link linkend="cmd_sect_start"><command>&no-i18n-tag;&no-i18n-cmd_start;</command>()</link>
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ sync() -->
<sect2 id="cmd_sect_sync"><title id="cmd_title_sync">&no-i18n-cmd_sync;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_sync;</command>()</title>
<para>
Waits until all commands which have been started asynchronously
have finished. If nothing is currently queued for delayed
execution this command has no effect.
</para>
</simplesect>
<simplesect><title>See also</title>
<para>
<link linkend="cmd_sect_delayed"><command>&no-i18n-tag;&no-i18n-cmd_delayed;</command>()</link>
</para>
</simplesect>
</sect2>
</sect1>
<sect1 id="commands_u"><title>&no-i18n-tag;u</title>
<!-- @COMMAND@ undo() -->
<sect2 id="cmd_sect_undo"><title id="cmd_title_undo">&no-i18n-cmd_undo;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_undo;</command>()</title>
<para>
Corresponds to the <guibutton>Undo</guibutton> toolbar
button and reverts the last operation.
</para>
</simplesect>
<simplesect><title>See also</title>
<para>
<link linkend="cmd_sect_redo"><command>&no-i18n-tag;&no-i18n-cmd_redo;</command>()</link>
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ undo_all() -->
<sect2 id="cmd_sect_undo_all"><title id="cmd_title_undo_all">&no-i18n-cmd_undo_all;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_undo_all;</command>()</title>
<para>
Similar to <command>&no-i18n-tag;&no-i18n-cmd_undo;</command>, but reverts
as many operations as possible.
</para>
</simplesect>
<simplesect><title>See also</title>
<para>
<link linkend="cmd_sect_undo"><command>&no-i18n-tag;&no-i18n-cmd_undo;</command>()</link>
</para>
</simplesect>
</sect2>
</sect1>
<sect1 id="commands_v"><title>&no-i18n-tag;v</title>
<!-- @COMMAND@ view:scroll_end() -->
<sect2 id="cmd_sect_view_scroll_end"><title id="cmd_title_view_scroll_end">&no-i18n-cmd_view_scroll_end;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_view_scroll_end;</command>()</title>
<para>Scrolls the current view to the <emphasis>end</emphasis> of the signal.</para>
</simplesect>
<simplesect><title>See also</title>
<para>
<link linkend="cmd_sect_view_scroll_start"><command>&no-i18n-tag;&no-i18n-cmd_view_scroll_start;</command>()</link>
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ view:scroll_left() -->
<sect2 id="cmd_sect_view_scroll_left"><title id="cmd_title_view_scroll_left">&no-i18n-cmd_view_scroll_left;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_view_scroll_left;</command>()</title>
<para>
Scrolls the current view by 1/10 of the currently visible range towards
the start of the signal. If the start of the signal is reached the visible
area starts at offset zero.
</para>
</simplesect>
<simplesect><title>See also</title>
<para>
<link linkend="cmd_sect_view_scroll_right"><command>&no-i18n-tag;&no-i18n-cmd_view_scroll_right;</command>()</link>
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ view:scroll_next() -->
<sect2 id="cmd_sect_view_scroll_next"><title id="cmd_title_view_scroll_next">&no-i18n-cmd_view_scroll_next;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_view_scroll_next;</command>()</title>
<para>
Scrolls the current view towards the end of the signal by
the currently visible range.
</para>
</simplesect>
<simplesect><title>See also</title>
<para>
<link linkend="cmd_sect_view_scroll_prev"><command>&no-i18n-tag;&no-i18n-cmd_view_scroll_prev;</command>()</link>
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ view:scroll_next_label() -->
<sect2 id="cmd_sect_view_scroll_next_label"><title id="cmd_title_view_scroll_next_label">&no-i18n-cmd_view_scroll_next_label;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_view_scroll_next_label;</command>()</title>
<para>
Scrolls right and tries to show the next label centered in the
view. If there was no label right from the current position,
it will scroll to the end of the signal.
</para>
</simplesect>
<simplesect><title>See also</title>
<para>
<link linkend="cmd_sect_view_scroll_prev_label"><command>&no-i18n-tag;&no-i18n-cmd_view_scroll_prev_label;</command>()</link>
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ view:scroll_prev() -->
<sect2 id="cmd_sect_view_scroll_prev"><title id="cmd_title_view_scroll_prev">&no-i18n-cmd_view_scroll_prev;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_view_scroll_prev;</command>()</title>
<para>
Scrolls the current view towards the start of the signal by
the currently visible range.
</para>
</simplesect>
<simplesect><title>See also</title>
<para>
<link linkend="cmd_sect_view_scroll_next"><command>&no-i18n-tag;&no-i18n-cmd_view_scroll_next;</command>()</link>
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ view:scroll_prev_label() -->
<sect2 id="cmd_sect_view_scroll_prev_label"><title id="cmd_title_view_scroll_prev_label">&no-i18n-cmd_view_scroll_prev_label;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_view_scroll_prev_label;</command>()</title>
<para>
Scrolls left and tries to show the previous label centered in the
view. If there was no label left from the current position,
it will scroll to the start of the signal.
</para>
</simplesect>
<simplesect><title>See also</title>
<para>
<link linkend="cmd_sect_view_scroll_next_label"><command>&no-i18n-tag;&no-i18n-cmd_view_scroll_next_label;</command>()</link>
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ view:scroll_right() -->
<sect2 id="cmd_sect_view_scroll_right"><title id="cmd_title_view_scroll_right">&no-i18n-cmd_view_scroll_right;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_view_scroll_right;</command>()</title>
<para>
Scrolls the current view by 1/10 of the currently visible range towards
the end of the signal. If the end of the signal is reached the visible
area ends at the end of the signal.
</para>
</simplesect>
<simplesect><title>See also</title>
<para>
<link linkend="cmd_sect_view_scroll_left"><command>&no-i18n-tag;&no-i18n-cmd_view_scroll_left;</command>()</link>
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ view:scroll_start() -->
<sect2 id="cmd_sect_view_scroll_start"><title id="cmd_title_view_scroll_start">&no-i18n-cmd_view_scroll_start;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_view_scroll_start;</command>()</title>
<para>Scrolls the current view to the start of the signal.</para>
</simplesect>
<simplesect><title>See also</title>
<para>
<link linkend="cmd_sect_view_scroll_end"><command>&no-i18n-tag;&no-i18n-cmd_view_scroll_end;</command>()</link>
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ view:zoom_all() -->
<sect2 id="cmd_sect_view_zoom_all"><title id="cmd_title_view_zoom_all">&no-i18n-cmd_view_zoom_all;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_view_zoom_all;</command>()</title>
<para>
Adjusts the zoom factor so that the complete signal is visible
in the current view.
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ view:zoom_in([position]) -->
<sect2 id="cmd_sect_view_zoom_in"><title id="cmd_title_view_zoom_in">&no-i18n-cmd_view_zoom_in;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-cmd_view_zoom_in;</command>([<replaceable>position</replaceable>])</title>
<para>
Reduces the zoom factor (in samples per pixel) by 30%, so that
more details get visible.
If a <replaceable>position</replaceable> is
given, it tries to show that position centered in the current
view, otherwise the center of the view before the zoom change
is used for centering.
The minimum zoom factor is limited to a minimum of five samples
per width of the view.
</para>
</simplesect>
<simplesect><title>Parameters</title><informaltable frame='none'><tgroup cols='2'><tbody>
<row><entry><parameter>position</parameter>:</entry>
<entry>a zero based position in samples to center the view (optional)</entry></row>
</tbody></tgroup></informaltable></simplesect>
<simplesect><title>See also</title>
<para>
<link linkend="cmd_sect_view_zoom_out"><command>&no-i18n-tag;&no-i18n-cmd_view_zoom_out;</command>()</link>
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ view:zoom_normal() -->
<sect2 id="cmd_sect_view_zoom_normal"><title id="cmd_title_view_zoom_normal">&no-i18n-cmd_view_zoom_normal;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_view_zoom_normal;</command>()</title>
<para>
Sets the zoom factor to one pixel per sample (factor 1.0) and
tries to keep the previous center of the view.
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ view:zoom_out([position]) -->
<sect2 id="cmd_sect_view_zoom_out"><title id="cmd_title_view_zoom_out">&no-i18n-cmd_view_zoom_out;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-cmd_view_zoom_out;([<replaceable>position</replaceable>])</command></title>
<para>
Increases the zoom factor (in samples per pixel) by 30%, so that
less details get visible.
If a <replaceable>position</replaceable> is
given, it tries to show that position centered in the current
view, otherwise the center of the view before the zoom change
is used for centering.
The maximum zoom factor is limited to the number of samples of
the complete signal and the width of the view.
</para>
</simplesect>
<simplesect><title>Parameters</title><informaltable frame='none'><tgroup cols='2'><tbody>
<row><entry><parameter>position</parameter>:</entry>
<entry>a zero based position is samples to center the view (optional)</entry></row>
</tbody></tgroup></informaltable></simplesect>
<simplesect><title>See also</title>
<para>
<link linkend="cmd_sect_view_zoom_in"><command>&no-i18n-tag;&no-i18n-cmd_view_zoom_in;</command>()</link>
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ view:zoom_selection() -->
<sect2 id="cmd_sect_view_zoom_selection"><title id="cmd_title_view_zoom_selection">&no-i18n-cmd_view_zoom_selection;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_view_zoom_selection;</command>()</title>
<para>
Adjusts the view (zoom factor and start of visible area) so
that it matches the current selection. This command does
nothing if the selection is empty.
</para>
</simplesect>
</sect2>
</sect1>
<sect1 id="commands_w"><title>&no-i18n-tag;w</title>
<!-- @COMMAND@ window:activate(title) -->
<sect2 id="cmd_sect_window_activate"><title id="cmd_title_window_activate">&no-i18n-cmd_window_activate;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-cmd_window_activate;</command>(<replaceable>title</replaceable>])</title>
<para>
Activates a sub window, identified by its window <replaceable>title</replaceable>.
If the sub window is minimized it will be restored.
Only available if in MDI and tab mode.
This command is internally used by the <quote><guisubmenu>Window</guisubmenu></quote> menu.
</para>
</simplesect>
<simplesect><title>Parameters</title><informaltable frame='none'><tgroup cols='2'><tbody>
<row><entry><parameter>title</parameter>:</entry>
<entry>the title of the sub window that should be activated</entry></row>
</tbody></tgroup></informaltable></simplesect>
</sect2>
<!-- @COMMAND@ window:cascade() -->
<sect2 id="cmd_sect_window_cascade"><title id="cmd_title_window_cascade">&no-i18n-cmd_window_cascade;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_window_cascade;</command>()</title>
<para>
Cascades all sub windows when in MDI mode. All sub windows that are currently
minimized stay minimized, they will not be restored.
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ window:click(class,x,y) -->
<sect2 id="cmd_sect_window_click"><title id="cmd_title_window_click">&no-i18n-cmd_window_click;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-cmd_window_click;</command>(
<replaceable>class</replaceable>,
<replaceable>x</replaceable>,
<replaceable>y</replaceable>
)</title>
<para>
Sends a mouse click event to window, identified by its
<replaceable>class</replaceable> name.
The event will only be sent to the first window that has
the given class name, therefore you should make sure that you
have only one instance of the given window when this command
gets executed.
</para>
</simplesect>
<simplesect><title>Parameters</title><informaltable frame='none'><tgroup cols='2'><tbody>
<row><entry><parameter>class</parameter>:</entry>
<entry>name of the window class</entry></row>
<row><entry><parameter>x</parameter>:</entry>
<entry>x position, relative to the left border of the window (in pixels)</entry></row>
<row><entry><parameter>y</parameter>:</entry>
<entry>y position, relative to the top border of the window (in pixels)</entry></row>
</tbody></tgroup></informaltable></simplesect>
</sect2>
<!-- @COMMAND@ window:close(class) -->
<sect2 id="cmd_sect_window_close"><title id="cmd_title_window_close">&no-i18n-cmd_window_close;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-cmd_window_close;</command>(
<replaceable>class</replaceable>
)</title>
<para>
Closes a window, identified by its
<replaceable>class</replaceable> name.
Only the first window that has the given class name will be
closed, therefore you should make sure that you have only one
instance of the given window when this command gets executed.
</para>
</simplesect>
<simplesect><title>Parameters</title><informaltable frame='none'><tgroup cols='2'><tbody>
<row><entry><parameter>class</parameter>:</entry>
<entry>name of the window class</entry></row>
</tbody></tgroup></informaltable></simplesect>
</sect2>
<!-- @COMMAND@ window:minimize() -->
<sect2 id="cmd_sect_window_minimize"><title id="cmd_title_window_minimize">&no-i18n-cmd_window_minimize;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-cmd_window_minimize;</command></title>
<para>
Minimizes the currently active sub window when in MDI mode or
the current toplevel window when in SDI or Tab mode.
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ window:mousemove(class,x,y) -->
<sect2 id="cmd_sect_window_mousemove"><title id="cmd_title_window_mousemove">&no-i18n-cmd_window_mousemove;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-cmd_window_resize;</command>(
<replaceable>class</replaceable>,
<replaceable>x</replaceable>,
<replaceable>y</replaceable>
)</title>
<para>
Sends a mouse move event to window, identified by its
<replaceable>class</replaceable> name.
The event will only be sent to the first window that has
the given class name, therefore you should make sure that you
have only one instance of the given window when this command
gets executed.
</para>
</simplesect>
<simplesect><title>Parameters</title><informaltable frame='none'><tgroup cols='2'><tbody>
<row><entry><parameter>class</parameter>:</entry>
<entry>name of the window class</entry></row>
<row><entry><parameter>x</parameter>:</entry>
<entry>x position, relative to the left border of the window (in pixels)</entry></row>
<row><entry><parameter>y</parameter>:</entry>
<entry>y position, relative to the top border of the window (in pixels)</entry></row>
</tbody></tgroup></informaltable></simplesect>
</sect2>
<!-- @COMMAND@ window:next_sub() -->
<sect2 id="cmd_sect_window_next_sub"><title id="cmd_title_window_next_sub">&no-i18n-cmd_window_next_sub;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_window_next_sub;</command>()</title>
<para>
Activates the <emphasis>next</emphasis> sub window when in MDI or tab mode. If the next
sub window is minimized it will be restored.
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ window:prev_sub() -->
<sect2 id="cmd_sect_window_prev_sub"><title id="cmd_title_window_prev_sub">&no-i18n-cmd_window_prev_sub;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_window_prev_sub;</command>()</title>
<para>
Activates the <emphasis>previous</emphasis> sub window when in MDI or tab mode. If the previous
sub window is minimized it will be restored.
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ window:resize(width,height) -->
<sect2 id="cmd_sect_window_resize"><title id="cmd_title_window_resize">&no-i18n-cmd_window_resize;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-cmd_window_resize;</command>(
<replaceable>class</replaceable>,
<replaceable>width</replaceable>,
<replaceable>height</replaceable>
)</title>
<para>
Changes the size of a window, identified by its
<replaceable>class</replaceable> name to a new
<replaceable>width</replaceable> and
<replaceable>height</replaceable>.
The change will only be applied to the first window that has
the given class name, therefore you should make sure that you
have only one instance of the given window when this command
gets executed.
</para>
</simplesect>
<simplesect><title>Parameters</title><informaltable frame='none'><tgroup cols='2'><tbody>
<row><entry><parameter>class</parameter>:</entry>
<entry>name of the window class</entry></row>
<row><entry><parameter>width</parameter>:</entry>
<entry>new width of the window (in pixels)</entry></row>
<row><entry><parameter>height</parameter>:</entry>
<entry>new height of the window (in pixels)</entry></row>
</tbody></tgroup></informaltable></simplesect>
</sect2>
<!-- @COMMAND@ window:screenshot(class,filename) -->
<sect2 id="cmd_sect_window_screenshot"><title id="cmd_title_window_screenshot">&no-i18n-cmd_window_screenshot;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-cmd_window_screenshot;</command>(
<replaceable>class</replaceable>,
<replaceable>filename</replaceable>
)</title>
<para>
Takes a screenshot of a window, identified by its
<replaceable>class</replaceable> and saves it to a file.
The screenshot will be taken from the first window that has
the given class name, therefore you should make sure that you
have only one instance of the given window when this command
gets executed.
Currently the format of the file is hardcoded and has to be
<literal>*.png</literal>.
</para>
</simplesect>
<simplesect><title>Parameters</title><informaltable frame='none'><tgroup cols='2'><tbody>
<row><entry><parameter>class</parameter>:</entry>
<entry>name of the window class</entry></row>
<row><entry><parameter>filename</parameter>:</entry>
<entry>name of the file to save the screenshot, must have the extension
<literal>*.png</literal></entry></row>
</tbody></tgroup></informaltable></simplesect>
</sect2>
<!-- @COMMAND@ window:sendkey(class,keycombo) -->
<sect2 id="cmd_sect_window_sendkey"><title id="cmd_title_window_sendkey">&no-i18n-cmd_window_sendkey;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-cmd_window_sendkey;</command>(
<replaceable>class</replaceable>,
<replaceable>key code</replaceable>
)</title>
<para>
Sends a key press and release event to a window, identified by its
<replaceable>class</replaceable> name.
The key will only be sent to the first window that has
the given class name, therefore you should make sure that you
have only one instance of the given window when this command
gets executed.
</para>
</simplesect>
<simplesect><title>Parameters</title><informaltable frame='none'><tgroup cols='2'><tbody>
<row><entry><parameter>class</parameter>:</entry>
<entry>name of the window class</entry></row>
<row><entry><parameter>key code</parameter>:</entry>
<entry>the key code that should be sent, using the same syntax
as used for setting up menus</entry></row>
</tbody></tgroup></informaltable></simplesect>
<simplesect><title>See also</title>
<para>
description of the parameter
<link linkend="cmd_menu_param_hotkey"><parameter>hotkey</parameter></link>
of the <command>&no-i18n-cmd_menu;</command> command.
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ window:tile() -->
<sect2 id="cmd_sect_window_tile"><title id="cmd_title_window_tile">&no-i18n-cmd_window_tile;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_window_tile;</command>()</title>
<para>
Tiles all sub windows when in MDI mode, using some scheme of
KDE. All sub windows that are currently minimized stay minimized,
they will not be restored.
</para>
</simplesect>
</sect2>
<!-- @COMMAND@ window:tile_vertical() -->
<sect2 id="cmd_sect_window_tile_vertical"><title id="cmd_title_window_tile_vertical">&no-i18n-cmd_window_tile_vertical;</title>
<simplesect>
<title>&i18n-cmd_syntax;<command>&no-i18n-tag;&no-i18n-cmd_window_tile_vertical;</command>()</title>
<para>
Tiles all sub windows vertically when in MDI mode. All windows
that are currently minimized stay minimized, they will not be
restored.
</para>
</simplesect>
</sect2>
<!-- @COMMAND_END_OF_LIST@ -->
</sect1>
</chapter>
<!-- ###################################################################### -->
<!-- ### Chapter: Plugin Reference ### -->
<!-- ###################################################################### -->
<chapter id="plugins"><title>Plugins</title>
<sect1 id="kwave_plugins"><title>Plugin Reference</title>
<index><title>Alphabetical Index</title>
&no-i18n-tag;
<!-- @PLUGIN_INDEX_START@ -->
<indexdiv><title>a</title>
<indexentry><primaryie><link linkend="plugin_sect_about" endterm="plugin_title_about"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="plugin_sect_amplifyfree" endterm="plugin_title_amplifyfree"/></primaryie></indexentry>
</indexdiv>
<indexdiv><title>b</title>
<indexentry><primaryie><link linkend="plugin_sect_band_pass" endterm="plugin_title_band_pass"/></primaryie></indexentry>
</indexdiv>
<indexdiv><title>c</title>
<indexentry><primaryie><link linkend="plugin_sect_codec_ascii" endterm="plugin_title_codec_ascii"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="plugin_sect_codec_audiofile" endterm="plugin_title_codec_audiofile"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="plugin_sect_codec_flac" endterm="plugin_title_codec_flac"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="plugin_sect_codec_mp3" endterm="plugin_title_codec_mp3"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="plugin_sect_codec_ogg" endterm="plugin_title_codec_ogg"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="plugin_sect_codec_wav" endterm="plugin_title_codec_wav"/></primaryie></indexentry>
</indexdiv>
<indexdiv><title>d</title>
<indexentry><primaryie><link linkend="plugin_sect_debug" endterm="plugin_title_debug"/></primaryie></indexentry>
</indexdiv>
<indexdiv><title>e</title>
<indexentry><primaryie><link linkend="plugin_sect_export_k3b" endterm="plugin_title_export_k3b"/></primaryie></indexentry>
</indexdiv>
<indexdiv><title>f</title>
<indexentry><primaryie><link linkend="plugin_sect_fileinfo" endterm="plugin_title_fileinfo"/></primaryie></indexentry>
</indexdiv>
<indexdiv><title>g</title>
<indexentry><primaryie><link linkend="plugin_sect_goto" endterm="plugin_title_goto"/></primaryie></indexentry>
</indexdiv>
<indexdiv><title>i</title>
<indexentry><primaryie><link linkend="plugin_sect_insert_at" endterm="plugin_title_insert_at"/></primaryie></indexentry>
</indexdiv>
<indexdiv><title>l</title>
<indexentry><primaryie><link linkend="plugin_sect_lowpass" endterm="plugin_title_lowpass"/></primaryie></indexentry>
</indexdiv>
<indexdiv><title>m</title>
<indexentry><primaryie><link linkend="plugin_sect_memory" endterm="plugin_title_memory"/></primaryie></indexentry>
</indexdiv>
<indexdiv><title>n</title>
<indexentry><primaryie><link linkend="plugin_sect_newsignal" endterm="plugin_title_newsignal"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="plugin_sect_noise" endterm="plugin_title_noise"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="plugin_sect_normalize" endterm="plugin_title_normalize"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="plugin_sect_notch_filter" endterm="plugin_title_notch_filter"/></primaryie></indexentry>
</indexdiv>
<indexdiv><title>p</title>
<indexentry><primaryie><link linkend="plugin_sect_pitch_shift" endterm="plugin_title_pitch_shift"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="plugin_sect_playback" endterm="plugin_title_playback"/></primaryie></indexentry>
</indexdiv>
<indexdiv><title>r</title>
<indexentry><primaryie><link linkend="plugin_sect_record" endterm="plugin_title_record"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="plugin_sect_reverse" endterm="plugin_title_reverse"/></primaryie></indexentry>
</indexdiv>
<indexdiv><title>s</title>
<indexentry><primaryie><link linkend="plugin_sect_samplerate" endterm="plugin_title_samplerate"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="plugin_sect_saveblocks" endterm="plugin_title_saveblocks"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="plugin_sect_selectrange" endterm="plugin_title_selectrange"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="plugin_sect_sonagram" endterm="plugin_title_sonagram"/></primaryie></indexentry>
<indexentry><primaryie><link linkend="plugin_sect_stringenter" endterm="plugin_title_stringenter"/></primaryie></indexentry>
</indexdiv>
<indexdiv><title>v</title>
<indexentry><primaryie><link linkend="plugin_sect_volume" endterm="plugin_title_volume"/></primaryie></indexentry>
</indexdiv>
<indexdiv><title>z</title>
<indexentry><primaryie><link linkend="plugin_sect_zero" endterm="plugin_title_zero"/></primaryie></indexentry>
</indexdiv>
<!-- @PLUGIN_INDEX_END@ -->
</index>
<para><literal> </literal></para>
</sect1>
<!-- @PLUGIN@ about -->
<sect1 id="plugin_sect_about"><title id="plugin_title_about">&no-i18n-plugin_about; (About Kwave)</title>
<screenshot>
<screeninfo>Screenshot</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kwave-plugin-about.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Screenshot of the About Kwave Plugin</phrase>
</textobject>
</mediaobject>
</screenshot>
<variablelist>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_internal_name;</emphasis></term>
<listitem><para><literal>&no-i18n-plugin_about;</literal></para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_type;</emphasis></term>
<listitem><para>gui</para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_description;</emphasis></term>
<listitem>
<para>
Shows a window with multiple tabs, including the following information:
<itemizedlist>
<listitem><para>general information about the program</para></listitem>
<listitem><para>authors, contributors and copyright holders</para></listitem>
<listitem><para>all found plugins including their versions and authors</para></listitem>
<listitem><para>information about the translation team</para></listitem>
<listitem><para>copyright and licensing information</para></listitem>
</itemizedlist>
</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<!-- @PLUGIN@ amplifyfree -->
<sect1 id="plugin_sect_amplifyfree"><title id="plugin_title_amplifyfree">&no-i18n-plugin_amplifyfree; (Amplify Free)</title>
<screenshot>
<screeninfo>Screenshot</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kwave-plugin-amplifyfree.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Screenshot of the Amplify Free Plugin</phrase>
</textobject>
</mediaobject>
</screenshot>
<variablelist>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_internal_name;</emphasis></term>
<listitem><para><literal>amplifyfree</literal></para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_type;</emphasis></term>
<listitem><para>effect</para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_description;</emphasis></term>
<listitem>
<para>
Amplifies the current selection with a curve that
consists of a set of coordinates and an interpolation
method. The coordinates on the time axis as well as on
the amplitude axis must be normed between 0.0
and 1.0.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">Parameters</emphasis></term>
<listitem>
<variablelist>
<varlistentry>
<term>
<replaceable>operation</replaceable>
</term>
<listitem>
<para>
Internal name, for undo/redo handling. Possible values are:
</para>
<informaltable frame='all'>
<tgroup cols='2'>
<thead>
<row>
<entry align='left'>keyword</entry>
<entry align='left'>description</entry>
</row>
</thead>
<tbody>
<row>
<entry>&no-i18n-tag;<command>fade in</command></entry>
<entry>fade in, curve from 0.0/0.0 to 1.0/1.0</entry>
</row>
<row>
<entry>&no-i18n-tag;<command>fade out</command></entry>
<entry>fade out, curve from 0.0/1.0 to 1.0/0.0</entry>
</row>
<row>
<entry>&no-i18n-tag;<command>fade intro</command></entry>
<entry>fade intro, one second pause, then fade in</entry>
</row>
<row>
<entry>&no-i18n-tag;<command>fade outro</command></entry>
<entry>fade outro, first fade out, then one second pause</entry>
</row>
<row>
<entry>&no-i18n-tag;<command>amplify free</command></entry>
<entry>user defined curve</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>interpolation</replaceable></term>
<listitem>
<para>
Interpolation type, possible values are:
<informaltable frame='all'>
<tgroup cols='2'>
<thead>
<row>
<entry align='left'>keyword</entry>
<entry align='left'>description</entry>
</row>
</thead>
<tbody>
<row>
<entry>&no-i18n-tag;<command>linear</command></entry>
<entry>Linear</entry>
</row>
<row>
<entry>&no-i18n-tag;<command>spline</command></entry>
<entry>Spline</entry>
</row>
<row>
<entry>&no-i18n-tag;<command>n-polynom</command></entry>
<entry>Polynom, nth Degree</entry>
</row>
<row>
<entry>&no-i18n-tag;<command>3-polynom</command></entry>
<entry>Polynom, 3rd Degree</entry>
</row>
<row>
<entry>&no-i18n-tag;<command>5-polynom</command></entry>
<entry>Polynom, 5th Degree</entry>
</row>
<row>
<entry>&no-i18n-tag;<command>7-polynom</command></entry>
<entry>Polynom, 7th Degree</entry>
</row>
<row>
<entry>&no-i18n-tag;<command>sample_hold</command></entry>
<entry>Sample and Hold</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>curve</replaceable></term>
<listitem>
<para>
A comma separated list of pairs of coordinates,
normed between 0.0 and 1.0, must be sorted by time
axis (ascending), should start at time 0.0 and end
with time 1.0.
</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<!-- @PLUGIN@ band_pass -->
<sect1 id="plugin_sect_band_pass"><title id="plugin_title_band_pass">&no-i18n-plugin_band_pass; (Band Pass Filter)</title>
<screenshot>
<screeninfo>Screenshot</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kwave-plugin-band_pass.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Screenshot of the Band Pass Filter Plugin</phrase>
</textobject>
</mediaobject>
</screenshot>
<variablelist>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_internal_name;</emphasis></term>
<listitem><para><literal>&no-i18n-plugin_band_pass;</literal></para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_type;</emphasis></term>
<listitem><para>effect</para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_description;</emphasis></term>
<listitem>
<para>
Applies a simple band pass filter to the current selection. A band pass
lets a certain range of frequencies around a <emphasis>center frequency</emphasis>
pass and filters out frequencies that are below or above the center frequency
by more than half of the <emphasis>bandwidth</emphasis> of the filter.
</para>
<para>
The filter has grade two and is implemented as described in the book
<citetitle>"An introduction to digital filter theory"</citetitle> by
<author>
<personname>
<firstname>Julius O.</firstname>
<surname>Smith</surname>
</personname>
</author>
and in Moore's book, where the normalized version from
Moore's book is used.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_parameters;</emphasis></term>
<listitem>
<variablelist>
<varlistentry>
<term><replaceable>frequency</replaceable></term>
<listitem>
<para>
Center frequency of the filter in Hz, must be below
half of the sample rate of the file.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>bandwidth</replaceable></term>
<listitem>
<para>
Bandwidth of the filter in Hz.
</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<!-- @PLUGIN@ codec_ascii -->
<sect1 id="plugin_sect_codec_ascii"><title id="plugin_title_codec_ascii">&no-i18n-plugin_codec_ascii; (ASCII Codec)</title>
<variablelist>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_internal_name;</emphasis></term>
<listitem><para><literal>&no-i18n-plugin_codec_ascii;</literal></para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_type;</emphasis></term>
<listitem><para>codec</para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_file_types;</emphasis></term>
<listitem>
<informaltable frame='none'><tgroup cols='2'><tbody>
<row>
<entry>&i18n-plugin-lbl_file_type_description;</entry>
<entry>ASCII encoded audio</entry>
</row>
<row>
<entry>&i18n-plugin-lbl_file_type_extensions;</entry>
<entry><filename>*.ascii</filename></entry>
</row>
<row>
<entry>&i18n-plugin-lbl_file_type_mime_types;</entry>
<entry><literal>audio/x-audio-ascii</literal></entry>
</row>
</tbody></tgroup></informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_meta_data;</emphasis></term>
<listitem>
<para>
(all known file info items,
see section <link linkend="file-info-list" endterm="file-info-list-title"/>)
</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<!-- @PLUGIN@ codec_audiofile -->
<sect1 id="plugin_sect_codec_audiofile"><title id="plugin_title_codec_audiofile">&no-i18n-plugin_codec_audiofile; (Audiofile Codec)</title>
<variablelist>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_internal_name;</emphasis></term>
<listitem><para><literal>&no-i18n-plugin_codec_audiofile;</literal></para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_type;</emphasis></term>
<listitem><para>codec [import only]</para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_file_types;</emphasis></term>
<listitem>
<informaltable frame='none'><tgroup cols='2'><tbody>
<row>
<entry>&i18n-plugin-lbl_file_type_description;</entry>
<entry>Amiga IFF/8SVX Sound File Format</entry>
</row>
<row>
<entry>&i18n-plugin-lbl_file_type_extensions;</entry>
<entry><filename>*.8svx</filename></entry>
<entry><filename>*.iff</filename></entry>
</row>
<row>
<entry>&i18n-plugin-lbl_file_type_mime_types;</entry>
<entry><literal>audio/x-8svx</literal></entry>
</row>
</tbody></tgroup></informaltable>
<informaltable frame='none'><tgroup cols='2'><tbody>
<row>
<entry>&i18n-plugin-lbl_file_type_description;</entry>
<entry>NeXT, Sun Audio</entry>
</row>
<row>
<entry>&i18n-plugin-lbl_file_type_extensions;</entry>
<entry>
<filename>*.au</filename>,
<filename>*.snd</filename>
</entry>
</row>
<row>
<entry>&i18n-plugin-lbl_file_type_mime_types;</entry>
<entry><literal>audio/basic</literal></entry>
</row>
</tbody></tgroup></informaltable>
<informaltable frame='none'><tgroup cols='2'><tbody>
<row>
<entry>&i18n-plugin-lbl_file_type_description;</entry>
<entry>Compressed Audio Interchange Format</entry>
</row>
<row>
<entry>&i18n-plugin-lbl_file_type_extensions;</entry>
<entry><filename>*.aifc</filename></entry>
</row>
<row>
<entry>&i18n-plugin-lbl_file_type_mime_types;</entry>
<entry><literal>audio/x-aifc</literal></entry>
</row>
</tbody></tgroup></informaltable>
<informaltable frame='none'><tgroup cols='2'><tbody>
<row>
<entry>&i18n-plugin-lbl_file_type_description;</entry>
<entry>Audio Interchange Format</entry>
</row>
<row>
<entry>&i18n-plugin-lbl_file_type_extensions;</entry>
<entry>
<filename>*.aif</filename>,
<filename>*.aiff</filename>
</entry>
</row>
<row>
<entry>&i18n-plugin-lbl_file_type_mime_types;</entry>
<entry><literal>audio/x-aiff</literal></entry>
</row>
</tbody></tgroup></informaltable>
<informaltable frame='none'><tgroup cols='2'><tbody>
<row>
<entry>&i18n-plugin-lbl_file_type_description;</entry>
<entry>Audio Visual Research File Format</entry>
</row>
<row>
<entry>&i18n-plugin-lbl_file_type_extensions;</entry>
<entry>
<filename>*.avr</filename>
</entry>
</row>
<row>
<entry>&i18n-plugin-lbl_file_type_mime_types;</entry>
<entry><literal>audio/x-avr</literal></entry>
</row>
</tbody></tgroup></informaltable>
<informaltable frame='none'><tgroup cols='2'><tbody>
<row>
<entry>&i18n-plugin-lbl_file_type_description;</entry>
<entry>Core Audio File Format</entry>
</row>
<row>
<entry>&i18n-plugin-lbl_file_type_extensions;</entry>
<entry><filename>*.caf</filename></entry>
</row>
<row>
<entry>&i18n-plugin-lbl_file_type_mime_types;</entry>
<entry><literal>audio/x-caf</literal></entry>
</row>
</tbody></tgroup></informaltable>
<informaltable frame='none'><tgroup cols='2'><tbody>
<row>
<entry>&i18n-plugin-lbl_file_type_description;</entry>
<entry>Berkeley, IRCAM, Carl Sound Format</entry>
</row>
<row>
<entry>&i18n-plugin-lbl_file_type_extensions;</entry>
<entry><filename>*.sf</filename></entry>
</row>
<row>
<entry>&i18n-plugin-lbl_file_type_mime_types;</entry>
<entry><literal>audio/x-ircam</literal></entry>
</row>
</tbody></tgroup></informaltable>
<informaltable frame='none'><tgroup cols='2'><tbody>
<row>
<entry>&i18n-plugin-lbl_file_type_description;</entry>
<entry>NIST SPHERE Audio File Format</entry>
</row>
<row>
<entry>&i18n-plugin-lbl_file_type_extensions;</entry>
<entry><filename>*.nist</filename></entry>
</row>
<row>
<entry>&i18n-plugin-lbl_file_type_mime_types;</entry>
<entry><literal>audio/x-nist</literal></entry>
</row>
</tbody></tgroup></informaltable>
<informaltable frame='none'><tgroup cols='2'><tbody>
<row>
<entry>&i18n-plugin-lbl_file_type_description;</entry>
<entry>Sample Vision Format</entry>
</row>
<row>
<entry>&i18n-plugin-lbl_file_type_extensions;</entry>
<entry><filename>*.smp</filename></entry>
</row>
<row>
<entry>&i18n-plugin-lbl_file_type_mime_types;</entry>
<entry><literal>audio/x-smp</literal></entry>
</row>
</tbody></tgroup></informaltable>
<informaltable frame='none'><tgroup cols='2'><tbody>
<row>
<entry>&i18n-plugin-lbl_file_type_description;</entry>
<entry>Creative Voice</entry>
</row>
<row>
<entry>&i18n-plugin-lbl_file_type_extensions;</entry>
<entry><filename>*.voc</filename></entry>
</row>
<row>
<entry>&i18n-plugin-lbl_file_type_mime_types;</entry>
<entry><literal>audio/x-voc</literal></entry>
</row>
</tbody></tgroup></informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_meta_data;</emphasis></term>
<listitem>
<para>
(none)
</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<!-- @PLUGIN@ codec_flac -->
<sect1 id="plugin_sect_codec_flac"><title id="plugin_title_codec_flac">&no-i18n-plugin_codec_flac; (FLAC Codec)</title>
<variablelist>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_internal_name;</emphasis></term>
<listitem><para><literal>&no-i18n-plugin_codec_flac;</literal></para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_type;</emphasis></term>
<listitem><para>codec</para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_file_types;</emphasis></term>
<listitem>
<informaltable frame='none'><tgroup cols='2'><tbody>
<row>
<entry>&i18n-plugin-lbl_file_type_description;</entry>
<entry>FLAC audio (Free Lossles Audio Codec)</entry>
</row>
<row>
<entry>&i18n-plugin-lbl_file_type_extensions;</entry>
<entry><filename>*.flac</filename></entry>
</row>
<row>
<entry>&i18n-plugin-lbl_file_type_mime_types;</entry>
<entry><literal>audio/x-flac</literal></entry>
</row>
</tbody></tgroup></informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_meta_data;</emphasis></term>
<listitem>
<para>
<link linkend="INF_CREATION_DATE">&i18n-INF_CREATION_DATE;</link>,
<link linkend="INF_NAME">&i18n-INF_NAME;</link>,
<link linkend="INF_VERSION">&i18n-INF_VERSION;</link>,
<link linkend="INF_ALBUM">&i18n-INF_ALBUM;</link>,
<link linkend="INF_TRACK">&i18n-INF_TRACK;</link>,
<link linkend="INF_AUTHOR">&i18n-INF_AUTHOR;</link>,
<link linkend="INF_PERFORMER">&i18n-INF_PERFORMER;</link>,
<link linkend="INF_COPYRIGHT">&i18n-INF_COPYRIGHT;</link>,
<link linkend="INF_LICENSE">&i18n-INF_LICENSE;</link>,
<link linkend="INF_ORGANIZATION">&i18n-INF_ORGANIZATION;</link>,
<link linkend="INF_SUBJECT">&i18n-INF_SUBJECT;</link>,
<link linkend="INF_GENRE">&i18n-INF_GENRE;</link>,
<link linkend="INF_SOURCE">&i18n-INF_SOURCE;</link>,
<link linkend="INF_CONTACT">&i18n-INF_CONTACT;</link>,
<link linkend="INF_ISRC">&i18n-INF_ISRC;</link>,
<link linkend="INF_SOFTWARE">&i18n-INF_SOFTWARE;</link>,
<link linkend="INF_ENGINEER">&i18n-INF_ENGINEER;</link>,
<link linkend="INF_VBR_QUALITY">&i18n-INF_VBR_QUALITY;</link>
</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<!-- @PLUGIN@ codec_mp3 -->
<sect1 id="plugin_sect_codec_mp3"><title id="plugin_title_codec_mp3">&no-i18n-plugin_codec_mp3; (MP3 Codec)</title>
<screenshot>
<screeninfo>Screenshot</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kwave-plugin-codec_mp3.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Screenshot of the MP3 Codec Setup Dialog</phrase>
</textobject>
</mediaobject>
</screenshot>
<variablelist>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_internal_name;</emphasis></term>
<listitem><para><literal>&no-i18n-plugin_codec_mp3;</literal></para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_type;</emphasis></term>
<listitem><para>codec</para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_file_types;</emphasis></term>
<listitem>
<informaltable frame='none'><tgroup cols='2'><tbody>
<row>
<entry>&i18n-plugin-lbl_file_type_description;</entry>
<entry>MPEG layer III audio</entry>
</row>
<row>
<entry>&i18n-plugin-lbl_file_type_extensions;</entry>
<entry><filename>*.mp3</filename></entry>
</row>
<row>
<entry>&i18n-plugin-lbl_file_type_mime_types;</entry>
<entry>
<literal>audio/x-mp3</literal>,
<literal>audio/mpeg</literal>s
</entry>
</row>
</tbody></tgroup></informaltable>
<informaltable frame='none'><tgroup cols='2'><tbody>
<row>
<entry>&i18n-plugin-lbl_file_type_description;</entry>
<entry>MPEG layer II audio</entry>
</row>
<row>
<entry>&i18n-plugin-lbl_file_type_extensions;</entry>
<entry><filename>*.mp2</filename></entry>
</row>
<row>
<entry>&i18n-plugin-lbl_file_type_mime_types;</entry>
<entry>
<literal>audio/x-mp2</literal>,
<literal>audio/mpeg</literal>
</entry>
</row>
</tbody></tgroup></informaltable>
<informaltable frame='none'><tgroup cols='2'><tbody>
<row>
<entry>&i18n-plugin-lbl_file_type_description;</entry>
<entry>MPEG layer I audio</entry>
</row>
<row>
<entry>&i18n-plugin-lbl_file_type_extensions;</entry>
<entry>
<filename>*.mp1</filename>,
<filename>*.mpg</filename>,
<filename>*.mpga</filename>
</entry>
</row>
<row>
<entry>&i18n-plugin-lbl_file_type_mime_types;</entry>
<entry>
<literal>audio/x-mpga</literal>,
<literal>audio/mpeg</literal>
</entry>
</row>
</tbody></tgroup></informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_meta_data;</emphasis></term>
<listitem>
<para>
<link linkend="INF_ALBUM">&i18n-INF_ALBUM;</link>,
<link linkend="INF_ANNOTATION">&i18n-INF_ANNOTATION;</link>,
<link linkend="INF_AUTHOR">&i18n-INF_AUTHOR;</link>,
<link linkend="INF_CD">&i18n-INF_CD;</link>,
<link linkend="INF_CDS">&i18n-INF_CDS;</link>,
<link linkend="INF_COMMENTS">&i18n-INF_COMMENTS;</link>,
<link linkend="INF_COMMISSIONED">&i18n-INF_COMMISSIONED;</link>,
<link linkend="INF_CONTACT">&i18n-INF_CONTACT;</link>,
<link linkend="INF_COPYRIGHT">&i18n-INF_COPYRIGHT;</link>,
<link linkend="INF_CREATION_DATE">&i18n-INF_CREATION_DATE;</link>,
<link linkend="INF_GENRE">&i18n-INF_GENRE;</link>,
<link linkend="INF_ISRC">&i18n-INF_ISRC;</link>,
<link linkend="INF_LENGTH">&i18n-INF_LENGTH;</link>,
<link linkend="INF_LICENSE">&i18n-INF_LICENSE;</link>,
<link linkend="INF_MEDIUM">&i18n-INF_MEDIUM;</link>,
<link linkend="INF_NAME">&i18n-INF_NAME;</link>,
<link linkend="INF_ORGANIZATION">&i18n-INF_ORGANIZATION;</link>,
<link linkend="INF_PERFORMER">&i18n-INF_PERFORMER;</link>,
<link linkend="INF_SOFTWARE">&i18n-INF_SOFTWARE;</link>,
<link linkend="INF_TECHNICAN">&i18n-INF_TECHNICAN;</link>,
<link linkend="INF_TRACK">&i18n-INF_TRACK;</link>,
<link linkend="INF_TRACKS">&i18n-INF_TRACKS;</link>,
<link linkend="INF_VERSION">&i18n-INF_VERSION;</link>
</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<!-- @PLUGIN@ codec_ogg -->
<sect1 id="plugin_sect_codec_ogg"><title id="plugin_title_codec_ogg">&no-i18n-plugin_codec_ogg; (Ogg Codec)</title>
<variablelist>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_internal_name;</emphasis></term>
<listitem><para><literal>&no-i18n-plugin_codec_ogg;</literal></para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_type;</emphasis></term>
<listitem><para>codec</para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_file_types;</emphasis></term>
<listitem>
<informaltable frame='none'><tgroup cols='2'><tbody>
<row>
<entry>&i18n-plugin-lbl_file_type_description;</entry>
<entry>Ogg Opus audio</entry>
</row>
<row>
<entry>&i18n-plugin-lbl_file_type_extensions;</entry>
<entry><filename>*.opus</filename></entry>
</row>
<row>
<entry>&i18n-plugin-lbl_file_type_mime_types;</entry>
<entry>
<literal>audio/ogg</literal>,
<literal>application/ogg</literal>,
<literal>audio/opus</literal>
</entry>
</row>
</tbody></tgroup></informaltable>
<informaltable frame='none'><tgroup cols='2'><tbody>
<row>
<entry>&i18n-plugin-lbl_file_type_description;</entry>
<entry>Ogg Vorbis audio</entry>
</row>
<row>
<entry>&i18n-plugin-lbl_file_type_extensions;</entry>
<entry><filename>*.ogg</filename></entry>
</row>
<row>
<entry>&i18n-plugin-lbl_file_type_mime_types;</entry>
<entry>
<literal>audio/ogg</literal>,
<literal>audio/x-ogg</literal>,
<literal>application/x-ogg</literal>,
<literal>audio/x-vorbis+ogg</literal>
</entry>
</row>
</tbody></tgroup></informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_meta_data;</emphasis></term>
<listitem>
<para>
<link linkend="INF_ALBUM">&i18n-INF_ALBUM;</link>,
<link linkend="INF_AUTHOR">&i18n-INF_AUTHOR;</link>,
<link linkend="INF_CONTACT">&i18n-INF_CONTACT;</link>,
<link linkend="INF_COPYRIGHT">&i18n-INF_COPYRIGHT;</link>,
<link linkend="INF_CREATION_DATE">&i18n-INF_CREATION_DATE;</link>,
<link linkend="INF_ENGINEER">&i18n-INF_ENGINEER;</link>,
<link linkend="INF_GENRE">&i18n-INF_GENRE;</link>,
<link linkend="INF_ISRC">&i18n-INF_ISRC;</link>,
<link linkend="INF_LICENSE">&i18n-INF_LICENSE;</link>,
<link linkend="INF_NAME">&i18n-INF_NAME;</link>,
<link linkend="INF_ORGANIZATION">&i18n-INF_ORGANIZATION;</link>,
<link linkend="INF_PERFORMER">&i18n-INF_PERFORMER;</link>,
<link linkend="INF_SOFTWARE">&i18n-INF_SOFTWARE;</link>,
<link linkend="INF_SOURCE">&i18n-INF_SOURCE;</link>,
<link linkend="INF_SUBJECT">&i18n-INF_SUBJECT;</link>,
<link linkend="INF_TRACK">&i18n-INF_TRACK;</link>,
<link linkend="INF_VBR_QUALITY">&i18n-INF_VBR_QUALITY;</link>,
<link linkend="INF_VERSION">&i18n-INF_VERSION;</link>,
</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<!-- @PLUGIN@ codec_wav -->
<sect1 id="plugin_sect_codec_wav"><title id="plugin_title_codec_wav">&no-i18n-plugin_codec_wav; (WAV Codec)</title>
<variablelist>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_internal_name;</emphasis></term>
<listitem><para><literal>&no-i18n-plugin_codec_wav;</literal></para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_type;</emphasis></term>
<listitem><para>codec</para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_file_types;</emphasis></term>
<listitem>
<informaltable frame='none'><tgroup cols='2'><tbody>
<row>
<entry>&i18n-plugin-lbl_file_type_description;</entry>
<entry>WAV audio</entry>
</row>
<row>
<entry>&i18n-plugin-lbl_file_type_extensions;</entry>
<entry><filename>*.wav</filename></entry>
</row>
<row>
<entry>&i18n-plugin-lbl_file_type_mime_types;</entry>
<entry>
<literal>audio/x-wav</literal>,
<literal>audio/vnd.wave</literal>,
<literal>audio/wav</literal>
</entry>
</row>
</tbody></tgroup></informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_meta_data;</emphasis></term>
<listitem>
<para>
<link linkend="INF_ALBUM">&i18n-INF_ALBUM;</link>,
<link linkend="INF_ANNOTATION">&i18n-INF_ANNOTATION;</link>,
<link linkend="INF_ARCHIVAL">&i18n-INF_ARCHIVAL;</link>,
<link linkend="INF_AUTHOR">&i18n-INF_AUTHOR;</link>,
<link linkend="INF_CD">&i18n-INF_CD;</link>,
<link linkend="INF_COMMENTS">&i18n-INF_COMMENTS;</link>,
<link linkend="INF_COMMISSIONED">&i18n-INF_COMMISSIONED;</link>,
<link linkend="INF_CONTACT">&i18n-INF_CONTACT;</link>,
<link linkend="INF_COPYRIGHT">&i18n-INF_COPYRIGHT;</link>,
<link linkend="INF_CREATION_DATE">&i18n-INF_CREATION_DATE;</link>,
<link linkend="INF_ENGINEER">&i18n-INF_ENGINEER;</link>,
<link linkend="INF_GENRE">&i18n-INF_GENRE;</link>,
<link linkend="INF_ISRC">&i18n-INF_ISRC;</link>,
<link linkend="INF_KEYWORDS">&i18n-INF_KEYWORDS;</link>,
<link linkend="INF_LICENSE">&i18n-INF_LICENSE;</link>,
<link linkend="INF_MEDIUM">&i18n-INF_MEDIUM;</link>,
<link linkend="INF_NAME">&i18n-INF_NAME;</link>,
<link linkend="INF_ORGANIZATION">&i18n-INF_ORGANIZATION;</link>,
<link linkend="INF_PERFORMER">&i18n-INF_PERFORMER;</link>,
<link linkend="INF_PRODUCT">&i18n-INF_PRODUCT;</link>,
<link linkend="INF_SOFTWARE">&i18n-INF_SOFTWARE;</link>,
<link linkend="INF_SOURCE">&i18n-INF_SOURCE;</link>,
<link linkend="INF_SOURCE_FORM">&i18n-INF_SOURCE_FORM;</link>,
<link linkend="INF_SUBJECT">&i18n-INF_SUBJECT;</link>,
<link linkend="INF_TECHNICAN">&i18n-INF_TECHNICAN;</link>,
<link linkend="INF_TRACK">&i18n-INF_TRACK;</link>,
<link linkend="INF_VERSION">&i18n-INF_VERSION;</link>,
</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<!-- @PLUGIN@ debug -->
<sect1 id="plugin_sect_debug"><title id="plugin_title_debug">&no-i18n-plugin_debug; (Debug Functions)</title>
<variablelist>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_internal_name;</emphasis></term>
<listitem><para><literal>&no-i18n-plugin_debug;</literal></para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_type;</emphasis></term>
<listitem><para>function</para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_description;</emphasis></term>
<listitem>
<para>
Provides various internal commands useful for debugging and
scripting &kwave;. These functions are only available through
the main menu if &kwave; has been compiled in debug mode
(built with the option CMAKE_WITH_DEBUG).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_commands;</emphasis></term>
<listitem>
<para>
<link linkend="cmd_sect_window_click" endterm="cmd_title_window_click"/>,
<link linkend="cmd_sect_window_close" endterm="cmd_title_window_close"/>
<link linkend="cmd_sect_window_mousemove" endterm="cmd_title_window_mousemove"/>,
<link linkend="cmd_sect_window_resize" endterm="cmd_title_window_resize"/>,
<link linkend="cmd_sect_window_screenshot" endterm="cmd_title_window_screenshot"/>,
<link linkend="cmd_sect_window_sendkey" endterm="cmd_title_window_sendkey"/>
</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<!-- @PLUGIN@ export_k3b -->
<sect1 id="plugin_sect_export_k3b"><title id="plugin_title_export_k3b">&no-i18n-plugin_export_k3b; (Export to K3b Project)</title>
<screenshot>
<screeninfo>Screenshot</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kwave-plugin-export_k3b.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Screenshot of the K3b Export Plugin</phrase>
</textobject>
</mediaobject>
</screenshot>
<variablelist>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_internal_name;</emphasis></term>
<listitem><para><literal>&no-i18n-plugin_export_k3b;</literal></para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_type;</emphasis></term>
<listitem><para>function</para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_description;</emphasis></term>
<listitem>
<para>
Saves all sections between markers into a separate file and creates
a K3b project file. After having successfully written all files it
is possible to start <ulink url="&url_k3b;">K3b</ulink> and
burn the result to an audio CD.
This is useful for splitting a file with a recording that consists
of several parts, which are separated by labels, and then burn it
to an audio CD with multiple tracks, including CD text meta data
which is extracted from the descriptions of the labels.
</para>
<para>
(This plugin is internally using the
<link linkend="plugin_sect_saveblocks" endterm="plugin_title_saveblocks"/>
plugin.)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_parameters;</emphasis></term>
<listitem>
<variablelist>
<varlistentry>
<term><replaceable>filename</replaceable></term>
<listitem>
<para>
The name of the K3b project file, will be used as
base name for the exported file names.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>pattern</replaceable></term>
<listitem>
<para>
A pattern that will be used for detecting
title and artist from the label at the start
of a section.
It supports the following wildcards which
will be replaced by the corresponding content
when creating the CD text meta data:
</para>
<informaltable frame='all'>
<tgroup cols='2'>
<thead>
<row>
<entry align='left'>wildcard</entry>
<entry align='left'>description</entry>
</row>
</thead>
<tbody>
<row>
<entry>&no-i18n-tag;<command>[%artist]</command></entry>
<entry>
Will be replaced with the artist that performed
the corresponding block or alternatively the author.
</entry>
</row>
<row>
<entry>&no-i18n-tag;<command>[%title]</command></entry>
<entry>
Will be replaced with the title of the block, which is taken
from the descriptive text of the label at the
<emphasis>start</emphasis> of the block.
If that text is empty it will fall back to the title
of the file (see file information item
"<link linkend="INF_NAME">Name</link>").
If this also does not exist, it will fall back to the
base file name as described above.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<para>
Example: <quote><command><literal>[%title] ([%artist])</literal></command></quote>
will detect author <quote><command><literal>Beethoven</literal></command></quote> and title
<quote><command><literal>Symphony No. 5</literal></command></quote> from the string
<quote><command><literal>Symphony No. 5 (Beethoven)</literal></command></quote>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>selection only</replaceable></term>
<listitem>
<para>
<informaltable frame='all'>
<tgroup cols='2'>
<thead>
<row>
<entry align='left'>value</entry>
<entry align='left'>description</entry>
</row>
</thead>
<tbody>
<row>
<entry>&no-i18n-tag;<command>0</command></entry>
<entry>
Save all sections of the whole file.
</entry>
</row>
<row>
<entry>&no-i18n-tag;<command>1</command></entry>
<entry>
Save only the sections that are within the
current selection. If nothing is selected,
the whole file will be saved.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>export location</replaceable></term>
<listitem>
<para>
Determines where the blocks should be saved.
<informaltable frame='all'>
<tgroup cols='2'>
<thead>
<row>
<entry align='left'>value</entry>
<entry align='left'>description</entry>
</row>
</thead>
<tbody>
<row>
<entry>&no-i18n-tag;<command>0</command></entry>
<entry>
Save to the same directory as the
K3b project file.
</entry>
</row>
<row>
<entry>&no-i18n-tag;<command>1</command></entry>
<entry>
Save into a sub directory of the directory
of the K3b project file, using the K3b
project file name as base and appending
<quote><command><literal>.dir</literal></command></quote>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>overwrite policy</replaceable></term>
<listitem>
<para>
Determines where the numbering should start.
<informaltable frame='all'>
<tgroup cols='2'>
<thead>
<row>
<entry align='left'>value</entry>
<entry align='left'>description</entry>
</row>
</thead>
<tbody>
<row>
<entry>&no-i18n-tag;<command>0</command></entry>
<entry>
Always start with index 1, with the risk
of overwriting existing files.
</entry>
</row>
<row>
<entry>&no-i18n-tag;<command>1</command></entry>
<entry>
Continue after the index of the highest
index that already exists, this avoids
overwriting existing files.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<!-- @PLUGIN@ fileinfo -->
<sect1 id="plugin_sect_fileinfo"><title id="plugin_title_fileinfo">&no-i18n-plugin_fileinfo; (File Info)</title>
<screenshot>
<screeninfo>Screenshot</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kwave-plugin-fileinfo.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Screenshot of the File Info Plugin</phrase>
</textobject>
</mediaobject>
</screenshot>
<variablelist>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_internal_name;</emphasis></term>
<listitem><para><literal>&no-i18n-plugin_fileinfo;</literal></para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_type;</emphasis></term>
<listitem><para>gui</para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_description;</emphasis></term>
<listitem>
<para>
Provides a dialog window to view and change parameters and meta
data of the currently opened file.
See section <link linkend="fileinfo" endterm="title_fileinfo"/>
in this manual.
</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<!-- @PLUGIN@ goto -->
<sect1 id="plugin_sect_goto"><title id="plugin_title_goto">&no-i18n-plugin_goto; (Goto Position)</title>
<screenshot>
<screeninfo>Screenshot</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kwave-plugin-goto.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Screenshot of the Goto Position Plugin</phrase>
</textobject>
</mediaobject>
</screenshot>
<variablelist>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_internal_name;</emphasis></term>
<listitem><para><literal>&no-i18n-plugin_goto;</literal></para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_type;</emphasis></term>
<listitem><para>function</para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_description;</emphasis></term>
<listitem>
<para>
Shows a dialog with the possibility to set the current position
of the selection to a new value, either by a time in milliseconds,
by a position in samples or by percentage of the length of the
current file.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_commands;</emphasis></term>
<listitem>
<para>
<link linkend="cmd_sect_goto" endterm="cmd_title_goto"/>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_parameters;</emphasis></term>
<listitem>
<variablelist>
<varlistentry>
<term><replaceable>mode</replaceable></term>
<listitem>
<informaltable frame='all'>
<tgroup cols='2'>
<thead>
<row>
<entry align='left'>value</entry>
<entry align='left'>description</entry>
</row>
</thead>
<tbody>
<row>
<entry>&no-i18n-tag;<command>0</command></entry>
<entry>position is given in milliseconds</entry>
</row>
<row>
<entry>&no-i18n-tag;<command>1</command></entry>
<entry>position is given in samples</entry>
</row>
<row>
<entry>&no-i18n-tag;<command>2</command></entry>
<entry>position is given in percentage of the file length</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>position</replaceable></term>
<listitem>
<para>
position to go to, in milliseconds, samples or
percentage of the length of the file, depending
on the parameter <parameter>mode</parameter>.
</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<!-- @PLUGIN@ insert_at -->
<sect1 id="plugin_sect_insert_at"><title id="plugin_title_insert_at">&no-i18n-plugin_insert_at; (Insert At)</title>
<screenshot>
<screeninfo>Screenshot</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kwave-plugin-insert_at.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Screenshot of the Insert At Plugin</phrase>
</textobject>
</mediaobject>
</screenshot>
<variablelist>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_internal_name;</emphasis></term>
<listitem><para><literal>&no-i18n-plugin_insert_at;</literal></para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_type;</emphasis></term>
<listitem><para>function</para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_description;</emphasis></term>
<listitem>
<para>
Similar to the
<link linkend="plugin_sect_goto" endterm="plugin_title_goto"/>
plugin, but shows a dialog with the possibility to insert the
current content of the clipboard at a given position, either
by a time in milliseconds, by a position in samples or by
percentage of the length of the current file.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_commands;</emphasis></term>
<listitem>
<para>
<link linkend="cmd_sect_insert_at" endterm="cmd_title_insert_at"/>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_parameters;</emphasis></term>
<listitem>
<variablelist>
<varlistentry>
<term><replaceable>mode</replaceable></term>
<listitem>
<informaltable frame='all'>
<tgroup cols='2'>
<thead>
<row>
<entry align='left'>value</entry>
<entry align='left'>description</entry>
</row>
</thead>
<tbody>
<row>
<entry>&no-i18n-tag;<command>0</command></entry>
<entry>position is given in milliseconds</entry>
</row>
<row>
<entry>&no-i18n-tag;<command>1</command></entry>
<entry>position is given in samples</entry>
</row>
<row>
<entry>&no-i18n-tag;<command>2</command></entry>
<entry>position is given in percentage of the file length</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>position</replaceable></term>
<listitem>
<para>
position where to insert the clipboard data,
in milliseconds, samples or percentage of the
length of the file, depending on the
parameter <parameter>mode</parameter>.
</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<!-- @PLUGIN@ lowpass -->
<sect1 id="plugin_sect_lowpass"><title id="plugin_title_lowpass">&no-i18n-plugin_lowpass; (Low Pass Filter)</title>
<screenshot>
<screeninfo>Screenshot</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kwave-plugin-lowpass.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Screenshot of the Low Pass Filter Plugin</phrase>
</textobject>
</mediaobject>
</screenshot>
<variablelist>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_internal_name;</emphasis></term>
<listitem><para><literal>&no-i18n-plugin_lowpass;</literal></para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_type;</emphasis></term>
<listitem><para>effect</para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_description;</emphasis></term>
<listitem>
<para>
Applies a simple low pass filter to the current selection.
A low pass filter lets frequencies below a <emphasis>border frequency</emphasis>
pass and filters out frequencies that are above the border frequency.
</para>
<para>
The filter has grade two and is implemented as described in the book
<citetitle>"The manifold joys of conformal mapping,
applications to digital filtering in the studio</citetitle> by
<author>
<personname>
<firstname>James A.</firstname>
<surname>Moorer</surname>
</personname>
</author>
(JAES, Vol. 31, No. 11, 1983 November).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_parameters;</emphasis></term>
<listitem>
<variablelist>
<varlistentry>
<term><replaceable>frequency</replaceable></term>
<listitem>
<para>
The border frequency of the low pass filter
in Hz.
</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<!-- @PLUGIN@ memory -->
<sect1 id="plugin_sect_memory"><title id="plugin_title_memory">&no-i18n-plugin_memory; (Memory Settings)</title>
<screenshot>
<screeninfo>Screenshot</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kwave-plugin-memory.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Screenshot of the Memory Setup Plugin</phrase>
</textobject>
</mediaobject>
</screenshot>
<variablelist>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_internal_name;</emphasis></term>
<listitem><para><literal>&no-i18n-plugin_memory;</literal></para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_type;</emphasis></term>
<listitem><para>gui</para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_description;</emphasis></term>
<listitem>
<para>
Provides a dialog to set up the memory usage of &kwave;.
Please refer to the section about the
<link linkend="memory-setup" endterm="sect_title_memory-setup"/>
in this manual for more information.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_parameters;</emphasis></term>
<listitem>
<variablelist>
<varlistentry>
<term><replaceable>physical limited</replaceable></term>
<listitem>
<para>
If zero, the use of physical memory will not
limited, otherwise the use of physical memory
will be limited.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>physical limit</replaceable></term>
<listitem>
<para>
Limitation of the physical memory in units of
whole MB. Only has an effect when the parameter
<replaceable>physical limited</replaceable>
has been set to a non zero value.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>virtual enabled</replaceable></term>
<listitem>
<para>
If zero, the use of virtual memory will be
disabled, otherwise the use of virtual memory
will be enabled.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>virtual limited</replaceable></term>
<listitem>
<para>
If zero, the use of virtual memory will be not
limited, otherwise the use of virtual memory
will be limited. Only has an effect if the
parameter
<replaceable>virtual enabled</replaceable>
has been set to a non zero value.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>virtual limit</replaceable></term>
<listitem>
<para>
Limitation of the virtual memory in units of
whole MB. Only has an effect if the parameters
<replaceable>virtual enabled</replaceable>
and <replaceable>virtual limited</replaceable>
have both been set to a non zero value.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>virtual directory</replaceable></term>
<listitem>
<para>
Directory to use for storing swap files that
will be used for providing virtual memory.
Only has an effect if the parameter
<replaceable>virtual enabled</replaceable>
has been set to a non zero value.
</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<!-- @PLUGIN@ newsignal -->
<sect1 id="plugin_sect_newsignal"><title id="plugin_title_newsignal">&no-i18n-plugin_newsignal; (New Signal)</title>
<screenshot>
<screeninfo>Screenshot</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kwave-plugin-newsignal.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Screenshot of the New Signal Plugin</phrase>
</textobject>
</mediaobject>
</screenshot>
<variablelist>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_internal_name;</emphasis></term>
<listitem><para><literal>&no-i18n-plugin_newsignal;</literal></para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_type;</emphasis></term>
<listitem><para>function</para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_description;</emphasis></term>
<listitem>
<para>
Provides a dialog to create a new file.
Please refer to the section
<link linkend="newsignal" endterm="sect_title_newsignal"/>
in this manual for more information.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_commands;</emphasis></term>
<listitem>
<para>
<link linkend="cmd_sect_newsignal" endterm="cmd_title_newsignal"/>,
</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<!-- @PLUGIN@ noise -->
<sect1 id="plugin_sect_noise"><title id="plugin_title_noise">&no-i18n-plugin_noise; (Noise Generator)</title>
<screenshot>
<screeninfo>Screenshot</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kwave-plugin-noise.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Screenshot of the Noise Generator Plugin</phrase>
</textobject>
</mediaobject>
</screenshot>
<variablelist>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_internal_name;</emphasis></term>
<listitem><para><literal>&no-i18n-plugin_noise;</literal></para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_type;</emphasis></term>
<listitem><para>effect</para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_description;</emphasis></term>
<listitem>
<para>
Adds some amount of white noise to the current selection. The
amount of noise can be selected between zero (no noise, original
remains unchanged) and one (original will be replaced by
100% noise).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_parameters;</emphasis></term>
<listitem>
<variablelist>
<varlistentry>
<term><replaceable>level</replaceable></term>
<listitem>
<para>
Noise level, always has to be a floating point
number above zero and below or equal to one.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>mode</replaceable></term>
<listitem>
<informaltable frame='all'>
<tgroup cols='2'>
<thead>
<row>
<entry align='left'>value</entry>
<entry align='left'>description</entry>
</row>
</thead>
<tbody>
<row>
<entry>&no-i18n-tag;<command>0</command></entry>
<entry>
Enter the noise value as percentage
of the amplitude, from 0 to 100.
</entry>
</row>
<row>
<entry>&no-i18n-tag;<command>1</command></entry>
<entry>
Enter the noise in decibel, from
-21 dB to 0 dB.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<!-- @PLUGIN@ normalize -->
<sect1 id="plugin_sect_normalize"><title id="plugin_title_normalize">&no-i18n-plugin_normalize; (Normalizer)</title>
<variablelist>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_internal_name;</emphasis></term>
<listitem><para><literal>&no-i18n-plugin_normalize;</literal></para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_type;</emphasis></term>
<listitem><para>effect</para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_description;</emphasis></term>
<listitem>
<para>
Normalizes the volume level of the current selection. Use this
if the volume of your signal is too low or too high.
</para>
<para>
The algorithm is taken from the <citetitle>normalize</citetitle>
project, and was originally written by
<link linkend="author_Chris_Vaill">
<author>
<personname>
<firstname>Chris</firstname>
<surname>Vaill</surname>
</personname>
</author>
</link>.
</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<!-- @PLUGIN@ notch_filter -->
<sect1 id="plugin_sect_notch_filter"><title id="plugin_title_notch_filter">&no-i18n-plugin_notch_filter; (Notch Filter)</title>
<screenshot>
<screeninfo>Screenshot</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kwave-plugin-notch_filter.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Screenshot of the Notch Filter Plugin</phrase>
</textobject>
</mediaobject>
</screenshot>
<variablelist>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_internal_name;</emphasis></term>
<listitem><para><literal>&no-i18n-plugin_notch_filter;</literal></para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_type;</emphasis></term>
<listitem><para>effect</para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_description;</emphasis></term>
<listitem>
<para>
Applies a notch filter to the current selection. A notch filter
removes a small range of frequencies around a
<emphasis>center frequency</emphasis> and lets all other
frequencies below and above the center frequency
by more than half of the <emphasis>bandwidth</emphasis> pass.
</para>
<para>
Use this to filter out single distortion frequencies.
</para>
<para>
The filter has grade two and is based on the implementation of
<link linkend="author_Juhana_Sadeharju">
<author>
<personname>
<firstname>Juhana</firstname>
<surname>Sadeharju</surname>
</personname>
</author>
</link>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_parameters;</emphasis></term>
<listitem>
<variablelist>
<varlistentry>
<term><replaceable>frequency</replaceable></term>
<listitem>
<para>
Center frequency of the filter in Hz, must be below
half of the sample rate of the file.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>bandwidth</replaceable></term>
<listitem>
<para>
Bandwidth of the filter in Hz.
</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<!-- @PLUGIN@ pitch_shift -->
<sect1 id="plugin_sect_pitch_shift"><title id="plugin_title_pitch_shift">&no-i18n-plugin_pitch_shift; (Pitch Shift)</title>
<screenshot>
<screeninfo>Screenshot</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kwave-plugin-pitch_shift.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Screenshot of the Pitch Shift Plugin</phrase>
</textobject>
</mediaobject>
</screenshot>
<variablelist>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_internal_name;</emphasis></term>
<listitem><para><literal>&no-i18n-plugin_pitch_shift;</literal></para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_type;</emphasis></term>
<listitem><para>effect</para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_description;</emphasis></term>
<listitem>
<para>
The pitch shift effect modifies the signal by changing the speed
of the content, but with keeping the original length. You can
select the relative speed either by factor from 1/10 to x5, or
as a percentage from 1% to 400% of the original speed.
</para>
<para>
A speed factor below 1.0 pitches the signal down (lower voice,
makes voices sound older), factor 1.0 does no change and a
factor above 1.0 pitches the signal up (higher voice, mickey
mouse effect).
</para>
<para>
The implementation is based on the work of
<link linkend="author_Jeff_Tranter">
<author>
<personname>
<firstname>Jeff</firstname>
<surname>Tranter</surname>
</personname>
</author>
</link>
and
<link linkend="author_Stefan_Westerfeld">
<author>
<personname>
<firstname>Stefan</firstname>
<surname>Westerfeld</surname>
</personname>
</author>
</link>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_parameters;</emphasis></term>
<listitem>
<variablelist>
<varlistentry>
<term><replaceable>speed</replaceable></term>
<listitem>
<para>
Factor for changing the speed, has to be a
floating point number between 0.001 and 4.0.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>frequency</replaceable></term>
<listitem>
<para>
Frequency internally used by the filter in Hz,
has to be between 2.0 and 10.0.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>mode</replaceable></term>
<listitem>
<informaltable frame='all'>
<tgroup cols='2'>
<thead>
<row>
<entry align='left'>value</entry>
<entry align='left'>description</entry>
</row>
</thead>
<tbody>
<row>
<entry>&no-i18n-tag;<command>0</command></entry>
<entry>
Enter the speed value as factor
from 1/10 to x5.
</entry>
</row>
<row>
<entry>&no-i18n-tag;<command>1</command></entry>
<entry>
Enter the speed value as percentage
from 1 to 400.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<!-- @PLUGIN@ playback -->
<sect1 id="plugin_sect_playback"><title id="plugin_title_playback">&no-i18n-plugin_playback; (Playback)</title>
<screenshot>
<screeninfo>Screenshot</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kwave-plugin-playback.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Screenshot of the Playback Plugin</phrase>
</textobject>
</mediaobject>
</screenshot>
<variablelist>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_internal_name;</emphasis></term>
<listitem><para><literal>&no-i18n-plugin_playback;</literal></para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_type;</emphasis></term>
<listitem><para>function</para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_description;</emphasis></term>
<listitem>
<para>
Provides a dialog to set up the playback parameters.
Please refer to the section
<link linkend="playback" endterm="sect_title_playback"/>
in this manual for more information.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_parameters;</emphasis></term>
<listitem>
<variablelist>
<varlistentry>
<term><replaceable>playback method</replaceable></term>
<listitem>
<para>
The method used for playback, see
<filename>PlayBackParam.h</filename>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>playback device</replaceable></term>
<listitem>
<para>
A string that determines the playback device or
channel. The meaning depends on the playback
method.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>channels</replaceable></term>
<listitem>
<para>
The number of channels to use for playback,
currently supports only 1 (mono) or 2 (stereo).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>bits per sample</replaceable></term>
<listitem>
<para>
The number of bits per sample for playback,
should be 8, 16, 24 or 32.
Depends on the playback method and the
playback device.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>buffer size</replaceable></term>
<listitem>
<para>
Determines the size of the playback buffer, used
as exponent for calculating the real buffer
size as 2^n, e.g. setting this to 16 gives a
buffer size of 2^16 = 64 kB.
</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<!-- @PLUGIN@ record -->
<sect1 id="plugin_sect_record"><title id="plugin_title_record">&no-i18n-plugin_record; (Record)</title>
<screenshot>
<screeninfo>Screenshot</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kwave-plugin-record.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Screenshot of the Record Plugin</phrase>
</textobject>
</mediaobject>
</screenshot>
<variablelist>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_internal_name;</emphasis></term>
<listitem><para><literal>&no-i18n-plugin_record;</literal></para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_type;</emphasis></term>
<listitem><para>function</para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_description;</emphasis></term>
<listitem>
<para>
Provides a dialog to set up the record parameters and to do
a recording. Please refer to the section
<link linkend="recording" endterm="sect_title_recording"/>
in this manual for more information.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_parameters;</emphasis></term>
<listitem>
<variablelist>
<varlistentry>
<term><replaceable>recording method</replaceable></term>
<listitem>
<para>
The method used for recording, see
<filename>RecordParams.h</filename>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>pre recording enabled</replaceable></term>
<listitem>
<para>
Enable/disable pre recording (1 if enabled, 0 if disabled).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>pre recording time</replaceable></term>
<listitem>
<para>
Number of seconds for pre recording.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>limit recording time</replaceable></term>
<listitem>
<para>
Enable/disable limiting of recording time (1 if limited, 0 if not limited).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>recording time</replaceable></term>
<listitem>
<para>
Duration of the recording in seconds.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>use starting time</replaceable></term>
<listitem>
<para>
Enable/disable starting time (1 if used, 0 if not used).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>starting time</replaceable></term>
<listitem>
<para>
Date/time to start the recording, in ISO format.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>use trigger level</replaceable></term>
<listitem>
<para>
Enable/disable trigger level (1 if used, 0 if not used).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>trigger level</replaceable></term>
<listitem>
<para>
Trigger level in percent.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>recording device</replaceable></term>
<listitem>
<para>
A string that determines the recording device.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>channels</replaceable></term>
<listitem>
<para>
The number of channels to use for recording.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>sample rate</replaceable></term>
<listitem>
<para>
Sample rate in samples per second.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>compression</replaceable></term>
<listitem>
<para>
Compression to use for storing the samples.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>sample format</replaceable></term>
<listitem>
<para>
Sample format to use for storing the samples,
see <link linkend="sample-formats">section
about sample formats</link>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>bits per sample</replaceable></term>
<listitem>
<para>
The number of bits per sample for recording,
should be 8, 16, 24 or 32.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>buffer count</replaceable></term>
<listitem>
<para>
Determines the number buffers used for recording.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>buffer size</replaceable></term>
<listitem>
<para>
Determines the size of the recording buffer, used
as exponent for calculating the real buffer
size as 2^n, e.g. setting this to 16 gives a
buffer size of 2^16 = 64 kB.
</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">Alternative Parameters:</emphasis></term>
<listitem>
<variablelist>
<varlistentry>
<term><replaceable>record plugin direct mode</replaceable></term>
<listitem>
<para>
Can be used as a single parameter for setting up the plugin.
The following values are possible:
<informaltable frame='all'>
<tgroup cols='2'>
<thead>
<row>
<entry align='left'>value</entry>
<entry align='left'>description</entry>
</row>
</thead>
<tbody>
<row>
<entry>&no-i18n-tag;<command>format</command></entry>
<entry>
Open the recording dialog and select the <guilabel>Format</guilabel> tab.
</entry>
</row>
<row>
<entry>&no-i18n-tag;<command>source</command></entry>
<entry>
Open the recording dialog and select the <guilabel>Source</guilabel> tab.
</entry>
</row>
<row>
<entry>&no-i18n-tag;<command>start_now</command></entry>
<entry>
Open the recording dialog and directly start recording.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<!-- @PLUGIN@ reverse -->
<sect1 id="plugin_sect_reverse"><title id="plugin_title_reverse">&no-i18n-plugin_reverse; (Reverse)</title>
<variablelist>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_internal_name;</emphasis></term>
<listitem><para><literal>&no-i18n-plugin_reverse;</literal></para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_type;</emphasis></term>
<listitem><para>effect</para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_description;</emphasis></term>
<listitem>
<para>
This simple effect reverses the content of the current selection.
</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<!-- @PLUGIN@ samplerate -->
<sect1 id="plugin_sect_samplerate"><title id="plugin_title_samplerate">&no-i18n-plugin_samplerate; (Sample Rate Conversion)</title>
<variablelist>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_internal_name;</emphasis></term>
<listitem><para><literal>&no-i18n-plugin_samplerate;</literal></para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_type;</emphasis></term>
<listitem><para>effect</para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_description;</emphasis></term>
<listitem>
<para>
Changes the sample rate of the current selection or the whole
signal.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_parameters;</emphasis></term>
<listitem>
<variablelist>
<varlistentry>
<term><replaceable>new rate</replaceable></term>
<listitem>
<para>
The new sample rate in samples per second
(floating point value).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>mode</replaceable> (optional)</term>
<listitem>
<para>
If this parameter is used and set to the
value "<literal>all</literal>", then this
effect will be applied to the whole signal.
Otherwise it will be applied to the current
selection only.
</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<!-- @PLUGIN@ saveblocks -->
<sect1 id="plugin_sect_saveblocks"><title id="plugin_title_saveblocks">&no-i18n-plugin_saveblocks; (Save Blocks)</title>
<screenshot>
<screeninfo>Screenshot</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kwave-plugin-saveblocks.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Screenshot of the Save Blocks Plugin</phrase>
</textobject>
</mediaobject>
</screenshot>
<variablelist>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_internal_name;</emphasis></term>
<listitem><para><literal>&no-i18n-plugin_saveblocks;</literal></para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_type;</emphasis></term>
<listitem><para>function</para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_description;</emphasis></term>
<listitem>
<para>
Saves all sections between markers, each into a separate file.
Each file is given a name that can be customized by using
a pattern that can contain the original file name, an index
and the number of sections.
</para>
<para>
It is also allowed that the file name pattern contains forward
slashes as path separators, which allows saving the sections
into different sub directories. Please note that all whitespace
characters around such path separators are silently removed, to
avoid creation of directory names which begin or end with a
whitespace.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_parameters;</emphasis></term>
<listitem>
<variablelist>
<varlistentry>
<term><replaceable>name</replaceable></term>
<listitem>
<para>
The name of the original file, will be used as
base name for the file names.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>pattern</replaceable></term>
<listitem>
<para>
A pattern that will be used for creating the
names of the files. It can contain the
following wildcards which will be replaced
by the corresponding content when creating
the final file name:
</para>
<informaltable frame='all'>
<tgroup cols='2'>
<thead>
<row>
<entry align='left'>wildcard</entry>
<entry align='left'>description</entry>
</row>
</thead>
<tbody>
<row>
<entry>&no-i18n-tag;<command>[%nr]</command></entry>
<entry>
Will be replaced with the current index of the
file to save.
</entry>
</row>
<row>
<entry>&no-i18n-tag;<command>[%count]</command></entry>
<entry>
Will be replaced with the number of sections that
will be saved.
</entry>
</row>
<row>
<entry>&no-i18n-tag;<command>[%total]</command></entry>
<entry>
Will be replaced with the index of the last file
to save.
</entry>
</row>
<row>
<entry>&no-i18n-tag;<command>[%filename]</command></entry>
<entry>
Will be replaced with the base file name,
without path and without extension.
</entry>
</row>
<row>
<entry>&no-i18n-tag;<command>[%fileinfo{<replaceable>keyword</replaceable>}]</command></entry>
<entry>
Will be replaced with the content of a file information
identified by <replaceable>keyword</replaceable>.
See section <link linkend="file-info-list" endterm="file-info-list-title"/>
for a list of all available keywords.
</entry>
</row>
<row>
<entry>&no-i18n-tag;<command>[%title]</command></entry>
<entry>
Will be replaced with the title of the block, which is taken
from the descriptive text of the label at the
<emphasis>start</emphasis> of the block.
If that text is empty it will fall back to the title
of the file (see file information item
"<link linkend="INF_NAME">Name</link>").
If this also does not exist, it will fall back to the
base file name as described above.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<para>
All numeric wildcards can also contain a numerical argument after the
"<literal>%</literal>" and the identifier, to force a certain number
of digits. If the number is preceded by a <literal>0</literal> then
the result will contain leading zeroes, otherwise it will contain leading
spaces.
</para>
<para>
Example: <command><literal>[%04nr]</literal></command> produces a
number between 0001 and 9999.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>numbering mode</replaceable></term>
<listitem>
<para>
Determines where the numbering should start.
<informaltable frame='all'>
<tgroup cols='2'>
<thead>
<row>
<entry align='left'>value</entry>
<entry align='left'>description</entry>
</row>
</thead>
<tbody>
<row>
<entry>&no-i18n-tag;<command>0</command></entry>
<entry>
Continue after the index of the highest
index that already exists, this avoids
overwriting existing files.
</entry>
</row>
<row>
<entry>&no-i18n-tag;<command>1</command></entry>
<entry>
Always start with index 1, with the risk
of overwriting existing files.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>selection only</replaceable></term>
<listitem>
<para>
<informaltable frame='all'>
<tgroup cols='2'>
<thead>
<row>
<entry align='left'>value</entry>
<entry align='left'>description</entry>
</row>
</thead>
<tbody>
<row>
<entry>&no-i18n-tag;<command>0</command></entry>
<entry>
Save all sections of the whole file.
</entry>
</row>
<row>
<entry>&no-i18n-tag;<command>1</command></entry>
<entry>
Save only the sections that are within the
current selection. If nothing is selected,
the whole file will be saved.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<!-- @PLUGIN@ selectrange -->
<sect1 id="plugin_sect_selectrange"><title id="plugin_title_selectrange">&no-i18n-plugin_selectrange; (Select Range)</title>
<screenshot>
<screeninfo>Screenshot</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kwave-plugin-selectrange.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Screenshot of the Select Range Plugin</phrase>
</textobject>
</mediaobject>
</screenshot>
<variablelist>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_internal_name;</emphasis></term>
<listitem><para><literal>&no-i18n-plugin_selectrange;</literal></para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_type;</emphasis></term>
<listitem><para>function</para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_description;</emphasis></term>
<listitem>
<para>
Shows a dialog to select a range of samples. The start and the
length of the selection can be set either by a time in milliseconds,
in samples, or as a percentage of the total length of the file.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_parameters;</emphasis></term>
<listitem>
<variablelist>
<varlistentry>
<term id="select_range_start_mode"><replaceable>start mode</replaceable></term>
<listitem>
<para>
Determines the units in which the
<emphasis>start</emphasis> of the selection
will be given.
<informaltable frame='all'>
<tgroup cols='2'>
<thead>
<row>
<entry align='left'>value</entry>
<entry align='left'>description</entry>
</row>
</thead>
<tbody>
<row>
<entry>&no-i18n-tag;<command>0</command></entry>
<entry>milliseconds</entry>
</row>
<row>
<entry>&no-i18n-tag;<command>1</command></entry>
<entry>samples</entry>
</row>
<row>
<entry>&no-i18n-tag;<command>2</command></entry>
<entry>percentage of the length of the file</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>range mode</replaceable></term>
<listitem>
<para>
Determines the units in which the
<emphasis>length</emphasis> of
the selection will be given. See the description
if the parameter
<parameter>start mode</parameter>
for a list of possible values.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>start</replaceable></term>
<listitem>
<para>
The start of the selection, in milliseconds,
samples or percentage of the length of the
file, depending on the parameter
<parameter>range mode</parameter>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>length</replaceable></term>
<listitem>
<para>
The length of the selection, in milliseconds,
samples or percentage of the length of the
file, depending on the parameter
<parameter>range mode</parameter>.
</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<!-- @PLUGIN@ sonagram -->
<sect1 id="plugin_sect_sonagram"><title id="plugin_title_sonagram">&no-i18n-plugin_sonagram; (Sonagram)</title>
<screenshot>
<screeninfo>Screenshot</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kwave-plugin-sonagram-setup.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Screenshot of the setup dialog of the Sonagram Plugin</phrase>
</textobject>
</mediaobject>
</screenshot>
<screenshot>
<screeninfo>Screenshot</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kwave-plugin-sonagram-window.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Screenshot of the Sonagram Window</phrase>
</textobject>
</mediaobject>
</screenshot>
<variablelist>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_internal_name;</emphasis></term>
<listitem><para><literal>&no-i18n-plugin_sonagram;</literal></para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_type;</emphasis></term>
<listitem><para>function</para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_description;</emphasis></term>
<listitem>
<para>
Evaluates the current selection by generating a
<emphasis>sonagram</emphasis>. A sonagram is an evaluation
of a signal over time (x axis), frequency (y axis) and
intensity (color).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_parameters;</emphasis></term>
<listitem>
<variablelist>
<varlistentry>
<term><replaceable>FFT points</replaceable></term>
<listitem>
<para>
Number of points of the FFT, a whole number
between 4 and 32767 which determines the
frequency resolution.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>window function</replaceable></term>
<listitem>
<para>
The window function used for the FFT calculation,
supported values are:
<informaltable frame='all'>
<tgroup cols='2'>
<thead>
<row>
<entry align='left'>value</entry>
<entry align='left'>description</entry>
</row>
</thead>
<tbody>
<row>
<entry>&no-i18n-tag;<command>none</command></entry>
<entry>no window function</entry>
</row>
<row>
<entry>&no-i18n-tag;<command>hamming</command></entry>
<entry>
<personname>
<surname>Hamming</surname>
</personname> window
</entry>
</row>
<row>
<entry>&no-i18n-tag;<command>hanning</command></entry>
<entry>
<personname>
<surname>Hanning</surname>
</personname> window
</entry>
</row>
<row>
<entry>&no-i18n-tag;<command>blackman</command></entry>
<entry>
<personname>
<surname>Blackman</surname>
</personname> window
</entry>
</row>
<row>
<entry>&no-i18n-tag;<command>triangular</command></entry>
<entry>Triangular window</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>use colors</replaceable></term>
<listitem>
<para>
If set to non-zero, use colors for intensity,
if set to zero use grayscales.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>track changes</replaceable></term>
<listitem>
<para>
If set to non-zero, the sonagram will be updated
when the area that was evaluated has changed.
If set to zero it will never be updated.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>follow selection</replaceable></term>
<listitem>
<para>
Not yet implemented, use zero for this parameter.
</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<!-- @PLUGIN@ stringenter -->
<sect1 id="plugin_sect_stringenter"><title id="plugin_title_stringenter">&no-i18n-plugin_stringenter; (Enter Command)</title>
<screenshot>
<screeninfo>Screenshot</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kwave-plugin-stringenter.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Screenshot of the Enter Command Plugin</phrase>
</textobject>
</mediaobject>
</screenshot>
<variablelist>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_internal_name;</emphasis></term>
<listitem><para><literal>&no-i18n-plugin_stringenter;</literal></para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_type;</emphasis></term>
<listitem><para>function</para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_description;</emphasis></term>
<listitem>
<para>
A small dialog window that allows to enter a &kwave; text command.
Please refer to the chapter
<link linkend="kwave_commands" endterm="title_kwave_commands"/> in
this manual.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_parameters;</emphasis></term>
<listitem>
<variablelist>
<varlistentry>
<term><replaceable>preset</replaceable> (optional)</term>
<listitem>
<para>
A text that is shown in the edit field when
entering the dialog. This parameter is optional,
if omitted the edit field of the dialog will
be empty at start.
</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<!-- @PLUGIN@ volume -->
<sect1 id="plugin_sect_volume"><title id="plugin_title_volume">&no-i18n-plugin_volume; (Volume)</title>
<screenshot>
<screeninfo>Screenshot</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kwave-plugin-volume.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Screenshot of the Volume Plugin</phrase>
</textobject>
</mediaobject>
</screenshot>
<variablelist>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_internal_name;</emphasis></term>
<listitem><para><literal>&no-i18n-plugin_volume;</literal></para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_type;</emphasis></term>
<listitem><para>effect</para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_description;</emphasis></term>
<listitem>
<para>
With this plugin you can change the volume of the current selection
by a constant factor. The corresponding dialog allows to enter
this factor as a
<emphasis>numeric factor</emphasis> given as a floating point
value between 0.10 and 10.0,
a <emphasis>percentage</emphasis> between 1 and 1000,
or in <emphasis>decibel</emphasis> between -21 and +21.
</para>
<para>
Use a factor above 1.0 (or percentage above 100 or more than 0 dB)
if the file is too silent, or a factor below 1.0
(percentage below 100 or less than 0 dB)
if the file is too loud.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_parameters;</emphasis></term>
<listitem>
<variablelist>
<varlistentry>
<term><replaceable>factor</replaceable></term>
<listitem>
<para>
A floating point value with the amplification
factor.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>mode</replaceable></term>
<listitem>
<para>
<informaltable frame='all'>
<tgroup cols='2'>
<thead>
<row>
<entry align='left'>value</entry>
<entry align='left'>description</entry>
</row>
</thead>
<tbody>
<row>
<entry>&no-i18n-tag;<command>0</command></entry>
<entry>factor</entry>
</row>
<row>
<entry>&no-i18n-tag;<command>1</command></entry>
<entry>percentage</entry>
</row>
<row>
<entry>&no-i18n-tag;<command>1</command></entry>
<entry>decibel</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<!-- @PLUGIN@ zero -->
<sect1 id="plugin_sect_zero"><title id="plugin_title_zero">&no-i18n-plugin_zero; (Zero Generator)</title>
<variablelist>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_internal_name;</emphasis></term>
<listitem><para><literal>&no-i18n-plugin_zero;</literal></para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_type;</emphasis></term>
<listitem><para>effect</para></listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_description;</emphasis></term>
<listitem>
<para>
This plugin has two modes of operation. If used without parameters
it wipes the current selection by overwriting it with silence.
When used with two parameters, it inserts some
amount of silence at the start of the current selection.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold">&i18n-plugin_lbl_parameters;</emphasis></term>
<listitem>
<variablelist>
<varlistentry>
<term><replaceable>length mode</replaceable></term>
<listitem>
<para>
Determines the units in which the
<emphasis>length</emphasis> of the inserted silence
will be given.
<informaltable frame='all'>
<tgroup cols='2'>
<thead>
<row>
<entry align='left'>value</entry>
<entry align='left'>description</entry>
</row>
</thead>
<tbody>
<row>
<entry>&no-i18n-tag;<command>0</command></entry>
<entry>milliseconds</entry>
</row>
<row>
<entry>&no-i18n-tag;<command>1</command></entry>
<entry>samples</entry>
</row>
<row>
<entry>&no-i18n-tag;<command>2</command></entry>
<entry>percentage of the length of the file</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>length</replaceable></term>
<listitem>
<para>
Length of the silence to insert, in milliseconds,
samples or percentage of the length of the
file, depending on the parameter
<parameter>length mode</parameter>.
</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<!-- @PLUGIN_END_OF_LIST@ -->
</chapter>
<!-- ###################################################################### -->
<!-- ### Chapter: Questions and Answers ### -->
<!-- ###################################################################### -->
<chapter id="faq"><title>Questions and Answers</title>
<para></para>
<qandaset>
<qandaentry>
<question>
<para>
What do I need to compile &kwave;?
</para>
</question>
<answer>
<para>
Read in the
<ulink url="&url_devel_requirements;">developer documentation</ulink>.
</para>
</answer>
</qandaentry>
<qandaentry>
<question>
<para>
Which sound cards does &kwave; support?
</para>
</question>
<answer>
<para>
&kwave; does not need support for any special sound card.
The sound card only has to be supported by your
operating system and &kwave; uses its interface to the
operating system's sound driver through a OSS or ALSA
interface.
</para>
</answer>
</qandaentry>
<qandaentry>
<question>
<para>
Why does &kwave; consume more memory than it can be
expected from the size of the opened file?
</para>
</question>
<answer>
<para>
The reason for this is that &kwave; internally stores
all samples in 32-bit integers. This was easy to program,
made the application faster and a bit more reliable.
So if you load an 8-bit file with about one megabyte
it will consume about four megabytes.
Maybe we will change this somewhere in the future...
</para>
</answer>
</qandaentry>
<qandaentry>
<question>
<para>
Which sound formats does &kwave; support?
</para>
</question>
<answer>
<para>
&kwave; currently supports .wav files with 8, 16 and
24 bits per sample, with any number of channels
(of course including mono and stereo). Additionally it
can import all file types that libaudiofile supports
and some other formats like Ogg/Vorbis and MP3.
</para>
</answer>
</qandaentry>
<qandaentry>
<question>
<para>
What if I have files with a format not
supported by &kwave;?
</para>
</question>
<answer>
<para>
If you have to work on a different format, you can convert
it into .wav format. A good set of tools for this is
in the
<ulink url="&url_sox;">SoX</ulink> package, they have also some nice
documentation!
</para>
</answer>
</qandaentry>
<qandaentry>
<question>
<para>
I get errors when I want to do playback?
</para>
</question>
<answer>
<para>
Maybe you have chosen a combination of playback
rate and sample size that is not supported by your
sound driver and / or sound hardware. Try playback with
8 bits per sample and mono first, this should always
work. Then try to increase the bits per sample and
stereo playback step by step. Note that some playback
rates are not at all supported by some sound hardware.
</para>
</answer>
</qandaentry>
<qandaentry>
<question>
<para>
The playback seems to do something but I hear nothing?
</para>
</question>
<answer>
<para>
Maybe you have forgotten to increase the volume of
the playback channel. &kwave; is not responsible for
changing the playback volume.
</para>
</answer>
</qandaentry>
<qandaentry>
<question>
<para>
Some files are played with half-speed?
</para>
</question>
<answer>
<para>
Try choosing a different sound playback device.
</para>
</answer>
</qandaentry>
<qandaentry>
<question>
<para>
The playback sometimes is disturbed and interrupted?
</para>
</question>
<answer>
<para>
You should increase the size of the playback buffer
to get a "smoother" playback (this also makes the
playback control reacting a bit slower).
</para>
</answer>
</qandaentry>
<qandaentry>
<question>
<para>
The playback does not stop if I immediately
press the stop button?
</para>
</question>
<answer>
<para>
The reason for this is that the sound driver already
has received some playback data from &kwave; at the
moment when you press the stop button. Decrease the
size of the playback buffer and it should react faster
(but makes interruptions more probable).
</para>
</answer>
</qandaentry>
<qandaentry>
<question>
<para>
Is ALSA supported?
</para>
</question>
<answer>
<para>
Yes, since v0.7.4 for playback and recording
</para>
</answer>
</qandaentry>
<qandaentry>
<question>
<para>
What about playback with 18, 20, 24 or 32 bits per sample
or more than two channels?
</para>
</question>
<answer>
<para>
This is possible through the ALSA interface,
since v0.7.4.
</para>
</answer>
</qandaentry>
<!--
<qandaentry>
<question>
<para>
...
</para>
</question>
<answer>
<para>
...
</para>
</answer>
</qandaentry>
-->
</qandaset>
</chapter>
<!-- ###################################################################### -->
<!-- ### Chapter: Credits ### -->
<!-- ###################################################################### -->
<chapter id="credits"><title>Credits and License</title>
<para>&kwave;</para>
<para>
Program copyright from 1998-2000 Martin Wilz
<email>martin@wilz.de</email>
</para>
<para>
Program copyright since 2000 Thomas Eschenbacher
<email>thomas.eschenbacher@gmx.de</email>
</para>
<para>
For a complete list of authors and licenses of all files, please
refer to the <ulink url="&url_licenses;"><filename>LICENSES</filename></ulink>
file, which is included in the sources. There also is a file with the
name <ulink url="&url_authors;"><filename>AUTHORS</filename></ulink>
that lists all authors and contributors of &kwave;.
</para>
<para>
Documentation copyright (C) &version_year; Thomas Eschenbacher
<email>thomas.eschenbacher@gmx.de</email>
</para>
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
&underFDL;
&underGPL;
<sect1 id="main_authors"><title>Main Authors</title>
<para>
<itemizedlist>
<listitem>
<para><emphasis role="bold">
Martin Wilz
<email>martin@wilz.de</email>
</emphasis></para><para>
creator of the project, active development 1998-2000
</para>
</listitem>
<listitem>
<para><emphasis role="bold">
Thomas Eschenbacher
<email>thomas.eschenbacher@gmx.de</email>
</emphasis></para><para>
maintainer since 2000, core development
</para>
</listitem>
</itemizedlist>
</para>
</sect1>
<sect1 id="major_contributors"><title>Major Contributors</title>
<para>
<itemizedlist>
<listitem>
<para><emphasis role="bold">
Aurelien Jarno
<email>aurel32@debian.org</email>
</emphasis></para><para>
<ulink url="&url_debian;">debian</ulink> packager,
patches
</para>
</listitem>
<listitem>
<para><emphasis role="bold">
Carlos R
<email>pureacetone@gmail.com</email>
</emphasis></para><para>
spanish translation
</para>
</listitem>
<listitem>
<para><emphasis role="bold">
David Flogeras
<email>dflogera@nbnet.nb.ca</email>
</emphasis></para><para>
Notch Filter plugin
</para>
</listitem>
<listitem>
<para><emphasis role="bold">
Gilles Caulier
<email>caulier.gilles@free.fr</email>
</emphasis></para><para>
i18n, french translations, splashscreen, beta tester
</para>
</listitem>
<listitem>
<para><emphasis role="bold">
Pavel Fric
<email>pavelfric@seznam.cz</email>
</emphasis></para><para>
Czech translation
</para>
</listitem>
<listitem>
<para><emphasis role="bold">
Ralf Waspe
<email>rwaspe@web.de</email>
</emphasis></para><para>
Help/About plugin
</para>
</listitem>
<listitem>
<para><emphasis role="bold">
Sven-Steffen Arndt
<email>ssa29@gmx.de</email>
</emphasis></para><para>
homepage, german translation
</para>
</listitem>
</itemizedlist>
</para>
</sect1>
<sect1 id="minor_contributors"><title>Minor contributors, copyright holders and others</title>
<para>
<itemizedlist>
<listitem>
<para><emphasis role="bold">
Aaron Holtzman <email>aholtzma@ess.engr.uvic.ca</email>
</emphasis></para><para>
libkwave/cpu_accel.cpp
</para>
</listitem>
<listitem>
<para><emphasis role="bold">
Bertrand Songis <email>bsongis@gmail.com</email>
</emphasis><emphasis>[historic]</emphasis></para><para>
french translation fixes,
substitutes for patented libaudiofile code,
debian bug 419124
</para>
</listitem>
<listitem>
<para><emphasis role="bold">
Carsten Lohrke <email>carlo@gentoo.org</email>
</emphasis></para><para>
svn r2163, patch for libaudiofile detection
</para>
</listitem>
<listitem id="author_Chris_Vaill">
<para><emphasis role="bold">
Chris Vaill <email>chrisvaill@gmail</email>
</emphasis></para><para>
code base for the normalize plugin
</para>
</listitem>
<listitem>
<para><emphasis role="bold">
David Faure <email>faure@kde.org</email>
</emphasis></para><para>
cmake/FindAlsa.cmake
</para>
</listitem>
<listitem>
<para><emphasis role="bold">
Diederick de Vries
<email>diederick76@gmail.com</email>
</emphasis></para><para>
packaging for Crux Linux
</para>
</listitem>
<listitem>
<para><emphasis role="bold">
Espen Sand <email>espen@kde.org</email> +
Mirko Boehm <email>mirko@kde.org</email>
</emphasis></para><para>
K3AboutContainer, base of KwaveAboutContainer
</para>
</listitem>
<listitem>
<para><emphasis role="bold">
Everaldo Coelho <email>contact@everaldo.com</email>
</emphasis></para><para>
the crystal icon theme http://www.everaldo.com/crystal/
</para>
</listitem>
<listitem>
<para><emphasis role="bold">
Jaroslav Kysela
</emphasis></para><para>
parts of plugins/playback/PlayBack-ALSA.cpp
</para>
</listitem>
<listitem id="author_Jeff_Tranter">
<para><emphasis role="bold">
Jeff Tranter
</emphasis></para><para>
parts of plugins/pitch_shift/PitchShiftFilter.{h,cpp}
</para>
</listitem>
<listitem id="author_Juhana_Sadeharju">
<para><emphasis role="bold">
Juhana Sadeharju <email>kouhia@nic.funet.fi</email>
</emphasis></para><para>
plugins/band_pass/BandPass.{h,cpp},
plugins/lowpass/LowPassFilter.cpp,
plugins/notch_filter/NotchFilter.{h,cpp}
</para>
</listitem>
<listitem>
<para><emphasis role="bold">
Kurt Roeck <email>Q@ping.be</email>
</emphasis></para><para>
svn r1370, fix for debian bug#288781, compilation for amd64
</para>
</listitem>
<listitem>
<para><emphasis role="bold">
Mark Donohoe (KDE) <email>donohoe@kde.org</email>
</emphasis></para><para>
some icons and bitmaps for toolbar and GUI
</para>
</listitem>
<listitem>
<para><emphasis role="bold">
Martin Hinsch <email>vidas@sourceforge.net</email>
</emphasis></para><para>
Matrix class
</para>
</listitem>
<listitem>
<para><emphasis role="bold">
Matthias Kretz <email>kretz@kde.org</email>
</emphasis></para><para>
cmake/FindAlsa.cmake
</para>
</listitem>
<listitem>
<para><emphasis role="bold">
Miguel Freitas
</emphasis></para><para>
parts of libkwave/memcpy.c
</para>
</listitem>
<listitem>
<para><emphasis role="bold">
Richard Laerkaeng, <email>richard@goteborg.utfors.se</email>
</emphasis></para><para>
cmake/FindOggVorbis.cmake
</para>
</listitem>
<listitem>
<para><emphasis role="bold">
Rik Hemsley
<email>rik@kde.org</email>
</emphasis></para><para>
<ulink url="&url_levelmeter;">level meter</ulink>
</para>
</listitem>
<listitem id="author_Stefan_Westerfeld">
<para><emphasis role="bold">
Stefan Westerfeld <email>stefan@space.twc.de</email>
</emphasis></para><para>
parts of plugins/pitch_shift/PitchShiftFilter.{h,cpp}
</para>
</listitem>
<listitem>
<para><emphasis role="bold">
Joerg-Christian Boehme <email>joerg@chaosdorf.de</email>
</emphasis></para><para>
plugins/record/Record-PulseAudio.cpp
plugins/record/Record-PulseAudio.h
</para>
</listitem>
<listitem>
<para><emphasis role="bold">
Sebastian Trueg <email>trueg@k3b.org</email>,
Gustavo Pichorim Boiko <email>gustavo.boiko@kdemail.net</email>,
Michal Malek <email>michalm@jabster.pl</email>
</emphasis></para>
<para>
parts of plugins/export_k3b/K3BExportPlugin.cpp
</para>
</listitem>
</itemizedlist>
</para>
</sect1>
<sect1 id="thanks_to"><title>Thanks To</title>
<para>
<itemizedlist>
<listitem>
<para><emphasis role="bold">
Martin Kuball
<email>makube@user.sourceforge.net</email>
</emphasis></para><para>
beta tester
</para>
</listitem>
<listitem>
<para><emphasis role="bold">
Jorge Luis Arzola
<email>arzolacub@gmx.de</email>
</emphasis></para><para>
packaging for SuSE Linux
</para>
</listitem>
<listitem>
<para><emphasis role="bold">
Michael Favreau
<email>michel.favreau@free.fr</email>
</emphasis></para><para>
packaging for Arch Linux
</para>
</listitem>
<listitem>
<para><emphasis role="bold">
T.H.F. Klok and Cedric Tefft
</emphasis></para><para>
maintainers of the <ulink url="&url_id3lib;">
id3lib</ulink> library
</para>
</listitem>
<listitem>
<para><emphasis role="bold">
Robert Leslie
<email>rob@mars.org</email>
</emphasis></para><para>
author of the
<ulink url="&url_libmad;">mad</ulink>
mp3 decoder library
</para>
</listitem>
<listitem>
<para><emphasis role="bold">
Robert M. Stockmann
<email>stock@stokkie.net</email>
</emphasis></para><para>
packaging for Mandrake / X86_64
</para>
</listitem>
<listitem>
<para><emphasis role="bold">
Erik de Castro Lopo
<email>erikd@zip.com.au</email>
</emphasis></para><para>
author of the
<ulink url="&url_libsndfile;">sndfile</ulink>
library
</para>
</listitem>
<listitem>
<para><emphasis role="bold">
Michael Pruett
<email>mpruett@sgi.com</email>
</emphasis></para><para>
author of the
<ulink url="&url_libaudiofile;">audiofile</ulink>
library
</para>
</listitem>
</itemizedlist>
</para>
</sect1>
<!--
historical entries:
<listitem><para>Juhana Kouhia</para></listitem>
<listitem><para>Gerhard Zintel</para></listitem>
<listitem><para>Gael Duval</para></listitem>
<listitem><para>Aaron Johnson</para></listitem>
<listitem><para>Uwe Steinmann</para></listitem>
<listitem><para>Juhana Kouhia</para></listitem>
<listitem><para>Dave Phillips</para></listitem>
<listitem><para>Martin Petriska</para></listitem>
<listitem><para>Winfried Truemper</para></listitem>
<listitem><para>Bruce Garlock</para></listitem>
<listitem><para>Christoph Raab</para></listitem>
<listitem><para>tOpHEr lAfaTA</para></listitem>
<listitem><para>Nemosoft</para></listitem>
<listitem><para>Guido</para></listitem>
<listitem><para>Eero</para></listitem>
<listitem><para>Carsten Jacobi</para></listitem>
<listitem><para>Frank Christian Stoffel</para></listitem>
<listitem><para>Achim Dahlhaus</para></listitem>
<listitem><para>Klaus Hendrik Lorenz</para></listitem>
<listitem><para>Matthias Düsterhöft</listitem>
-->
</chapter>
<appendix id="file-info-list"><title id="file-info-list-title">File Info</title>
<table frame='all'><title>List of File Info Identifiers</title>
<tgroup cols='3' align='center' colsep='1' rowsep='1'>
<colspec colname='c1'/> <colspec/>
<colspec colname='c2' colnum='3'/><colspec/>
<thead>
<row><entry>Keyword</entry><entry> </entry><entry>Description</entry></row>
</thead>
<tbody>
<!-- @FILEINFO_TABLE_START@ -->
<row id="INF_ALBUM">
<entry colname='c1'>&no-i18n-tag;Album</entry>
<entry colname='c2'>
Name of the album if the source is an album that consist of
more medias.
</entry>
</row>
<row id="INF_ANNOTATION">
<entry colname='c1'>&no-i18n-tag;Annotation</entry>
<entry colname='c2'>
Provides general comments about the file or the subject of the
file. If the comment is several sentences long, end each
sentence with a period. Do not include newline characters!
</entry>
</row>
<row id="INF_ARCHIVAL">
<entry colname='c1'>&no-i18n-tag;Archival location</entry>
<entry colname='c2'>
Indicates where the subject of the file is archived.
</entry>
</row>
<row id="INF_AUTHOR">
<entry colname='c1'>&no-i18n-tag;Author</entry>
<entry colname='c2'>
Identifies the name of the author of the original subject of
the file. Example: <quote>van Beethoven, Ludwig</quote>
</entry>
</row>
<row id="INF_BITRATE_LOWER">
<entry colname='c1'>&no-i18n-tag;Lower Bitrate</entry>
<entry colname='c2'>
Specifies the lower limit in a VBR bitstream.
</entry>
</row>
<row id="INF_BITRATE_MODE">
<entry colname='c1'>&no-i18n-tag;Bitrate Mode</entry>
<entry colname='c2'>
Bitrate Mode (ABR, VBR, CBR, etc...)
</entry>
</row>
<row id="INF_BITRATE_NOMINAL">
<entry colname='c1'>&no-i18n-tag;Bitrate</entry>
<entry colname='c2'>
Nominal bitrate of the audio stream in bits per second
</entry>
</row>
<row id="INF_BITRATE_UPPER">
<entry colname='c1'>&no-i18n-tag;Upper Bitrate</entry>
<entry colname='c2'>
Specifies the upper limit in a VBR bitstream.
</entry>
</row>
<row id="INF_BITS_PER_SAMPLE">
<entry colname='c1'>&no-i18n-tag;Bits per Sample</entry>
<entry colname='c2'>
Specifies the number of bits per sample.
</entry>
</row>
<row id="INF_CD">
<entry colname='c1'>&no-i18n-tag;CD</entry>
<entry colname='c2'>
Number of the CD, if the source is an album of more CDROMs
</entry>
</row>
<row id="INF_CDS">
<entry colname='c1'>&no-i18n-tag;CDS</entry>
<entry colname='c2'>
Number of CDs, if the source is an album of more CDROMs
</entry>
</row>
<row id="INF_COMMISSIONED">
<entry colname='c1'>&no-i18n-tag;Commissioned</entry>
<entry colname='c2'>
Lists the name of the person or organization that commissioned
the subject of the file.
</entry>
</row>
<row id="INF_COMMENTS">
<entry colname='c1'>&no-i18n-tag;Comments</entry>
<entry colname='c2'>
Provides general comments about the file or the subject of the
file. If the comment is several sentences long, end each
sentence with a period. Do not include newline characters!
</entry>
</row>
<row id="INF_COMPRESSION">
<entry colname='c1'>&no-i18n-tag;Compression</entry>
<entry colname='c2'>
Sets a mode for compressing the audio data to reduce disk
space.
</entry>
</row>
<row id="INF_CONTACT">
<entry colname='c1'>&no-i18n-tag;Contact</entry>
<entry colname='c2'>
Contact information for the creators or distributors of the
track. This could be a URL, an email address, the physical
address of the producing label.
</entry>
</row>
<row id="INF_COPYRIGHT">
<entry colname='c1'>&no-i18n-tag;Copyright</entry>
<entry colname='c2'>
Records the copyright information for the file. If there are
multiple copyrights, separate them by a semicolon followed by
a space. Example: <quote>Copyright Linux community 2002</quote>
</entry>
</row>
<row id="INF_COPYRIGHTED">
<entry colname='c1'>&no-i18n-tag;Copyrighted</entry>
<entry colname='c2'>
Indicates whether the file is protected by copyright or not.
</entry>
</row>
<row id="INF_CREATION_DATE">
<entry colname='c1'>&no-i18n-tag;Date</entry>
<entry colname='c2'>
Specifies the date the subject of the file was created.
Example: <quote>2001-12-24</quote>
</entry>
</row>
<row id="INF_ENGINEER">
<entry colname='c1'>&no-i18n-tag;Engineer</entry>
<entry colname='c2'>
Shows the name of the engineer who worked on the file. If there
are multiple engineers, separate the names by a semicolon and
a blank.
</entry>
</row>
<row id="INF_ESTIMATED_LENGTH">
<entry colname='c1'>&no-i18n-tag;Estimated Length</entry>
<entry colname='c2'>
Estimated length of the file in samples
</entry>
</row>
<row id="INF_FILENAME">
<entry colname='c1'>&no-i18n-tag;Filename</entry>
<entry colname='c2'>
Name of the opened file
</entry>
</row>
<row id="INF_FILESIZE">
<entry colname='c1'>&no-i18n-tag;File Size</entry>
<entry colname='c2'>
Size of the file in bytes
</entry>
</row>
<row id="INF_GENRE">
<entry colname='c1'>&no-i18n-tag;Genre</entry>
<entry colname='c2'>
Describes the genre or style of the original work. Examples:
<quote>classic</quote>, <quote>pop</quote>
</entry>
</row>
<row id="INF_ISRC">
<entry colname='c1'>&no-i18n-tag;ISRC</entry>
<entry colname='c2'>
ISRC number for the track; see the ISRC intro page for more
information on ISRC numbers.
&url_isrc;
</entry>
</row>
<row id="INF_KEYWORDS">
<entry colname='c1'>&no-i18n-tag;Keywords</entry>
<entry colname='c2'>
Provides a list of keywords that refer to the file or subject
of the file.
</entry>
</row>
<row id="INF_LABELS">
<entry colname='c1'>&no-i18n-tag;Labels</entry>
<entry colname='c2'>
The list of labels/markers.
</entry>
</row>
<row id="INF_LENGTH">
<entry colname='c1'>&no-i18n-tag;Length</entry>
<entry colname='c2'>
Length of the file in samples.
</entry>
</row>
<row id="INF_LICENSE">
<entry colname='c1'>&no-i18n-tag;License</entry>
<entry colname='c2'>
License information, e.g., <quote>All Rights Reserved</quote>,
<quote>Any Use Permitted</quote>, an URL to a license or the
Attribution-ShareAlike 4.0 International
(<quote>distributed under the terms of the
Attribution-ShareAlike 4.0 International License. See
&url_cc_by_sa_4; for details</quote>), etc.
</entry>
</row>
<row id="INF_MEDIUM">
<entry colname='c1'>&no-i18n-tag;Medium</entry>
<entry colname='c2'>
Describes the original subject of the file, where it was first
recorded. Example: <quote>orchestra</quote>
</entry>
</row>
<row id="INF_MIMETYPE">
<entry colname='c1'>&no-i18n-tag;Mime Type</entry>
<entry colname='c2'>
Mime type of the file format
</entry>
</row>
<row id="INF_MPEG_EMPHASIS">
<entry colname='c1'>&no-i18n-tag;Emphasis</entry>
<entry colname='c2'>
Audio emphasis mode
</entry>
</row>
<row id="INF_MPEG_LAYER">
<entry colname='c1'>&no-i18n-tag;Layer</entry>
<entry colname='c2'>
MPEG Layer, I, II or III
</entry>
</row>
<row id="INF_MPEG_MODEEXT">
<entry colname='c1'>&no-i18n-tag;Mode Extension</entry>
<entry colname='c2'>
MPEG Mode Extension (only if Joint Stereo)
</entry>
</row>
<row id="INF_MPEG_VERSION">
<entry colname='c1'>&no-i18n-tag;Version</entry>
<entry colname='c2'>
MPEG Version, 1, 2 or 2.5
</entry>
</row>
<row id="INF_NAME">
<entry colname='c1'>&no-i18n-tag;Name</entry>
<entry colname='c2'>
Stores the title of the subject of the file. Example:
<quote>Symphony No.6, Op.68 "Pastoral"</quote>
</entry>
</row>
<row id="INF_OPUS_FRAME_LEN">
<entry colname='c1'>&no-i18n-tag;Opus Frame Length</entry>
<entry colname='c2'>
Opus Frame Length in ms (supported values are 2.5, 5, 10, 20,
40, or 60 ms)
</entry>
</row>
<row id="INF_ORGANIZATION">
<entry colname='c1'>&no-i18n-tag;Organization</entry>
<entry colname='c2'>
Name of the organization producing the track (i.e. the
<quote>record label</quote>)
</entry>
</row>
<row id="INF_ORIGINAL">
<entry colname='c1'>&no-i18n-tag;Original</entry>
<entry colname='c2'>
Indicates whether the file is an original or a copy
</entry>
</row>
<row id="INF_PERFORMER">
<entry colname='c1'>&no-i18n-tag;Performer</entry>
<entry colname='c2'>
The artist(s) who performed the work. In classical music this
would be the conductor, orchestra, soloists. In an audio book
it would be the actor who did the reading.
</entry>
</row>
<row id="INF_PRIVATE">
<entry colname='c1'>&no-i18n-tag;Private</entry>
<entry colname='c2'>
Indicates whether the subject is private
</entry>
</row>
<row id="INF_PRODUCT">
<entry colname='c1'>&no-i18n-tag;Product</entry>
<entry colname='c2'>
Specifies the name or the title the file was originally
intended for. Example: <quote>Linux audio collection</quote>
</entry>
</row>
<row id="INF_SAMPLE_FORMAT">
<entry colname='c1'>&no-i18n-tag;Sample Format</entry>
<entry colname='c2'>
Format used for storing the digitized audio samples. Example:
<quote>32-bit IEEE floating-point</quote>
</entry>
</row>
<row id="INF_SAMPLE_RATE">
<entry colname='c1'>&no-i18n-tag;Sample Rate</entry>
<entry colname='c2'>
Number of samples per second
</entry>
</row>
<row id="INF_SOFTWARE">
<entry colname='c1'>&no-i18n-tag;Software</entry>
<entry colname='c2'>
Identifies the name of the software package used to create the
file. Example: <quote>Kwave v0.6.4-1</quote>
</entry>
</row>
<row id="INF_SOURCE">
<entry colname='c1'>&no-i18n-tag;Source</entry>
<entry colname='c2'>
Identifies the name of the person or organization who supplied
the original subject of the file. Example: <quote>Chaotic Sound
Research</quote>
</entry>
</row>
<row id="INF_SOURCE_FORM">
<entry colname='c1'>&no-i18n-tag;Source form</entry>
<entry colname='c2'>
Identifies the original form of the material that was
digitized. Examples: <quote>Record/Vinyl/90RPM</quote>,
<quote>Audio DAT</quote>, <quote>tape/CrO2/60min</quote>
</entry>
</row>
<row id="INF_SUBJECT">
<entry colname='c1'>&no-i18n-tag;Subject</entry>
<entry colname='c2'>
Describes the subject of the file. Example: <quote>Bird voices
at early morning</quote>
</entry>
</row>
<row id="INF_TECHNICAN">
<entry colname='c1'>&no-i18n-tag;Technician</entry>
<entry colname='c2'>
Identifies the technician who digitized the subject file.
Example: <quote>Torvalds, Linus</quote>
</entry>
</row>
<row id="INF_TRACK">
<entry colname='c1'>&no-i18n-tag;Track</entry>
<entry colname='c2'>
Track of the CD if the source was a CDROM.
</entry>
</row>
<row id="INF_TRACKS">
<entry colname='c1'>&no-i18n-tag;Tracks</entry>
<entry colname='c2'>
Number of tracks of the CD if the source was a CDROM.
</entry>
</row>
<row id="INF_CHANNELS">
<entry colname='c1'>&no-i18n-tag;Channels</entry>
<entry colname='c2'>
Specifies the number of channels of the signal.
</entry>
</row>
<row id="INF_VBR_QUALITY">
<entry colname='c1'>&no-i18n-tag;Base Quality</entry>
<entry colname='c2'>
Base quality of the compression in VBR mode
</entry>
</row>
<row id="INF_VERSION">
<entry colname='c1'>&no-i18n-tag;Version</entry>
<entry colname='c2'>
May be used to differentiate multiple versions of the same
track title in a single collection. (e.g. remix info)
</entry>
</row>
<!-- @FILEINFO_TABLE_END@ -->
</tbody>
</tgroup>
</table>
</appendix>
</book>
distrib
>
Mageia
>
6
>
x86_64
>
media
>
core-updates
>
by-pkgid
>
0554524c698c8d6726b3c98dbe07efbc
>
files
>
34
