add support for RcB2 build sys
[rofl0r-c-flod.git] / readme.txt
blob7f9798561a23015c68ace272a6ef7f66112e6dd9
1 C-Flod        version 4.1
2 2012/05/16
3 rofl0r
5 currently done:
7 - complete flod core
8 - whittaker player
9 - future composer
10 - (ultimate) sound tracker
11 - pro tracker
12 - fasttracker 2
13 - digital mugician
14 - soundfx
15 - sidmon 1,2
16 - bp soundmon
17 - rob hubbard (only v1)
18 - "fred editor" player
19 - jochen hippel and COSO players.
20   (there are a few tunes (maybe 3-5 %) that are not working correctly.
21    they dont work in uade/original flod either.)
22 - DeltaMusic 1 & 2
23 - pseudo barebone flashlib
24 - libao and wave writer backends.
26 in my conversion i followed a pretty straight 1:1 approach, 
27 so that the number of bugs introduced is minimized and future enhancement 
28 in flod can be backported easily.
30 i am currently in the process of translating the remaining players.
32 my goal is to remove any dynamically allocated memory so it could 
33 be used with a fixed memory usage profile on low end hardware (gba, nds).
34 since the samples for the fasttracker can be of any size, this needs either
35 a custom allocator or a pretty huge buffer for each instrument.
37 the build system should allow to turn off unneeded players and set the size
38 of buffers manually for the specific need.
40 also, the code could probably be simplified a lot by removing some of the 
41 classes and using direct memory writes etc.
43 -------------------------------------------------------------------------------------
45 Flod          version 4.1
46 Flod JS       version 2.1
47 Flip          version 1.2
49    2012/04/30
50    Christian Corti
51    Neoart Costa Rica
53    E-Mail: flod@neoartcr.com
55 This work is licensed under the Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License.
56 To view a copy of this license, visit http://creativecommons.org/licenses/by-nc-sa/3.0/ or send a letter to
57 Creative Commons, 171 Second Street, Suite 300, San Francisco, California, 94105, USA.
59 Flod is free for non commercial user, to use it in any commercial production I'll ask you to
60 mention the proper credits and to make a donation to: chreil@hotmail.com via PayPal, thank you.
62 Special thanks to Richard Davey, Mathew Nolan and Andreas Argirakis :)
64 What's new:
65 4.1/2.1:
66   - some small modules (less than 2150 bytes) were not recognized as valid
67   - His Master's Noisetracker, fixed Peggy Go Home null sample pointer
68   - His Master's Noisetracker, fixed Ikke Advanced wrong patterns pointers
69   - SoundFX, fixed effect 9
70   - SoundFX, added support for untouched Operation Stealth modules
71   - Soundtrackers, fixed period overflow, portamento up/down
72   - FastTracker II, fixed not working master volume
73 4.0/2.0:
74   - new David Whittaker player
75   - new FredEd player
76   - new Jochen Hippel player (regular and COSO formats, 4 voices only)
77   - new Rob Hubbard player
78   - added DigiBooster Pro 2.18 detection to the XM player
79   - Delta Music 1.0, fixed wrong sustain value
80   - Delta Music 2.0, fixed Warfalcons-Intromusik 2 crash
81   - Delta Music 2.0, fixed wrong restart pointer
82   - Digital Mugician, fixed sample loop pointer (fixes Hoi Level 4)
83   - Future Composer (Flod only), 1.0/1.3 was using the wrong waves
84   - SoundFX, fixed effect 7/8 [step down/up] (fixes Forever Tonight)
85   - SidMON 2, fixed effect C/F [volume and speed] (fixes Cool Module)
86   - SidMON 2 was processing effects at tick 0, it shouldn't :)
87   - SidMON 2, fixed adsr sustain volume
88   - SoundMon, fixed buffer restore, most modules didn't play at all
89   - ProTracker/NoiseTracker fixed vibrato depth value not set at the beginning
90   - Fixed and updated Flip/Unzip
91 3.0/1.0:
92   - Flod XM is now part of Flod base code
93   - Lots of bugs fixed
94   - Flod JS source code released
96 Supported Formats:
97   - Brian Postma's SoundMon 1.0/2.0/3.0
98   - David Whittaker
99   - Delta Music 1.0
100   - Delta Music 2.0/2.2
101   - Digital Mugician
102   - Digital Mugician 7 voices
103   - D.O.C. Soundtracker 9/2.0
104   - FastTracker II XM (PC)
105   - FredEd
106   - Future Composer 1.0/1.3
107   - Future Composer 1.4
108   - His Master's NoiseTracker
109   - Jochen Hippel
110   - Jochen Hippel COSO
111   - NoiseTracker 1.0/1.1/2.0
112   - ProTracker 1.0/1.1/1.2
113   - Rob Hubbard
114   - SidMON
115   - SidMON II
116   - SoundFX 1.0/1.8/1.9/2.0
117   - Soundtracker 2.3/2.5
118   - Ultimate Soundtracker, The (Karsten Obarski)