1 |
Home |
2 |
==== |
3 |
You can always find the latest version of libgig at: |
4 |
http://stud.hs-heilbronn.de/~cschoene/projects/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 |
Beside the actual library there are four example applications: |
21 |
|
22 |
gigdump: Demo app that prints out the content of a .gig file. |
23 |
gigextract: Extracts samples from a .gig file. |
24 |
dlsdump: Demo app that prints out the content of a DLS file. |
25 |
rifftree: Tool that prints out the RIFF tree of an arbitrary RIFF |
26 |
file. |
27 |
|
28 |
Since version 3.0.0 libgig also provides write support, that is for |
29 |
creating modifying .gig, DLS and RIFF files. |
30 |
|
31 |
Requirements |
32 |
============ |
33 |
POSIX systems (e.g. Linux, OS X): |
34 |
--------------------------------- |
35 |
|
36 |
You need at least to have libtool installed to be able to build the |
37 |
library with "./configure && make". |
38 |
|
39 |
Additionally you need to have either libaudiofile (>= 0.2.3) or |
40 |
libsndfile (>= 1.0.2) installed which is mandatory to be able to compile |
41 |
the 'gigextract' example application. But of course 'gigextract' is still |
42 |
just an example application, so it would make sense to compile it only if |
43 |
one of those libraries are available. That would remove that hard |
44 |
dependency to those two libs. But that's not a priority for me now. |
45 |
Note: for Windows systems only libsndfile is available. |
46 |
|
47 |
If you want to regenerate all autotools build files (that is configure, |
48 |
Makefile.in, etc.) then you need to have automake (>= 1.5) and autoconf |
49 |
installed. |
50 |
|
51 |
Windows: |
52 |
-------- |
53 |
|
54 |
The precompiled versions of libgig (and its tools) should be compatible |
55 |
with any Windows operating system of at least Win95 or younger. Notice |
56 |
that all example / demo applications coming with libgig are pure console |
57 |
applications, thus you won't see a GUI showing up! :) |
58 |
|
59 |
If you want to compile libgig and its tools by yourself, please also |
60 |
notice the requirements under "Compiling for Windows". |
61 |
|
62 |
Other Operating Systems: |
63 |
------------------------ |
64 |
|
65 |
libgig was written to compile for any operating system, using standard C |
66 |
library functions. However the latest versions of libgig lack a portable |
67 |
implementation of one tiny method called RIFF::File::ResizeFile(). So you |
68 |
would either have to add native OS API calls for that particular method, |
69 |
that is dependant to your OS, or you have to add a portable |
70 |
implementation. No matter which way you choose, please let us know! :) |
71 |
|
72 |
Compiling for Linux |
73 |
=================== |
74 |
You can either compile the sources and install the library directly on |
75 |
your system or you can create Redhat or Debian packages. |
76 |
|
77 |
a) Compiling and installing directly |
78 |
|
79 |
Call './configure && make' on the console to compile the library, all |
80 |
tools and demo applications, documentation and install them with |
81 |
'make install'. The latter has to be called as root. |
82 |
|
83 |
If you are compiling from CVS you have to call 'make -f Makefile.cvs' |
84 |
to generate all autotools build files before calling |
85 |
'./configure && make'. |
86 |
|
87 |
You can use 'make distclean' and probably 'make -f Makefile.cvs clean' |
88 |
to clean up everything again. The latter will also delete all automatic |
89 |
generated autools build files. |
90 |
|
91 |
b) Creating Debian packages |
92 |
|
93 |
Use 'dpkg-buildpackage -rfakeroot -b' to compile and create the Debian |
94 |
packages. This will generate 3 Debian packages: |
95 |
|
96 |
libgig: Contains the shared library files. |
97 |
libgig-dev: Contains the header files and documentation for building |
98 |
applications using libgig. |
99 |
gigtools: Contains the tools and demo applications. |
100 |
|
101 |
You can use 'fakeroot debian/rules clean' to clean up everything again. |
102 |
|
103 |
c) Creating Redhat packages |
104 |
|
105 |
You need to have the rpmbuild tool installed and properly configured to |
106 |
create RPM packages. To create the RPM packages do the following: |
107 |
|
108 |
* Get .spec file generated by ./configure and edit it as appropriate. |
109 |
|
110 |
* Copy the source tarball to "/usr/src/<rpmdir>/SOURCES" directory, |
111 |
where <rpmdir> is dependent to the system you are using. For SuSE |
112 |
<rmpdir> will be "packages", for Mandrake <rpmdir> is "RPM" and for |
113 |
Redhat / Fedora <rpmdir> always equals "redhat". |
114 |
|
115 |
* Build the rpm(s) by invoking 'rpmbuild -bb <specfile>' from the |
116 |
command line. |
117 |
|
118 |
On success, the resulting rpm(s) can usually be found under the proper |
119 |
"/usr/src/<rpmdir>/RPMS/<arch>" directory. |
120 |
|
121 |
Compiling for Windows |
122 |
===================== |
123 |
libgig and its tools can be compiled for Windows using Bloodshed Dev-C++, |
124 |
which is a free (GPL) C++ integrated development environment for Windows. |
125 |
You can download it here: |
126 |
|
127 |
http://www.bloodshed.net/devcpp.html |
128 |
|
129 |
Make sure you install a version with Mingw integrated. |
130 |
|
131 |
a) Compiling libgig.dll |
132 |
|
133 |
Simply open the project file "win32/libgig.dev" either directly in Dev-C++ |
134 |
or by double clicking on the project file in the Windows explorer, then |
135 |
click on "Compile" in the Dev-C++ menu and that's it! After compilation |
136 |
finished, you can find the files "libgig.dll", "libgig.a" and |
137 |
"liblibgig.def" in the "win32" directory. |
138 |
|
139 |
b) Compiling the example tools "rifftree", "dlsdump" and "gigdump" |
140 |
|
141 |
You need to have libgig.dll compiled as described in a). Then you can |
142 |
compile the respective tool by simply opening the respective project |
143 |
(.dev) file and clicking on "Compile" from the Dev-C++ menu. After |
144 |
compilation you can find the respective .exe file in the "win32" |
145 |
directory. |
146 |
|
147 |
c) Compiling the example tool "gigextract" |
148 |
|
149 |
You need to have libgig.dll compiled as described in a). Also you need |
150 |
libsndfile (as DLL) which is used to create the .wav files. You can |
151 |
download libsndfile already precompiled as DLL here: |
152 |
|
153 |
http://www.mega-nerd.com/libsndfile/ |
154 |
|
155 |
Extract the .zip file i.e. to "C:\". The libsndfile .dll file should then |
156 |
be i.e. under "C:\libsndfile-1_0_17". Beside the .dll file, make sure |
157 |
libsndfile's .lib file exists in that directory as well. If the .lib file |
158 |
does not exist yet, you have to create it with: |
159 |
|
160 |
dlltool --input-def libsndfile-1.def --output-lib libsndfile-1.lib |
161 |
|
162 |
Then you have to ensure the settings of gigextract's Dev-C++ project file |
163 |
are pointing to the correct location of your local copy of libsndfile. For |
164 |
that click in the Dev-C++ menu on "Project" -> "Project Options". Then |
165 |
click on the tab "Parameter" and make sure the path to "libsndfile-1.lib" |
166 |
in the "Linker" list view is correct. Then click on the tab "Directories" |
167 |
and then on the tab "Include Directories" and make sure the path to |
168 |
libsndfile points to the correct location there as well. |
169 |
|
170 |
After that you should finally be able to compile "gigextract" by clicking |
171 |
on "Compile" in the Dev-C++ menu. After compilation succeeded, you can |
172 |
find the "gigextract.exe" file in the "win32" directory. |
173 |
|
174 |
Test Cases |
175 |
========== |
176 |
The libgig sources come with a tiny console application which allows to |
177 |
automatically test libgig's functions on your system. This test |
178 |
application is not compiled by default, you have to compile it explicitly |
179 |
with the following commands on the console (cppunit has to be installed): |
180 |
|
181 |
cd src/testcases |
182 |
make libgigtests |
183 |
|
184 |
and then run the test application from the same directory with: |
185 |
|
186 |
./libgigtests |
187 |
|
188 |
License |
189 |
======= |
190 |
libgig and its tools are released under the GNU General Public License. |
191 |
|
192 |
API Documentation |
193 |
================= |
194 |
If you have Doxygen installed you can generate the API documentation by |
195 |
running 'make docs' in the sources' top level directory. The API |
196 |
documentation will be generated in the 'doc' subdirectory. |
197 |
|
198 |
Patches |
199 |
======= |
200 |
If you have bug fixes or improvements, your patches are always welcome! |
201 |
Send them either directly to me or to the LinuxSampler developer's mailing |
202 |
list <linuxsampler-devel@lists.sourceforge.net>. |
203 |
|
204 |
Bugs |
205 |
==== |
206 |
Please use http://bugs.linuxsampler.org to check and report possible bugs. |
207 |
You might also try to run the "Test Cases" coming with libgig (see above), |
208 |
especially in case you are running on an odd system. |
209 |
|
210 |
Credits |
211 |
======= |
212 |
The initial library was based on the reverse engineering effort of |
213 |
Paul Kellett and Ruben van Royen. We owe current support for the quite new |
214 |
Gigasampler v3 format to Andreas Persson. Please also have a look at the |
215 |
ChangeLog for all those who contributed. Thanks to all of you for your |
216 |
great work! |
217 |
|
218 |
Christian Schoenebeck <cuse@users.sourceforge.net> |