[xiph-cvs] cvs commit: ices/doc basic.html config.html faq.html inputs.html
Karl Heyes
karl at xiph.org
Fri Jan 2 16:02:26 PST 2004
karl 04/01/02 19:02:25
Modified: . HACKING
doc basic.html config.html faq.html inputs.html
Log:
minor updates to the docs
Revision Changes Path
1.3 +8 -12 ices/HACKING
Index: HACKING
===================================================================
RCS file: /usr/local/cvsroot/ices/HACKING,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- HACKING 8 Aug 2002 08:26:48 -0000 1.2
+++ HACKING 3 Jan 2004 00:02:24 -0000 1.3
@@ -9,7 +9,6 @@
-----
These are *brief* instructions on how to build this package from CVS.
-Yes, there are details left out.
There are generally four steps necessary when building from CVS (i.e.,
a developer's copy):
@@ -22,15 +21,6 @@
GNU autoconf/automake tools. Run the "autogen.sh" script to
perform this step.
- *** IF YOU ARE NOT BUILDING WITH GNU MAKE *AND* GCC: you must set
- the AUTOMAKE_FLAGS environment variable to "--include-deps"
- before running autogen.sh. For example:
-
- csh% setenv AUTOMAKE_FLAGS --include-deps
- csh% ./autogen.sh
- or
- sh% AUTOMAKE_FLAGS=--include-deps ./autogen.sh
-
3. Run configure. There are several options available; see
"./configure --help" for more information.
@@ -39,10 +29,16 @@
In general, steps 2 and 3 need to be re-run every time any of the
following files are modified (either manually or by a cvs update):
- configure.in
- acinclude.m4
+ configure.in
+ m4/*.m4
Running "make clean" after running steps 2 and 3 is generally also
advisable before running step 4. It isn't *always* necessary, but
unless you understand the workings of autoconf/automake, it's safest
to just do it.
+
+Note that the make allows for supplying compiler flags as well. eg
+make CFLAGS='-static' will try the build linking against any static
+libraries available. Also specific COU optimisations can be supplied
+this way.
+
<p><p>1.2 +2 -2 ices/doc/basic.html
Index: basic.html
===================================================================
RCS file: /usr/local/cvsroot/ices/doc/basic.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- basic.html 29 Dec 2003 23:49:25 -0000 1.1
+++ basic.html 3 Jan 2004 00:02:25 -0000 1.2
@@ -14,7 +14,7 @@
<p>
IceS v2 is not a graphical application, it's purpose is to stream
whatever it is given into a stream for feeding to the Icecast streaming
- server. It does however require the following
+ server. It does however require the following:
</p>
<ul>
<li>libogg available at <a HREF="http://www.vorbis.com">www.vorbis.com</a>
@@ -49,7 +49,7 @@
<br>
<h2>What input can IceS handle?</h2>
<p>
- Several inputs current exist, but some maybe dependant on certain
+ Several inputs currently exist, but some maybe dependant on certain
platforms or if certain drivers or libraries are available.
</p>
<ul>
<p><p>1.2 +7 -7 ices/doc/config.html
Index: config.html
===================================================================
RCS file: /usr/local/cvsroot/ices/doc/config.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- config.html 29 Dec 2003 23:49:25 -0000 1.1
+++ config.html 3 Jan 2004 00:02:25 -0000 1.2
@@ -29,7 +29,7 @@
</pre>
<h4>background</h4>
<div class=indentedbox>
- Set to 1 if you want IceS to put itself into the background
+ Set to 1 if you want IceS to put itself into the background.
</div>
<h4>logpath</h4>
<div class=indentedbox>
@@ -67,7 +67,7 @@
of certain events.
</div>
<h2>Stream section</h2>
- <p>This describes how the input and outgoing streams are configured<p>
+ <p>This describes how the input and outgoing streams are configured.<p>
<pre>
<stream>
Metadata
@@ -88,19 +88,19 @@
This section describes what metadata information is passed in the headers
at connection time to icecast. This applies to each instance defined within
the stream section but maybe overridden by a per-instance <metadata>
- section
+ section.
</p>
<h3>Input</h3>
<p>
This section deals with getting the audio data into IceS. There are a few
- ways that can happen. Typically it's either from a playlist or via a soundcard
+ ways that can happen. Typically it's either from a playlist or via a soundcard.
</p>
<p>
The layout is consistent between the different input modules. Within the
input section a module tag is needed to identify the module in question. The
rest are made up of param tags specific to the module. There can be several
param tags supplied to a module. Details of the module parameters are
- shown later
+ shown later.
</p>
<h3>Instance</h3>
<p>
@@ -142,7 +142,7 @@
<div class=indentedbox>
Mountpoints are used to identify a particular stream on a icecast server,
they must begin with / and for the sake of certain listening clients should
- end in .ogg
+ end with the .ogg extension.
</div>
<h4>yp</h4>
<div class=indentedbox>
@@ -167,7 +167,7 @@
<p>
The most common values used are 48000, 44100, 22050 and 11025, and is
really only used to resample to a lower samplerate, going to a higher rate
- serves no purpose within IceS
+ serves no purpose within IceS.
</p>
</div>
<h4>Downmix</h4>
<p><p>1.2 +21 -0 ices/doc/faq.html
Index: faq.html
===================================================================
RCS file: /usr/local/cvsroot/ices/doc/faq.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- faq.html 29 Dec 2003 23:49:25 -0000 1.1
+++ faq.html 3 Jan 2004 00:02:25 -0000 1.2
@@ -42,6 +42,27 @@
they only support one samplerate like 48khz. You have to experiment if the
documentation for the device is not specific.
</div>
+ <h4>The sound quality is poor</h4>
+ <div class=indentedbox>
+ <p>
+ Ogg Vorbis is a lossy compression technology, so quality of the sound is
+ reduced, however with live input the source of audio can be poor depending
+ on the soundcard and the system it's in. As an initial test just record
+ a wav file from the DSP (using eg rec, arecord etc) and listen to the
+ quality of the audio recorded. If the source of audio is poor then encoding
+ it to Ogg Vorbis is not going to improve it.
+ </p>
+ <p>
+ The reasons for poor audio from the DSP can be difficult to resolve, search
+ for information on audio quality. It could be driver related or maybe some
+ interference from some other device.
+ </p>
+ <p>
+ Here are some links where further information can be found:
+ </p>
+ http://www.djcj.org/LAU/guide/index.php<BR>
+ http://www.linuxdj.com/audio/lad/index.php3
+ </div>
</div>
</body>
</html>
<p><p>1.2 +10 -2 ices/doc/inputs.html
Index: inputs.html
===================================================================
RCS file: /usr/local/cvsroot/ices/doc/inputs.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- inputs.html 29 Dec 2003 23:49:25 -0000 1.1
+++ inputs.html 3 Jan 2004 00:02:25 -0000 1.2
@@ -12,7 +12,7 @@
<table width="100%"><tr><td bgcolor="#007B79" height="10" align="center"></td></tr></table>
<p>
Several input modules are available, depending on the platform, drivers
- and libraries available. The general layout is defined as
+ and libraries available. The general layout is defined as
</p>
<pre>
<input>
@@ -22,6 +22,11 @@
<param name="name3">value</param>
</input>
</pre>
+ <p>
+ For live input you may want to look into various resources on the web for
+ information on sound input. You may find that ALSA for instance supports
+ a particular soundcard better than the Open Sound System.
+ </p>
<h2>Open Sound</h2>
<pre>
<module>oss</module>
@@ -130,7 +135,10 @@
<h2>Playlist</h2>
<p>
The playlist module is used to get audio from some pre-encoded Ogg
- Vorbis files. The method of file selection is determined by the playlist
+ Vorbis files. IceS currently checks to see if the same file gets
+ played in succession and skips it, this means that having a playlist
+ repeat with only one ogg file listed won't work.
+ The method of file selection is determined by the playlist
type. The current types are basic and script.
</p>
<p><p>--- >8 ----
List archives: http://www.xiph.org/archives/
Ogg project homepage: http://www.xiph.org/ogg/
To unsubscribe from this list, send a message to 'cvs-request at xiph.org'
containing only the word 'unsubscribe' in the body. No subject is needed.
Unsubscribe messages sent to the list will be ignored/filtered.
More information about the commits
mailing list