docs for "audio" vocab

diff --git a/extra/audio/audio-docs.factor b/extra/audio/audio-docs.factor
new file mode 100644 (file)
index 0000000..c08887e
--- /dev/null
+++ b/extra/audio/audio-docs.factor
@@ -0,0 +1,43 @@
+! (c)2010 Joe Groff bsd license
+USING: alien byte-arrays help.markup help.syntax kernel math
+memory ;
+IN: audio
+
+HELP: <audio>
+{ $values
+    { "channels" integer } { "sample-bits" integer } { "sample-rate" integer } { "size" integer } { "data" c-ptr }
+    { "audio" integer }
+}
+{ $description "Constructs an " { $link audio } " object with the given parameters." } ;
+
+HELP: audio
+{ $class-description "Objects of this class contain uncompressed PCM audio data. The " { $snippet "data" } " slot contains an " { $link alien } " pointer or " { $link byte-array } " with the binary PCM data, and the " { $link size } " slot indicates the length in bytes of the data. The " { $snippet "channels" } ", " { $snippet "sample-bits" } " and " { $snippet "sample-rate" } " slots indicate the number of channels (1 for mono, 2 for stereo), bits per sample, and sample rate of the data." } ;
+
+HELP: format-unsupported-by-openal
+{ $values
+    { "audio" audio }
+}
+{ $description "Errors of this class are thrown when " { $link openal-format } " is called on an " { $link audio } " object for which there is no OpenAL-supported format." } ;
+
+HELP: openal-format
+{ $values
+    { "audio" audio }
+    { "format" "an ALenum value" }
+}
+{ $description "Returns the OpenAL format value that corresponds to the format of the " { $snippet "audio" } " object. If the object's format doesn't match an OpenAL-supported format, a " { $link format-unsupported-by-openal } " error is thrown." } ;
+
+ARTICLE: "audio" "Audio framework"
+"The " { $vocab-link "audio" } " vocabulary and its child vocabularies provide a framework for reading audio data from disk and playing back audio using prerendered, streaming, or generated audio sources. By itself, the " { $snippet "audio" } " vocabulary provides a container class for prerendered PCM audio data:"
+{ $subsections
+    audio
+    <audio>
+    openal-format
+}
+"The following child vocabularies provide additional audio features:"
+{ $list
+{ { $vocab-link "audio.engine" } " provides a high-level OpenAL-based engine for playing audio clips." }
+{ { $vocab-link "audio.loader" } " reads PCM data from files on disk into " { $link audio } " objects. " { $vocab-link "audio.wav" } " and " { $vocab-link "audio.aiff" } " support specific audio file formats." }
+{ { $vocab-link "audio.vorbis" } " implements an " { $snippet "audio.engine" } " compatible generator object for decoding Ogg Vorbis audio data from a stream." } 
+} ;
+
+ABOUT: "audio"

diff --git a/extra/audio/audio.factor b/extra/audio/audio.factor
index 04df36ebd67a8ce573fc837c1e2295ece6a40711..1d4e17292da318b0dc94225681880fd1eba18852 100644 (file)
--- a/extra/audio/audio.factor
+++ b/extra/audio/audio.factor
@@ -1,3 +1,4 @@
+! (c)2010 Joe Groff bsd license
 USING: accessors alien arrays combinators kernel math openal ;
 IN: audio
 

diff --git a/extra/audio/authors.txt b/extra/audio/authors.txt
new file mode 100644 (file)
index 0000000..f13c9c1
--- /dev/null
+++ b/extra/audio/authors.txt
@@ -0,0 +1 @@
+Joe Groff

diff --git a/extra/audio/summary.txt b/extra/audio/summary.txt
new file mode 100644 (file)
index 0000000..4110f0d
--- /dev/null
+++ b/extra/audio/summary.txt
@@ -0,0 +1 @@
+Framework for reading and playing back audio