GoatTracker - Revision history

Mcassera: /* 3. Pitch and Timing (Important) */

2026-01-30T04:45:52Z

3. Pitch and Timing (Important)

← Older revision		Revision as of 00:45, 30 January 2026
Line 25:		Line 25:
	== 3. Pitch and Timing (Important) ==		== 3. Pitch and Timing (Important) ==

	Pitch and playback speed are '''separate settings'''.		Pitch and playback speed are '''related but separate settings'''.

	* Playback speed is controlled by PAL vs NTSC timing (50 Hz vs 60 Hz).		* '''Playback speed''' is controlled by PAL vs NTSC timing (50 Hz vs 60 Hz).
	* Pitch is controlled by the A-4 tuning value.		* '''Pitch''' is controlled by the A-4 tuning value.

	The F256K uses '''NTSC (60 Hz)''' timing.		The F256K uses '''NTSC (60 Hz)''' timing so Goattracker must be configured accordingly.

	---		---
Line 59:		Line 59:
	* '''A-4 = 454 Hz'''		* '''A-4 = 454 Hz'''

	~~Always~~ start GoatTracker with:		When packing a song, always start GoatTracker with the correct tuning and the song loaded at startup:

	<code>		<code>
Line 65:		Line 65:
	</code>		</code>

	'''Important:''' <code>.sng</code> files store tuning. Loading after startup will overwrite the setting.		'''Important:''' <code>.sng</code> files store tuning. Loading after startup will overwrite the setting and result in an incorrectly tuned packed file.

	---		---
Line 71:		Line 71:
	== 4. Packing the Song ==		== 4. Packing the Song ==

	Songs must be packed into a self-playing binary.		Songs must be packed into a self-playing binary for use on the F256.

	---		---
Line 79:		Line 79:
	* Press <code>F9</code> in GoatTracker.		* Press <code>F9</code> in GoatTracker.
	* Ensure it was started with <code>-G454</code> and the song loaded.		* Ensure it was started with <code>-G454</code> and the song loaded.
			The internal packer always uses the '''current tuning'''.

	---		---
Line 109:		Line 110:

	* <code>-Wxx</code> sets the high byte only		* <code>-Wxx</code> sets the high byte only
	** <code>-Wa0</code> = $A000		** Example:<code>-Wa0</code> = $A000
	* <code>-Zxx</code> uses two bytes		* <code>-Zxx</code> specifies the '''starting zeropage address'''
	** $80/$81 is tested and safe		** uses two bytes
	** Avoid $F0–$FF (kernel use)		*** $80/$81 is tested and safe
	* <code>-Wxx</code> and <code>-Zxx</code> are configurable		*** Avoid $F0–$FF (kernel use)
			* <code>-Wxx</code> and <code>-Zxx</code> are configurable based on your program's memory layout.

	---		---
Line 123:		Line 125:
	=== 5.1 Initialization ===		=== 5.1 Initialization ===

	Call the init routine:		Call the music player's init routine once. It is located at the player load address <code>(-Wxx)</code>.

	<code>		<code>
	JSR $A000		JSR $A000 ; initialize song
	</code>		</code>

Line 133:		Line 135:
	=== 5.2 Per-Frame Playback ===		=== 5.2 Per-Frame Playback ===

	Call once per frame:		Call the playback routine '''once per frame''' (SOF / 60 Hz)'''.'''

			* Playback routine address = <code>init + 3</code>

	<code>		<code>
	JSR $A003		JSR $A003 ; play song for this frame
	</code>		</code>

			Repeat this call every frame for continuous playback.

	---		---
Line 143:		Line 149:
	== 6. Additional Notes ==		== 6. Additional Notes ==

	* <code>-N</code> controls speed		* Pitch and speed are '''not the same''':
	* <code>-Gxx</code> controls pitch		** <code>-N</code> controls speed
	* ~~Both are~~ required		** <code>-Gxx</code> controls pitch
	* The ~~binary~~ is C64-~~compatible~~		* GoatTracker adjusts pitch tables when switching PAL/NTSC, but '''manual A-4 correction is still required.'''
	* Correct setup ensures compatibility		* The packed <code>.bin</code> file is unchanged between the C64 and the F256 - compatibility comes from correct timing, tuning, and memory placement.

	---		---
Line 157:		Line 163:
	---		---

			This example matches the configuration described in this wiki page:

			* Player loaded at '''$A000''' (<code>-Wa0</code>)
			* Player routine at '''$A003'''
			* Zeropage usage at '''$80/$81''' (used internally by the player)
			* NTSC / 60 Hz playback<br />
	; ============================================================================		; ============================================================================
	; music_min.asm - Minimal Music Player for Wildbits/K & /Jr		; music_min.asm - Minimal Music Player for Wildbits/K & /Jr
Line 235:		Line 246:
	== Cheat Sheet ==		== Cheat Sheet ==

	=== Edit / Preview ===		=== Edit / Preview (NTSC, correct pitch) ===

	<code>		<code>
Line 257:		Line 268:
	---		---

	=== Playback ===		=== Playback in your program ===

	<code>		<code>
Line 267:		Line 278:
	---		---

	=== Tested Defaults ===		=== Tested Defaults for the F256 ===

	* SID: $D400		* SID: $D400

Mcassera: /* 3. Pitch and Timing */

2026-01-30T04:24:19Z

3. Pitch and Timing

← Older revision		Revision as of 00:24, 30 January 2026
Line 23:		Line 23:
	---		---

	== 3. Pitch and Timing ==		== 3. Pitch and Timing (Important) ==

	Pitch and playback speed are '''separate settings'''.		Pitch and playback speed are '''separate settings'''.

Mcassera: /* Notes */

2026-01-30T04:21:02Z

Notes

← Older revision		Revision as of 00:21, 30 January 2026
Line 109:		Line 109:

	* <code>-Wxx</code> sets the high byte only		* <code>-Wxx</code> sets the high byte only
	* <code>-Wa0</code> = $A000		** <code>-Wa0</code> = $A000
	* <code>-Zxx</code> uses two bytes		* <code>-Zxx</code> uses two bytes
	* $80/$81 is tested and safe		** $80/$81 is tested and safe
	* Avoid $F0–$FF (kernel use)		** Avoid $F0–$FF (kernel use)
	* <code>-Wxx</code> and <code>-Zxx</code> are configurable		* <code>-Wxx</code> and <code>-Zxx</code> are configurable

Mcassera: Created page with "= Using GoatTracker to Create F256K SID Music = This guide explains how to use '''GoatTracker''' to compose SID music and generate a packed `.bin` file that plays correctly on the '''F256K / F256K2 FPGA SID'''. This document focuses on SID-only usage (no PSG or other sound chips). --- == 1. Getting GoatTracker == * GoatTracker is available for '''Windows, macOS, and Linux'''. * Download page: https://cadaver.github.io/ * The stereo version (useful for dua..."

2026-01-30T04:17:39Z

Created page with "= Using GoatTracker to Create F256K SID Music = This guide explains how to use '''GoatTracker''' to compose SID music and generate a packed <code>.bin</code> file that plays correctly on the '''F256K / F256K2 FPGA SID'''. This document focuses on SID-only usage (no PSG or other sound chips). --- == 1. Getting GoatTracker == * GoatTracker is available for '''Windows, macOS, and Linux'''. * Download page: https://cadaver.github.io/ * The stereo version (useful for dua..."

New page

= Using GoatTracker to Create F256K SID Music =

This guide explains how to use '''GoatTracker''' to compose SID music and generate a packed <code>.bin</code> file that plays correctly on the '''F256K / F256K2 FPGA SID'''.

This document focuses on SID-only usage (no PSG or other sound chips).

---

== 1. Getting GoatTracker ==

* GoatTracker is available for '''Windows, macOS, and Linux'''.
* Download page: https://cadaver.github.io/
* The stereo version (useful for dual SIDs on F256K2) is available on SourceForge under the files tab.

---

== 2. Creating a Song ==

# Create and edit your song in GoatTracker as you would for a C64.
# Most instruments, effects, and patterns work correctly on the F256K FPGA SID.
# GoatTracker was tuned for real C64 hardware, so FPGA SIDs may sound slightly different.

---

== 3. Pitch and Timing ==

Pitch and playback speed are '''separate settings'''.

* Playback speed is controlled by PAL vs NTSC timing (50 Hz vs 60 Hz).
* Pitch is controlled by the A-4 tuning value.

The F256K uses '''NTSC (60 Hz)''' timing.

---

=== 3.1 Editing and Previewing on Your Computer ===

When composing music on your computer, use NTSC timing and corrected pitch.

Recommended settings:

<code>
goattracker -N -G424 song.sng
</code>

* <code>-N</code> — NTSC timing (60 Hz)
* <code>-G424</code> — Correct pitch for NTSC preview

This setting is for '''editing only'''.

---

=== 3.2 Packing for Playback on the F256K ===

The F256K requires a different tuning to produce true 440 Hz pitch.

Tested value:

* '''A-4 = 454 Hz'''

Always start GoatTracker with:

<code>
goattracker -G454 song.sng
</code>

'''Important:''' <code>.sng</code> files store tuning. Loading after startup will overwrite the setting.

---

== 4. Packing the Song ==

Songs must be packed into a self-playing binary.

---

=== Option A: Internal Pack (F9) ===

* Press <code>F9</code> in GoatTracker.
* Ensure it was started with <code>-G454</code> and the song loaded.

---

=== Option B: External Packer (GT2RELOC.EXE) ===

Recommended method.

Example command:

<code>
GT2RELOC song.sng song.bin -N -G454 -LD400 -Wa0 -Z80
</code>

---

==== Parameter Explanation ====

* <code>song.sng</code> — Input song
* <code>song.bin</code> — Output binary
* <code>-N</code> — NTSC timing
* <code>-G454</code> — F256K tuning
* <code>-LD400</code> — SID base address
* <code>-Wa0</code> — Player load address ($A000)
* <code>-Z80</code> — Zeropage ($80/$81)

---

==== Notes ====

* <code>-Wxx</code> sets the high byte only
* <code>-Wa0</code> = $A000
* <code>-Zxx</code> uses two bytes
* $80/$81 is tested and safe
* Avoid $F0–$FF (kernel use)
* <code>-Wxx</code> and <code>-Zxx</code> are configurable

---

== 5. Playing the Music ==

---

=== 5.1 Initialization ===

Call the init routine:

<code>
JSR $A000
</code>

---

=== 5.2 Per-Frame Playback ===

Call once per frame:

<code>
JSR $A003
</code>

---

== 6. Additional Notes ==

* <code>-N</code> controls speed
* <code>-Gxx</code> controls pitch
* Both are required
* The binary is C64-compatible
* Correct setup ensures compatibility

---

== Appendix: Minimal F256 SID Music Player Example ==

The following is a minimal working music player using kernel timers.

---

; ============================================================================
; music_min.asm - Minimal Music Player for Wildbits/K & /Jr
; ============================================================================

.cpu "65816"
MMU_IO_CTRL = $01
init_music = $A000
play_music = init_music+3
timer_cookie = $D0

*=$A0
.dsection zp
.cerror * > $AF, "Too many zero page variables"

.include "api.asm"

.section zp
event: .dstruct kernel.event.event_t
.send

*=$1000

start:
stz MMU_IO_CTRL

lda #<event
sta kernel.args.events
lda #>event
sta kernel.args.events+1

jsr init_music
jsr SetTimer

loop:
jsr handle_events
bra loop

handle_events:
lda kernel.args.events.pending
bpl done_handle_events
jsr kernel.NextEvent
bcs done_handle_events
jsr dispatch
jmp handle_events

done_handle_events:
rts

dispatch:
lda event.type
cmp #kernel.event.timer.EXPIRED
beq music_playback
rts

music_playback:
jsr SetTimer
jsr play_music
rts

SetTimer:
inc timer_cookie
lda timer_cookie
sta kernel.args.timer.absolute
sta kernel.args.timer.cookie
lda #kernel.args.timer.FRAMES
sta kernel.args.timer.units
jsr kernel.Clock.SetTimer
rts

*=$A000
.binary "testsong.bin"

---

== Cheat Sheet ==

=== Edit / Preview ===

<code>
goattracker -N -G424 song.sng
</code>

=== Pack for F256K ===

<code>
GT2RELOC song.sng song.bin -N -G454 -LD400 -Wa0 -Z80
</code>

=== Internal Pack ===

<code>
goattracker -G454 song.sng
</code>

Press <code>F9</code>

---

=== Playback ===

<code>
JSR $A000

JSR $A003
</code>

---

=== Tested Defaults ===

* SID: $D400
* Player: $A000
* Zeropage: $80/$81
* Timing: NTSC (60 Hz)

---

End of document.