/[svn]/libgig/trunk/README

Diff of /libgig/trunk/README

Parent Directory | Revision Log | View Patch Patch

-revision 2785 by schoenebeck,
Tue Jul 14 13:19:11 2015 UTC
+revision 4075 by schoenebeck,
Fri Jan 26 14:45:26 2024 UTC
 Line 1
  Home
  ====
    You can always find the latest version of libgig at:
-   http://www.linuxsampler.org/libgig/
+   https://www.linuxsampler.org/libgig/
  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:
 Line 29 
 Content
    - 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:
      gigdump:     Demo app that prints out the content of a .gig file.
-Line 36 
 Content
+Line 44 
 Content
      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.
+     wav2gig:     Creates a new .gig file from a set of .wav files.
      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.
-Line 53 
 Content
+Line 62 
 Content
  Requirements
  ============
-   POSIX systems (e.g. Linux, OS X):
+   All systems
+   -----------
+   Since libgig 4.3.0 you need at least a C++11 compliant compiler.
+   POSIX systems (e.g. Linux, macOS):
    ---------------------------------
    You need at least to have libtool installed to be able to build the
-Line 86 
 Requirements
+Line 101 
 Requirements
    ------------------------
    libgig was written to compile for any operating system, using standard C
-   library functions. However the latest versions of libgig lack a portable
+   library functions. However there are some OS dependent requirements:
-   implementation of one tiny method called RIFF::File::ResizeFile(). So you
-   would either have to add native OS API calls for that particular method,
+   * Since libgig 3.0.0 an OS dependent implementation for a tiny method called
-   that is dependant to your OS, or you have to add a portable
+     RIFF::File::ResizeFile() is required. So you would either have to add
-   implementation. No matter which way you choose, please let us know! :)
+     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! :)
+   * Since libgig 4.3.0 presence of some UUID generating function is required to
+     be provided by the underlying system. This was an optional feature in
+     previous versions of libgig for many years, its absence only meant that you
+     were unable to load gig files created/modified by libgig to be accepted by
+     Tascam's original GigaStudio studio software, did not mean any restriction
+     for being used with LinuxSampler though. This has changed in the meantime,
+     so this is now a hard build requirement, as you would potentially encounter
+     misbehaviours now even if you stay entirely in the Linux eco system if UUIDs
+     were missing in gig files.
  Compiling for Linux
  ===================
-Line 141 
 Compiling for Linux
+Line 168 
 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.
+ 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 be compiled for Windows using Bloodshed 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.

 Legend:



Removed from v.2785
 


changed lines


 
Added in v.4075
 Legend:



Removed from v.2785
 


changed lines


 
Added in v.4075
-Removed from v.2785
+Added in v.4075

	ViewVC Help
Powered by ViewVC