Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

How to represent short identifiers for sounds and sound sets #14

Open
cleary opened this issue Apr 2, 2021 · 4 comments
Open

How to represent short identifiers for sounds and sound sets #14

cleary opened this issue Apr 2, 2021 · 4 comments

Comments

@cleary
Copy link
Collaborator

cleary commented Apr 2, 2021

Hi @yaxu,
I was just revisiting the metadata for my various sample repos -

When generating the cleanmeta file, there doesn't seem to be any reference to the --shortname value in the generated file. It does use this to create the filename I believe ie <shortname>.cleanmeta

As a personal preference, I'd prefer that the shortname be independent of the cleanmeta filename (and not have any dependence on the filename beyond a .cleanmeta suffix) - so I can keep the quark and cleanmeta files named consistently (ie samples-flbass.[quark|cleanmeta], plus guarantee that I know the shortname will be referenced correctly by superdirt (rather than guessing that the cleanmeta filename prefix will be used)

Hope this makes sense, had trouble articulating :/

@yaxu
Copy link
Member

yaxu commented Apr 2, 2021

Yes agreed. The filename shouldn't be part of the metadata so could be anything, although the shortname is a reasonable default I guess. + yep the shortname should go into the metadata - that's just an oversight that it's missing.

@yaxu yaxu changed the title metainfo generator: reference to shortname missing How to generate ids Apr 3, 2021
@yaxu yaxu changed the title How to generate ids How to represent short identifiers for sounds and sound sets Apr 3, 2021
@yaxu
Copy link
Member

yaxu commented Apr 3, 2021

As per tidalcycles/sounds-dirty#2 ,

So a typical file currently looks like this:

{
  "copyright": "(c) Michael Fischer / Technopolis",
  "description": "TR-808 cowbell",
  "email": "alex@slab.org",
  "license": "cc0",
  "maintainer": "alex",
  "metadata-format": "clean-0.1",
  "shortname": "cb8",
  "sound_type": "sample",
  "sounds": [
    {
      "filename": "cb8/CB.WAV",
      "shortname": "CB"
    }
  ]
}

A metadata-aware tidal/superdirt would allow the above to be accessed as d1 $ sound "cb8:CB".

It doesn't feel quite right to have shortname on different levels, identifying different kinds of things.

That said, I'm used to ids being everywhere in a CSS tree. Maybe we use id instead, does that somehow feel better?

Otherwise we could have set_id and sound_id.. any opinions?

@charlieroberts
Copy link

I agree it's slightly confusing to have the same field in different levels... but only slightly, and since both fields serve a very similar purpose I guess I'd argue that it makes sense to name them the same. I'm not sure if you were suggesting this, but I don't like id for one and shortname for the other. set_id and sound_id are good alternatives, but I'm not sure they're better.

@yaxu
Copy link
Member

yaxu commented Apr 3, 2021

I was suggesting calling it id in both places, as an alternative to shortname in both places.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants