1 |
Home |
Home |
2 |
==== |
==== |
3 |
You can always find the latest version of libgig at: |
You can always find the latest version of libgig at: |
4 |
http://stud.hs-heilbronn.de/~cschoene/projects/libgig/ |
http://www.linuxsampler.org/libgig/ |
5 |
|
|
6 |
Content |
Content |
7 |
======= |
======= |
17 |
provide the necessary extensions for |
provide the necessary extensions for |
18 |
the Gigasampler file format. |
the Gigasampler file format. |
19 |
|
|
20 |
Beside the actual library there are four example applications: |
Beside the actual library there are following example applications: |
21 |
|
|
22 |
gigdump: Demo app that prints out the content of a .gig file. |
gigdump: Demo app that prints out the content of a .gig file. |
23 |
gigextract: Extracts samples from a .gig file. |
gigextract: Extracts samples from a .gig file. |
24 |
|
gigmerge: Merges several .gig files to one .gig file. |
25 |
|
gig2mono: Converts .gig files from stereo to mono. |
26 |
dlsdump: Demo app that prints out the content of a DLS file. |
dlsdump: Demo app that prints out the content of a DLS file. |
27 |
rifftree: Tool that prints out the RIFF tree of an arbitrary RIFF |
rifftree: Tool that prints out the RIFF tree of an arbitrary RIFF |
28 |
file. |
file. |
50 |
Makefile.in, etc.) then you need to have automake (>= 1.5) and autoconf |
Makefile.in, etc.) then you need to have automake (>= 1.5) and autoconf |
51 |
installed. |
installed. |
52 |
|
|
53 |
Non-POSIX systems (e.g. Windows): |
Windows: |
54 |
--------------------------------- |
-------- |
55 |
|
|
56 |
If you don't have a POSIX system, you have to set 'POSIX' to '0' in RIFF.h. |
The precompiled versions of libgig (and its tools) should be compatible |
57 |
Instead of using POSIX calls then standard C calls will be used for file |
with any Windows operating system of at least Win95 or younger. Notice |
58 |
access. This applies e.g. to Windows systems. I would appreciate if |
that all example / demo applications coming with libgig are pure console |
59 |
somebody sends me his MS Visual Studio / .NET, Borland C++ Builder or |
applications, thus you won't see a GUI showing up! :) |
60 |
Apple XCode project file! This might help others to conveniently compile |
|
61 |
libgig on those platforms as well. |
If you want to compile libgig and its tools by yourself, please also |
62 |
|
notice the requirements under "Compiling for Windows". |
63 |
|
|
64 |
|
Other Operating Systems: |
65 |
|
------------------------ |
66 |
|
|
67 |
|
libgig was written to compile for any operating system, using standard C |
68 |
|
library functions. However the latest versions of libgig lack a portable |
69 |
|
implementation of one tiny method called RIFF::File::ResizeFile(). So you |
70 |
|
would either have to add native OS API calls for that particular method, |
71 |
|
that is dependant to your OS, or you have to add a portable |
72 |
|
implementation. No matter which way you choose, please let us know! :) |
73 |
|
|
74 |
Compiling |
Compiling for Linux |
75 |
========= |
=================== |
76 |
You can either compile the sources and install the library directly on |
You can either compile the sources and install the library directly on |
77 |
your system or you can create Redhat or Debian packages. |
your system or you can create Redhat or Debian packages. |
78 |
|
|
120 |
On success, the resulting rpm(s) can usually be found under the proper |
On success, the resulting rpm(s) can usually be found under the proper |
121 |
"/usr/src/<rpmdir>/RPMS/<arch>" directory. |
"/usr/src/<rpmdir>/RPMS/<arch>" directory. |
122 |
|
|
123 |
|
Compiling for Windows |
124 |
|
===================== |
125 |
|
|
126 |
|
libgig and its tools can be compiled for Windows using Bloodshed Dev-C++, |
127 |
|
which is a free (GPL) C++ integrated development environment for Windows. |
128 |
|
It is also possible to use MSYS from MinGW, which allows you to use |
129 |
|
'./configure && make' like the linux builds. |
130 |
|
|
131 |
|
You can download Dev-C++ here: |
132 |
|
|
133 |
|
http://www.bloodshed.net/devcpp.html |
134 |
|
|
135 |
|
Make sure you install a version with Mingw integrated. |
136 |
|
|
137 |
|
a) Compiling libgig.dll |
138 |
|
|
139 |
|
Simply open the project file "win32/libgig.dev" either directly in Dev-C++ |
140 |
|
or by double clicking on the project file in the Windows explorer, then |
141 |
|
click on "Compile" in the Dev-C++ menu and that's it! After compilation |
142 |
|
finished, you can find the files "libgig.dll", "libgig.a" and |
143 |
|
"liblibgig.def" in the "win32" directory. |
144 |
|
|
145 |
|
b) Compiling the example tools "rifftree", "dlsdump" and "gigdump" |
146 |
|
|
147 |
|
You need to have libgig.dll compiled as described in a). Then you can |
148 |
|
compile the respective tool by simply opening the respective project |
149 |
|
(.dev) file and clicking on "Compile" from the Dev-C++ menu. After |
150 |
|
compilation you can find the respective .exe file in the "win32" |
151 |
|
directory. |
152 |
|
|
153 |
|
c) Compiling the example tool "gigextract" |
154 |
|
|
155 |
|
You need to have libgig.dll compiled as described in a). Also you need |
156 |
|
libsndfile (as DLL) which is used to create the .wav files. You can |
157 |
|
download libsndfile already precompiled as DLL here: |
158 |
|
|
159 |
|
http://www.mega-nerd.com/libsndfile/ |
160 |
|
|
161 |
|
Extract the .zip file i.e. to "C:\". The libsndfile .dll file should then |
162 |
|
be i.e. under "C:\libsndfile-1_0_17". Beside the .dll file, make sure |
163 |
|
libsndfile's .lib file exists in that directory as well. If the .lib file |
164 |
|
does not exist yet, you have to create it with: |
165 |
|
|
166 |
|
dlltool --input-def libsndfile-1.def --output-lib libsndfile-1.lib |
167 |
|
|
168 |
|
Then you have to ensure the settings of gigextract's Dev-C++ project file |
169 |
|
are pointing to the correct location of your local copy of libsndfile. For |
170 |
|
that click in the Dev-C++ menu on "Project" -> "Project Options". Then |
171 |
|
click on the tab "Parameter" and make sure the path to "libsndfile-1.lib" |
172 |
|
in the "Linker" list view is correct. Then click on the tab "Directories" |
173 |
|
and then on the tab "Include Directories" and make sure the path to |
174 |
|
libsndfile points to the correct location there as well. |
175 |
|
|
176 |
|
After that you should finally be able to compile "gigextract" by clicking |
177 |
|
on "Compile" in the Dev-C++ menu. After compilation succeeded, you can |
178 |
|
find the "gigextract.exe" file in the "win32" directory. |
179 |
|
|
180 |
|
Test Cases |
181 |
|
========== |
182 |
|
The libgig sources come with a tiny console application which allows to |
183 |
|
automatically test libgig's functions on your system. This test |
184 |
|
application is not compiled by default, you have to compile it explicitly |
185 |
|
with the following commands on the console (cppunit has to be installed): |
186 |
|
|
187 |
|
cd src/testcases |
188 |
|
make libgigtests |
189 |
|
|
190 |
|
and then run the test application from the same directory with: |
191 |
|
|
192 |
|
./libgigtests |
193 |
|
|
194 |
License |
License |
195 |
======= |
======= |
196 |
libgig and its tools are released under the GNU General Public License. |
libgig and its tools are released under the GNU General Public License. |
203 |
|
|
204 |
Patches |
Patches |
205 |
======= |
======= |
206 |
If you find bugs or have improvements, your patches are always welcome! |
If you have bug fixes or improvements, your patches are always welcome! |
207 |
Send them either directly to me or to the LinuxSampler developer's mailing |
Send them either directly to me or to the LinuxSampler developer's mailing |
208 |
list <linuxsampler-devel@lists.sourceforge.net>. |
list <linuxsampler-devel@lists.sourceforge.net>. |
209 |
|
|
210 |
|
Bugs |
211 |
|
==== |
212 |
|
Please use http://bugs.linuxsampler.org to check and report possible bugs. |
213 |
|
You might also try to run the "Test Cases" coming with libgig (see above), |
214 |
|
especially in case you are running on an odd system. |
215 |
|
|
216 |
Credits |
Credits |
217 |
======= |
======= |
218 |
The initial library was based on the reverse engineering effort of |
The initial library was based on the reverse engineering effort of |