/[svn]/libgig/trunk/README

Diff of /libgig/trunk/README

Parent Directory | Revision Log | View Patch Patch

-revision 2490 by schoenebeck,
Tue Dec 31 12:56:28 2013 UTC
+revision 3476 by schoenebeck,
Wed Feb 20 19:12:49 2019 UTC
 Line 5 
 Home
  Content
  =======
-   libgig actually consists of three parts:
+   libgig actually consists of three major parts:
    - RIFF classes (RIFF.h, RIFF.cpp): Provides convenient methods to parse and
                                       access arbitrary RIFF files.
 Line 15 
 Content
                                       data.
    - gig classes (gig.h, gig.cpp):    These are based on the DLS classes and
                                       provide the necessary extensions for
-                                      the Gigasampler file format.
+                                      the Gigasampler/GigaStudio file format.
+   Despite its name, libgig also provides (since version 4.0.0) support for
+   other sampler file formats as well:
+   - 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.
+   Additionally libgig contains the following separate API:
+   - Serialization classes (Serialization.h, Serialization.cpp):
+                                        Framework to serialize and deserialize
+                                        the runtime state of native C++ objects
+                                        (for saving and restoring their states
+                                        as abstract data).
    Beside the actual library there are following example applications:
-Line 23 
 Content
+Line 43 
 Content
      gigextract:  Extracts samples from a .gig file.
      gigmerge:    Merges several .gig files to one .gig file.
      gig2mono:    Converts .gig files from stereo to mono.
+     gig2stereo:  Converts .gig files to true interleaved stereo sounds.
      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.
+     sf2dump:     Prints out the content of a .sf2 file.
+     sf2extract:  Extracts audio samples from a .sf2 file.
      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):
+   POSIX systems (e.g. Linux, macOS):
    ---------------------------------
    You need at least to have libtool installed to be able to build the
-Line 120 
 Compiling for Linux
+Line 149 
 Compiling for Linux
    On success, the resulting rpm(s) can usually be found under the proper
    "/usr/src/<rpmdir>/RPMS/<arch>" directory.
- Compiling for Windows
+ Compiling for Windows using CMake
- =====================
+ =================================
+ The easiest way is to compile is to use vcpkg (https://github.com/Microsoft/vcpkg)
+ to install libsndfile (required) and cppunit (optional). In the vcpkg install dir
+ type:
+ .\vcpkg.exe install libsndfile cppunit [--triplet x64-windows]
+ This should install the libraries in vcpkg, add the triplet option if you wish to
+ get the 64bit libraries.
+ In an empty directory type:
+ cmake <libgig source dir> -DCMAKE_TOOLCHAIN_FILE=<vcpkg dir>\scripts\buildsystems\vcpkg.cmake
+ [-G"Visual Studio 15 2017 Win64"]
+ Use the -G option to select the visual studio version and whether to compile for
+bits.
-   libgig and its tools can be compiled for Windows using Bloodshed Dev-C++,
+ This will create libgig.sln file which you can open in visual studio or you can use
+ the following command line to compile:
+ cmake --build . --config <Release|Debug|MinRelSize|RelWithDebInfo>
+ Compiling for Windows using Dev-C++
+ ===================================
+   libgig and its tools can also be compiled on 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.
-Line 193 
 Test Cases
+Line 244 
 Test Cases
  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
  =================
-Line 213 
 Bugs
+Line 268 
 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
+   The initial library (Gigasampler part) was based on the reverse engineering
-   Paul Kellett and Ruben van Royen. We owe current support for the quite new
+   effort of Paul Kellett and Ruben van Royen. We owe current support for the
-   Gigasampler v3 format to Andreas Persson. Please also have a look at the
+   Gigasampler v3/v4 format to Andreas Persson. Please also have a look at the
-   ChangeLog for all those who contributed. Thanks to all of you for your
+   ChangeLog for all those who contributed.
-   great work!
+   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.
+   The SoundFont 2 file format C++ classes were written by Grigor Iliev.
+   Thanks to all of you for your great work!
   Christian Schoenebeck <cuse@users.sourceforge.net>

 Legend:



Removed from v.2490
 


changed lines


 
Added in v.3476
 Legend:



Removed from v.2490
 


changed lines


 
Added in v.3476
-Removed from v.2490
+Added in v.3476

	ViewVC Help
Powered by ViewVC