Difference between revisions of "Component: Speech (Phoneme) (Audio Output)"

Revision as of 11:07, 17 November 2021

Author	Matrix Ltd
Version	1.2
Category	Audio Output

Speech (Phoneme) component

Speech component allowing Phoneme based speech for use on an embedded platform. The simulation also has an advanced speech engine allowing realistic text to speech in multiple languages using the RealSpeak voice engine.

Detailed description

No detailed description exists yet for this component

Examples

Example of Phoneme Speech (download and simulation) Speech The Phoneme based speech can be output on Microcontroller hardware using a number of methods.

PWM - Outputs using a single PWM pin, a simple external RC low pass filter can be used to remove the high frequency PWM to create an audio signal.

Parallel - Outputs using a 8-bit port, a simple 8-bit R2R DAC circuit can be used to combine the bits into an audio signal.

Other - A third option is to use the ReadByteFromPhoneme macro to pull out the phoneme values a byte at a time which can be used to pass on to an external DAC etc.

Another example of Phoneme Speech, taking a reading from an analogue channel and speaking the Voltage. (download and simulation) Talking Volt Meter Example of Real Speak Speech (simulation only) Speech2 Adding additional language packs to the Real Speak engine.

Real Speak Voice Downloads

Downloadable macro reference

	ReadPhonemeLength
Function to return the number of bytes used in a single phoneme array.
- STRING	Phoneme
Specifies a single Phoneme
- UINT	Return

	EnableOutput
Sets up the output to allow the speech data to be streamed out.
- VOID	Return

	DisableOutput
Disables the output to prevent any buzzing etc while not speaking.
- VOID	Return

	ReadByteFromPhoneme
Reads a single byte value from the specified phoneme data array. This function will not simulate correctly as it requires C style pointers.
- STRING	Phoneme
Specifies a single Phoneme
- UINT	Idx
Specifies the position within the Phoneme
- BYTE	Return

	OutputPhoneme
Streams a single Phoneme or string of comma seperated Phonemes. OutputPhoneme("OY") OutputPhoneme("OY,AY,OY")
- STRING	DataString

- VOID	Return

Property reference

	Properties
	Phoneme Selection
Selects which phonemes are included in the embedded firmware
	Phoneme Data Set
Specifies if the phonemes used are based on the inbuilt phoneme wav files set or a custom file set. To create your own phonemes, copy the wav files from the components directory, then overwrite the phonemes you wish to edit. Phonemes are re-parsed on simulation start and on compile to C.
	Pitch (Hz)
The frequency at which the phoneme data is output in bytes/samples per second.
	Phoneme Data Size
The number of bytes used by the current phoneme selection
	ROM Size
The maximum number of bytes available in the ROM of the selected target device. The ROM has to contain the program as well as the Phoneme data.
	Base ROM Address
The address in ROM to place the phoneme data. It is recomended to always use the suggested address as this will place the phonemes right at the end of ROM and away from the program.
	Suggested Address
The ideal address to allow all the selected phonemes to fit into the end of the ROM memory Thereby allowing the maximum space for the user program.
	Output Mode
Determines how the phoneme data is going to be output.
	PWM Pin
PWM channel selection used to determine which PWM peripheral to stream the Phoneme data to.
	PWM Pin
The actual port pin assigned to the selected PWM channel.
	Word Dictionary

	Phonemes

	Word Count

	Add

	Word

	Phonemes

	Delete All

	Select All
Selects all Phonemes
	Select None
Deselects all Phonemes
	PA1 (10ms)
10ms Pause - Always included
	PA2 (30ms)
30ms Pause - Always included
	PA3 (50ms)
50ms Pause - Always included
	PA4 (100ms)
100ms Pause - Always included
	PA5 (200ms)
200ms Pause - Always included
	AA - hOt
Phoneme selection
	AE - hAt
Phoneme selection
	AO - AUght
Phoneme selection
	AR - alARm
Phoneme selection
	AW - sOUnd
Phoneme selection
	AX - Apple
Phoneme selection
	AY - skY
Phoneme selection
	BB1 - Brown
Phoneme selection
	BB2 - Business
Phoneme selection
	CH - CHurCH
Phoneme selection
	DD1 - enD
Phoneme selection
	DD2 - Down
Phoneme selection
	DH1 - THey
Phoneme selection
	DH2 - baTHe
Phoneme selection
	EH - Extent
Phoneme selection
	EL - angLE
Phoneme selection
	ER1 - intERupt
Phoneme selection
	ER2 - bIRd
Phoneme selection
	EY - grEAt
Phoneme selection
	FF - Food
Phoneme selection
	GG1 - Get
Phoneme selection
	GG2 - Green
Phoneme selection
	GG3 - anGer
Phoneme selection
	HH1 - Help
Phoneme selection
	HH2 - Hope
Phoneme selection
	IH - sIt
Phoneme selection
	IY - trEAt
Phoneme selection
	JH - inJure
Phoneme selection
	KK1 - Clown
Phoneme selection
	KK2 - tasK
Phoneme selection
	KK3 - Crane
Phoneme selection
	LL - Lake
Phoneme selection
	MM - Milk
Phoneme selection
	NG - aNGer
Phoneme selection
	NN1 - thiN
Phoneme selection
	NN2 - Now
Phoneme selection
	OR - stORe
Phoneme selection
	OW - zOne
Phoneme selection
	OY - nOIse
Phoneme selection
	PP - triP
Phoneme selection
	RR1 - WRite
Phoneme selection
	RR2 - gRease
Phoneme selection
	SH - SHip
Phoneme selection
	SS - teSt
Phoneme selection
	TH - THin
Phoneme selection
	TT1 - tesT
Phoneme selection
	TT2 - Test
Phoneme selection
	UH - bOOk
Phoneme selection
	UW1 - cumpUter
Phoneme selection
	UW2 - fOOd
Phoneme selection
	VV - Vest
Phoneme selection
	WH - WHite
Phoneme selection
	WW - Work
Phoneme selection
	XR - haiR
Phoneme selection
	YR - clEAR
Phoneme selection
	YY1 - compUter
Phoneme selection
	YY2 - Yes
Phoneme selection
	ZH - aZure
Phoneme selection
	ZZ - phaSe
Phoneme selection
	Connections
	Simulations

Difference between revisions of "Component: Speech (Phoneme) (Audio Output)"

Revision as of 11:07, 17 November 2021

Contents

Speech (Phoneme) component

Detailed description

Examples

Downloadable macro reference

Property reference

Navigation menu

Page actions

Page actions

Personal tools

Navigation

Search

Tools

@@ Line 16: / Line 16: @@
 ==Detailed description==
@@ Line 22: / Line 24: @@
 ==Examples==
@@ Line 129: / Line 133: @@
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
-|}
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetConsoleHandle'''
-|-
-| colspan="2" | Gets the handle to the console allowing data displaying on the panel etc.&nbsp;
-|-
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:]] -
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
-|}
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SendByteArray'''
-|-
-| colspan="2" | Sends an array of bytes to the COM port.&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Data
-|-
-| colspan="2" | Data byte array to send&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
-| width="90%" | Length
-|-
-| colspan="2" | Number of bytes to send&nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
-|}
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReceiveBinary16Bit'''
-|-
-| colspan="2" | Receives a binary 16-bit value split across two bytes.&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:]] -
-| width="90%" | MSBfirst
-|-
-| colspan="2" | 0=Least significant byte first, 1=Most significant byte first&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Timeout
-|-
-| colspan="2" | Max amount of time in ms to wait between bytes&nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
-|}
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReceiveFloat'''
-|-
-| colspan="2" | Attempts to receive a floating point number as ASCII characters and convert back into a numeric value. Note this function will receive until a timeout or a none numeric char is received, the none numeric char will be lost.&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Timeout
-|-
-| colspan="2" | Max time in ms to wait in between bytes&nbsp;
-|-
-| width="10%" align="center" | [[File:]] -
-| width="90%" | IgnoreData
-|-
-| colspan="2" | 0=Dont ignore any data, 1=Ignore any initial none numeric data&nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:]] -
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
-|}
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SendFloat'''
-|-
-| colspan="2" | Sends out a floating point number as an ASCII String from the UART interface.&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:]] -
-| width="90%" | Number
-|-
-| colspan="2" | &nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
-|}
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SendHexNumber'''
-|-
-| colspan="2" | Sends out a number as an ASCII hexadecimal String from the UART interface.&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
-| width="90%" | Number
-|-
-| colspan="2" | &nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | NumChars
-|-
-| colspan="2" | Number of characters in the string data, 0 for auto, 2 for 0x00, 4 for 0x0000&nbsp;
-|-
-| width="10%" align="center" | [[File:]] -
-| width="90%" | Prefix
-|-
-| colspan="2" | Generate hexadecimal prefix 0x e.g. 1= 0xFF, 0= FF&nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
-|}
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetFlowControl'''
-|-
-| colspan="2" | Allows the Flowcontrol signals to be enabled or disabled.&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | State
-|-
-| colspan="2" | A value of 0 disables flow control, 1 or above willl enable flow control.&nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
-|}
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''OpenPort'''
-|-
-| colspan="2" | Opens the currently selected COM port, allowing data to be sent and received.&nbsp;
-|-
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
-|}
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReceiveHexNumber'''
-|-
-| colspan="2" | Attempts to receive a hex number as ASCII characters and convert back into a numeric value. Note this function will receive until a timeout or a none hexadecimal char is received, the none numeric char will be lost.&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Timeout
-|-
-| colspan="2" | Max time in ms to wait in between bytes&nbsp;
-|-
-| width="10%" align="center" | [[File:]] -
-| width="90%" | IgnoreData
-|-
-| colspan="2" | 0=Dont ignore any data, 1=Ignore any initial none numeric data&nbsp;
-|-
-| width="10%" align="center" | [[File:]] -
-| width="90%" | Prefix
-|-
-| colspan="2" | Look for prefix before receiving, 1=0xFF, 0=FF&nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
-|}
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetProp'''
-|-
-| colspan="2" | Allows the COM port property to be set from a parent component.&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
-| width="90%" | PropName
-|-
-| colspan="2" | &nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
-| width="90%" | PropVal
-|-
-| colspan="2" | &nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
-|}
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SendBinary32Bit'''
-|-
-| colspan="2" | Sends out a 32-bit binary value split across four bytes.&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
-| width="90%" | Value
-|-
-| colspan="2" | &nbsp;
-|-
-| width="10%" align="center" | [[File:]] -
-| width="90%" | MSBfirst
-|-
-| colspan="2" | 0=Least significant byte first, 1=Most significant byte first&nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
-|}
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SendBinaryFloat'''
-|-
-| colspan="2" | Sends out a 32-bit binary floating point value split across four bytes.&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:]] -
-| width="90%" | Value
-|-
-| colspan="2" | &nbsp;
-|-
-| width="10%" align="center" | [[File:]] -
-| width="90%" | MSBfirst
-|-
-| colspan="2" | 0=Least significant byte first, 1=Most significant byte first&nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
-|}
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetProp'''
-|-
-| colspan="2" | Allows the property filter for the COM port list to be copied to a parent component.&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
-| width="90%" | PropName
-|-
-| colspan="2" | &nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
-|}
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReceiveByteArray'''
-|-
-| colspan="2" | Attempts to receive an array of bytes using the COM port Returns the number of bytes received. &nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Data
-|-
-| colspan="2" | &nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
-| width="90%" | MaxLength
-|-
-| colspan="2" | Max number of bytes to try and read&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
-| width="90%" | Timeout
-|-
-| colspan="2" | Time to wait for incoming data in milliseconds&nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
-|}
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReceiveString'''
-|-
-| colspan="2" | Attempts to receive an string using the COM port Returns the number of bytes received. &nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
-| width="90%" | Timeout
-|-
-| colspan="2" | Time to wait for incoming data in milliseconds&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
-| width="90%" | MaxLength
-|-
-| colspan="2" | Max number of bytes to try and read&nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
-|}
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PWMEnable'''
-|-
-| colspan="2" | Allows pulse width modulated transistor outputs to be switched on or off. Bit 0 = Enable AB Bit 1 = A / Bit 2 = B Bit 3 = C / Bit 4 = D Bit 5 = Enable CD&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | EnableMask
-|-
-| colspan="2" | Range 0-63 or 0b00000 to 0b111111&nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
-|}
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
-|-
-| colspan="2" | &nbsp;
-|-
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
-|}
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetProp'''
-|-
-| colspan="2" | Allows the property filter for the COM port list to be copied to a parent component.&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
-| width="90%" | PropName
-|-
-| colspan="2" | &nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}