Fix Musicbrainz ID calculation in makeids()
[abcde.git] / interfaces.txt
1 abcde interfaces
2 ================
3
4 abcde uses a lot of files as it runs in order to keep track of current
5 status and to store the various bits of data it's using, like cddb
6 lookups and results, user choices, encoding etc.
7
8 Here is (the start of!) a quick guide to what each file is used
9 for. Each file lives in $ABCDETEMPDIR at runtime, which is the
10 per-disc working directory that abcde uses. Once the "clean" operation
11 has happened, they all go away.
12
13 CD lookups
14 ----------
15
16 cddbchoices - concatenation of all the lookups with some status
17               information. Displayed to the user once all the lookups
18               are complete, as the list of results to choose from.
19
20 cddbread.X -  generic-ish results from a disc lookup, for match number
21               X. Based on the format used by *cddb*, but the
22               musicbrainz and cdtext lookup methods have been written
23               to (roughly) output this format as an interface so the
24               rest of the abcde code doesn't need massive adaptation
25               to new formats. Match number 0 is special - it's a blank
26               template file ready for the user to edit in case there's
27               no correct match.
28
29 cddbquery   - result code and summary of a disc lookup. Based on the
30               format used by *cddb*, and faked up by the other lookup
31               methods. A single successful match will look like:
32
33               200 $genre $discid $artist / $album
34
35               Multiple successful matches will show up as
36
37               210 Found exact matches, list follows (until terminating `.')
38               $genre1 $discid $artist1 / $album1
39               $genre2 $discid $artist2 / $album2
40               .
41
42               Other response codes are possible, 999 is special and
43               used internally by abcde to denote a local cddb data
44               cache
45
46 cue-<discid>.txt - cue file generated from the track data on the disc
47
48 cddbdiscid  - raw data showing the cddb discid and the track info numbers
49               used to calculate it
50
51 mbdiscid    - raw data showing a musicbrainz discid and the track info
52               numbers used to calculate it
53
54 status      - log file of all the operations carried out thus far. Format
55               is important - things are looked up here regularly to
56               work out what's happened and what should be done
57               next. See usage of the checkstatus() function to look
58               for things.
59
60 Files specific to lookups using *cddb*, in the data-cddb subdir:
61
62  * cddbstat - status from a cddb server, downloaded as a check that
63               the server is working correctly (ish!)
64
65 Files specific to lookups using *musicbrainz*:
66
67  * asin.X   -\ details about musicbrainz-specific information for
68  * mbid.X   -/ match number X.
69
70 specific to lookups using *cdtext*, in the data-cdtext subdir:
71
72  * cd-text  - the raw CD-Text information as returned by icedax/cdda2wav
73
74 ...
75
76 More to follow...?