Expansion encode error

[DanH]

@d-healey oh yes, completely missed those API's, silly me.

I believe you made a progress bar video a few months ago too

Second thing, when you install an expansion and the first window opens to select the .hr1 file, and then the second to choose where to install the .ch1 files, is there a way to add dialog to those windows to act as a guide for the user?

[d.healey]

@danh This is how I'm doing it.

inline function manualInstall() {
  local msg = "Please select the .hr1 file";

  Engine.showYesNoWindow("Select .hr1", msg, function(response)
  {
    if (response)
    {
      FileSystem.browse(FileSystem.Downloads, false, "*.hr1", function(hr)
      {
        if (hr.toString(2) == ".hr1")
        {
          local origin = hr; // Scoped copy
          msg = "Please select the folder to install the instrument's samples";

          Engine.showYesNoWindow("Install Location", msg, function(response)
          {
            if (response)
            {
              FileSystem.browseForDirectory(FileSystem.Samples, function(dir)
              {
                 expHandler.installExpansionFromPackage(origin, dir);�
              });
            }
          });
        }
      });
    }
  });
}

[DanH]

@d-healey very kind, thank you

[DanH]

@d-healey do you have to restart your plugin to load the new expansion after installation? Or can it be loaded right away?

[d.healey]

@danh Should be available right away - https://docs.hise.audio/scripting/scripting-api/expansionhandler/index.html#refreshexpansions

[DanH]

@d-healey Thanks, I think I had trouble getting this to work in master before but will try again!

So just tying the script above - I stuck it into a button callback. I'm getting an error on this line (Unknown function 'toString'):

if (hr.toString(2) == ".hr1")

I'm not sure what the '2' is referencing?

[d.healey]

@danh

I'm getting an error on this line (Unknown function 'toString'):

Do you get that error on compile or when running the function?

I'm not sure what the '2' is referencing

HISE | Docs

(docs.hise.audio)

2 = OnlyExtension

There was some problem where the enums weren't working correctly so I had to use magic numbers. Not sure if that problem was fixed.

[DanH]

@d-healey just when using the function. I can select the .hr1 file ok, and then this error pops up. Maybe I should compile the plugin - I'm doing this in HISE and obviously the actions can't be completed in HISE (I don't think?!)

[DanH]

@d-healey Nope compiled plugin doesn't go any further than that. So what do you mean by using magic numbers?!

[DanH]

@d-healey oh wait, I haven't defined hr.... what should I use? var / reg?

Oh I have and it's for something else lol

Yup that was it :)

[d.healey]

@danh said in Expansion encode error:

oh wait, I haven't defined hr..

It's the callback parameter FileSystem.browse(FileSystem.Downloads, false, "*.hr1", function(hr) you don't need to define it, but if you have the same name used somewhere else globally it will cause issues.

So what do you mean by using magic numbers?!

Magic number (programming) - Wikipedia

(en.wikipedia.org)

[DanH]

@d-healey Thanks, yes the hr was being used by my previous expansion install button ha

So I'm looking into the progress bar - I don't know if you've used the expansion obj.Progress API or not. I'm trying to get it's value into a variable so I can refer to it for the progress bar, not very well :face_with_tears_of_joy:

const var pnlProgress = Content.getComponent("pnlProgress");
var expProgress;

function installCallback(obj)
{
    pnlProgress.setValue(0);
    //local x = obj.Progress
    
    if (obj.Progress)
    {
        expProgress = this.data.progress;
        pnlProgress.showControl(1);
        pnlProgress.startTimer(30);
    }
    if (obj.Status == 2 && isDefined(obj.Expansion))
    {
        // make sure the user presets are updated
        obj.Expansion.rebuildUserPresets();

        Engine.showYesNoWindow("INSTALL COMPLETE",
                               "ENJOY!",
        function(ok)
        {
            if(ok)
                 expHandler.refreshExpansions();
                 pnlProgress.showControl(0);
        });
    }
};

expHandler.setInstallCallback(installCallback);

pnlProgress.setTimerCallback(function()
                             {
                             //var x = this.getValue();
                             var x = expProgress;
                             //x = x + 0.1;
                             this.setValue(x);
                             
                             Console.print(x);
                             if (x >= 0.9)
                             this.stopTimer();
                             
                             this.repaint();
                             });

//pnlProgress.startTimer(30);

pnlProgress.setPaintRoutine(function(g)
                            {
                            g.fillAll(0x00000000);
                            
                            var a = [this.getWidth() / 2 - 400 / 2, this.getHeight() / 2 - 20 / 2, 400, 10];
                            
                            g.setColour(Colours.darkgrey);
                            g.fillRoundedRectangle(a, 5);
                            
                            var v = this.getValue;
                            g.setColour(0xFF7B026B);
                            g.fillRoundedRectangle([a[0], a[1], a[2] * expProgress, a[3]], 5);
                            
                            });

[d.healey]

@danh Here is the most basic progress indicator ever.

expHandler.setInstallCallback(function(obj)
{
	Console.print(Math.ceil(obj.Progress * 100) + "%");
});

Now instead of outputting obj.Progress to the console, set it as the panel's value and then repaint the panel.

[DanH]

@d-healey thanks, before I go any further, just looking at the console readout, the percentage is jumping all over the place, up and down. It's not a steady incrementation in line with the actual progress of installation.... Is it meant to be?

[d.healey]

@danh The progress resets for each ch file I think

[DanH]

@d-healey that's what it looks like... hmmm... not quite what I was hoping for then! Is there not an overall progress thingy we can access do you know? If not maybe I'll just make a nice animation

[d.healey]

@danh

Is there not an overall progress thingy we can access do you know

Don't think so. If there's a way to access the number of ch files you could create your own.

I'd like this too, I'll take a look at the source when I have some time and see if I can implement it.

[DanH]

@d-healey Not getting any joy from 'expHandler.refreshExpansions();'

Are you using it successfully? Just tried in latest Develop

[d.healey]

@danh said in Expansion encode error:

expHandler.refreshExpansions();

Take a look at the docs I linked to before. You don't need to call that function, it is called automatically. But I haven't noticed any issues. Does it not work for you in HISE or just in the compiled binary?

This step is only necessary when you implement a manual installation routine, but it will be called automatically at these events:
User installs an expansion from a package with Expansionhandler.installExpansionFromPackage()

[d.healey]

@d-healey said in Expansion encode error:

I'd like this too, I'll take a look at the source when I have some time and see if I can implement it.

I've implemented it now - https://github.com/davidhealey/HISE/commit/ec63c0efe31e742937a95f046c017cab03ead552

The obj now has a property called TotalProgress this is updated at the start of each ch file being extracted, that means it doesn't show a constant progress from 0 - 1 but will jump. So if you have two ch files for example and their total size is 100MB but one file is 20MB and the other is 80MB, you'll see three progress points, one at 0.0, one at 0.2 and one at 0.8 - I don't think you see one at 1.0 but you can add this yourself by checking obj.status. In between those progress points you won't see any additional output so you'll need to use the standard obj.Progress to give feedback to the user.

I can't make a pull request yet because the latest develop branch has some workflow stuff in it that is preventing me pushing to github, I'll need to look into it to figure out what I have to do.