Add new crystal audio dump script

and update red audio scripts
This commit is contained in:
dannye 2020-05-05 19:27:23 -05:00
parent a28e6f460d
commit c1a67e680d
6 changed files with 522 additions and 16 deletions

View File

@ -1,4 +1,72 @@
# coding: utf-8
cry_names = ['%.2X' % x for x in xrange(0x44)]
cry_names = [
'Nidoran_M',
'Nidoran_F',
'Slowpoke',
'Kangaskhan',
'Charmander',
'Grimer',
'Voltorb',
'Muk',
'Oddish',
'Raichu',
'Nidoqueen',
'Diglett',
'Seel',
'Drowzee',
'Pidgey',
'Bulbasaur',
'Spearow',
'Rhydon',
'Golem',
'Blastoise',
'Pidgeotto',
'Weedle',
'Caterpie',
'Ekans',
'Fearow',
'Clefairy',
'Venonat',
'Lapras',
'Metapod',
'Squirtle',
'Paras',
'Growlithe',
'Krabby',
'Psyduck',
'Rattata',
'Vileplume',
'Vulpix',
'Weepinbell',
'Marill',
'Spinarak',
'Togepi',
'Girafarig',
'Raikou',
'Mareep',
'Togetic',
'Hoothoot',
'Sentret',
'Slowking',
'Cyndaquil',
'Chikorita',
'Totodile',
'Gligar',
'Cleffa',
'Slugma',
'Ledyba',
'Entei',
'Wooper',
'Mantine',
'Typhlosion',
'Natu',
'Teddiursa',
'Sunflora',
'Ampharos',
'Magcargo',
'Pichu',
'Aipom',
'Dunsparce',
'Donphan',
]

351
pokemontools/crystal_audio.py Executable file
View File

@ -0,0 +1,351 @@
#!/usr/bin/env python
from song_names import song_names
from cry_names import cry_names
from sfx_names import sfx_names
from drum_names import drum_names
rom = bytearray(open("baserom.gbc", "rb").read())
# music command names and parameter lists
music_commands = {
0x00: { "name": "rest", "params": [ "lower_nibble_off_by_one" ] },
0x10: { "name": "note", "params": [ "note", "lower_nibble_off_by_one" ] },
0xb0: { "name": "drum_note", "params": [ "upper_nibble", "lower_nibble_off_by_one" ] },
0xd0: { "name": "octave", "params": [ "octave" ] },
0xd7: { "name": "drum_speed", "params": [ "byte" ] },
0xd8: { "name": "note_type", "params": [ "byte", "nibbles_unsigned_signed" ] },
0xda: { "name": "tempo", "params": [ "word_big_endian" ] },
0xdb: { "name": "duty_cycle", "params": [ "byte" ] },
0xde: { "name": "duty_cycle_pattern", "params": [ "crumbs" ] },
0xe0: { "name": "pitch_slide", "params": [ "byte_off_by_one", "nibbles_octave_note" ] },
0xe1: { "name": "vibrato", "params": [ "byte", "nibbles" ] },
0xe5: { "name": "volume", "params": [ "nibbles" ] },
0xef: { "name": "stereo_panning", "params": [ "nibbles_boolean" ] },
0xfd: { "name": "sound_loop", "params": [ "byte", "label" ] },
0xfe: { "name": "sound_call", "params": [ "label" ] },
0xff: { "name": "sound_ret", "params": [] },
0xd9: { "name": "transpose", "params": [ "nibbles" ] },
0xdc: { "name": "volume_envelope", "params": [ "nibbles_unsigned_signed" ] },
0xe3: { "name": "toggle_noise", "params": [ "byte" ] },
0xe6: { "name": "pitch_offset", "params": [ "word_big_endian" ] },
0xfc: { "name": "sound_jump", "params": [ "label" ] },
0x01: { "name": "square_note", "params": [ "command_byte", "nibbles_unsigned_signed", "word" ] },
0x02: { "name": "noise_note", "params": [ "command_byte", "nibbles_unsigned_signed", "byte" ] },
0xdd: { "name": "pitch_sweep", "params": [ "nibbles_unsigned_signed" ] },
0xdf: { "name": "toggle_sfx", "params": [] },
0xec: { "name": "sfx_priority_on", "params": [] },
0xed: { "name": "sfx_priority_off", "params": [] },
0xf0: { "name": "sfx_toggle_noise", "params": [ "byte" ] },
}
# length in bytes of each type of parameter
param_lengths = {
"command_byte": 0,
"note": 0,
"upper_nibble": 0,
"lower_nibble": 0,
"lower_nibble_off_by_one": 0,
"octave": 0,
"crumbs": 1,
"nibbles": 1,
"nibbles_boolean": 1,
"nibbles_binary": 1,
"nibbles_unsigned_signed": 1,
"nibbles_octave_note": 1,
"byte": 1,
"byte_off_by_one": 1,
"word": 2,
"word_big_endian": 2,
"label": 2,
}
# constants used for note commands
music_notes = {
0x0: "B_",
0x1: "C_",
0x2: "C#",
0x3: "D_",
0x4: "D#",
0x5: "E_",
0x6: "F_",
0x7: "F#",
0x8: "G_",
0x9: "G#",
0xa: "A_",
0xb: "A#",
0xc: "B_",
}
def get_base_command_id(command_id, channel=1, is_sfx=False):
# noise
if command_id < 0xd0 and is_sfx and (channel == 4 or channel == 8):
return 0x02
# sound
elif command_id < 0xd0 and is_sfx:
return 0x01
# rest
elif command_id < 0x10:
return 0x00
# drum_note
elif command_id < 0xd0 and channel == 4:
return 0xb0
# note
elif command_id < 0xd0:
return 0x10
# octave
elif command_id < 0xd8:
return 0xd0
# drum_speed
elif command_id == 0xd8 and (channel == 4 or channel == 8):
return 0xd7
else:
return command_id
def get_bank(address):
return int(address / 0x4000)
# get absolute pointer stored at an address in the rom
# if bank is None, assumes the pointer refers to the same bank as the bank it is located in
def get_pointer(address, bank=None):
if bank is None:
bank = get_bank(address)
return (rom[address + 1] * 0x100 + rom[address]) % 0x4000 + bank * 0x4000
# return True if the command at address is a loop command
# and the loop count is 0 (infinite)
# or if the command is a jump command (effectively the same as infinite loop)
def is_infinite_loop(address):
return ((rom[address] == 0xfd and rom[address + 1] == 0) or
(rom[address] == 0xfc))
def make_blob(start, output, end=None, label=None):
return { "start": start, "output": output, "end": end if end else start, "label": label }
# parse a single channel of a sound
# returns a list of all labels and commands
def dump_channel(start_address, sound_name, channel, prefix="", is_sfx=True, address=None):
blobs = []
labels = []
branches = set()
if address is None:
blobs.append(make_blob(start_address, "{}{}_Ch{}:\n".format(prefix, sound_name, channel)))
address = start_address
if sound_name == "MagnetTrain" and channel == 4:
unseen_branch = 0xef711
unseen_label = "; unused\n{}{}_branch_{:x}".format(prefix, sound_name, unseen_branch)
labels.append({ "address": unseen_branch, "label": unseen_label })
branches.add(unseen_branch)
while 1:
if rom[address] == 0xdf:
is_sfx = not is_sfx
command_address = address
command_id = rom[command_address]
command = music_commands[get_base_command_id(command_id, channel, is_sfx)]
output = "\t{}".format(command["name"])
label = None
address += 1
# print all params for current command
for i in range(len(command["params"])):
param = rom[address]
param_type = command["params"][i]
param_length = param_lengths[param_type]
if param_type == "command_byte":
output += " {}".format(command_id)
elif param_type == "note":
output += " {}".format(music_notes[command_id >> 4])
elif param_type == "upper_nibble":
output += " {}".format(command_id >> 4)
elif param_type == "lower_nibble":
output += " {}".format(command_id & 0b1111)
elif param_type == "lower_nibble_off_by_one":
output += " {}".format((command_id & 0b1111) + 1)
elif param_type == "octave":
output += " {}".format(8 - (command_id & 0b1111))
elif param_type == "crumbs":
output += " {}, {}, {}, {}".format((param >> 6) & 0b11, (param >> 4) & 0b11, (param >> 2) & 0b11, (param >> 0) & 0b11)
elif param_type == "nibbles":
output += " {}, {}".format(param >> 4, param & 0b1111)
elif param_type == "nibbles_boolean":
output += " {}, {}".format("TRUE" if param >> 4 else "FALSE", "TRUE" if param & 0b1111 else "FALSE")
elif param_type == "nibbles_binary":
output += " %{:04b}, %{:04b}".format(param >> 4, param & 0b1111)
elif param_type == "nibbles_unsigned_signed":
output += " {}, {}".format(param >> 4, param & 0b1111 if param & 0b1111 <= 8 else (param & 0b0111) * -1)
elif param_type == "nibbles_octave_note":
output += " {}, {}".format(8 - (param >> 4), music_notes[param & 0b1111])
elif param_type == "byte":
output += " {}".format(param)
elif param_type == "byte_off_by_one":
output += " {}".format(param + 1)
elif param_type == "word":
output += " {}".format(param + rom[address + 1] * 0x100)
elif param_type == "word_big_endian":
output += " {}".format(param * 0x100 + rom[address + 1])
elif param_type == "label":
param = get_pointer(address)
output += " {:x}".format(param)
if param == start_address:
label = "{}{}_Ch{}".format(prefix, sound_name, channel)
else:
label = "{}{}_branch_{:x}".format(prefix, sound_name, param)
if command_id == 0xfe and param >= start_address:
branches.add(param)
elif param < start_address:
labels.append({ "address": param, "label": label })
address += param_length
if i < len(command["params"]) - 1:
output += ","
output += "\n"
blobs.append(make_blob(command_address, output, address, label))
if (command_id == 0xff or (is_infinite_loop(command_address) and
not (is_infinite_loop(address) or rom[address] == 0xff))):
blobs.append(make_blob(address, "\n"))
break
for branch in branches:
blobs += dump_channel(start_address, sound_name, channel, prefix, is_sfx, branch)[0]
return blobs, labels
def dump_sound(header, sound_name, prefix="", is_sfx=True):
blobs = []
blobs.append(make_blob(header, "{}{}:\n".format(prefix, sound_name)))
labels = []
final_channel = (rom[header] >> 6) + 1
for i in range(final_channel):
channel_num = (rom[header] & 0b1111) + 1
start_address = get_pointer(header + 1)
if i == 0 and sound_name != "Sandstorm":
h = "\tchannel_count {}\n\tchannel {}, {:x}\n".format(final_channel, channel_num, start_address)
else:
h = "\tchannel {}, {:x}\n".format(channel_num, start_address)
label = "{}{}_Ch{}".format(prefix, sound_name, channel_num)
blobs.append(make_blob(header, h, header + 3, label))
channel_blobs, channel_labels = dump_channel(start_address, sound_name, channel_num, prefix, is_sfx)
blobs += channel_blobs
labels += channel_labels
header += 3
blobs.append(make_blob(header, "\n"))
return blobs, labels
def dump_all_sounds(header_pointer, sound_names, prefix="", is_sfx=True):
blobs = []
for sound_name in sound_names:
header = get_pointer(header_pointer + 1, rom[header_pointer])
blobs += dump_sound(header, sound_name, prefix, is_sfx)[0]
header_pointer += 3
return blobs
def fill_gap(start, end):
output = ""
for address in range(start, end):
byte = rom[address]
if byte == get_base_command_id(byte) and len(music_commands[byte]["params"]) == 0:
output += "\t{}\n".format(music_commands[byte]["name"])
else:
output += "\tdb ${:x}\n".format(rom[address])
output += "\n"
return output
def sort_and_filter(blobs, extra_labels=[]):
blobs.sort(key=lambda b: (b["start"], b["end"], len(b["output"])))
filtered = []
added_labels = []
for label in extra_labels:
if label["label"] not in added_labels and blobs[0]["start"] <= label["address"] < blobs[-1]["end"]:
filtered.append(make_blob(label["address"], label["label"] + ":\n"))
added_labels.append(label["label"])
for blob, next in zip(blobs, blobs[1:]+[None]):
if next and blob["start"] == next["start"] and blob["output"] == next["output"]:
continue
if blob["label"] is not None:
label_pos = blob["output"].rfind(" ") + 1
label_address = int(blob["output"][label_pos:], 16)
blob["output"] = blob["output"][:label_pos] + blob["label"] + "\n"
if "_branch_" in blob["label"] and blob["label"] not in added_labels and label_address >= blobs[0]["start"]:
filtered.append(make_blob(label_address, blob["label"] + ":\n"))
added_labels.append(blob["label"])
if next and blob["end"] < next["start"] and get_bank(blob["end"]) == get_bank(next["start"]):
blob["output"] += fill_gap(blob["end"], next["start"])
filtered.append(blob)
filtered.sort(key=lambda b: (b["start"], b["end"], len(b["output"])))
return filtered
def write_all_sounds_to_file(path, file, blobs):
import os
try:
print("Writing {}...".format(path + file))
os.makedirs(path, exist_ok=True)
sound_file = open(path + file, "w")
for blob in blobs[:-1]:
sound_file.write(blob["output"])
sound_file.close()
except IOError as ex:
print("Error writing {}".format(path + file))
print(ex)
def export_all_sounds(path, header_pointer, sound_names, prefix="", is_sfx=True):
sounds = []
labels = []
for sound_name in sound_names:
header = get_pointer(header_pointer + 1, rom[header_pointer])
blobs, sound_labels = dump_sound(header, sound_name, prefix, is_sfx)
sounds.append(blobs)
labels += sound_labels
header_pointer += 3
for blobs, sound_name in zip(sounds, sound_names):
blobs = sort_and_filter(blobs, labels)
write_all_sounds_to_file(path, "{}.asm".format(sound_name.lower()), blobs)
def dump_all_songs():
export_all_sounds("audio/music/", 0xe906e, song_names, "Music_", is_sfx=False)
def dump_all_cries():
blobs = dump_all_sounds(0xe91b0, cry_names, "Cry_")
blobs += dump_channel(0xf3134, "Sentret", 8, "Cry_")[0]
blobs += dump_channel(0xf35d3, "Unused", 5, "Cry_")[0]
blobs += dump_channel(0xf35ee, "Unused", 6, "Cry_")[0]
blobs += dump_channel(0xf3609, "Unused", 8, "Cry_")[0]
blobs = sort_and_filter(blobs)
write_all_sounds_to_file("audio/", "cries.asm", blobs)
def dump_all_sfx():
blobs = dump_all_sounds(0xe927c, sfx_names, "Sfx_")
blobs += dump_sound(0xf0d5f, "Unused", "Sfx_")[0]
blobs = sort_and_filter(blobs)
for i, (blob, next) in enumerate(zip(blobs, blobs[1:])):
if get_bank(blob["end"]) != get_bank(next["start"]):
sfx = blobs[:i + 1]
sfx_crystal = blobs[i + 1:]
break
write_all_sounds_to_file("audio/", "sfx.asm", sfx)
write_all_sounds_to_file("audio/", "sfx_crystal.asm", sfx_crystal)
def dump_all_drumkits():
blobs = []
pointer_table = "Drumkits:\n"
pointer_tables = []
drumkit_pointer = 0xe8e52
for drumkit in range(6):
pointer_table += "\tdw Drumkit{}\n".format(drumkit)
drumkit_table = "Drumkit{}:\n".format(drumkit)
drum_pointer = get_pointer(drumkit_pointer + drumkit * 2)
for drum in range(13):
address = get_pointer(drum_pointer + drum * 2)
drumkit_table += "\tdw {}\n".format(drum_names[drumkit * 13 + drum])
blobs += dump_channel(address, "{}".format(drum_names[drumkit * 13 + drum]), 4)[0]
pointer_tables.append(drumkit_table)
output = pointer_table + "\n" + "".join(pointer_tables) + "\n"
blobs.append(make_blob(drumkit_pointer, output, blobs[0]["start"]))
for blob in blobs:
if blob["output"].endswith("_Ch4:\n"):
blob["output"] = blob["output"][:-6] + ":\n"
blobs = sort_and_filter(blobs)
write_all_sounds_to_file("audio/", "drumkits.asm", blobs)
if __name__ == "__main__":
dump_all_songs()
dump_all_cries()
dump_all_sfx()
dump_all_drumkits()

View File

@ -0,0 +1,87 @@
# coding: utf-8
drum_names = [
'Drum00',
'Snare1',
'Snare2',
'Snare3',
'Snare4',
'Drum05',
'Triangle1',
'Triangle2',
'HiHat1',
'Snare5',
'Snare6',
'Snare7',
'HiHat2',
'Drum00',
'HiHat1',
'Snare5',
'Snare6',
'Snare7',
'HiHat2',
'HiHat3',
'Snare8',
'Triangle3',
'Triangle4',
'Snare9',
'Snare10',
'Snare11',
'Drum00',
'Snare1',
'Snare9',
'Snare10',
'Snare11',
'Drum05',
'Triangle1',
'Triangle2',
'HiHat1',
'Snare5',
'Snare6',
'Snare7',
'HiHat2',
'Drum21',
'Snare12',
'Snare13',
'Snare14',
'Kick1',
'Triangle5',
'Drum20',
'Drum27',
'Drum28',
'Drum29',
'Drum21',
'Kick2',
'Crash2',
'Drum21',
'Drum20',
'Snare13',
'Snare14',
'Kick1',
'Drum33',
'Triangle5',
'Drum35',
'Drum31',
'Drum32',
'Drum36',
'Kick2',
'Crash1',
'Drum00',
'Snare9',
'Snare10',
'Snare11',
'Drum27',
'Drum28',
'Drum29',
'Drum05',
'Triangle1',
'Crash1',
'Snare14',
'Snare13',
'Kick2',
]

View File

@ -83,10 +83,10 @@ alternate_start_songs = [
# music command names and parameter lists
music_commands = {
0x00: { "name": "note", "params": [ "note", "lower_nibble_off_by_one" ] },
0xb0: { "name": "dnote", "params": [ "byte", "lower_nibble_off_by_one" ] },
0xb0: { "name": "drum_note", "params": [ "byte", "lower_nibble_off_by_one" ] },
0xc0: { "name": "rest", "params": [ "lower_nibble_off_by_one" ] },
0xd0: { "name": "note_type", "params": [ "lower_nibble", "nibbles_unsigned_signed" ] },
0xd1: { "name": "dspeed", "params": [ "lower_nibble" ] },
0xd1: { "name": "drum_speed", "params": [ "lower_nibble" ] },
0xe0: { "name": "octave", "params": [ "octave" ] },
0xe8: { "name": "toggle_perfect_pitch", "params": [] },
0xea: { "name": "vibrato", "params": [ "byte", "nibbles" ] },
@ -144,10 +144,10 @@ def get_command_length(command_id):
return length
def get_base_command_id(command_id, channel):
# dnote
# drum_note
if command_id < 0xc0 and channel == 4:
return 0xb0
# dspeed
# drum_speed
elif command_id >= 0xd0 and command_id < 0xe0 and channel == 4:
return 0xd1
# note

View File

@ -340,10 +340,10 @@ music_commands = {
0x10: { "name": "pitch_sweep", "params": [ "nibbles_unsigned_signed" ] },
0x20: { "name": "square_note", "params": [ "lower_nibble", "nibbles_unsigned_signed", "word" ] },
0x21: { "name": "noise_note", "params": [ "lower_nibble", "nibbles_unsigned_signed", "byte" ] },
0xb0: { "name": "dnote", "params": [ "byte", "lower_nibble_off_by_one" ] },
0xb0: { "name": "drum_note", "params": [ "byte", "lower_nibble_off_by_one" ] },
0xc0: { "name": "rest", "params": [ "lower_nibble_off_by_one" ] },
0xd0: { "name": "note_type", "params": [ "lower_nibble", "nibbles_unsigned_signed" ] },
0xd1: { "name": "dspeed", "params": [ "lower_nibble" ] },
0xd1: { "name": "drum_speed", "params": [ "lower_nibble" ] },
0xe0: { "name": "octave", "params": [ "octave" ] },
0xe8: { "name": "toggle_perfect_pitch", "params": [] },
0xea: { "name": "vibrato", "params": [ "byte", "nibbles" ] },
@ -411,10 +411,10 @@ def get_base_command_id(command_id, channel, execute_music):
# square_note
elif command_id < 0x30 and not execute_music:
return 0x20
# dnote
# drum_note
elif command_id < 0xc0 and channel == 4:
return 0xb0
# dspeed
# drum_speed
elif command_id >= 0xd0 and command_id < 0xe0 and channel == 4:
return 0xd1
# note

View File

@ -99,7 +99,7 @@ sfx_names = [
'Unknown5F',
'Unknown60',
'Unknown61',
'Unknown62',
'SwitchPockets',
'Unknown63',
'Burn',
'TitleScreenEntrance',
@ -149,9 +149,9 @@ sfx_names = [
'KeyItem',
'Fanfare2',
'RegisterPhoneNumber',
'3RdPlace',
'GetEggFromDaycareMan',
'GetEggFromDaycareLady',
'3rdPlace',
'GetEgg',
'GetEgg',
'MoveDeleted',
'2ndPlace',
'1stPlace',
@ -180,7 +180,7 @@ sfx_names = [
'Encore',
'BeatUp',
'BatonPass',
'BallWiggle',
'BallWobble',
'SweetScent',
'SweetScent2',
'HitEndOfExpBar',
@ -204,7 +204,7 @@ sfx_names = [
'IntroSuicune4',
'GameFreakPresents',
'Tingle',
'UnknownCB',
'IntroWhoosh',
'TwoPcBeeps',
'4NoteDitty',
'Twinkle',