--- libgig/trunk/README 2003/10/25 20:15:04 2 +++ libgig/trunk/README 2006/10/19 19:01:13 923 @@ -1,3 +1,8 @@ +Home +==== + You can always find the latest version of libgig at: + http://stud.hs-heilbronn.de/~cschoene/projects/libgig/ + Content ======= libgig actually consists of three parts: @@ -9,43 +14,141 @@ files and provide abstract access to the data. - gig classes (gig.h, gig.cpp): These are based on the DLS classes and - provide the neccessary extensions for + provide the necessary extensions for the Gigasampler file format. + Beside the actual library there are four example applications: + + gigdump: Demo app that prints out the content of a .gig file. + gigextract: Extracts samples from a .gig file. + dlsdump: Demo app that prints out the content of a DLS file. + rifftree: Tool that prints out the RIFF tree of an arbitrary RIFF + file. + + Since version 3.0.0 libgig also provides write support, that is for + creating modifying .gig, DLS and RIFF files. + Requirements ============ - I simply used automake & co this time so you will need to have automake, - autoconf and libtool installed. I used the following versions: + POSIX systems (e.g. Linux, OS X): + --------------------------------- - automake 1.6.3 - autoconf 2.57 + You need at least to have libtool installed to be able to build the + library with "./configure && make". - If you want to compile the 'gigextract' application that comes with these - sources then you will additionally need to have libaudiofile installed (I - used version 0.2.3). + 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. + + Non-POSIX systems (e.g. Windows): + --------------------------------- -Non-POSIX systems -================= If you don't have a POSIX system, you have to set 'POSIX' to '0' in RIFF.h. Instead of using POSIX calls then standard C calls will be used for file - access. + access. This applies e.g. to Windows systems. I would appreciate if + somebody sends me his MS Visual Studio / .NET, Borland C++ Builder or + Apple XCode project file! This might help others to conveniently compile + libgig on those platforms as well. + +Compiling +========= + 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. -Compiling: + 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//SOURCES" directory, + where is dependent to the system you are using. For SuSE + will be "packages", for Mandrake is "RPM" and for + Redhat / Fedora always equals "redhat". + + * Build the rpm(s) by invoking 'rpmbuild -bb ' from the + command line. + + On success, the resulting rpm(s) can usually be found under the proper + "/usr/src//RPMS/" directory. + +Test Cases ========== - - Use 'CXXFLAGS=-pedantic ./configure && make all' to compile the library - and all tools and demo applications. + 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): - - Beside the actual library there are four applications: + cd src/testcases + make libgigtests - gigdump: Demo app that prints out the content of a .gig file. - gigextract: Extracts samples from a .gig file. - dlsdump: Demo app that prints out the content of a DLS file. - rifftree: Tool that prints out the RIFF tree of an arbitrary RIFF - file. + and then run the test application from the same directory with: - - If you have Doxygen installed you can generate the API documentation by - just running 'doxygen' in the sources' top level directory. + ./libgigtests - - 'make distclean' to clean up everything again +License +======= + libgig and its tools are released under the GNU General Public License. + +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 . + +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. + +Credits +======= + The initial library was based on the reverse engineering effort of + Paul Kellett and Ruben van Royen. We owe current support for the quite new + Gigasampler v3 format to Andreas Persson. Please also have a look at the + ChangeLog for all those who contributed. Thanks to all of you for your + great work! Christian Schoenebeck