| 1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| 2 |
<html> |
| 3 |
<head> |
| 4 |
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
| 5 |
<title>IceS v2.0 Documentation</title> |
| 6 |
<link rel="STYLESHEET" type="text/css" href="style.css"> |
| 7 |
</head> |
| 8 |
<body> |
| 9 |
<div class=boxtest> |
| 10 |
<h1>Basic setup</h1> |
| 11 |
<table width="100%"><tr><td bgcolor="#007B79" height="10" align="center"></td></tr></table> |
| 12 |
<br> |
| 13 |
<h2>What does IceS require?</h2> |
| 14 |
<p> |
| 15 |
IceS v2 is not a graphical application, it's purpose is to stream |
| 16 |
whatever it is given into a stream for feeding to the Icecast streaming |
| 17 |
server. It does however require the following: |
| 18 |
</p> |
| 19 |
<ul> |
| 20 |
<li>libogg available at <a HREF="http://www.vorbis.com">www.vorbis.com</a> |
| 21 |
<li>libvorbis available at <a HREF="http://www.vorbis.com">www.vorbis.com</a> |
| 22 |
<li>libxml2 available at <a HREF="http://xmlsoft.org">xmlsoft</a> |
| 23 |
<li>libshout 2 available at <a HREF="http://www.icecast.org">The Icecast site</a> |
| 24 |
</ul> |
| 25 |
<p> |
| 26 |
Please note that in many cases, pre-built packages are split into two, |
| 27 |
a run-time package, typically consisting of the actual run-time library |
| 28 |
and a development package, consisting of the support files needed to |
| 29 |
compile and link the application. |
| 30 |
</p> |
| 31 |
<p> |
| 32 |
The following are optional |
| 33 |
</p> |
| 34 |
<ul> |
| 35 |
<li>ALSA. driver and libs available at <a HREF="http://www.alsa-project.org">The ALSA site</a> |
| 36 |
<li>RoarAudio driver and libs available at <a HREF="http://roaraudio.keep-cool.org/">The RoarAudio site</a> |
| 37 |
</ul> |
| 38 |
<br> |
| 39 |
<h2>What does IceS do ?</h2> |
| 40 |
<p> |
| 41 |
IceS reads audio data from an input and sends the audio data to one or |
| 42 |
more files or icecast servers. Before it's actually sent out, some |
| 43 |
processing maybe performed, typically resampling and/or downmixing to |
| 44 |
produce streams suited to various bandwidth requirements. |
| 45 |
</p> |
| 46 |
<p> |
| 47 |
The streams produced are Ogg Vorbis streams so while icecast 2 is |
| 48 |
capable of streaming these streams, other streaming servers may not be. |
| 49 |
<p> |
| 50 |
<br> |
| 51 |
<h2>What input can IceS handle?</h2> |
| 52 |
<p> |
| 53 |
Several inputs currently exist, but some maybe dependant on certain |
| 54 |
platforms or if certain drivers or libraries are available. |
| 55 |
</p> |
| 56 |
<ul> |
| 57 |
<li>OSS - Open Sound System. Typically used on linux based systems to |
| 58 |
get live input from a soundcard. |
| 59 |
<li>ALSA - Advanced Linux Sound Architecture. Like OSS but with various |
| 60 |
improvements for linux based systems. |
| 61 |
<li>stdinpcm - Uses standard input to receive PCM audio. |
| 62 |
<li>playlist - Uses a playlist to read audio files for processing. |
| 63 |
<li>sun - like OSS, but for Sun Solaris, also works for OpenBSD |
| 64 |
<li>roar - RoarAudio is a modern, multi OS sound system. |
| 65 |
</ul> |
| 66 |
<h2>How do you start IceS?</h2> |
| 67 |
<p> |
| 68 |
The configuration of IceS is done via an XML based config file. Which |
| 69 |
you supply as an argument to the program at invocation time. For example |
| 70 |
</p> |
| 71 |
<BR> |
| 72 |
ices /etc/ices.xml |
| 73 |
<BR> |
| 74 |
</div> |
| 75 |
</body> |
| 76 |
</html> |