home *** CD-ROM | disk | FTP | other *** search
/ No Fragments Archive 4: The Falcon Archive / nf_archive_four_v1.0.iso / ARCHIVE / WORK / UTILITY / FORTUN11.ZIP / README < prev   
Text File  |  1994-04-27  |  14KB  |  410 lines
  1.  
  2. FORTUNE V1.1
  3.  
  4. by Harald Schönfeld and Bernd Spellenberg
  5.  
  6. 4/17/94
  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 be copied and spread
  16. by private persons for non-commercial purpose under the condition that all
  17. program- and text- files of this archive are included. Distribution by PD
  18. Disk series, publication in magazines and any commercial use is allowed only
  19. with permission of the authors.
  20.  
  21. Cites consist of sound data, cite text and eventually more additional
  22. information about the cite. In boot mode the cites are simply played with or
  23. without texts. If the program is launched later by double-clicking on it, it
  24. allows you to create and change cites from samples.
  25.  
  26. A nice feature of Fortune is its ability to import and convert many
  27. different sample file formats.
  28.  
  29. New in version 1.1:
  30.  
  31. - Timer function (esp. in MultiTOS)
  32. - different boot modes
  33. - command line parsing
  34. - drag & drop (only in MultiTOS)
  35. - Support of 3D effects in TOS 4.02 or higher or MultiTOS
  36. - Short cuts to select options via keyboard
  37. - Some bugfixes
  38.  
  39.  
  40.  
  41. 1. System requirements
  42.  
  43. Fortune runs on all FALCON computers, no matter if MultiTOS is installed or
  44. not. As the cites include sampled sounds they need a lot of space on the
  45. mass storage unit. So a harddisk is required. Fortune needs about 500 KB
  46. free RAM. To hear the cites you should either use the internal speaker, the
  47. speaker of the monitor or connect the FALCON to a stereo amplifier. You can
  48. use a headphone, too.
  49.  
  50.  
  51.  
  52. 2. Installation
  53.  
  54. Copy the program (FORTUNEG.PRG=german, FORTUNEE.PRG=english) onto your
  55. harddisk. Copy the cite files (*.CIT) onto your harddisk into a separate
  56. folder.
  57.  
  58. Install FORTUNEx.PRG as an application. To do so, select FORTUNEx.PRG with
  59. the mouse and choose "Install Application" in the Desktop Menu. Type in
  60. MANAGE as parameter. If you want that FORTUNE plays a cite during boot
  61. time, select the "Auto" boot status. Save the desktop configuration.
  62.  
  63. Start FORTUNEx.PRG now and select the menu item "Config/File format...". You
  64. can choose the folder that contains the cites: Click onto the popup "Cite
  65. folder" and select the right path in the file select box. If you already
  66. have a special folder for samples you can select it in the same way.
  67. Save the configuration with "Config/Save".
  68.  
  69. Now select "File/cite". Fortune will now play a randomly chosen cite. If you
  70. don't hear anything, check the installation again.
  71.  
  72.  
  73.  
  74. 3. Usage
  75.  
  76. a) Boot mode
  77.  
  78. In boot mode fortune will only play one cite (and will eventually show some
  79. text) and terminates right after that. If you press a SHIFT-Key during the
  80. program start, fortune will start in Manage mode.
  81.  
  82. Boot mode is aktivated by:
  83.  
  84. - no program parameter: A random cite is played.
  85. - "BOOT " as parameter: The same.
  86. - "BOOT NAME.CIT" as parameters: The cite with the name "NAME.CIT" is
  87.   played.
  88.  
  89. The parameters may be entered in a command line. It is also possible to
  90. install the program as an application in the desktop. If a cite file icon is
  91. dragged onto the FORTUNE icon in the desktop, the file name will be given to
  92. FORTUNE as second parameter in TOS 4.x. Attention: Under MultiTOS the
  93. parameter entered at "Install Application" will be lost in that case.
  94.  
  95. b) Manage mode
  96.  
  97. After a normal program start the Fortune menu appears.
  98. The manage mode is activated by:
  99.  
  100. - "MANAGE " as parameter: The main menu appears.
  101. - Pressing the Shift key during program start: The same.
  102. - Activating the alarm function: The same.
  103. - "FILE.CIT" as parameter: The cite will be played, then the main menu
  104.   appears.
  105. - "MANAGE FILE.CIT": The same.
  106.  
  107.  
  108. There are the following menu items:
  109.  
  110.  
  111. Desk/about FORTUNE...
  112.  
  113. Informs about the current version number.
  114.  
  115.  
  116. File/cite
  117.  
  118. Randomly plays a cite. According to "Config/Play mode...", the text will or
  119. will not be shown. The sound data will be loaded in real time therefore only
  120. very little memory will be needed. You can also play very long cites (or
  121. music). If other programs are running in parallel it is possible that the
  122. data could not be loaded fast enough.
  123.  
  124.  
  125. File/Manager...
  126.  
  127. Here you can select samples for import, edit sound data, export samples and
  128. load/save cites. You can further edit the text information of the cites.
  129.  
  130. At the beginning you have to select a sample or an existing cite:
  131. klick onto the popup Import/Sample or Import/Cite. The file will be loaded
  132. and scanned, the filename appears in the popup. You can select EITHER a
  133. sample OR a cite for input.
  134. If you are using MultiTOS 1.08 you may also drag a cite file icon from a
  135. desktop window into the manage window.
  136.  
  137. If Fortune is unable to recognize any header, a dialog appears, where you
  138. can  select the format of the sample to load:
  139. - The frequency
  140. - The pack/data format
  141. - The number format: Signed or unsigned
  142. many old ST samples are 8 Bit Mono unsigned.
  143.  
  144. The text information of the cite can be edited by "Cite", "Source" and
  145. "Remark". When selecting one of these buttons, a box appears in which you
  146. can write the text. Use our cites as guidelines. You can also select the
  147. language of the cite.
  148. If you import a sample file and there exists already text data of a former
  149. cite, you can choose to keep them.
  150.  
  151. In "Edit" you can pinpoint the beginning and the end of the cite within
  152. your sound data up to 1/100 second. The left four buttons are used for the
  153. beginning, the right ones for the end. "Play" plays the current cut.
  154. It is important to choose the cut properly to avoid any disturbing noise
  155. and - even more important - every useless 1/100 second costs up to 2000
  156. Bytes of harddisk space.
  157.  
  158. "Info" shows informations about the current input file. Please pay
  159. attention to the fact that length is the length of the raw sound data
  160. without any headers.
  161.  
  162. "cite" plays the current cite sound
  163.  
  164. Saving the samples and cites:
  165.  
  166. In the box "Save" you find two buttons and to popups for saving.
  167. Normally you will first klick on the popup to type the filename in the
  168. following file select box. The data will be saved and the name appears in
  169. the popup.
  170. If there already is a name in the popup, you can just klick on the according
  171. button to save the data under this name.
  172.  
  173. If import and export cite (or sample) have the same name, a temporary file
  174. will be created on the harddisk. Therefore it is possible that the data
  175. could not be saved even if there should be enough space on the disk.
  176.  
  177.  
  178. File/Quit
  179.  
  180. Terminates the program.
  181.  
  182.  
  183. Config/File format...
  184.  
  185. First, you can type the default paths for your sample and cite files. Klick
  186. on the according popup and select the folder.
  187.  
  188. Select sample format
  189.  
  190. Fortune can read and write samples in 5 different formats:
  191. - DVSM: For Fortune and WinRec
  192. - AVR: Many ATARI St/Falcon Programs
  193. - SND: Sun, NeXT, Mac
  194. - WAV: PC
  195. - Raw data: Raw data for many programs
  196.  
  197. Select pack format
  198.  
  199. Moreover, you can choose in which pack format the cite sounds should be
  200. saved and the samples sould be exported. Basically the following formats are
  201. possible (not all are implemented in every case):
  202.  
  203. - Keep: the sound data will not be changed.
  204. - 16 Bit Stereo: save in 2 channels with 16 Bit each.
  205. - 16 Bit deltapack: save as logarithmic compressed data, that needs 50%
  206. less memory but sounds nearly like 16 Bit.
  207. - 16 Bit µ-LAW: Only needs 8 Bit, sounds better than 8 Bit, but worse than
  208. deltapack. Used on Sun and NeXT.
  209. - 8 Bit Stereo
  210. - 16 Bit Mono: if stereo data should be saved as mono, both channels are
  211. added together.
  212. - 16 Bit Mono deltapack
  213. - 16 Bit Mono µ-LAW
  214. - 8 Bit Mono: Better use deltapack!
  215.  
  216. Notice that it is almost useless to convert a worse format to a better one.
  217. It only requires more memory but sounds the same. But it is possible that
  218. other programms support only some formats.
  219. Converting µ-LAW to deltapack can result in slightly worse sound quality,
  220. although deltapack is the better format.
  221. Cites can only be written in µ-LAW if the input data is in the same format.
  222. To do this, select "Keep". 
  223.  
  224. Save options
  225.  
  226. When saving samples and cites, fortune can maximize the volume of the
  227. sample. But this is always done relative to the peak of the whole input
  228. sample, not to the part you have possibly selected in the edit dialog.
  229. Therefore it is possible that the sample's volume is not 100%.
  230.  
  231. You can select a fade in/out effect, too, which ranges over the first and
  232. last 0.2 seconds of the selected part of the sample. You should use this
  233. effect only once with the same sample. This effect can not be heard until
  234. the sample is saved and reloaded.
  235.  
  236. Config/Play mode...
  237.  
  238. Cite display
  239.  
  240. You can determine how to cite
  241. - "cite without text": no text will be shown. In MultiTOS, that means the
  242. other programs execute undisturbed.
  243. - "cite with text": during playing, the text is shown in a box and
  244. dissapears automatically.
  245. - "cite with dialog": the text resides on the screen. Now you can select
  246. "Remark" or "Source" to get further information about the cite. Quit with
  247. "OK".
  248.  
  249. Cite timing
  250.  
  251. Here it is possible to select, if a cite is played every time the program is
  252. started in boot mode, or only once an hour or even once a day. That's
  253. especially important for programmers who frequently make use of the reset
  254. button.
  255.  
  256. Alarm function
  257.  
  258. This options allows you to use FORTUNE's alarm function, that will play a
  259. cite automatically at a certain alarm time and/or on the hour.
  260. As the program has to run all the time to use that option, it is rather
  261. sensible to use it under MultiTOS.
  262.  
  263. The alarm time has to be entered in the 24 hours format HH:MM. Normally a
  264. random cite will be played. If you select a cite file in the 'alarm cite'
  265. box, then this one will be played.
  266.  
  267.  
  268. Most of the dialogs are "fly dials". Just klick on the background of the box
  269. to move it while pressing the mouse button. Some of the other dialogs are
  270. placed in windows so you don't have to close them to go on.
  271.  
  272. Pressing the Shift key interrupts the playing of samples at any time.
  273.  
  274.  
  275.  
  276. 4. Internals
  277.  
  278. One supported sample format is the DVSM-Format of the program "WINREC". You
  279. should get this program where you got FORTUNE.
  280.  
  281. A DVSM sample file has the following structure:
  282.  
  283. typedef struct
  284. {
  285.     char magic[6];     /* "DVSM" */
  286.     int headlen;       /* Headlen in Bytes*/
  287.     int freq;           /* Sample freqency 0=8kHz 7=50kHz*/
  288.     char pack;           /* 0 unpacked, 2=DVS packmethod (not yet supported)*/
  289.     char mode;         /* 0=Stereo 8Bit,1=Stereo 16Bit,2=Mono 8Bit*/
  290.     long blocklen;     /* if pack=1: Length of a packed block*/ 
  291. } DVSMHEAD;
  292.  
  293. followed by the 16 Bit stereo data (or DVS 8 Bit data).
  294.  
  295. The sample frequencies 0 to 7 correspond to the following frequencies:
  296. sam_freq[8]={8195,9834,12292,16490,20770,24585,33880,49170};
  297. For further information refer to the WinRec documentation.
  298.  
  299. The cites are saved in the FORHEAD-Fortune format:
  300.  
  301. typedef struct
  302. {
  303.     char magic[24];         /* Version number e.g. "Fortune V01.00" */
  304.     int  lang;              /* Language of the cite a la TOS */
  305.     TEXTHEAD text;
  306.     unsigned long t_length; /* Length of the textinformations */
  307.     FOSMHEAD sound;         
  308.     unsigned long s_length; /* Length of the sound data */
  309.     long res1;                /* Reserved */
  310.     long res2;
  311. }FORHEAD;
  312.  
  313. typedef struct
  314. {
  315.     long cite;            /* Length of each informations string */
  316.     long signature;     /* including the zero byte at the end */
  317.     long author;
  318.     long speaker;
  319.     long source;
  320.     long editor;
  321.     long date;
  322.     long remarks;
  323.     long tres;            /* Reserved */
  324. } TEXTHEAD;
  325.  
  326. All texts are zero terminated strings. cite and remarks contain at maximum
  327. 5x40 characters, every line terminated by '\n'. The others at maximum 40
  328. characters (except the signature).
  329.  
  330. typedef struct
  331. {
  332.     char magic[6];        /* Info about original sample format e.g. "DVSM" */
  333.     int freq;           /* same as DVSMHEAD */
  334.     char pack,mode;        /* see below */
  335.     long real_l;        /* expanded Length */
  336.     long pblock_l;        /* smallest expandable blocksize, e.g. 1 */
  337.     long origfrequ;        /* original frequency of the sample*/
  338. } FOSMHEAD;
  339.  
  340. pack and mode determine the format of the data:
  341.  
  342. If bit 0 in mode is set, the data is 16 Bit.
  343. If bit 0 in pack is set, the data is mono.
  344. If bit 1 in pack is set, the data is deltapacked.
  345. If bit 2 in pack is set, the data is µ-LAW.
  346.  
  347. After the FORHEAD header the text data follows in the same order as in the
  348. header, then the sound data.
  349.  
  350. If FORTUNE is started without command line arguments (and no SHIFT key is
  351. pressed) FORTUNE starts in boot mode. Normally (see Installation) the
  352. parameter MANAGE is passed, so it starts in manage mode.
  353.  
  354.  
  355.  
  356. 5. Known Bugs
  357.  
  358. None - at the moment ;-)
  359.  
  360.  
  361. 6. Future Releases
  362.  
  363. - Other compression methods (ADPCM)
  364. - More editing functions
  365. - A play list
  366.  
  367.  
  368. 7. Contact
  369.  
  370. Send suggestions, criticism, comments, bug reports and nice cites (esp.
  371. suggestions and information about compression methods and file formats) to:
  372.  
  373. Harald Schönfeld
  374. Email:
  375. Harald.Schoenfeld@rzmail.uni-erlangen.de
  376. Postal:
  377. Lerchenstrasse 2, D-90587 Veitsbronn, Germany
  378.  
  379. Bernd Spellenberg
  380. Email:
  381. Bernd.Spellenberg@rzmail.uni-erlangen.de
  382. Postal:
  383. Fuerther Strasse 11, D-90617 Puschendorf, Germany
  384.  
  385. We are planning to install a cite archive at the server
  386. "ftp.uni-erlangen.de" in the "/pub/atari/falcon" directory, where everybody
  387. can upload his own cites. Is anybody interested in that?
  388.  
  389.  
  390.  
  391. 8. Release History
  392.  
  393. 22.1.93: Version 1.0 Beta
  394.  
  395. 26.2.93: Version 1.0
  396.          - new sound formats: AVR, SND, WAV, Raw
  397.          - new pack formats: µ-LAW, deltapack
  398.          - Support of AES 4.02
  399.          - some bugs fixed
  400.          - Change in the FOSM-Head (origfrequ)
  401.  
  402. 17.4.94: Version 1.1
  403.          - Timer function (esp. in MultiTOS)
  404.          - different boot modes
  405.          - command line parsing
  406.          - drag & drop (only in MultiTOS)
  407.          - Support of 3D effects in TOS 4.02 or higher or MultiTOS
  408.          - Short cuts to select options via keyboard
  409.          - Some bugfixes
  410.