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

Annotation of /libgig/trunk/README

Parent Directory Parent Directory | Revision Log Revision Log


Revision 220 - (hide annotations) (download)
Wed Aug 18 12:11:26 2004 UTC (19 years, 7 months ago) by schoenebeck
File size: 4101 byte(s)
* added support for libsndfile to the 'gigextract' tool

1 schoenebeck 2 Content
2     =======
3     libgig actually consists of three parts:
4    
5     - RIFF classes (RIFF.h, RIFF.cpp): Provides convenient methods to parse and
6     access arbitrary RIFF files.
7     - DLS classes (DLS.h, DLS.cpp): They're using the RIFF classes to parse
8     DLS (Downloadable Sounds) Level 1 and 2
9     files and provide abstract access to the
10     data.
11     - gig classes (gig.h, gig.cpp): These are based on the DLS classes and
12     provide the neccessary extensions for
13     the Gigasampler file format.
14    
15     Requirements
16     ============
17     I simply used automake & co this time so you will need to have automake,
18     autoconf and libtool installed. I used the following versions:
19    
20     automake 1.6.3
21     autoconf 2.57
22    
23     If you want to compile the 'gigextract' application that comes with these
24 schoenebeck 220 sources then you will additionally need to have libaudiofile (>= 0.2.3)
25     or libsndfile (>= 1.0.2) installed. Note: for Windows systems only
26     libsndfile is available.
27 schoenebeck 2
28     Non-POSIX systems
29     =================
30     If you don't have a POSIX system, you have to set 'POSIX' to '0' in RIFF.h.
31     Instead of using POSIX calls then standard C calls will be used for file
32 schoenebeck 11 access. This applies e.g. to Windows systems.
33 schoenebeck 2
34 schoenebeck 186 Compiling
35     =========
36 schoenebeck 2
37 schoenebeck 186 You can either compile the sources and install the library directly on
38     your system or you can create Redhat or Debian packages.
39 schoenebeck 2
40 schoenebeck 186 a) Compiling and installing directly
41    
42     Use 'make -f Makefile.cvs && ./configure && make' to compile the library,
43     all tools, demo applications, documentation and install them with
44     'make install'. You can use 'make distclean && make -f Makefile.cvs clean'
45     to clean up everything again.
46    
47     b) Creating Debian packages
48    
49 schoenebeck 220 Use 'make -f Makefile.cvs && dpkg-buildpackage -rfakeroot -b' to compile
50     and create the Debian packages. This will generate 3 Debian packages:
51 schoenebeck 186
52     libgig: Contains the shared library files.
53     libgig-dev: Contains the header files and documentation for building
54     applications using libgig.
55     gigtools: Contains the tools and demo applications.
56    
57     You can use 'fakeroot debian/rules clean && make -f Makefile.cvs clean'
58     to clean up everything again.
59    
60     c) Creating Redhat packages
61    
62 schoenebeck 191 You need to have the rpmbuild tool installed and properly configured to
63     create RPM packages. To create the RPM packages do the following:
64 schoenebeck 186
65 schoenebeck 191 * Get .spec file generated by ./configure and edit it as appropriate.
66    
67     * Copy the source tarball to "/usr/src/<rpmdir>/SOURCES" directory,
68     where <rpmdir> is dependent to the system you are using. For SuSE
69     <rmpdir> will be "packages", for Mandrake <rpmdir> is "RPM" and for
70     Redhat / Fedora <rpmdir> always equals "redhat".
71    
72     * Build the rpm(s) by invoking 'rpmbuild -bb <specfile>' from the
73     command line.
74    
75     On success, the resulting rpm(s) can usually be found under the proper
76     "/usr/src/<rpmdir>/RPMS/<arch>" directory.
77    
78 schoenebeck 186 Tools
79     =====
80    
81     Beside the actual library there are four applications:
82    
83 schoenebeck 2 gigdump: Demo app that prints out the content of a .gig file.
84     gigextract: Extracts samples from a .gig file.
85     dlsdump: Demo app that prints out the content of a DLS file.
86     rifftree: Tool that prints out the RIFF tree of an arbitrary RIFF
87     file.
88    
89 schoenebeck 186 API Documentation
90     =================
91 schoenebeck 2
92 schoenebeck 186 If you have Doxygen installed you can generate the API documentation by
93     just running 'doxygen' in the sources' top level directory. The API
94     documentation will be generated in the 'html' subdirectory.
95 schoenebeck 2
96 schoenebeck 11 Patches
97     =======
98     If you find bugs or have improvements, your patches are always welcome!
99     Send them either directly to me or to the LinuxSampler developer's mailing
100     list <linuxsampler-devel@lists.sourceforge.net>.
101    
102     Credits
103     =======
104     This library is based on the reverse engineering work of Paul Kellett and
105     Ruben van Royen. Thanks for your great work!
106    
107 schoenebeck 2 Christian Schoenebeck <cuse@users.sourceforge.net>

  ViewVC Help
Powered by ViewVC