Difference between revisions of "Component: WAV Player ROM (File)"

From Flowcode Help
Jump to navigationJump to search
Line 17: Line 17:
 
==Component Source Code==
 
==Component Source Code==
  
−
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_WAV_Player.fcfx FC_Comp_Source_WAV_Player.fcfx]
+
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_temp/WAV_Player.fcfx FC_Comp_Source_temp/WAV_Player.fcfx]
  
−
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_WAV_Player.fcfx FC_Comp_Source_WAV_Player.fcfx]
+
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_temp/WAV_Player.fcfx FC_Comp_Source_temp/WAV_Player.fcfx]
  
 
==Detailed description==
 
==Detailed description==
Line 52: Line 52:
  
 
''<span style="color:red;">No additional examples</span>''
 
''<span style="color:red;">No additional examples</span>''
 +
 +
  
  
Line 59: Line 61:
 
==Macro reference==
 
==Macro reference==
  
−
===SetFilePointer===
+
===EndOfFile===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetFilePointer'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''EndOfFile'''
 
|-
 
|-
−
| colspan="2" | Allows direct control of the file pointer. Write the file pointer to 0 to reset the pointer to the beginning of the file. Write the file pointer to 0xFFFFFFFF to force the pointer to the end of the file.&nbsp;
+
| colspan="2" | A simple check to see if we are at the end of the file. Returns 0 if we and not yet at the end fo the file. Returns 1 if we are at the end of the file.&nbsp;
 
|-
 
|-
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
−
| width="90%" | Pointer
 
−
|-
 
−
| colspan="2" | Range: 0x0 to 0xFFFFFFFF, 0 = Beginning of file&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''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
  
  
−
===EndOfFile===
+
===GetBitsPerSample===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''EndOfFile'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetBitsPerSample'''
 
|-
 
|-
−
| colspan="2" | A simple check to see if we are at the end of the file. Returns 0 if we and not yet at the end fo the file. Returns 1 if we are at the end of the file.&nbsp;
+
| colspan="2" | Returns the number of bits per sample.&nbsp;
 
|-
 
|-
 
|-
 
|-
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
  
  
−
===GetNumChannels===
+
===GetNextSample===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetNumChannels'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetNextSample'''
 
|-
 
|-
−
| colspan="2" | Returns the number of audio channels stored in the WAV file.&nbsp;
+
| colspan="2" | Retreives the value for the next sample and auto increments the file pointer. Ideally this function should be called as part of a timer interrupt at the sample rate. The value returned should be passed onto a means of analogue output e.g. a DAC or PWM.&nbsp;
 
|-
 
|-
 
|-
 
|-
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+
| 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''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
  
  
−
===GetBitsPerSample===
+
===GetNumChannels===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetBitsPerSample'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetNumChannels'''
 
|-
 
|-
−
| colspan="2" | Returns the number of bits per sample.&nbsp;
+
| colspan="2" | Returns the number of audio channels stored in the WAV file.&nbsp;
 
|-
 
|-
 
|-
 
|-
Line 120: Line 117:
  
  
−
===GetNextSample===
+
===SetFilePointer===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetNextSample'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetFilePointer'''
 +
|-
 +
| colspan="2" | Allows direct control of the file pointer. Write the file pointer to 0 to reset the pointer to the beginning of the file. Write the file pointer to 0xFFFFFFFF to force the pointer to the end of the file.&nbsp;
 +
|-
 
|-
 
|-
−
| colspan="2" | Retreives the value for the next sample and auto increments the file pointer. Ideally this function should be called as part of a timer interrupt at the sample rate. The value returned should be passed onto a means of analogue output e.g. a DAC or PWM.&nbsp;
+
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" | Pointer
 
|-
 
|-
 +
| colspan="2" | Range: 0x0 to 0xFFFFFFFF, 0 = Beginning of file&nbsp;
 
|-
 
|-
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
+
| 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''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}

Revision as of 12:03, 3 February 2023

Author Matrix TSL
Version 1.0
Category File


WAV Player ROM component

Stores an audio WAV file in ROM and contains component macros to allow the WAV file to be streamed out. Compatible with analogue outputs such as DAC or PWM.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_temp/WAV_Player.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_temp/WAV_Player.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples




Macro reference

EndOfFile

Fc9-comp-macro.png EndOfFile
A simple check to see if we are at the end of the file. Returns 0 if we and not yet at the end fo the file. Returns 1 if we are at the end of the file. 
Fc9-bool-icon.png - BOOL Return


GetBitsPerSample

Fc9-comp-macro.png GetBitsPerSample
Returns the number of bits per sample. 
Fc9-u8-icon.png - BYTE Return


GetNextSample

Fc9-comp-macro.png GetNextSample
Retreives the value for the next sample and auto increments the file pointer. Ideally this function should be called as part of a timer interrupt at the sample rate. The value returned should be passed onto a means of analogue output e.g. a DAC or PWM. 
Fc9-u16-icon.png - UINT Return


GetNumChannels

Fc9-comp-macro.png GetNumChannels
Returns the number of audio channels stored in the WAV file. 
Fc9-u8-icon.png - BYTE Return


SetFilePointer

Fc9-comp-macro.png SetFilePointer
Allows direct control of the file pointer. Write the file pointer to 0 to reset the pointer to the beginning of the file. Write the file pointer to 0xFFFFFFFF to force the pointer to the end of the file. 
Fc9-u32-icon.png - ULONG Pointer
Range: 0x0 to 0xFFFFFFFF, 0 = Beginning of file 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-13-icon.png WAV File
WAV File to Embed into the ROM Flash memory. 
Fc9-type-10-icon.png File Status
Displays diagnostic data about the selected file. 
Fc9-type-21-icon.png Num Channels
Number of audio channels encoded in the WAV file. 1 indicates a MONO audio stream. 2 indicates a STEREO autio stream. 
Fc9-type-21-icon.png Sample Rate
The rate in samples per second at which the WAV file was recorded. 
Fc9-type-21-icon.png Bits Per Sample
The number of bits used to store a single sample. 
Fc9-type-21-icon.png Byte Rate
The number of data bytes per second that need to be processed in order to maintain playback. 
Fc9-type-21-icon.png ROM Bytes
Number of bytes of ROM that will be required to store the WAV file. 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_WAV_Player_ROM_(File)&oldid=36897"