WIP: Port "Gameboy sound hardware" from the old wiki #562

remind-me-later · 2024-08-28T10:48:07Z

Closes #552. Each section from the old wiki corresponds to a commit.
I encountered the following issues while porting some sections:

The Channels section diagram is pretty ugly, I would like recommendations on how to redo it.
The Frame Sequencer section diagram has been skipped, since it
doesn't match with SameBoy source, and I think that's more accurate.
The VIN mixing section is pretty bare and I don't know if the information in there
is useful, so I skipped it.
The obscure behavior section could probably be refactored to be in Audio Registers,
and Audio Details, but I don't know if that would make the rest of the section more bothersome
to read.
I don't think a lot of version differences are mentioned in the rest of the page,
so I skipped them as well.

ISSOtm

Thank you!

This looks largely like a straight port, correct? If so, I anticipate that we'll want to check some of the statements. Will you want to help with that?

src/Audio.md

src/Audio_Registers.md

ISSOtm · 2024-09-01T13:36:22Z

src/Audio_Registers.md

+:::warning RETRIGGERING CAUTION

-  On monochrome consoles only, retriggering CH3 while it's about to read a byte from wave RAM causes wave RAM to be corrupted in a generally unpredictable manner.
+On monochrome consoles only, retriggering CH3 while it's about to read a byte from wave RAM causes wave RAM to be corrupted in a generally unpredictable manner.

-  :::
+:::

-  :::warning PLAYBACK DELAY
+:::warning PLAYBACK DELAY

-  Triggering the wave channel does not immediately start playing wave RAM; instead, the *last* sample ever read (which is reset to 0 when the APU is off) is output until the channel next reads a sample.
-  ([Source](https://github.com/LIJI32/SameSuite/blob/master/apu/channel_3/channel_3_delay.asm))
+Triggering the wave channel does not immediately start playing wave RAM; instead, the *last* sample ever read (which is reset to 0 when the APU is off) is output until the channel next reads a sample.
+([Source](https://github.com/LIJI32/SameSuite/blob/master/apu/channel_3/channel_3_delay.asm))
+
+:::

-  :::


Wouldn't unindenting those break the list in two?

With the last commit the warnings are nested 2 levels deep in the sublist.

src/Audio_Registers.md

avivace · 2024-09-01T13:43:27Z

@ISSOtm would you say we can start merging and afterwards "check" the statements ?

For "critical ones" we could directly add notes/earnings asking for help to verify the statements

ISSOtm · 2024-09-01T13:46:25Z

I don't know. The risk of adding false statements to Pan Docs always exists, and is a regression of sorts.

I'd like to fix them from the get-go if the resources (primarily motivation) are available, but if not, then yes we'll merge this and improve later.

remind-me-later · 2024-09-02T13:19:56Z

Thank you!

This looks largely like a straight port, correct? If so, I anticipate that we'll want to check some of the statements. Will you want to help with that?

Sure, for now I've been using SameBoy source as a reference but I don't know if there's a better source for checking the statements of the old wiki.

Co-authored-by: Eldred Habert <[email protected]>

ISSOtm · 2024-09-02T22:42:08Z

SameBoy's source is one of the best references, since it's accurate, well-tested, and often well commented; but since it's code, it's still subject to interpretation. That's why we prefer citing test ROMs (when possible).

But “best effort“ remains in effect, so only verifying against SameBoy's source is perfectly fine, and hey, still miles better than just blindly copy-pasting some text! ^^

remind-me-later · 2024-09-03T12:26:26Z

Ok, I'll see if I can find some test ROMs, specially for the "obscure behavior" claims.

avivace

Just started to leave some possible minor improvements after a read

avivace · 2024-09-04T08:55:39Z

src/Audio_Registers.md

@@ -202,7 +204,15 @@ Period changes (written to `NR13` or `NR14`) only take effect after the current
  "NR14" 7:"Trigger" 6:"Length enable" 2-0:"Period"
 }}

- **Trigger** (*Write-only*): Writing any value to `NR14` with this bit set [triggers](<#Triggering>) the channel.
+- **Trigger** (*Write-only*): Writing any value to `NR14` with this bit set [triggers](<#Triggering>) the channel, causing the


Maybe we can improve this wording a bit? "triggering a channel"

src/Audio_Registers.md

src/Audio_details.md

avivace · 2024-09-04T09:24:04Z

src/Audio_details.md

+optionally negating the value, depending on the [direction](<#FF10 — NR10: Channel 1 sweep>), and summing this with the frequency "shadow register" to produce a new frequency.
+What is done with this new frequency depends on the context.
+
+The _overflow check_ simply calculates the new frequency and if it is greater than 2047, or $7FF, CH1 is disabled.


minor: this section may enjoy a flow diagram?

ISSOtm · 2024-09-18T17:44:28Z

Have you been able to find any test ROMs?

If not, that's fine, then SameBoy would be quite sufficient.

avivace · 2024-09-20T14:33:00Z

@remind-me-later do you have any update on this? It's fine to just mention SameBoy for the time being, we can open an issue for the test roms

remind-me-later · 2024-09-23T14:26:37Z

Have you been able to find any test ROMs?

If not, that's fine, then SameBoy would be quite sufficient.

I've seen that the blargg test roms check for some of the behavior of the sweep (cgb-sound tests 04-sweep and 05-sweep details) which seem to coincide with the behavior described. The test 03-trigger also matches the added text about triggering a channel. The parts I'm less sure of are some claims in the obscure behavior section, for example the zombie step paragraph, I've tried reading SameBoy's source about this but couldn't quite get how this mode works.

avivace

I'd like to start merging what we have, if that's okay @ISSOtm ?

remind-me-later added 5 commits August 22, 2024 18:25

Port channels section from old wiki

e890e39

Port Frequency Sweep section from old wiki

2d677f2

Port Trigger Event section from old wiki

1f8594c

Port Power Control section from old wiki

1bd39c0

Port Obscure Behavior section from old wiki

c17d184

avivace requested review from ISSOtm and avivace August 28, 2024 16:29

ISSOtm requested changes Sep 1, 2024

View reviewed changes

remind-me-later and others added 2 commits September 2, 2024 15:22

Update src/Audio.md

8697f2f

Co-authored-by: Eldred Habert <[email protected]>

Fix formatting

6b00a8c

avivace requested changes Sep 4, 2024

View reviewed changes

avivace requested review from ISSOtm and avivace September 12, 2024 08:13

avivace added 3 commits September 20, 2024 16:31

Update src/Audio_details.md

7c390d8

Update src/Audio_Registers.md

b3c8414

Update src/Audio_Registers.md

55410d9

avivace approved these changes Nov 18, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WIP: Port "Gameboy sound hardware" from the old wiki #562

WIP: Port "Gameboy sound hardware" from the old wiki #562

remind-me-later commented Aug 28, 2024

ISSOtm left a comment

ISSOtm Sep 1, 2024

remind-me-later Sep 2, 2024

avivace commented Sep 1, 2024

ISSOtm commented Sep 1, 2024

remind-me-later commented Sep 2, 2024

ISSOtm commented Sep 2, 2024

remind-me-later commented Sep 3, 2024

avivace left a comment

avivace Sep 4, 2024

avivace Sep 4, 2024

ISSOtm commented Sep 18, 2024

avivace commented Sep 20, 2024 •

edited

Loading

remind-me-later commented Sep 23, 2024

avivace left a comment

WIP: Port "Gameboy sound hardware" from the old wiki #562

Are you sure you want to change the base?

WIP: Port "Gameboy sound hardware" from the old wiki #562

Conversation

remind-me-later commented Aug 28, 2024

ISSOtm left a comment

Choose a reason for hiding this comment

ISSOtm Sep 1, 2024

Choose a reason for hiding this comment

remind-me-later Sep 2, 2024

Choose a reason for hiding this comment

avivace commented Sep 1, 2024

ISSOtm commented Sep 1, 2024

remind-me-later commented Sep 2, 2024

ISSOtm commented Sep 2, 2024

remind-me-later commented Sep 3, 2024

avivace left a comment

Choose a reason for hiding this comment

avivace Sep 4, 2024

Choose a reason for hiding this comment

avivace Sep 4, 2024

Choose a reason for hiding this comment

ISSOtm commented Sep 18, 2024

avivace commented Sep 20, 2024 • edited Loading

remind-me-later commented Sep 23, 2024

avivace left a comment

Choose a reason for hiding this comment

avivace commented Sep 20, 2024 •

edited

Loading