Skip to content

Commit

Permalink
doc: improve help text in Sound panel
Browse files Browse the repository at this point in the history
  • Loading branch information
midwan committed May 10, 2024
1 parent de20d00 commit f2a3b1f
Showing 1 changed file with 47 additions and 10 deletions.
57 changes: 47 additions & 10 deletions src/osdep/gui/PanelSound.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -860,19 +860,56 @@ void RefreshPanelSound()
bool HelpPanelSound(std::vector<std::string>& helptext)
{
helptext.clear();
helptext.emplace_back("You can turn on sound emulation with different levels of accuracy and");
helptext.emplace_back("choose between Mono and Stereo.");
helptext.emplace_back("In this panel you can configure the audio output options of Amiberry.");
helptext.emplace_back(" ");
helptext.emplace_back("The different types of interpolation have different impact on performance.");
helptext.emplace_back("Play with the settings to find the type you like most. You may need headphones");
helptext.emplace_back("to really hear the difference between the interpolation types.");
helptext.emplace_back("The top dropdown, allows you to select the sound card Amiberry will use. The dropdown");
helptext.emplace_back("is populated automatically with every detected device capable of sound output found in");
helptext.emplace_back("your system, which can include USB cards or even some game controllers that include ");
helptext.emplace_back("headset support.");
helptext.emplace_back(" ");
helptext.emplace_back("With \"Filter\", you can select the type of the Amiga audio filter.");
helptext.emplace_back("The System default checkbox, will instead use whatever audio output device is");
helptext.emplace_back("configured as the default in your system.");
helptext.emplace_back(" ");
helptext.emplace_back(R"(With "Stereo separation" and "Stereo delay", you can adjust how the left )");
helptext.emplace_back("and right audio channels of the Amiga are mixed to the left and right channels ");
helptext.emplace_back("of your device. A value of 70% for separation and no delay is a good start.");
helptext.emplace_back("Sound emulation");
helptext.emplace_back("Here you can select if Sound will be Disabled, Disabled but emulated or Enabled.");
helptext.emplace_back("If the selected sound card could not be initialized during startup, Amiberry will");
helptext.emplace_back("automatically disable the sound emulation.");
helptext.emplace_back(" ");
helptext.emplace_back("Volume");
helptext.emplace_back("Here you can select the output volume for the various emulated devices.");
helptext.emplace_back(" ");
helptext.emplace_back("Options");
helptext.emplace_back("You can adjust the options for the sound output below, to tune things to your liking:");
helptext.emplace_back(" - Channel mode: Mono, Stereo and other configurations are supported.");
helptext.emplace_back(" - Stereo separation: the default value is 70%, which sounds good in most cases.");
helptext.emplace_back(" - Interpolation: The default value is Anti. Different of interpolation have a ");
helptext.emplace_back(" different impact on performance. You may need headphones to really hear the");
helptext.emplace_back(" difference.");
helptext.emplace_back(" - Frequency: The default frequency is 44100 Hz, which most sound cards support.");
helptext.emplace_back(" - Swap channels: Swap the left/right channels, for Paula, AHI or both.");
helptext.emplace_back(" - Stereo delay: By default, there is no stereo delay at all.");
helptext.emplace_back(" - Filter: Depending on the model you selected, the relevant filter option will be");
helptext.emplace_back(" set here by default.");
helptext.emplace_back(" ");
helptext.emplace_back("Floppy drive sound emulation");
helptext.emplace_back("This option allows you to enable the sound the floppy drive makes in a real Amiga,");
helptext.emplace_back("when reading/writing disks. If you enable this option, you can also adjust the volume");
helptext.emplace_back("for the sounds produced.");
helptext.emplace_back(" ");
helptext.emplace_back("Sound buffer size");
helptext.emplace_back("The size of the buffer used for producing the sound output, as well as the method used");
helptext.emplace_back("for consuming that buffer. The default value is 6 and Pull audio, which uses a");
helptext.emplace_back("medium-sized buffer and a callback that consumes it automatically. The size of the");
helptext.emplace_back("audio buffer can affect latency and CPU load: too big a buffer and there will be some");
helptext.emplace_back("latency before the audio is heard, too small a buffer and the CPU will have more load");
helptext.emplace_back("to constantly try and fill the buffer.");
helptext.emplace_back(" ");
helptext.emplace_back("The Pull audio option enables a callback, which will then automatically consume the");
helptext.emplace_back("buffer asynchronously. This works better with a medium-sized buffer (e.g. 6 or 8).");
helptext.emplace_back("The Push audio option, will change the behavior to have Amiberry push audio directly");
helptext.emplace_back("on an interval, during custom chipset emulation. This option works best with smaller");
helptext.emplace_back("buffer sizes (e.g. 1 or even 0) and might help decrease any latency found even");
helptext.emplace_back("further, but at the cost of slightly higher CPU usage.");
helptext.emplace_back(" ");
helptext.emplace_back("The audio volume of the Amiga (not CD) can be adjusted with \"Paula Volume\".");
return true;
}

0 comments on commit f2a3b1f

Please sign in to comment.