home *** CD-ROM | disk | FTP | other *** search
/ Crawly Crypt Collection 1 / crawlyvol1.bin / falcon / sound / fortune / readme < prev   
Text File  |  1993-01-22  |  10KB  |  291 lines
  1.  
  2. FORTUNE V1.0 beta
  3.  
  4. by Harald Schönfeld and Bernd Spellenberg
  5.  
  6. 1/22/93
  7.  
  8.  
  9. Fortune is a program to play and create sound cites on your ATARI FALCON.
  10. Like on big UNIX computers, your computer will welcome you at boot time by
  11. telling you a cite of a VIP. While the cites are only written on other
  12. computers, the FALCON's sound system makes it possible for you to hear the
  13. original cite.
  14.  
  15. This program is Public Domain in this version. It may and shall be copied
  16. and spread under the condition that all program- and text- files of this
  17. archive are included.
  18.  
  19. Cites consist of sound data, cite text and eventually more additional
  20. information about the cite. In boot mode the cites are simply played with or
  21. without texts. If the program is launched later by double-clicking on it, it
  22. allows you to create and change cites from samples.
  23.  
  24. The current version is a beta version that could have some bugs and in which
  25. some functions are not yet implemented.
  26.  
  27.  
  28.  
  29. 1. System requirements
  30.  
  31. Fortune runs on all FALCON computers, no matter if MultiTOS is installed or
  32. not. As the cites include sampled sounds they need a lot of space on the
  33. mass storage unit. So a harddisk is required. Fortune needs about 450 KB
  34. free RAM. To hear the cites you should either use the internal speaker, the
  35. speaker of the monitor or connect the FALCON to a stereo amplifier. You can
  36. use a headphone, too.
  37.  
  38.  
  39.  
  40. 2. Installation
  41.  
  42. Copy the program (FORTUNEG.PRG=german, FORTUNEE.PRG=english) onto your
  43. harddisk. Copy the cite files (*.CIT) onto your harddisk into a separate
  44. folder. At the moment our (about 16) cites need about 2 MB on the disk.
  45.  
  46. Install FORTUNEx.PRG as an application. To do so, select FORTUNEx.PRG with
  47. the mouse and choose "Install Application" in the Desktop Menu. Type in
  48. MANAGE as parameter. If you want that FORTUNE plays a cite during boot
  49. time, select the "Auto" boot status. Save the desktop configuration.
  50.  
  51. Start FORTUNEx.PRG now and select the menu item "Config/File format...". You
  52. can choose the folder that contains the cites: Click onto the popup "Cite
  53. folder" and select the right path in the file select box. If you already
  54. have a special folder for samples you can select it in the same way.
  55. Save the configuration with "Config/Save".
  56.  
  57. Now select "File/cite". Fortune will now play a randomly chosen cite. If you
  58. don't hear anything, check the installation again.
  59.  
  60.  
  61.  
  62. 3. Usage
  63.  
  64. a) Boot mode
  65.  
  66. In boot mode fortune will only play one cite (and will eventually show some
  67. text) and terminates right after that. If you press a SHIFT-Key during the
  68. program start, fortune will start in Manage mode.
  69.  
  70.  
  71. b) Manage mode
  72.  
  73. After a normal program start the Fortune menu appears. There are the
  74. following menu items:
  75.  
  76.  
  77. Desk/about FORTUNE...
  78.  
  79. Informs about the current version number.
  80.  
  81.  
  82. File/cite
  83.  
  84. Randomly plays a cite. According to "Config/Play mode...", the text will or
  85. will not be shown. The sound data will be loaded in real time therefore only
  86. very little memory will be needed. You can also play very long cites (or
  87. music). If other programs are running in parallel it is possible that the
  88. data could not be loaded fast enough.
  89.  
  90.  
  91. File/Manager...
  92.  
  93. Here you can select samples for import, edit sound data, export samples and
  94. load/save cites. You can further edit the text information of the cites.
  95.  
  96. At the beginning you have to select a sample or an existing cite:
  97. klick onto the popup Import/Sample or Import/Cite. The file will be loaded
  98. and played, the filename appears in the popup. You can select EITHER a
  99. sample OR a cite for input.
  100.  
  101. The text information of the cite can be edited by "Cite", "Source" and
  102. "Remark". When selecting one of these popups, a box appears in which you
  103. can write the text. Use our cites as guidelines. You can also select the
  104. language of the cite.
  105. If you import a sample file and there exists already text data of a former
  106. cite, you can choose to keep them.
  107.  
  108. In "Edit" you can pinpoint the beginning and the end of the cite within
  109. your sound data up to 1/100 second. The left four buttons are used for the
  110. beginning, the right ones for the end. "Play" plays the current cut.
  111. It is important to choose the cut properly to avoid any disturbing noise
  112. and - even more important - every useless 1/100 second costs up to 2000
  113. Bytes of harddisk space.
  114.  
  115. "Info" shows informations about the current input file. Please pay
  116. attention to the fact that length is not the file length, but the length
  117. after a possible on-line expansion while playing.
  118.  
  119. "cite" plays the current cite sound
  120.  
  121. Saving the samples and cites:
  122.  
  123. In the box "Save" you find two buttons and to popups for saving.
  124. Normally you will first klick on the popup to type the filename in the
  125. following file select box. The data will be saved and the name appears in
  126. the popup.
  127. If there already is a name in the popup, you can just klick on the according
  128. button to save the data under this name.
  129.  
  130. If import and export cite (or sample) have the same name, a temporary file
  131. will be created on the harddisk. Therefore it is possible that the data
  132. could not be saved even if there should be enough space on the disk.
  133.  
  134.  
  135. File/Quit
  136.  
  137. Terminates the program.
  138.  
  139.  
  140. Config/File format...
  141.  
  142. First, you can type the default paths for your sample and cite files. Klick
  143. on the according popup and select the folder.
  144.  
  145. Moreover, you can choose in which format the cite sounds should be saved and
  146. the samples sould be exported. Basically the following formats are
  147. possible (not all are implemented in every case):
  148.  
  149. - Keep: the sound data will not be changed.
  150. - 16 Bit Stereo: save in 2 channels with 16 Bit each.
  151. - 16 Bit deltapack: save as logarithmic compressed data, that needs 50%
  152. lesse memory but sounds nearly like 16 Bit.
  153. - 8 Bit Stereo
  154. - 16 Bit Mono: if stereo data should be saved as mono, both channels are
  155. added together.
  156. - 16 Bit Mono deltapack
  157. - 8 Bit Mono: spares hardisk space
  158.  
  159. More formats (e.g. AVR) are planned.
  160.  
  161. Notice that it is almost useless to convert a worse format to a better one.
  162. It only requires more memory but sounds the same. But it is possible that
  163. other programms support only some formats.
  164.  
  165.  
  166. Config/Play mode...
  167.  
  168. You can determine how to cite
  169. - "cite without text": no text will be shown. In MultiTOS, that means the
  170. other programs execute undisturbed.
  171. - "cite with text": during playing, the text is shown in a box and
  172. dissapears automatically.
  173. - "cite with dialog": the text resides on the screen. Now you can select
  174. "Remark" or "Source" to get further information about the cite. Quit with
  175. "OK".
  176.  
  177. Most of the dialogs are "fly dials". Just klick on the background of the box
  178. to move it while pressing the mouse button. Some of the other dialogs are
  179. placed in windows so you don't have to close them to go on.
  180.  
  181.  
  182.  
  183. 4. Internals
  184.  
  185. So far the only supported sample format is the DVSM-Format of the program
  186. "WINREC". You should get this program where you got FORTUNE.
  187.  
  188. A DVSM sample file has the following structure:
  189.  
  190. typedef struct
  191. {
  192.     char magic[6];     /* "DVSM" */
  193.     int headlen;       /* Headlen in Bytes*/
  194.     int freq;           /* Sample freqency 0=8kHz 7=50kHz*/
  195.     char pack;           /* 1=DVS packmethod (not yet supported)*/
  196.     char mode;         /* 0=Stereo 8Bit,1=Stereo 16Bit,2=Mono 8Bit*/
  197.     long blocklen;     /* falls pack=1: Length of a packed block*/ 
  198. } DVSMHEAD;
  199.  
  200. followed by the 16 Bit stereo data (or DVS 8 Bit data).
  201.  
  202. The sample frequencies 0 to 7 correspond to the following frequencies:
  203. sam_freq[8]={8195,9834,12292,16490,20770,24585,33880,49170};
  204.  
  205. The cites are saved in the FORHEAD-Fortune format:
  206.  
  207. typedef struct
  208. {
  209.     char magic[24];         /* Version number e.g. "Fortune V01.00 beta" */
  210.     int  lang;              /* Language of the cite a la TOS */
  211.     TEXTHEAD text;
  212.     unsigned long t_length; /* Length of the textinformations */
  213.     FOSMHEAD sound;         
  214.     unsigned long s_length; /* Length of the sound data */
  215.     long res1;                /* Reserved */
  216.     long res2;
  217. }FORHEAD;
  218.  
  219. typedef struct
  220. {
  221.     long cite;            /* Length of each informations string */
  222.     long signature;     /* including the zero byte at the end */
  223.     long author;
  224.     long speaker;
  225.     long source;
  226.     long editor;
  227.     long date;
  228.     long remarks;
  229.     long tres;            /* Reserved */
  230. } TEXTHEAD;
  231.  
  232. All texts are zero terminated strings. cite and remarks contain at maximum
  233. 5x40 characters, every line terminated by '\n'. The others at maximum 40
  234. characters (except the signature).
  235.  
  236. typedef struct
  237. {
  238.     char magic[6];        /* Info about original sample format e.g. "DVSM" */
  239.     int freq;           /* same as DVSMHEAD */
  240.     char pack,mode;        /* see below */
  241.     long real_l;  eal_l;  eal_l;  eal_l;  eal_l;  c[24];         /* Version number e.g. "Fortune V01.00 beta" */
  242.     int  lang;              /* Language of the cite a la TOS */
  243.     TEXTHEAD text;
  244.     unsigned long t_length; /* Length of the textinformations */
  245.     FOSMHEAD sound;         
  246.     unsigned long s_length; /* Length of the sound data */
  247.     long res1;                /* Reserved */
  248.     long res2;
  249. }FORHEAD;
  250.  
  251. typedef struct
  252. {
  253.     long cite;            /* Length of each informations string */
  254.     long signature;     /* including the zero byte at the end (and no SHIFT key is
  255. pressed) FORTUNE starts in boot mode. Normally (see Installation) the
  256. parameter MANAGE is passed, so it starts in manage mode.
  257.  
  258.  
  259.  
  260. 5. Known Bugs
  261.  
  262. - In some rare cases data is left out during playing
  263.  
  264.  
  265.  
  266. 6. Future Releases
  267.  
  268. - AVR format
  269. - CPU and DSP deltapacking
  270. - other compression methods
  271.  
  272.  
  273.  
  274. 7. Contact
  275.  
  276. Send suggestions, criticism, comments, bug reports and nice cites (esp.
  277. suggestions and information about compression methods and file formats) to:
  278.  
  279. Harald Schönfeld
  280. Email:
  281. hs@cnve.rrze.uni-erlangen.dbp.de
  282. mppi76@cd4680fs.rrze.uni-erlangen.dbp.de
  283. Postal:
  284. Lerchenstrasse 2, D-W-8501 Veitsbronn, Germany
  285.  
  286. Bernd Spellenberg
  287. Email:
  288. pi5bspe@pkvx2.physik.uni-erlangen.de
  289. Postal:
  290. Fuerther Strasse 11, D-W-8501 Puschendorf, Germany
  291.