August'24: Kamaelia is in maintenance mode and will recieve periodic updates, about twice a year,
primarily targeted around Python 3 and ecosystem compatibility.
PRs are always welcome. Latest Release: 1.14.32 (2024/3/24)
For examples and more explanations, see the module level docs.
VorbisDecode() -> new VorbisDecoder
A Vorbis decoder accepts data on its inbox "inbox", as would be read
from an ogg vorbis file, decodes it and sends on the decompressed data
on out of its outbox "outbox". It doesn't provide any further
information at this stage, such as bitrate, or any other frills.
Requires libvorbissimple and python bindings (see
kamaelia downloads)
Example
A simple player:
Pipeline(
ReadFileAdaptor("somefile.ogg"),
VorbisDecode(),
AOAudioPlaybackAdaptor(),
).run()
This component expects to recieve OGG VORBIS data as you would get
from a .ogg file containing vorbis data. (rather than raw vorbis
data)
Inboxes
- control : Receiving a message here causes component
shutdown
- inbox : Ogg wrapped vorbis data
Outboxes
- outbox : As data is decompresessed it is sent to
this outbox
- signal : When the component shuts down, it sends on
a producerFinished message
Methods defined here
Warning!
You should be using the inbox/outbox interface, not these methods
(except construction). This documentation is designed as a roadmap as to
their functionalilty for maintainers and new component developers.
__init__(self)
x.__init__(...) initializes x; see x.__class__.__doc__ for
signature
main(self)
This contains no user serviceable parts :-)
Theory of operation is simple. It simply repeatedly asks the decoder
object for audio. That decoded audio is sent to the component's outbox.
If the decoder object responds with RETRY, the component retries. If the
decoder object responds with NEEDDATA, the component waits for data on
any inbox until some is available (from an inbox)
Feedback
Got a problem with the documentation? Something unclear that could be
clearer? Want to help improve it? Constructive criticism is very welcome
- especially if you can suggest a better rewording!
Please leave you feedback here in reply to the documentation thread in the
Kamaelia blog.
-- Automatic documentation generator, 05 Jun 2009 at 03:01:38
UTC/GMT
