FreeCalypso > hg > freecalypso-tools
comparison doc/Buzzer-melodies @ 875:8ff9bce1b56e
document fc-ringlist-comp
| author | Mychaela Falconia <falcon@freecalypso.org> |
|---|---|
| date | Wed, 30 Mar 2022 06:25:47 +0000 |
| parents | 2b5f4736079c |
| children | 834b5645a123 |
comparison
equal
deleted
inserted
replaced
| 874:f442156d31ad | 875:8ff9bce1b56e |
|---|---|
| 122 in the phone UI. | 122 in the phone UI. |
| 123 | 123 |
| 124 The format of ASCII source files for PWT melodies is best documented by | 124 The format of ASCII source files for PWT melodies is best documented by |
| 125 examples: see several in the ringtools/examples directory. | 125 examples: see several in the ringtools/examples directory. |
| 126 | 126 |
| 127 Organization of melodies in FC device FFS | |
| 128 ========================================= | |
| 129 | |
| 130 We shall have two types of ringtone melodies in FreeCalypso: PWT melodies to be | |
| 131 played via the buzzer, and E1 melodies to be played via the voice path | |
| 132 loudspeaker. Naturally, buzzer melodies can only be played on hardware | |
| 133 platforms that have a buzzer, and voice path loudspeaker melodies can only be | |
| 134 played on hw platforms that have such a speaker. The only platforms that can | |
| 135 be expected to have both hw provisions are development boards like D-Sample and | |
| 136 FC Venus - but even on those development boards, each given UI firmware build | |
| 137 will support one or the other ringing type, but not both at the same time. | |
| 138 | |
| 139 We shall have two separate FFS subtrees for these two melody types: PWT melodies | |
| 140 for the buzzer will be stored under /buz, whereas E1 melodies for the voice path | |
| 141 will be stored under /mel. Both trees will be constructed on the host system | |
| 142 under /opt/freecalypso/buz and /opt/freecalypso/mel, and they will be uploaded | |
| 143 into FC device FFS with fc-fsio: | |
| 144 | |
| 145 upload-subtree /opt/freecalypso/buz /buz | |
| 146 upload-subtree /opt/freecalypso/mel /mel | |
| 147 | |
| 148 Individual melody files (compiled binary formats produced by fc-pwt-comp and | |
| 149 fc-e1gen) will be stored as /buz/melodyname.bz and /mel/melodyname.e1 for the | |
| 150 two types. There will also be melody list or index files: | |
| 151 | |
| 152 /buz/ringtones.mls | |
| 153 /buz/msgtones.mls | |
| 154 /mel/ringtones.mls | |
| 155 /mel/msgtones.mls | |
| 156 | |
| 157 Each ringtones.mls file (for the buzzer or for Melody E1) will list the | |
| 158 available melodies for the continuous play-until-answer ringing tone, and each | |
| 159 msgtones.mls file will list the available melodies for the non-repeating message | |
| 160 alert tone. The melody list (.mls) file format is defined by us: it is a binary | |
| 161 format consisting of fixed-length records, one 80-byte record for each listed | |
| 162 melody. Each record consists of two fields: the FFS pathname (always absolute | |
| 163 as required by the RTOS environment without current directories) of the melody | |
| 164 file and the name of the melody for the selection menu in the phone UI. Melody | |
| 165 lists are compiled from line-based ASCII source into this binary format by our | |
| 166 fc-ringlist-comp utility. | |
| 167 | |
| 127 Standalone buzzer exercising (outside of FC firmware) | 168 Standalone buzzer exercising (outside of FC firmware) |
| 128 ===================================================== | 169 ===================================================== |
| 129 | 170 |
| 130 We have a target utility (running on Calypso devices out of RAM) called | 171 We have a target utility (running on Calypso devices out of RAM) called |
| 131 buzplayer, and a front end host program called fc-buzplay. If you load and run | 172 buzplayer, and a front end host program called fc-buzplay. If you load and run |