Annotation of /libgig/trunk/README

Home
====
  You can always find the latest version of libgig at:
  http://www.linuxsampler.org/libgig/

Content
=======
  libgig actually consists of three parts:

  - RIFF classes (RIFF.h, RIFF.cpp): Provides convenient methods to parse and
                                     access arbitrary RIFF files.
  - DLS classes (DLS.h, DLS.cpp):    They're using the RIFF classes to parse
                                     DLS (Downloadable Sounds) Level 1 and 2
                                     files and provide abstract access to the
                                     data.
  - gig classes (gig.h, gig.cpp):    These are based on the DLS classes and
                                     provide the necessary extensions for
                                     the Gigasampler file format.

  Despite its name, libgig also provides support for other sampler file
  formats as well today:

  - SoundFont classes (SF.h, SF.cpp):  They provide support for the very popular
                                       SoundFont v1 and v2 format (.sf2).

  - KORG classes (Korg.h, Korg.cpp):   Provides support for sample based sounds
                                       used on many KORG synthesizer keyboards.

  - Akai classes (Akai.h):             Currently S1000, S01, S2000 and S3000
                                       series are supported.

  Beside the actual library there are following example applications:

    gigdump:     Demo app that prints out the content of a .gig file.
    gigextract:  Extracts samples from a .gig file.
    gigmerge:    Merges several .gig files to one .gig file.
    gig2mono:    Converts .gig files from stereo to mono.
    dlsdump:     Demo app that prints out the content of a DLS file.
    korgdump:    Prints out the content of the various KORG file types.
    korg2gig:    Convert KORG sound file to Gigasampler/GigaStudio format.
    rifftree:    Tool that prints out the RIFF tree of an arbitrary RIFF
                 file.
    akaidump:    Dump an AKAI media i.e. from a CDROM drive as disk image file
                 to your hard disk drive.
    akaiextract: Extracts samples from an Akai disk image, either from a media
                 (i.e. CDROM or Zip drive) for from a AKAI disk image file.

  Since version 3.0.0 libgig also provides write support, that is for
  creating modifying .gig, DLS and RIFF files.

Requirements
============
  POSIX systems (e.g. Linux, OS X):
  ---------------------------------

  You need at least to have libtool installed to be able to build the
  library with "./configure && make".

  Additionally you need to have either libaudiofile (>= 0.2.3) or
  libsndfile (>= 1.0.2) installed which is mandatory to be able to compile
  the 'gigextract' example application. But of course 'gigextract' is still
  just an example application, so it would make sense to compile it only if
  one of those libraries are available. That would remove that hard
  dependency to those two libs. But that's not a priority for me now.
  Note: for Windows systems only libsndfile is available.

  If you want to regenerate all autotools build files (that is configure,
  Makefile.in, etc.) then you need to have automake (>= 1.5) and autoconf
  installed.

  Windows:
  --------

  The precompiled versions of libgig (and its tools) should be compatible
  with any Windows operating system of at least Win95 or younger. Notice
  that all example / demo applications coming with libgig are pure console
  applications, thus you won't see a GUI showing up! :)

  If you want to compile libgig and its tools by yourself, please also
  notice the requirements under "Compiling for Windows".

  Other Operating Systems:
  ------------------------

  libgig was written to compile for any operating system, using standard C
  library functions. However the latest versions of libgig lack a portable
  implementation of one tiny method called RIFF::File::ResizeFile(). So you
  would either have to add native OS API calls for that particular method,
  that is dependant to your OS, or you have to add a portable
  implementation. No matter which way you choose, please let us know! :)

Compiling for Linux
===================
  You can either compile the sources and install the library directly on
  your system or you can create Redhat or Debian packages.

  a) Compiling and installing directly

  Call './configure && make' on the console to compile the library, all
  tools and demo applications, documentation and install them with
  'make install'. The latter has to be called as root.

  If you are compiling from CVS you have to call 'make -f Makefile.cvs'
  to generate all autotools build files before calling
  './configure && make'.

  You can use 'make distclean' and probably 'make -f Makefile.cvs clean'
  to clean up everything again. The latter will also delete all automatic
  generated autools build files.

  b) Creating Debian packages

  Use 'dpkg-buildpackage -rfakeroot -b' to compile and create the Debian
  packages. This will generate 3 Debian packages:

    libgig:      Contains the shared library files.
    libgig-dev:  Contains the header files and documentation for building
                 applications using libgig.
    gigtools:    Contains the tools and demo applications.

  You can use 'fakeroot debian/rules clean' to clean up everything again.

  c) Creating Redhat packages

  You need to have the rpmbuild tool installed and properly configured to
  create RPM packages. To create the RPM packages do the following:

    * Get .spec file generated by ./configure and edit it as appropriate.

    * Copy the source tarball to "/usr/src/<rpmdir>/SOURCES" directory,
      where <rpmdir> is dependent to the system you are using. For SuSE
      <rmpdir> will be "packages", for Mandrake <rpmdir> is "RPM" and for
      Redhat / Fedora <rpmdir> always equals "redhat".

    * Build the rpm(s) by invoking 'rpmbuild -bb <specfile>' from the
      command line.

  On success, the resulting rpm(s) can usually be found under the proper
  "/usr/src/<rpmdir>/RPMS/<arch>" directory.

Compiling for Windows
=====================

  libgig and its tools can be compiled for Windows using Bloodshed Dev-C++,
  which is a free (GPL) C++ integrated development environment for Windows.
  It is also possible to use MSYS from MinGW, which allows you to use
  './configure && make' like the linux builds.

  You can download Dev-C++ here:

    http://www.bloodshed.net/devcpp.html

  Make sure you install a version with Mingw integrated.

  a) Compiling libgig.dll

  Simply open the project file "win32/libgig.dev" either directly in Dev-C++
  or by double clicking on the project file in the Windows explorer, then
  click on "Compile" in the Dev-C++ menu and that's it! After compilation
  finished, you can find the files "libgig.dll", "libgig.a" and
  "liblibgig.def" in the "win32" directory.

  b) Compiling the example tools "rifftree", "dlsdump" and "gigdump"

  You need to have libgig.dll compiled as described in a). Then you can
  compile the respective tool by simply opening the respective project
  (.dev) file and clicking on "Compile" from the Dev-C++ menu. After
  compilation you can find the respective .exe file in the "win32"
  directory.

  c) Compiling the example tool "gigextract"

  You need to have libgig.dll compiled as described in a). Also you need
  libsndfile (as DLL) which is used to create the .wav files. You can
  download libsndfile already precompiled as DLL here:

    http://www.mega-nerd.com/libsndfile/

  Extract the .zip file i.e. to "C:\". The libsndfile .dll file should then
  be i.e. under "C:\libsndfile-1_0_17". Beside the .dll file, make sure
  libsndfile's .lib file exists in that directory as well. If the .lib file
  does not exist yet, you have to create it with:

    dlltool --input-def libsndfile-1.def --output-lib libsndfile-1.lib

  Then you have to ensure the settings of gigextract's Dev-C++ project file
  are pointing to the correct location of your local copy of libsndfile. For
  that click in the Dev-C++ menu on "Project" -> "Project Options". Then
  click on the tab "Parameter" and make sure the path to "libsndfile-1.lib"
  in the "Linker" list view is correct. Then click on the tab "Directories"
  and then on the tab "Include Directories" and make sure the path to
  libsndfile points to the correct location there as well.

  After that you should finally be able to compile "gigextract" by clicking
  on "Compile" in the Dev-C++ menu. After compilation succeeded, you can
  find the "gigextract.exe" file in the "win32" directory.

Test Cases
==========
  The libgig sources come with a tiny console application which allows to
  automatically test libgig's functions on your system. This test
  application is not compiled by default, you have to compile it explicitly
  with the following commands on the console (cppunit has to be installed):

    cd src/testcases
    make libgigtests

  and then run the test application from the same directory with:

    ./libgigtests

License
=======
  libgig and its tools are released under the GNU General Public License (GPL).

  libakai and its tools are released under the GNU Lesser General Public (LGPL).
  Due to its different license model the Akai support part is built as separate
  DLL (.so) file.

API Documentation
=================
  If you have Doxygen installed you can generate the API documentation by
  running 'make docs' in the sources' top level directory. The API
  documentation will be generated in the 'doc' subdirectory.

Patches
=======
  If you have bug fixes or improvements, your patches are always welcome!
  Send them either directly to me or to the LinuxSampler developer's mailing
  list <linuxsampler-devel@lists.sourceforge.net>.

Bugs
====
  Please use http://bugs.linuxsampler.org to check and report possible bugs.
  You might also try to run the "Test Cases" coming with libgig (see above),
  especially in case you are running on an odd system.

Trademarks
==========
  Tascam, Gigasampler, GigaStudio, KORG, Trinity, Triton, OASYS, M3, Kronos
  and Akai are trademarks of their respective owners.

Credits
=======
  The initial library (Gigasampler part) was based on the reverse engineering
  effort of Paul Kellett and Ruben van Royen. We owe current support for the
  Gigasampler v3/v4 format to Andreas Persson. Please also have a look at the
  ChangeLog for all those who contributed.

  Akai support files are a ported version of S�bastien M�trot's libakai. The
  original libakai only supported Mac and Windows. This forked version of
  libakai now also supports Linux and other POSIX compliant operating systems
  as well and does not have a dependency to libngl as the original libakai had.

  Thanks to all of you for your great work!

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