/[svn]/libgig/trunk/README
ViewVC logotype

Diff of /libgig/trunk/README

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 530 by schoenebeck, Mon May 9 14:09:16 2005 UTC revision 859 by schoenebeck, Sun May 7 18:19:55 2006 UTC
# Line 1  Line 1 
1    Home
2    ====
3      You can always find the latest version of libgig at:
4      http://stud.hs-heilbronn.de/~cschoene/projects/libgig/
5    
6  Content  Content
7  =======  =======
8    libgig actually consists of three parts:    libgig actually consists of three parts:
# Line 12  Content Line 17  Content
17                                       provide the necessary extensions for                                       provide the necessary extensions for
18                                       the Gigasampler file format.                                       the Gigasampler file format.
19    
20      Beside the actual library there are four example applications:
21    
22        gigdump:     Demo app that prints out the content of a .gig file.
23        gigextract:  Extracts samples from a .gig file.
24        dlsdump:     Demo app that prints out the content of a DLS file.
25        rifftree:    Tool that prints out the RIFF tree of an arbitrary RIFF
26                     file.
27    
28      Since version 3.0.0 libgig also provides write support, that is for
29      creating modifying .gig, DLS and RIFF files.
30    
31  Requirements  Requirements
32  ============  ============
33    I simply used automake & co this time so you will need to have automake,    POSIX systems (e.g. Linux, OS X):
34    autoconf and libtool installed. I used the following versions:    ---------------------------------
35    
36      automake  1.6.3    You need at least to have libtool installed to be able to build the
37      autoconf  2.57    library with "./configure && make".
38    
39    If you want to compile the 'gigextract' application that comes with these    Additionally you need to have either libaudiofile (>= 0.2.3) or
40    sources then you will additionally need to have libaudiofile (>= 0.2.3)    libsndfile (>= 1.0.2) installed which is mandatory to be able to compile
41    or libsndfile (>= 1.0.2) installed. Note: for Windows systems only    the 'gigextract' example application. But of course 'gigextract' is still
42    libsndfile is available.    just an example application, so it would make sense to compile it only if
43      one of those libraries are available. That would remove that hard
44      dependency to those two libs. But that's not a priority for me now.
45      Note: for Windows systems only libsndfile is available.
46    
47      If you want to regenerate all autotools build files (that is configure,
48      Makefile.in, etc.) then you need to have automake (>= 1.5) and autoconf
49      installed.
50    
51      Non-POSIX systems (e.g. Windows):
52      ---------------------------------
53    
 Non-POSIX systems  
 =================  
54    If you don't have a POSIX system, you have to set 'POSIX' to '0' in RIFF.h.    If you don't have a POSIX system, you have to set 'POSIX' to '0' in RIFF.h.
55    Instead of using POSIX calls then standard C calls will be used for file    Instead of using POSIX calls then standard C calls will be used for file
56    access. This applies e.g. to Windows systems. I would appreciate if    access. This applies e.g. to Windows systems. I would appreciate if
# Line 36  Non-POSIX systems Line 60  Non-POSIX systems
60    
61  Compiling  Compiling
62  =========  =========
   
63    You can either compile the sources and install the library directly on    You can either compile the sources and install the library directly on
64    your system or you can create Redhat or Debian packages.    your system or you can create Redhat or Debian packages.
65    
66    a) Compiling and installing directly    a) Compiling and installing directly
67    
68    Use 'make -f Makefile.cvs && ./configure && make' to compile the library,    Call './configure && make' on the console to compile the library, all
69    all tools, demo applications, documentation and install them with    tools and demo applications, documentation and install them with
70    'make install'. You can use 'make distclean && make -f Makefile.cvs clean'    'make install'. The latter has to be called as root.
71    to clean up everything again.  
72      If you are compiling from CVS you have to call 'make -f Makefile.cvs'
73      to generate all autotools build files before calling
74      './configure && make'.
75    
76      You can use 'make distclean' and probably 'make -f Makefile.cvs clean'
77      to clean up everything again. The latter will also delete all automatic
78      generated autools build files.
79    
80    b) Creating Debian packages    b) Creating Debian packages
81    
82    Use 'make -f Makefile.cvs && dpkg-buildpackage -rfakeroot -b' to compile    Use 'dpkg-buildpackage -rfakeroot -b' to compile and create the Debian
83    and create the Debian packages. This will generate 3 Debian packages:    packages. This will generate 3 Debian packages:
84    
85      libgig:      Contains the shared library files.      libgig:      Contains the shared library files.
86      libgig-dev:  Contains the header files and documentation for building      libgig-dev:  Contains the header files and documentation for building
87                   applications using libgig.                   applications using libgig.
88      gigtools:    Contains the tools and demo applications.      gigtools:    Contains the tools and demo applications.
89    
90    You can use 'fakeroot debian/rules clean && make -f Makefile.cvs clean'    You can use 'fakeroot debian/rules clean' to clean up everything again.
   to clean up everything again.  
91    
92    c) Creating Redhat packages    c) Creating Redhat packages
93    
# Line 78  Compiling Line 107  Compiling
107    On success, the resulting rpm(s) can usually be found under the proper    On success, the resulting rpm(s) can usually be found under the proper
108    "/usr/src/<rpmdir>/RPMS/<arch>" directory.    "/usr/src/<rpmdir>/RPMS/<arch>" directory.
109    
110  Tools  License
111  =====  =======
112      libgig and its tools are released under the GNU General Public License.
  Beside the actual library there are four 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.  
113    
114  API Documentation  API Documentation
115  =================  =================
116      If you have Doxygen installed you can generate the API documentation by
117   If you have Doxygen installed you can generate the API documentation by    running 'make docs' in the sources' top level directory. The API
118   running 'make docs' in the sources' top level directory. The API    documentation will be generated in the 'doc' subdirectory.
  documentation will be generated in the 'doc' subdirectory.  
119    
120  Patches  Patches
121  =======  =======
# Line 107  Credits Line 128  Credits
128    The initial library was based on the reverse engineering effort of    The initial library was based on the reverse engineering effort of
129    Paul Kellett and Ruben van Royen. We owe current support for the quite new    Paul Kellett and Ruben van Royen. We owe current support for the quite new
130    Gigasampler v3 format to Andreas Persson. Please also have a look at the    Gigasampler v3 format to Andreas Persson. Please also have a look at the
131    ChangeLog for all those who contributed. Thanks for your great work!    ChangeLog for all those who contributed. Thanks to all of you for your
132      great work!
133    
134   Christian Schoenebeck <cuse@users.sourceforge.net>   Christian Schoenebeck <cuse@users.sourceforge.net>
Legend:
Removed from v.530  
changed lines
  Added in v.859
  ViewVC Help
Powered by ViewVC