Programmer Guide/Macro Library/BSF - Revision history

Jw: /* Open */

2018-09-19T10:12:34Z

Open

← Older revision		Revision as of 12:12, 19 September 2018
Line 84:		Line 84:
	==Open==		==Open==
	BSF OPEN <var>path</var> [ ; <var>mode</var> ; <var>srate</var> [ ; <var>nch</var> ; <var>code</var> ; <var>type</var> ; <var>offset</var> ]		BSF OPEN <var>path</var> [ ; <var>mode</var> ; <var>srate</var> [ ; <var>nch</var> ; <var>code</var> ; <var>type</var> ; <var>offset</var> ]
	:Create and/or open a ~~soundfile~~.		:Create and/or open a sound file.
	{\|class="einrahmen"		{\|class="einrahmen"
	!argument !!description !!default		!argument !!description !!default
	\|-		\|-
	\|<var>path</var>		\|<var>path</var>
	\|Path of the ~~soundfile~~ to be opened or created.<BR>Note: If the asterisk '''*''' is used for <var>path</var>, an unique ~~soundfile~~ is '''created''' in the temp. directory (<code>@TempDir</code>).		\|Path of the sound file to be opened or created.<BR>Note: If the asterisk '''*''' is used for <var>path</var>, an unique sound file is '''created''' in the temp. directory (<code>@TempDir</code>).
	\|		\|
	\|-		\|-
	\|<var>mode</var>		\|<var>mode</var>
	\|<code>CREATE</code> → Create a new ~~soundfile~~. If the file <var>path</var> exists, it is replaced by the new ~~soundfile~~.<BR>		\|<code>CREATE</code> → Create a new sound file. If the file <var>path</var> exists, it is replaced by the new sound file.<BR>
	<code>READ</code> → Open an existing ~~soundfile~~ for readonly-access.<BR>		<code>READ</code> → Open an existing sound file for readonly-access.<BR>
	<code>WRITE</code> → Open a ~~soundfile~~ for read- and write-access. The file is created if it do not exist!<BR>		<code>WRITE</code> → Open a sound file for read- and write-access. The file is created if it do not exist!<BR>
	<code>AUTO</code> → Open a ~~soundfile~~ and select the access type automatically (try read/write first and than readonly).		<code>AUTO</code> → Open a sound file and select the access type automatically (try read/write first and than readonly).
	\|<code>WRITE</code>		\|<code>WRITE</code>
	\|-		\|-
Line 121:		Line 121:
	\|-		\|-
	\|<var>offset</var>		\|<var>offset</var>
	\|The size of the header of a plain binary ~~soundfile~~.		\|The size of the header of a plain binary sound file.
	\|<code>0</code>.		\|<code>0</code>.
	\|-		\|-
	!RESULT !!description		!RESULT !!description
	\|-		\|-
	\|<code>0</code> \|\|The ~~soundfile~~ was successfully selected, opened or created.		\|<code>0</code> \|\|The sound file was successfully selected, opened or created.
	\|-		\|-
	\|≠ <code>0</code> \|\|It is not the case that the ~~soundfile~~ was successfully selected, opened or created.<BR>		\|≠ <code>0</code> \|\|It is not the case that the sound file was successfully selected, opened or created.<BR>
	<code>-2</code> → can not assign unique tempfile name<BR>		<code>-2</code> → can not assign unique tempfile name<BR>
	<code>-3</code> → sampling rate out of range<BR>		<code>-3</code> → sampling rate out of range<BR>
Line 136:		Line 136:
	\|}		\|}
	;Notes:		;Notes:
	*If a ~~soundfile~~ is already opened, it is selected and its open-counter is incremented. The variables <code>CSF</code> and <code>CSFH</code> contain the full path and the header parameters of the ~~soundfile~~.		*If a sound file is already opened, it is selected and its open-counter is incremented. The variables <code>CSF</code> and <code>CSFH</code> contain the full path and the header parameters of the sound file.
	*If a ~~soundfile~~ is opened the first time, the open-counter is set to 1.		*If a sound file is opened the first time, the open-counter is set to 1.
	*This function updates the shared ~~soundfile~~ table (<code>SoundFileList</code>) and the table <code>BSFOpenList</code> (if called in a [[Programmer_Guide/BScript\|BScript]] application)		*This function updates the shared sound file table (<code>SoundFileList</code>) and the table <code>BSFOpenList</code> (if called in a [[Programmer_Guide/BScript\|BScript]] application)
	*The arguments <var>srate</var>, <var>nch</var>, <var>code</var> and <var>type</var> are only used if a new ~~soundfile~~ is created (<var>mode</var> equals <code>CREATE</code>, <code>WRITE</code> or <code>AUTO</code>) or if the <var>type</var> <code>BINARY</code> is used. If an existing ~~soundfile~~ with a known header format is opened, these parameters are read from the ~~soundfile~~ header.		*The arguments <var>srate</var>, <var>nch</var>, <var>code</var> and <var>type</var> are only used if a new sound file is created (<var>mode</var> equals <code>CREATE</code>, <code>WRITE</code> or <code>AUTO</code>) or if the <var>type</var> <code>BINARY</code> is used. If an existing sound file with a known header format is opened, these parameters are read from the sound file header.
	*If a ~~soundfile~~ of type <code>BINARY</code> is opened, the ~~soundfile~~ parameters <var>srate</var>, <var>nch</var> and <var>code</var> must always be specified, because the format and content of the (optional) header of such files is not known. The header of binary files must be located at the file begin and must consist of <var>offset</var> (≥ 0) bytes. If a binary file is created, no header is written and <var>offset</var> must be <code>0</code>.		*If a sound file of type <code>BINARY</code> is opened, the sound file parameters <var>srate</var>, <var>nch</var> and <var>code</var> must always be specified, because the format and content of the (optional) header of such files is not known. The header of binary files must be located at the file begin and must consist of <var>offset</var> (≥ 0) bytes. If a binary file is created, no header is written and <var>offset</var> must be <code>0</code>.

	==Close==		==Close==

Toni at 08:25, 29 January 2016

2016-01-29T08:25:09Z

← Older revision		Revision as of 10:25, 29 January 2016
Line 18:		Line 18:
	\|<code>@TempDir</code> \|\|variable \|\|directory for temporary files		\|<code>@TempDir</code> \|\|variable \|\|directory for temporary files
	\|-		\|-
	\|<code>BSFOpenList</code> \|\|table item \|\|list of open soundfiles (only for [[Programmer_Guide/BScript\|BScript]] applications);		\|<code>BSFOpenList</code> \|\|table item \|\|list of open soundfiles (only for [[Programmer_Guide/BScript\|BScript]] applications); this table is used by the functions [[#Open\|Open]], [[#Close\|Close]] and [[#CloseAll\|CloseAll]]
	this table is used by the functions [[#Open\|Open]], [[#Close\|Close]] and [[#CloseAll\|CloseAll]]
	\|-		\|-
	\|<code>SoundFileList</code> \|\|variable \|\|name of the shared soundfile table item (see [[../BSTXIni\|BSTXIni]]); the following information is stored in the table fields:<BR>		\|<code>SoundFileList</code> \|\|variable \|\|name of the shared soundfile table item (see [[../BSTXIni\|BSTXIni]]); the following information is stored in the table fields:<BR>

Toni at 08:24, 29 January 2016

2016-01-29T08:24:09Z

← Older revision		Revision as of 10:24, 29 January 2016
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}} - Soundfile Handling}}		{{DISPLAYTITLE:{{SUBPAGENAME}} - Soundfile Handling}}
	:'''File''': BSF.STX, linked to library STX.LIB		:'''File''': BSF.STX, linked to library STX.LIB
	:'''See also''': [[Programmer_Guide/Command_Reference/LOAD#LOAD_SOUNDFILE\|LOAD SOUNDFILE]], [[Programmer_Guide/Command_Reference/UNLOAD#UNLOAD_SOUNDFILE\|UNLOAD SOUNDFILE]],[[Programmer_Guide/Command_Reference/SFTRUNCATE\|SFTRUNCATE]], [[Programmer_Guide/Command_Reference/SEGMENT\|SEGMENT]], [[Programmer_Guide/Shell_Items/Wave\|WAVE items]]		:'''See also''': [[Programmer_Guide/Command_Reference/LOAD#LOAD_SOUNDFILE\|LOAD SOUNDFILE]], [[Programmer_Guide/Command_Reference/UNLOAD#UNLOAD_SOUNDFILE\|UNLOAD SOUNDFILE]],[[Programmer_Guide/Command_Reference/SFTRUNCATE\|SFTRUNCATE]], [[Programmer_Guide/Command_Reference/SEGMENT\|SEGMENT]], [[Programmer_Guide/Shell_Items/Wave\|WAVE items]]
	==Variables and items used by this library==		==Variables and items used by this library==
	:{\|class="einrahmen"		:{\|class="einrahmen"

Toni at 08:22, 29 January 2016

2016-01-29T08:22:46Z

← Older revision		Revision as of 10:22, 29 January 2016
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}} - Soundfile Handling}}		{{DISPLAYTITLE:{{SUBPAGENAME}} - Soundfile Handling}}
	'''File''': BSF.STX, linked to library STX.LIB		:'''File''': BSF.STX, linked to library STX.LIB
	'''See also''': [[Programmer_Guide/Command_Reference/LOAD#LOAD_SOUNDFILE\|LOAD SOUNDFILE]], [[Programmer_Guide/Command_Reference/UNLOAD#UNLOAD_SOUNDFILE\|UNLOAD SOUNDFILE]],[[Programmer_Guide/Command_Reference/SFTRUNCATE\|SFTRUNCATE]], [[Programmer_Guide/Command_Reference/SEGMENT\|SEGMENT]], [[Programmer_Guide/Shell_Items/Wave\|WAVE items]]		:'''See also''': [[Programmer_Guide/Command_Reference/LOAD#LOAD_SOUNDFILE\|LOAD SOUNDFILE]], [[Programmer_Guide/Command_Reference/UNLOAD#UNLOAD_SOUNDFILE\|UNLOAD SOUNDFILE]],[[Programmer_Guide/Command_Reference/SFTRUNCATE\|SFTRUNCATE]], [[Programmer_Guide/Command_Reference/SEGMENT\|SEGMENT]], [[Programmer_Guide/Shell_Items/Wave\|WAVE items]]
	==Variables and items used by this library==		==Variables and items used by this library==
	:{\|class="einrahmen"		:{\|class="einrahmen"

Toni at 08:22, 29 January 2016

2016-01-29T08:22:19Z

← Older revision		Revision as of 10:22, 29 January 2016
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}} - Soundfile Handling}}		{{DISPLAYTITLE:{{SUBPAGENAME}} - Soundfile Handling}}
	'''File''': BSF.STX, linked to library STX.LIB		'''File''': BSF.STX, linked to library STX.LIB
	~~----~~		'''See also''': [[Programmer_Guide/Command_Reference/LOAD#LOAD_SOUNDFILE\|LOAD SOUNDFILE]], [[Programmer_Guide/Command_Reference/UNLOAD#UNLOAD_SOUNDFILE\|UNLOAD SOUNDFILE]],[[Programmer_Guide/Command_Reference/SFTRUNCATE\|SFTRUNCATE]], [[Programmer_Guide/Command_Reference/SEGMENT\|SEGMENT]], [[Programmer_Guide/Shell_Items/Wave\|WAVE items]]
	~~;Content:~~
	[[#NewDialog\|NewDialog]] · [[#OpenDialog\|OpenDialog]] · [[#Open\|Open]] · [[#Close\|Close]] · [[#CloseAll\|CloseAll]] · [[#Select\|Select]] · [[#Truncate\|Truncate]]

	;See also: [[Programmer_Guide/Command_Reference/LOAD#LOAD_SOUNDFILE\|LOAD SOUNDFILE]], [[Programmer_Guide/Command_Reference/UNLOAD#UNLOAD_SOUNDFILE\|UNLOAD SOUNDFILE]],[[Programmer_Guide/Command_Reference/SFTRUNCATE\|SFTRUNCATE]], [[Programmer_Guide/Command_Reference/SEGMENT\|SEGMENT]], [[Programmer_Guide/Shell_Items/Wave\|WAVE items]]
	==Variables and items used by this library==		==Variables and items used by this library==
	:{\|class="einrahmen"		:{\|class="einrahmen"

Toni at 08:21, 29 January 2016

2016-01-29T08:21:27Z

← Older revision		Revision as of 10:21, 29 January 2016
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}} - Soundfile Handling}}~~__NOTOC__~~		{{DISPLAYTITLE:{{SUBPAGENAME}} - Soundfile Handling}}
	'''File''': BSF.STX, linked to library STX.LIB		'''File''': BSF.STX, linked to library STX.LIB
	----		----
	;Content: [[#NewDialog\|NewDialog]] · [[#OpenDialog\|OpenDialog]] · [[#Open\|Open]] · [[#Close\|Close]] · [[#CloseAll\|CloseAll]] · [[#Select\|Select]] · [[#Truncate\|Truncate]]		;Content:
			[[#NewDialog\|NewDialog]] · [[#OpenDialog\|OpenDialog]] · [[#Open\|Open]] · [[#Close\|Close]] · [[#CloseAll\|CloseAll]] · [[#Select\|Select]] · [[#Truncate\|Truncate]]

	;See also: [[Programmer_Guide/Command_Reference/LOAD#LOAD_SOUNDFILE\|LOAD SOUNDFILE]], [[Programmer_Guide/Command_Reference/UNLOAD#UNLOAD_SOUNDFILE\|UNLOAD SOUNDFILE]],[[Programmer_Guide/Command_Reference/SFTRUNCATE\|SFTRUNCATE]], [[Programmer_Guide/Command_Reference/SEGMENT\|SEGMENT]], [[Programmer_Guide/Shell_Items/Wave\|WAVE items]]		;See also: [[Programmer_Guide/Command_Reference/LOAD#LOAD_SOUNDFILE\|LOAD SOUNDFILE]], [[Programmer_Guide/Command_Reference/UNLOAD#UNLOAD_SOUNDFILE\|UNLOAD SOUNDFILE]],[[Programmer_Guide/Command_Reference/SFTRUNCATE\|SFTRUNCATE]], [[Programmer_Guide/Command_Reference/SEGMENT\|SEGMENT]], [[Programmer_Guide/Shell_Items/Wave\|WAVE items]]

Toni at 07:49, 29 January 2016

2016-01-29T07:49:20Z

← Older revision		Revision as of 09:49, 29 January 2016
Line 4:		Line 4:
	;Content: [[#NewDialog\|NewDialog]] · [[#OpenDialog\|OpenDialog]] · [[#Open\|Open]] · [[#Close\|Close]] · [[#CloseAll\|CloseAll]] · [[#Select\|Select]] · [[#Truncate\|Truncate]]		;Content: [[#NewDialog\|NewDialog]] · [[#OpenDialog\|OpenDialog]] · [[#Open\|Open]] · [[#Close\|Close]] · [[#CloseAll\|CloseAll]] · [[#Select\|Select]] · [[#Truncate\|Truncate]]

	;See also: [[Programmer_Guide/Command_Reference/LOAD#LOAD_SOUNDFILE\|LOAD SOUNDFILE]], [[Programmer_Guide/Command_Reference/UNLOAD#UNLOAD_SOUNDFILE\|UNLOAD SOUNDFILE]],[[Programmer_Guide/Command_Reference/SFTRUNCATE\|SFTRUNCATE]], [[Programmer_Guide/Shell_Items/WAVE]]		;See also: [[Programmer_Guide/Command_Reference/LOAD#LOAD_SOUNDFILE\|LOAD SOUNDFILE]], [[Programmer_Guide/Command_Reference/UNLOAD#UNLOAD_SOUNDFILE\|UNLOAD SOUNDFILE]],[[Programmer_Guide/Command_Reference/SFTRUNCATE\|SFTRUNCATE]], [[Programmer_Guide/Command_Reference/SEGMENT\|SEGMENT]], [[Programmer_Guide/Shell_Items/Wave\|WAVE items]]

	==Variables and items used by this library==		==Variables and items used by this library==
	:{\|class="einrahmen"		:{\|class="einrahmen"

Toni at 07:47, 29 January 2016

2016-01-29T07:47:38Z

← Older revision		Revision as of 09:47, 29 January 2016
Line 4:		Line 4:
	;Content: [[#NewDialog\|NewDialog]] · [[#OpenDialog\|OpenDialog]] · [[#Open\|Open]] · [[#Close\|Close]] · [[#CloseAll\|CloseAll]] · [[#Select\|Select]] · [[#Truncate\|Truncate]]		;Content: [[#NewDialog\|NewDialog]] · [[#OpenDialog\|OpenDialog]] · [[#Open\|Open]] · [[#Close\|Close]] · [[#CloseAll\|CloseAll]] · [[#Select\|Select]] · [[#Truncate\|Truncate]]

	;See also: ~~command~~ [[Programmer_Guide/Command_Reference/LOAD#LOAD_SOUNDFILE\|LOAD SOUNDFILE]], ~~command~~ [[Programmer_Guide/Command_Reference/SFTRUNCATE\|SFTRUNCATE]]		;See also: [[Programmer_Guide/Command_Reference/LOAD#LOAD_SOUNDFILE\|LOAD SOUNDFILE]], [[Programmer_Guide/Command_Reference/UNLOAD#UNLOAD_SOUNDFILE\|UNLOAD SOUNDFILE]],[[Programmer_Guide/Command_Reference/SFTRUNCATE\|SFTRUNCATE]], [[Programmer_Guide/Shell_Items/WAVE]]

	==Variables and items used by this library==		==Variables and items used by this library==

Toni at 07:45, 29 January 2016

2016-01-29T07:45:13Z

← Older revision		Revision as of 09:45, 29 January 2016
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}__NOTOC__		{{DISPLAYTITLE:{{SUBPAGENAME}} - Soundfile Handling}}__NOTOC__
	*'''File''': BSF.STX, linked to library STX.LIB		'''File''': BSF.STX, linked to library STX.LIB
	*'''Title''': soundfile handling
	----		----
	;Content: [[#NewDialog\|NewDialog]] · [[#OpenDialog\|OpenDialog]] · [[#Open\|Open]] · [[#Close\|Close]] · [[#CloseAll\|CloseAll]] · [[#Select\|Select]] · [[#Truncate\|Truncate]]		;Content: [[#NewDialog\|NewDialog]] · [[#OpenDialog\|OpenDialog]] · [[#Open\|Open]] · [[#Close\|Close]] · [[#CloseAll\|CloseAll]] · [[#Select\|Select]] · [[#Truncate\|Truncate]]

Toni: /* Truncate */

2016-01-29T07:42:53Z

Truncate

← Older revision		Revision as of 09:42, 29 January 2016
Line 217:		Line 217:

	==Truncate==		==Truncate==
	~~====<code>~~BSF TRUNCATE <var>path</var> ~~; <var>segexp</var> [ ; <var>afileref</var> ]</code>====~~		BSF TRUNCATE <var>path</var>\|<var>index</var> ; <var>segexp</var> [ ; <var>afileref</var> ]
	~~====<code>BSF TRUNCATE~~ <var>index</var> ; <var>segexp</var> [ ; <var>afileref</var> ]~~</code>====~~
	:Truncate the specified soundfile. Remove the signal outside the range specified by <var>segexp</var> from the soundfile.		:Truncate the specified soundfile. Remove the signal outside the range specified by <var>segexp</var> from the soundfile.
	{\|class="einrahmen"		{\|class="einrahmen"