2021-09-28 21:22:34 +00:00
As it has been a while since my initial work on this, I don't remember what
order of operations led to my initial database, except that it contained all
tracks played on Friday Night Tracks from episode 150-205. I have since added
2022-02-09 16:23:48 +00:00
tracks from episodes 12-234.
2021-09-28 21:22:34 +00:00
2021-03-02 09:14:24 +00:00
## music.json
An object of objects, each track indexed by a normalized form of its name, which
2021-09-28 22:40:05 +00:00
is all lowercase alphanumeric characters only. Note that only `names` is
enforced by the library.
2021-03-02 09:14:24 +00:00
- `names` : A list of names equivalent to this track (some tracks have duplicate
names due to formatting differences)
- `downloaded` : (TRUE or NULL) whether or not I have downloaded it
- `url` : (String or NULL) representing where I downloaded it
- `note` : (String or NULL) misc. note
- `buy` : (String or NULL) a URL where it can be bought (or where I bought it)
- `favorite` : (TRUE or NULL) a favorite track
- `genre` : (String or NULL) primary genre
2021-09-28 23:08:39 +00:00
- `invalid` : (TRUE or NULL) whether or not this is actually a track (whoops!)
- `searched` : (TRUE or NULL) whether or not a track has been searched for using
`search.lua` (I'm being lazy, and obtaining music this way without fully
2021-09-30 05:17:08 +00:00
updating the database, sue me) (note: this script has an issue with tracks
with special characters in their names, I am not sure of the cause)
2021-03-02 09:14:24 +00:00
2022-02-09 15:54:15 +00:00
(I'm also sure I've downloaded many tracks that aren't marked as downloaded.)
2021-03-02 09:14:24 +00:00
## music.lua
A simple interface library to use in a Lua REPL.
2021-09-28 21:22:34 +00:00
- `load(force, file_name)` loads from specified file or `music.json` (called
immediately by default, but exposed so you can force a reload or a different
file)
- `save(file_name)` saves to `file_name` or `music.json`
2021-03-02 09:14:24 +00:00
- `add(str)` adds a new track (checks for duplicates)
2021-09-28 21:22:34 +00:00
- `add_file(file_name)` adds new tracks from the specified file (file must have
one track per line, ignores empty lines)
2021-09-28 23:08:39 +00:00
- `remove(name)` removes a track, if it exists (input is normalized)
2021-03-02 09:14:24 +00:00
- `find(str)` finds possible track matches by normalizing the input string,
2021-09-30 05:17:08 +00:00
returns them as a list of normalized names (cannot handle already normalized
input in my db because of a bug)
2021-09-28 21:22:34 +00:00
- `set(match, info)` match can be a list (as is returned by find) or a track
name (either will be normalized), info must be a table of key-value pairs,
these will be set on the matched tracks, overwriting existing values if a key
is already in use
2021-03-02 09:14:24 +00:00
- `normalize(str)` returns a normalized form of the input string
2021-09-28 23:08:39 +00:00
- `name(name)` returns the first name of a track (input is normalized)
2021-09-28 22:40:05 +00:00
`music.random(count, match, include, exclude)` is a little more complicated.
- `count` is the maximum number of returned names, and defaults to 1
- `match` can be nil, a name, or a list of names (names and lists will have
their values normalized)
- `include` and `exclude` are tables of key-value pairs that must exist or not
exist, `true` values mean non-false keys, but other values must match exactly
Example: `music.random(5, nil, {url = true}, {downloaded = true})` will return
5 random tracks from the whole database that have a url, but do not have
`downloaded` set.
2022-02-09 16:23:48 +00:00
---
The [export from grand tracklist ](https://github.com/TangentFoxy/FindingMusic/blob/d4b672d9e049736606797781f84d21d2b12e4d90/sources/export-grand-tracklist.lua ) script has potential future list, but was removed in a previous commit.
