--- libgig/trunk/README 2006/05/07 18:19:55 859 +++ libgig/trunk/README 2014/05/22 12:14:04 2572 @@ -1,7 +1,7 @@ Home ==== You can always find the latest version of libgig at: - http://stud.hs-heilbronn.de/~cschoene/projects/libgig/ + http://www.linuxsampler.org/libgig/ Content ======= @@ -17,13 +17,33 @@ provide the necessary extensions for the Gigasampler file format. - Beside the actual library there are four example applications: + 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. @@ -48,18 +68,29 @@ Makefile.in, etc.) then you need to have automake (>= 1.5) and autoconf installed. - Non-POSIX systems (e.g. Windows): - --------------------------------- + Windows: + -------- - 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. 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. + 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 -========= +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. @@ -107,9 +138,84 @@ On success, the resulting rpm(s) can usually be found under the proper "/usr/src//RPMS/" 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. + 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 ================= @@ -119,16 +225,33 @@ Patches ======= - If you find bugs or have improvements, your patches are always welcome! + 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. + +Trademarks +========== + Tascam, Gigasampler, GigaStudio, KORG, Trinity, Triton, OASYS, M3, Kronos + and Akai are trademarks of their respective owners. + 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! + 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. + + Thanks to all of you for your great work! Christian Schoenebeck