STX Wiki - User contributions [en]

Template:STX

2019-06-05T20:55:44Z

Christian:

STx

Main Page

2019-06-05T20:53:55Z

Christian:

== {{STx}} {{VERSION}}==

{{STX}} is an amazing software tool for the analysis, signal processing and annotation of Wave sound files. {{STX}} runs on the Windows operating system. It was originally a port of the S_TOOLS application for dedicated DSP hardware developed at the [https://www.kfs.oeaw.ac.at Acoustics Research Institute] in the 1980s. This documentation is work in progress and by no means complete. If you fail to find something you need, please [[Contact|get in touch]] with the development team.

=== Using {{STx}} ===

* [[User_Guide|User Guide]]

=== {{STx}} Programming ===

* [[Programmer_Guide/STx_Guru|Starting with {{STx}} Programming]]
* [[Programmer_Guide|Programmer Guide]]
* [[Programmer_Guide/Quick_Reference|Quick Reference]]

=== About {{STx}} {{VERSION}} ===

* Platform: runs on Windows Vista and higher
* [[History of Changes]]
* [[Known Bugs]]
* [[Feature Requests]]
* [[Contact]]
* [[Running STx under Linux or macOS]]

=== Download ===

[https://www.kfs.oeaw.ac.at/pub/stx/stx-4.4.10.9712-freeware.exe STx 4.4.10]

[https://www.kfs.oeaw.ac.at/pub/stx/ older releases]

==MediaWiki Links==
* [[STx Documentation Style Guide|Style guide]] for documenting {{STx}} in this wiki.
* Consult the [http://meta.wikimedia.org/wiki/Help:Contents User's Guide] for information on using the wiki software.
* [http://www.mediawiki.org/wiki/Manual:Configuration_settings Configuration settings list]
* [http://www.mediawiki.org/wiki/Manual:FAQ MediaWiki FAQ]
* [https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce MediaWiki release mailing list]
__NOTOC__

Category:Shell Item

2019-01-23T13:31:30Z

Christian: Created blank page

2017-11-20T17:39:32Z

Christian:

{{DISPLAYTITLE:{{SUBPAGENAME}}}}
{{User Guide}}
==Organise your sound files==

{{STX}} can play, analyse, annotate and modify wave files. The main application - the [[User_Guide/Workspace|Workspace]] - is where you load your sound files and start your analysis from. Your sound files are organised in a [[User_Guide/Project|project]] file. You can use the [[User_Guide/FindFile|FindFile]] application to search for wave files on disk and import them into {{STX}}.

==Analyse a Signal==

There are a number of applications for analysing signals in {{STX}}.

* [[User_Guide/Real_Time_Analyser|Real-Time Analyser]] - analyse the current sound input as a spectrum, wave or spectrogram graph
* [[User Guide/Waveform and Segmentation Viewer|Waveform and Segmentation Viewer]] - useful for segmenting signals
* [[User Guide/Spectrogram and Parameter Viewer|Spectrogram and Parameter Viewer]] - calculate, edit and extract parameters from the signal. Segmentation is also easy here.
* [[User Guide/Spectrum Viewer]] - average the spectra of a signal segment.
* [[User Guide/Transcription Script|SPExL]] - an application specifically designed for segmentation.

==Record a Signal==

The [[/Recorder/]] can be used to save an input stream to disk and whilst segmenting it on the fly.

==Command-Line Parameters==

There is a minimal set of [[/Command-Line Parameters/|command line parameters]] which can be passed to {{STX}}.

==Tutorials==

There are a few tutorials available [[/Tutorials/|here]].

==Scripts, Development, and Extending {{STX}}==

{{STX}} comes with a number of [[/Pre-installed scripts|pre-installed scripts]] - applications written in the {{STX}} scripting language, and loaded and run from a text file. You can write your own {{STX}} scripts, [[/Toolbox/|toolboxes]] and applications. All the functionality that you find in {{STX}} is available to you in the script language. The [[/The_Script_Controller|script controller]] dialog, the [[/STX_Console|command line console]], the integrated [[/Debugger/|debugger]] and the [[Programmer Guide]] will help you.

==The Log Window==
The little window up on the left hand corner of the screen is the {{STX}} [[/Log Window/]]. You can start a number of applications from here, change some general {{STX}} settings, and view the log messages.

2014-05-08T13:20:09Z

Christian:

{{DISPLAYTITLE:{{STX|caps}} {{SUBPAGENAME}}}}
The command reference documents all the commands available in the {{STX}} macro language. This is with the notable exception of the {{Stx}} shell item commands, which are documented in the chapter [[Programmer_Guide/Shell_Items|Shell Items]].

Each {{STx}} command generates both a ''result value'' (the return value of the command) and a ''completion code'', the latter indicating success or failure of the command. The completion code is stored in the shell variables <var>RC</var> (a numerical error or warning code, 0 indicating success) and <var>EMSG</var> (textual error message according to value of <var>RC</var>).

;Notes:
:* You should make it a habit to always end the list of options with the [[Programmer_Guide/Command_Reference_Options/-|"end of options" option, <code>/-</code>]] (q.v.) because, otherwise, you will get into trouble when command arguments start with a slash.
:*Most commands overwrite the variables <var>RC</var> and <var>EMSG</var>. There are a few commands, though, which touch <var>RC</var> and <var>EMSG</var> only if an execution error occours. The most prominent commands in the latter group are [[/IF|IF]] and [[/GOTO|GOTO]] and, actually, most other control commands.
:* Some commands return the completion code also as their return value.
:* In contrast to commands, ''macros'' store their return value (generated with the [[/EXIT|EXIT]] command) in the variable <var>RESULT</var>, meaning that macro calls do not affect the variables <var>RC</var> and <var>EMSG</var>.

;See also: [[Programmer_Guide/Introduction|Introduction]], [[Programmer_Guide/Shell_Items|shell items]]

== {{STx|caps}} commands (alphabetical list) ==
<splist
parent=Programmer_Guide/Command_Reference
sort=asc
sortby=title
showpath=no
liststyle=bar
kidsonly=yes
></splist>

== Common {{STX}} options ==
<splist
parent=Programmer_Guide/Command_Reference_Options
sort=asc
sortby=title
showpath=no
liststyle=unordered
kidsonly=yes
></splist>