Configure boot volume vs max volume?

akiddisaster · June 15, 2022, 4:51am

As I understand it, the value set with #define VOLUME is the maximum allowed volume for the saber. Is that correct? Is it possible to boot the saber up at a volume lower than the max?

Having a setting for boot volume would be ideal, but even storing and recalling the last volume setting would be nice.

profezzorn · June 15, 2022, 5:54am

You can use #define SAVE_STATEor #define SAVE_VOLUME to make the saber remember what volume it used last. You probably want to use a pop that lets you change the volume on the fly though…

akiddisaster · June 15, 2022, 11:41am

Oh, awesome! Thank you!

I Google’d “SAVE_STATE” and “SAVE_VOLUME” just now and found the proffieboard user manual. I didn’t know that was a thing. Now I have a list of the possible define options for future reference.

I do use Edit Mode to change volume on the fly. It’s just quite jarring if it’s late at night and I’m pushing config edits or whatever and it comes back on at full volume every time.

Fett263 · June 15, 2022, 1:00pm

NOTE: If you’re uploading new configs then you’d need to use this define or the volume would still reset to max when you upload the new config.

#define KEEP_SAVEFILES_WHEN_PROGRAMMING

HOWEVER, this define will also hold onto all previous edits so if you change fonts or styles or add or remove presets in an upload they will not show on your saber so definitely read through this before using.

The SAVE_STATE and SAVE_VOLUME are for saving between boots, not uploads. Typically when you upload a new config it assumes that’s how you want the saber to be, the KEEP_SAVEFILES_WHEN_PROGRAMMING will apply all save files over the new config but that can cause issues if you’re making changes or adding/deleting presets or features as the old config settings will still show. So you’ll want to be mindful of everything listed in the above article if you use, some users are confused by this when using the KEEP define.

akiddisaster · June 15, 2022, 10:26pm

Thanks for that info! I could see how enabling that might lead to some undesired behavior. It seems a little overkill for what I want.

Having another define for boot volume would be a welcome addition to a future version of the OS

NoSloppy · June 16, 2022, 4:06am

# Set the volume for each effect individually, in percent.
# 50 makes it half as loud. 200 makes it twice as loud. 
# Maximum allowed value is currently 255. The default is 100.
# EFFECTNAME can be "clash", “preon”, “out”, “pstoff”, etc.
#
# ProffieOS.SFX.EFFECTNAME.volume=100

Sound font config.ini file

akiddisaster · June 16, 2022, 4:51am

Maybe you’re thinking I just want to change the volume of the boot.wav file for the sound font? I don’t need to adjust volumes per effect. I’m talking about the overall volume of the saber after I’ve uploaded a new config to the board and I power the saber back on.

I want the saber to power on at 50% volume after an upload, but I still want the option of dialing the volume up to 100% using the volume menu. Currently, after you upload, you get booted back up to 100% volume. I can set VOLUME to a lower number, and it will boot quieter, but then I can’t crank it up later if I want to since VOLUME dictates the maximum volume.

SAVE_VOLUME doesn’t solve this problem, but it at least perseveres my volume setting between toggles of the kill switch. I can deal with the volume reset after a config upload.

profezzorn · June 17, 2022, 6:28am

Something for ProffieOS 7.x maybe?

NoSloppy · June 17, 2022, 8:28am

How about if you add #define BOOT_HALF_VOLUME to your config, then add to your prop file something like

#ifdef BOOT_HALF_VOLUME
  dynamic_mixer.set_volume(std::max<int>(VOLUME * 0.1,
  dynamic_mixer.get_volume() - VOLUME * 0.50));
#endif

Or you could make it a settable percentage right in the define.

#define BOOT_VOLUME .30

then in the prop

#ifdef BOOT_VOLUME
  dynamic_mixer.set_volume(std::max<int>(VOLUME * 0.1,
  dynamic_mixer.get_volume() - VOLUME * BOOT_VOLUME));
#endif

Someone should check my code there. I’m not sure if float is an issue.

I have no idea why the formatting looks different on here between those 2 practically identical code blocks

Fett263 · June 17, 2022, 11:35am

I think we just need to break out defines to allow users to “KEEP” certain .ini files on programming, specifically global.ini ,curstate.ini and gestures.ini

This way if users edit volume, blade length, clash threshold and/or gestures they can keep those changes while still updating the presets in their config. I find most uploads after editing would be adding or changing styles in the config for their presets so giving defines like:

KEEP_GLOBAL_SETTINGS_WHEN_PROGRAMMING //keeps global.ini 
KEEP_CURRENT_STATE_WHEN_PROGRAMMING //keeps curstate.ini
KEEP_CONTROL_SETTINGS_WHEN_PROGRAMMING //keeps gestures.ini (in my prop)

would be simpler and better approach. I find once a user sets these value they aren’t usually trying to change on future uploads.

If you agree I can add it to my OS7 list unless you have a specific way you’d want it.

akiddisaster · June 17, 2022, 12:11pm

Thanks a ton! I haven’t tested this code yet, but I definitely will when I get some free time. I’m a software engineer, but I just haven’t taken the time to really look into how ProffieOS works and how to code for it. Adding this boot volume thing might be what I need to get going.

profezzorn · June 17, 2022, 6:02pm

Seems easier to have the boot volume in the same unit as the volume.

Just:

#ifdef BOOT_VOLUME
  dynamic_mixer.set_volume(BOOT_VOLUME);
#endif

Fett263:

KEEP_GLOBAL_SETTINGS_WHEN_PROGRAMMING //keeps global.ini 
KEEP_CURRENT_STATE_WHEN_PROGRAMMING //keeps curstate.ini
KEEP_CONTROL_SETTINGS_WHEN_PROGRAMMING //keeps gestures.ini (in my prop)

If this would be useful, I don’t mind having the extra defines for it.
A PR would be most welcome.

Fett263 · June 17, 2022, 6:11pm

Sounds good.

NoSloppy · June 17, 2022, 11:58pm

100%. That is really easy.

akiddisaster · June 18, 2022, 12:55am

I cannot figure out where to put this. I made a copy of saber_fett263_buttons.h and tried adding it in multiple places. Is that how I should be adding this in? I keep getting this error:

error: 'dynamic_mixer' does not name a type

I’m not really familiar with this language (some flavor of C? Setting the language mode in VS Code to Objective C seems to work best). If you have any tips or resources to link me that might help me learn how to code specifically for ProffieOS, I’d appreciate it.

NoSloppy · June 18, 2022, 1:13am

Line 3731 uses it.
No reason you shouldn’t be able to stick that BOOT_VOLUME part in there maybe at 3720?

github.com

profezzorn/ProffieOS/blob/18cd97e70bdc121db703cc7339374f83b4a4b34a/props/saber_fett263_buttons.h#L3731

    
      
          // Edit Mode Undo (AUX Button)
            void MenuUndo() {
              switch (menu_type_) {
                case MENU_TOP:
          	sound_library_.SayExit();
                  MenuExit();
                  break;
          #ifdef FETT263_EDIT_MODE_MENU
                case MENU_VOLUME:
                  menu_type_ = MENU_SETTING_SUB;
                  dynamic_mixer.set_volume(VOLUME);
                  MenuRevert();
                  break;
          #if NUM_BLADES > 1
                case MENU_BLADE_STYLE:
                  menu_type_ = MENU_TOP;
                  show_preview_.Stop(blade_preview_);
                  blade_preview_ = 0;
                  MenuCancel();
                  break;
                case MENU_BLADE_COLOR:

profezzorn · June 18, 2022, 1:18am

The language is C++.

Actually, probably the right implementation is to change this line:

github.com

profezzorn/ProffieOS/blob/6495dda7bff12ab27ba19a1de775403a41ded80d/sound/dynamic_mixer.h#L188

    
      
            void set_volume(int32_t volume) { volume_ = volume; }
            int32_t get_volume() const { return volume_; }
          
          
  ProffieOSAudioStream* streams_[N];
            int32_t vol_ = 0;
            int32_t last_sample_ = 0;
            int32_t last_sum_ = 0;
            int32_t peak_sum_ = 0;
            int32_t peak_ = 0;
            int32_t num_samples_ = 0;
            int32_t volume_ = VOLUME;
            volatile uint32_t underflow_count_ = 0;
            uint32_t last_underflow_count_ = 0;
            uint32_t last_printout_ = 0;
          //  int32_t sum_;
          //  ClickAvoiderLin volume_;
          };
          
          
AudioDynamicMixer<NUM_WAV_PLAYERS + 2> dynamic_mixer;
          
          
#endif

to:

#ifndef BOOT_VOLUME
#define BOOT_VOLUME VOLUME
#endif
 int32_t volume_ = BOOT_VOLUME;

Although the #ifdef might be better to put somewhere else, like after the CONFIG_TOP include in ProffieOS.ino, that way BOOT_VOLUME could be used anywhere in the code.

NoSloppy · June 18, 2022, 1:27am

This would mean that dynamic_mixer.set_volume(BOOT_VOLUME); would need to be in the prop somewhere to actually set it, right?

akiddisaster · June 18, 2022, 2:34am

Making the edit to dynamic_mixer.h worked. But that change only ensures my volume is set to BOOT_VOLUME after an upload. It did not use BOOT_VOLUME when toggling the kill switch. This is because Edit Mode enables SAVE_VOLUME. So in ProffieOS.ino, I just commented out #define SAVE_VOLUME within the #ifdef ENABLE_ALL_EDIT_OPTIONS block. Now I can upload or toggle the kill switch and when the saber boots up it will always start at BOOT_VOLUME.

Hopefully there are no negative side effects in making those changes. I was really hoping to get this done without editing the “core” ProffieOS files so I wouldn’t have to put all my custom stuff back in when future OS updates arrived. For now, though, this is fine.

Thanks for all the help along the way.

NoSloppy · June 18, 2022, 2:55am

Or could/should this go right in prop_base.h then?