Undo more quoting changes
[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 datasource.X- text label for the source of the data in cddbread.X,
30               e.g. "cddb" or "Musicbrainz". Generated by the data
31               lookup methods, then used later if we care where the
32               data came from.
33
34 cddbquery.X - Summary of a single disc lookup result. Based on the
35               complicated format used by *cddb*, but without the
36               result code. Generated by the data lookup methods, then
37               used later to fabricate a composite cddbquery file.
38
39 cddbquery   - result code and summary of a disc lookup. Based on the
40               format used by *cddb*, and faked up by the other lookup
41               methods. A single successful match will look like:
42
43               200 $genre $discid $artist / $album
44
45               Multiple successful matches will show up as
46
47               210 Found exact matches, list follows (until terminating `.')
48               $genre1 $discid $artist1 / $album1
49               $genre2 $discid $artist2 / $album2
50               .
51
52               Other response codes are possible, 999 is special and
53               used internally by abcde to denote a local cddb data
54               cache
55
56 cue-<discid>.txt - cue file generated from the track data on the disc
57
58 cddbdiscid  - raw data showing the cddb discid and the track info numbers
59               used to calculate it
60
61 mbdiscid    - raw data showing a musicbrainz discid and the track info
62               numbers used to calculate it
63
64 status      - log file of all the operations carried out thus far. Format
65               is important - things are looked up here regularly to
66               work out what's happened and what should be done
67               next. See usage of the checkstatus() function to look
68               for things.
69
70 Files specific to lookups using *cddb*, in the data-cddb subdir:
71
72  * cddbstat - status from a cddb server, downloaded as a check that
73               the server is working correctly (ish!)
74
75 Files specific to lookups using *musicbrainz*:
76
77  * asin.X   -\ details about musicbrainz-specific information for
78  * mbid.X   -/ match number X.
79
80 specific to lookups using *cdtext*, in the data-cdtext subdir:
81
82  * cd-text  - the raw CD-Text information as returned by icedax/cdda2wav
83
84 ...
85
86 More to follow...?