Move conf/ to examples/. Add ezstream_metadata.xml and two minimalistic example

scripts.


git-svn-id: https://svn.xiph.org/trunk/ezstream@12710 0101bb08-14d6-0310-b084-bc0e0c8e3800

Makefile.am

@@ -1,7 +1,7 @@
 AUTOMAKE_OPTIONS = 1.9 foreign
 ACLOCAL_AMFLAGS = -I m4
 
-SUBDIRS =	conf doc m4 src win32
+SUBDIRS =	doc examples m4 src win32
 
 dist_doc_DATA = COPYING NEWS README
 

configure.in

@@ -201,8 +201,8 @@ XIPH_VAR_PREPEND([XIPH_LIBS], [$XML_LIBS])
 dnl OUTPUT
 
 AC_CONFIG_FILES(Makefile \
-		conf/Makefile \
 		doc/Makefile \
+		examples/Makefile \
 		m4/Makefile \
 		src/Makefile \
 		win32/Makefile)

examples/Makefile.am

@@ -3,6 +3,8 @@ AUTOMAKE_OPTIONS = 1.9 foreign
 examplesdir =	@EXAMPLES_DIR@
 dist_examples_DATA = ezstream_mp3.xml ezstream_reencoding_example_mp3.xml \
 		ezstream_reencoding_example_theora.xml \
-		ezstream_reencoding_example_vorbis.xml ezstream_vorbis.xml
+		ezstream_reencoding_example_vorbis.xml ezstream_vorbis.xml \
+		ezstream_metadata.xml
+dist_examples_SCRIPTS = meta.sh play.sh
 
 CLEANFILES =	core *.core *~ .*~

examples/ezstream_metadata.xml

@@ -0,0 +1,38 @@
+<!--
+   EXAMPLE: Ogg Vorbis stream WITHOUT reencoding, using an external playlist
+            program and an external metadata program, with a custom format
+            string.
+
+   This example streams (only) Ogg Vorbis files that are provided by an
+   external playlist script. The script must not return filenames of non-.ogg
+   files. Metadata for this stream is not acquired from the media file itself
+   but from another external program 'meta.sh'.
+ -->
+<ezstream>
+    <url>http://localhost:8000/vorbis.ogg</url>
+    <sourcepassword>hackme</sourcepassword>
+    <format>VORBIS</format>
+    <!-- The playlist program name is provided here: -->
+    <filename>play.sh</filename>
+    <!-- Tell ezstream that <filename/> is a playlist program: -->
+    <playlist_program>1</playlist_program>
+    <!-- Use the meta.sh script to get metadata -->
+    <metadata_progname>meta.sh</metadata_progname>
+    <!-- Set the metadata string according to this format: -->
+    <metadata_format>@s@: @a@ - @t@</metadata_format>
+    <!--
+      The following settings are used to describe your stream to the server.
+      It's up to you to make sure that the bitrate/quality/samplerate/channels
+      information matches up with your input stream files.
+     -->
+    <svrinfoname>My Stream</svrinfoname>
+    <svrinfourl>http://www.oddsock.org</svrinfourl>
+    <svrinfogenre>RockNRoll</svrinfogenre>
+    <svrinfodescription>This is a stream description</svrinfodescription>
+    <svrinfobitrate>96</svrinfobitrate>
+    <svrinfoquality>2.0</svrinfoquality>
+    <svrinfochannels>2</svrinfochannels>
+    <svrinfosamplerate>44100</svrinfosamplerate>
+    <!-- Allow the server to advertise the stream on a public YP directory: -->
+    <svrinfopublic>1</svrinfopublic>
+</ezstream>

examples/meta.sh

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+# Example metadata script that has the behavior required by ezstream.
+
+test -z "${1}" && echo "Ezstream presents"
+test x"${1}" = "xartist" && echo "Great Artist"
+test x"${1}" = "xtitle" && echo "Great Song"

examples/play.sh

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+# Example playlist script that has the behavior required by ezstream.
+
+echo "Great_Artist_-_Great_Song.ogg"

win32/README.win32

@@ -15,9 +15,14 @@ README.win32 - Information about the binary Ezstream distribution for Windows
 +-----------------------+----------------------------------------------+
 | \ezstream.exe         | The ezstream executable file.                |
 +-----------------------+----------------------------------------------+
-| \ezstream-X.Y.Z.zip   | The ezstream source distribution.            |
+| \ezstream-X.Y.Z.zip   | The ezstream source distribution, from which |
+|                       | ezstream.exe was built.                      |
 +-----------------------+----------------------------------------------+
-| \conf\*.xml           | Ezstream example configuration files.        |
+| \examples\*.xml       | Ezstream example configuration files.        |
++-----------------------+----------------------------------------------+
+| \examples\*.sh        | Example playlist and metadata scripts, for   |
+|                       | demonstrational purposes (these are shell    |
+|                       | scripts.)                                    |
 +-----------------------+----------------------------------------------+