/[svn]/libgig/trunk/README
ViewVC logotype

Contents of /libgig/trunk/README

Parent Directory Parent Directory | Revision Log Revision Log


Revision 2785 - (show annotations) (download)
Tue Jul 14 13:19:11 2015 UTC (8 years, 8 months ago) by schoenebeck
File size: 11142 byte(s)
* Preparations for new release (libgig 4.0.0).

1 Home
2 ====
3 You can always find the latest version of libgig at:
4 http://www.linuxsampler.org/libgig/
5
6 Content
7 =======
8 libgig actually consists of three parts:
9
10 - RIFF classes (RIFF.h, RIFF.cpp): Provides convenient methods to parse and
11 access arbitrary RIFF files.
12 - DLS classes (DLS.h, DLS.cpp): They're using the RIFF classes to parse
13 DLS (Downloadable Sounds) Level 1 and 2
14 files and provide abstract access to the
15 data.
16 - gig classes (gig.h, gig.cpp): These are based on the DLS classes and
17 provide the necessary extensions for
18 the Gigasampler file format.
19
20 Despite its name, libgig also provides (since version 4.0.0) support for
21 other sampler file formats as well:
22
23 - SoundFont classes (SF.h, SF.cpp): They provide support for the very popular
24 SoundFont v1 and v2 format (.sf2).
25
26 - KORG classes (Korg.h, Korg.cpp): Provides support for sample based sounds
27 used on many KORG synthesizer keyboards.
28
29 - Akai classes (Akai.h): Currently S1000, S01, S2000 and S3000
30 series are supported.
31
32 Beside the actual library there are following example applications:
33
34 gigdump: Demo app that prints out the content of a .gig file.
35 gigextract: Extracts samples from a .gig file.
36 gigmerge: Merges several .gig files to one .gig file.
37 gig2mono: Converts .gig files from stereo to mono.
38 gig2stereo: Converts .gig files to true interleaved stereo sounds.
39 dlsdump: Demo app that prints out the content of a DLS file.
40 korgdump: Prints out the content of the various KORG file types.
41 korg2gig: Convert KORG sound file to Gigasampler/GigaStudio format.
42 sf2dump: Prints out the content of a .sf2 file.
43 sf2extract: Extracts audio samples from a .sf2 file.
44 rifftree: Tool that prints out the RIFF tree of an arbitrary RIFF
45 file.
46 akaidump: Dump an AKAI media i.e. from a CDROM drive as disk image file
47 to your hard disk drive.
48 akaiextract: Extracts samples from an Akai disk image, either from a media
49 (i.e. CDROM or Zip drive) for from a AKAI disk image file.
50
51 Since version 3.0.0 libgig also provides write support, that is for
52 creating modifying .gig, DLS and RIFF files.
53
54 Requirements
55 ============
56 POSIX systems (e.g. Linux, OS X):
57 ---------------------------------
58
59 You need at least to have libtool installed to be able to build the
60 library with "./configure && make".
61
62 Additionally you need to have either libaudiofile (>= 0.2.3) or
63 libsndfile (>= 1.0.2) installed which is mandatory to be able to compile
64 the 'gigextract' example application. But of course 'gigextract' is still
65 just an example application, so it would make sense to compile it only if
66 one of those libraries are available. That would remove that hard
67 dependency to those two libs. But that's not a priority for me now.
68 Note: for Windows systems only libsndfile is available.
69
70 If you want to regenerate all autotools build files (that is configure,
71 Makefile.in, etc.) then you need to have automake (>= 1.5) and autoconf
72 installed.
73
74 Windows:
75 --------
76
77 The precompiled versions of libgig (and its tools) should be compatible
78 with any Windows operating system of at least Win95 or younger. Notice
79 that all example / demo applications coming with libgig are pure console
80 applications, thus you won't see a GUI showing up! :)
81
82 If you want to compile libgig and its tools by yourself, please also
83 notice the requirements under "Compiling for Windows".
84
85 Other Operating Systems:
86 ------------------------
87
88 libgig was written to compile for any operating system, using standard C
89 library functions. However the latest versions of libgig lack a portable
90 implementation of one tiny method called RIFF::File::ResizeFile(). So you
91 would either have to add native OS API calls for that particular method,
92 that is dependant to your OS, or you have to add a portable
93 implementation. No matter which way you choose, please let us know! :)
94
95 Compiling for Linux
96 ===================
97 You can either compile the sources and install the library directly on
98 your system or you can create Redhat or Debian packages.
99
100 a) Compiling and installing directly
101
102 Call './configure && make' on the console to compile the library, all
103 tools and demo applications, documentation and install them with
104 'make install'. The latter has to be called as root.
105
106 If you are compiling from CVS you have to call 'make -f Makefile.cvs'
107 to generate all autotools build files before calling
108 './configure && make'.
109
110 You can use 'make distclean' and probably 'make -f Makefile.cvs clean'
111 to clean up everything again. The latter will also delete all automatic
112 generated autools build files.
113
114 b) Creating Debian packages
115
116 Use 'dpkg-buildpackage -rfakeroot -b' to compile and create the Debian
117 packages. This will generate 3 Debian packages:
118
119 libgig: Contains the shared library files.
120 libgig-dev: Contains the header files and documentation for building
121 applications using libgig.
122 gigtools: Contains the tools and demo applications.
123
124 You can use 'fakeroot debian/rules clean' to clean up everything again.
125
126 c) Creating Redhat packages
127
128 You need to have the rpmbuild tool installed and properly configured to
129 create RPM packages. To create the RPM packages do the following:
130
131 * Get .spec file generated by ./configure and edit it as appropriate.
132
133 * Copy the source tarball to "/usr/src/<rpmdir>/SOURCES" directory,
134 where <rpmdir> is dependent to the system you are using. For SuSE
135 <rmpdir> will be "packages", for Mandrake <rpmdir> is "RPM" and for
136 Redhat / Fedora <rpmdir> always equals "redhat".
137
138 * Build the rpm(s) by invoking 'rpmbuild -bb <specfile>' from the
139 command line.
140
141 On success, the resulting rpm(s) can usually be found under the proper
142 "/usr/src/<rpmdir>/RPMS/<arch>" directory.
143
144 Compiling for Windows
145 =====================
146
147 libgig and its tools can be compiled for Windows using Bloodshed Dev-C++,
148 which is a free (GPL) C++ integrated development environment for Windows.
149 It is also possible to use MSYS from MinGW, which allows you to use
150 './configure && make' like the linux builds.
151
152 You can download Dev-C++ here:
153
154 http://www.bloodshed.net/devcpp.html
155
156 Make sure you install a version with Mingw integrated.
157
158 a) Compiling libgig.dll
159
160 Simply open the project file "win32/libgig.dev" either directly in Dev-C++
161 or by double clicking on the project file in the Windows explorer, then
162 click on "Compile" in the Dev-C++ menu and that's it! After compilation
163 finished, you can find the files "libgig.dll", "libgig.a" and
164 "liblibgig.def" in the "win32" directory.
165
166 b) Compiling the example tools "rifftree", "dlsdump" and "gigdump"
167
168 You need to have libgig.dll compiled as described in a). Then you can
169 compile the respective tool by simply opening the respective project
170 (.dev) file and clicking on "Compile" from the Dev-C++ menu. After
171 compilation you can find the respective .exe file in the "win32"
172 directory.
173
174 c) Compiling the example tool "gigextract"
175
176 You need to have libgig.dll compiled as described in a). Also you need
177 libsndfile (as DLL) which is used to create the .wav files. You can
178 download libsndfile already precompiled as DLL here:
179
180 http://www.mega-nerd.com/libsndfile/
181
182 Extract the .zip file i.e. to "C:\". The libsndfile .dll file should then
183 be i.e. under "C:\libsndfile-1_0_17". Beside the .dll file, make sure
184 libsndfile's .lib file exists in that directory as well. If the .lib file
185 does not exist yet, you have to create it with:
186
187 dlltool --input-def libsndfile-1.def --output-lib libsndfile-1.lib
188
189 Then you have to ensure the settings of gigextract's Dev-C++ project file
190 are pointing to the correct location of your local copy of libsndfile. For
191 that click in the Dev-C++ menu on "Project" -> "Project Options". Then
192 click on the tab "Parameter" and make sure the path to "libsndfile-1.lib"
193 in the "Linker" list view is correct. Then click on the tab "Directories"
194 and then on the tab "Include Directories" and make sure the path to
195 libsndfile points to the correct location there as well.
196
197 After that you should finally be able to compile "gigextract" by clicking
198 on "Compile" in the Dev-C++ menu. After compilation succeeded, you can
199 find the "gigextract.exe" file in the "win32" directory.
200
201 Test Cases
202 ==========
203 The libgig sources come with a tiny console application which allows to
204 automatically test libgig's functions on your system. This test
205 application is not compiled by default, you have to compile it explicitly
206 with the following commands on the console (cppunit has to be installed):
207
208 cd src/testcases
209 make libgigtests
210
211 and then run the test application from the same directory with:
212
213 ./libgigtests
214
215 License
216 =======
217 libgig and its tools are released under the GNU General Public License (GPL).
218
219 libakai and its tools are released under the GNU Lesser General Public (LGPL).
220 Due to its different license model the Akai support part is built as separate
221 DLL (.so) file.
222
223 API Documentation
224 =================
225 If you have Doxygen installed you can generate the API documentation by
226 running 'make docs' in the sources' top level directory. The API
227 documentation will be generated in the 'doc' subdirectory.
228
229 Patches
230 =======
231 If you have bug fixes or improvements, your patches are always welcome!
232 Send them either directly to me or to the LinuxSampler developer's mailing
233 list <linuxsampler-devel@lists.sourceforge.net>.
234
235 Bugs
236 ====
237 Please use http://bugs.linuxsampler.org to check and report possible bugs.
238 You might also try to run the "Test Cases" coming with libgig (see above),
239 especially in case you are running on an odd system.
240
241 Trademarks
242 ==========
243 Tascam, Gigasampler, GigaStudio, KORG, Trinity, Triton, OASYS, M3, Kronos
244 and Akai are trademarks of their respective owners.
245
246 Credits
247 =======
248 The initial library (Gigasampler part) was based on the reverse engineering
249 effort of Paul Kellett and Ruben van Royen. We owe current support for the
250 Gigasampler v3/v4 format to Andreas Persson. Please also have a look at the
251 ChangeLog for all those who contributed.
252
253 Akai support files are a ported version of S�bastien M�trot's libakai. The
254 original libakai only supported Mac and Windows. This forked version of
255 libakai now also supports Linux and other POSIX compliant operating systems
256 as well and does not have a dependency to libngl as the original libakai had.
257
258 The SoundFont 2 file format C++ classes were written by Grigor Iliev.
259
260 Thanks to all of you for your great work!
261
262 Christian Schoenebeck <cuse@users.sourceforge.net>

  ViewVC Help
Powered by ViewVC