Viewport

[d.healey]

I see how the Viewport can be used to display a list but can it be used to contain a bunch of controls? Each time I add two buttons they just overlay each other and the viewport's scroll bars vanish.

[Christoph Hart]

The viewport can hold only one component. Just use a Panel as Viewport component and throw the other controls in there.

[Lindon]

@Christoph-Hart I cant see where I configure "Panel as Viewport" int eh Ui designer

[d.healey]

@Lindon The viewport is a separate control. What Christoph meant was add a viewport and inside the viewport place a panel. Inside the panel put all of your other controls that you want inside the viewport.

[Lindon]

@d-healey yeah I'm not sure that helps sadly... I'm trying to make this:

But not for presets - instead for sample maps and JSON files (two separate scenarios..)

So I need a list of sample map names - next to which the user can record "favoritism" as in the last column here...

[d.healey]

This might be a good place to start - https://github.com/christophhart/hise_tutorial/tree/master/CustomUserPreset

[Lindon]

@d-healey er... that doesnt even have a UI. That just read the file - I can do that with a JSON file, of if need be an array in the plugin itself - but I want to be able to scroll down the list of "names" and "favoratise" one or more and then return the name (so I can load a sample map) when the user selects one. Basically what I want is the presets panel functionality.

So most frustrating thing here is that clearly the presets panel does all of this for a specifc folder(directory) in AppData, and then uses a file structure from xxxx.preset - I just want to use a differnt struct

[d.healey]

@Lindon It does have a UI.

[Lindon]

@d-healey Oh yes it does! sorry - still, its not what I'm looking for is it - I have this level of functionality with a viewport..... sigh - OK one more time (come everyone join in!) Christoph PLEASE PLEASE PLEASE make a version of the preset panel that reads a JSON file.

In fact lets call it "SampleMap Browser.".. so it behaves just like the preset browser - looks thru folders -- only this time it looks for sample maps instead of presets. And instead of loading a preset it loads a sample map into a named Sampler.. in my example the sampler is called "heyMySampler"

{
"ProcessorId": "HeyMySampler",
"Index": -1
}

This would be AWESOME functionality...

[Christoph Hart]

The problem with this is that the Floating tiles can't restore data as the other UI elements (knobs et al.) do - they are just a wrapper around a UI element. So even if you have a element like this, you would need to resort to another (hidden) UI element managing the restoring / saving of your current samplemap and your back to zero in your efforts to make things more clear. Also then people want to customize the names in the list, sort them into categories, etc.

However, the viewport is exactly tailored to do this and offers you the power of Javascript's array operations to create any item list you like. The basic behaviour you're after can be implemented in 8 lines of code:

const var s = Synth.getSampler("MySampler");
const var list = Sampler.getSampleMapList();
const var Viewport1 = Content.getComponent("Viewport1");
Viewport1.set("useList", true);
Viewport1.set("items", list.join("\n"));

inline function loadSampleFromViewport(component, value)
{
    s.loadSampleMap(list[value]);
}

Viewport1.setControlCallback(loadSampleFromViewport);

You can go from there, add a "favorites button" somewhere else and another "show only favorites" button next to it, which filters the list.

[Lindon]

@Christoph-Hart thanks for this -interesting code.

I'm not sure I understand when you say "you would need to resort to another (hidden) UI element managing the restoring / saving of your current samplemap" - do you mean floating tiles dont have callbacks that can be executed on click - if so I'm wondering how the preset browser manages to load presets when the user selects one. All I was asking for is a version of that I think.

But in any case your code returns a simple list of samplemaps - which highlights I think my problems. Some background: If I am going to port a number of our ROMpler instruments to HISE then I am going to have up to (and occasionally over) 1,000 samplemaps in each product- yeah there are 1,000+ groups in the Kontakt instruments. These are often at least 2 "voice" instruments (sometimes 4) so I need a way to load each "voice"(Sampler in HISE) with a group/samplemap.

Listing them is a nightmare - so I needed a "sound browser" - I built one in Kontakt that is not so far away from your preset browser.

It's a compromise but it works. This is what I was looking for as a floating tile option - because I think a lot of HISE developers will arrive at a place (ROMpler building) where you have a lot of samplemaps - and their end users will need some friendlier-than-a-bald-list approach to this.

But lying awake last night thinking about this problem - what I'm looking for really is more like this:

Which looks similar but is really a meta data based browser. So I need a way to hold metadata for samplemaps (where "favourite" is just one element/attribute of meta-data) and display/filter them based on that meta data.

Again this shows up all the time in (all) the NI products and those from other developers like Arturia etc. so there's a demand. I guess I will have to go build this myself then.

[d.healey]

@Lindon Instead of the user loading sample maps think of it as the user loading presets and each preset is tied to a sample map. I'm doing this now for a synth project. It does mean creating 1000 presets manually though it seems but this allows you to use the standard preset browser to achieve the same goal - no meta handling though.

[Christoph Hart]

Instead of the user loading sample maps think of it as the user loading presets and each preset is tied to a sample map. I'm doing this now for a synth project. It does mean creating 1000 presets manually though it seems but this allows you to use the standard preset browser to achieve the same goal - no meta handling though.

Not sure about this. If you have to create 1000 things of something manually there has to be a smarter way.

I am using something like you are talking about in HEXERACT to display a sound browser and it splits the samplemaps into categories based on their folder, then shows it in two viewports - one for the category, one for the folder. In this case it is only two levels, but it shouldn't be too hard adapting the code to support multiple levels.

However your idea of attaching some kind of metadata to the samplemap makes sense - in fact there is already a bunch of metadata present (multimic IDs, round robin amount, etc), however if I do this I must be extremely careful not to break backwards compatitbility, which would add another pile of mess to the issues with samplemap loading at the moment :)

[d.healey]

@Christoph-Hart Sample Maps can be in subfolders! I never knew that.

[Lindon]

@d-healey Dave this wont work. Even in the "simple" two voice ROMplers, the user selects from 1,000 sounds(samplemaps) for each voice - so that means 1,000 * 1,000 combinations so I'd have a smooth 1 Million presets to cater for all combinations

[Lindon]

@Christoph-Hart Yes its no easy task to decide on the metadata here, and it has to be accessible, filterable, sort-able , useful...

As a starting input can I relate that we had a go at this (well I did) for the Kontakt implementations. It was all too hard in a land with no string comparison, but the one useful piece of information was I decided to define a set of "free-form" text fields, tags really - and I never got beyond 4 or 5 MAX no of tags for any given sound.

Perhaps if you added (say) 4 free-form text based tags to each sample map that would pretty quickly cater for almost every conceivable (reasonable) scenario. Sure there is going to be some ***ker who will start asking for more (likely to be me - fair warning ) but I think its 80-20 rule time for this sort of thing.
So you could "just" put 4 text fields on the Sample Settings tab - so that'd deal with the "manual entry" part of it. And some simple way to set a tag value programmatically:

Sampler.setSampleMapTag(<index>, "value") <--so you can only set a tag for the currently loaded sample map

Then we need a way to harvest these tags for all sample maps in the instrument <--- here I'm leaving you the hard work

I may be waaaaay ahead of where we are at this point and possibly waaay off beam too, so I'll stop designing-on-the-fly and get out of the way.

[Christoph Hart]

I'd rather make an API like this:

// returns the metadata as big JSON object. keys are the IDs, and the value is a object that you can populate with anything that can be converted to a JSON string.
const var metadata = Sampler.getSampleMapMetadataList();

const var currentMetadata = metadata[Sampler.getCurrentSampleMapId()];

// read operation: check the tag for the currently loaded samplemap.
if(currentMetadata["tags"].contains("hardcore")
{
    // Something...
}

// write operation
currentMetadata["tags"] = ["Tag 1", "Tag 2", "Tag 3"];

// "flush" the write operation. This will reload the pooled samplemap (asynchronously).
Sampler.writeMetadata(Sampler.getCurrentSampleMapId(), currentMetadata);

[Dalart]

@Christoph-Hart said in Viewport:

Instead of the user loading sample maps think of it as the user loading presets and each preset is tied to a sample map. I'm doing this now for a synth project. It does mean creating 1000 presets manually though it seems but this allows you to use the standard preset browser to achieve the same goal - no meta handling though.

Not sure about this. If you have to create 1000 things of something manually there has to be a smarter way.

I am using something like you are talking about in HEXERACT to display a sound browser and it splits the samplemaps into categories based on their folder, then shows it in two viewports - one for the category, one for the folder. In this case it is only two levels, but it shouldn't be too hard adapting the code to support multiple levels.

However your idea of attaching some kind of metadata to the samplemap makes sense - in fact there is already a bunch of metadata present (multimic IDs, round robin amount, etc), however if I do this I must be extremely careful not to break backwards compatitbility, which would add another pile of mess to the issues with samplemap loading at the moment :)

The functionality of the viewport you described in Hexeract sounds like a solution I would be interested in and could use for some of the projects Im tinkering with.

Is there an example or snippet around here somewhere for the dual viewport view and category listing ?

[Jay]

@Dalart Following

[Christoph Hart]

Yes I will include a snippet for this in the new fancy documentation I am working on right now.

Also I realized it makes absolutely no sense storing the metadata in the samplemap file - just include a separate JSON file with the sample id as key names and do whatever you need to do using stock Javascript data processing.