Component: WAV Player ROM (File) - Revision history

Wiki bot at 13:13, 7 February 2023

2023-02-07T13:13:26Z

Wiki bot at 12:22, 3 February 2023

2023-02-03T12:22:30Z

Wiki bot at 12:03, 3 February 2023

2023-02-03T12:03:43Z

Wiki bot at 11:52, 3 February 2023

2023-02-03T11:52:57Z

Wiki bot at 16:50, 30 January 2023

2023-01-30T16:50:48Z

Show changes

Wiki bot at 10:00, 27 January 2023

2023-01-27T10:00:40Z

Wiki bot at 15:25, 20 January 2023

2023-01-20T15:25:16Z

Wiki bot at 15:17, 20 January 2023

2023-01-20T15:17:42Z

Wiki bot at 14:13, 20 January 2023

2023-01-20T14:13:57Z

Wiki bot: Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Matrix TSL |- | width="20%" style="color:gray;" | Version | 1.0 |- | width="20%" style="color:gray..."

2023-01-16T14:43:32Z

Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Matrix TSL |- | width="20%" style="color:gray;" | Version | 1.0 |- | width="20%" style="color:gray..."

New page

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| Matrix TSL
|-
| width="20%" style="color:gray;" | Version
| 1.0
|-
| width="20%" style="color:gray;" | 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 for the component source code: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_WAV_Player.fcfx FC_Comp_Source_WAV_Player.fcfx]

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

''<span style="color:red;">No additional examples</span>''

==Downloadable macro reference==

{| 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;" | '''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. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
| width="90%" | Pointer
|-
| colspan="2" | Range: 0x0 to 0xFFFFFFFF, 0 = Beginning of file 
|-
| 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;" | '''EndOfFile'''
|-
| 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. 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
| 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;" | '''GetNumChannels'''
|-
| colspan="2" | Returns the number of audio channels stored in the WAV file. 
|-
|-
| 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''
|}

{| 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;" | '''GetBitsPerSample'''
|-
| colspan="2" | Returns the number of bits per sample. 
|-
|-
| 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''
|}

{| 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;" | '''GetNextSample'''
|-
| 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. 
|-
|-
| 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''
|}

==Property reference==

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
|-
|-
| width="10%" align="center" | [[File:Fc9-type-13-icon.png]]
| width="90%" | WAV File
|-
| colspan="2" | WAV File to Embed into the ROM Flash memory. 
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | File Status
|-
| colspan="2" | Displays diagnostic data about the selected file. 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Num Channels
|-
| colspan="2" | Number of audio channels encoded in the WAV file. 1 indicates a MONO audio stream. 2 indicates a STEREO autio stream. 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Sample Rate
|-
| colspan="2" | The rate in samples per second at which the WAV file was recorded. 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Bits Per Sample
|-
| colspan="2" | The number of bits used to store a single sample. 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Byte Rate
|-
| colspan="2" | The number of data bytes per second that need to be processed in order to maintain playback. 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | ROM Bytes
|-
| colspan="2" | Number of bytes of ROM that will be required to store the WAV file. 
|}

@@ Line 17: / Line 17: @@
 ==Component Source Code==
-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 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 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]
+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]
 ==Detailed description==
@@ Line 52: / Line 52: @@
 ''<span style="color:red;">No additional examples</span>''

@@ Line 17: / Line 17: @@
 ==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==
@@ Line 52: / Line 52: @@
 ''<span style="color:red;">No additional examples</span>''
@@ Line 59: / Line 61: @@
 ==Macro reference==
-===SetFilePointer===
+===EndOfFile===
 {| 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;" | '''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%" style="border-top: 2px solid #000;" | ''Return''
 |}
-===EndOfFile===
+===GetBitsPerSample===
 {| 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;" | '''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''
 |}
-===GetNumChannels===
+===GetNextSample===
 {| 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;" | '''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''
 |}
-===GetBitsPerSample===
+===GetNumChannels===
 {| 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;" | '''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;"
 |-
 | 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" | 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="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''
 |}

@@ Line 20: / Line 20: @@
 ==Detailed description==
@@ Line 26: / Line 28: @@
 ==Examples==
@@ Line 31: / Line 35: @@
 ''<span style="color:red;">No additional examples</span>''
-==Downloadable macro reference==
+==Macro reference==
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"