https://github.com/arirusso/audio-playback
Ruby/Command Line Audio File Player
https://github.com/arirusso/audio-playback
aiff audio command-line command-line-tool mp3 portaudio ruby sound wav
Last synced: 24 days ago
JSON representation
Ruby/Command Line Audio File Player
- Host: GitHub
- URL: https://github.com/arirusso/audio-playback
- Owner: arirusso
- License: other
- Created: 2015-10-01T03:34:17.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2017-06-08T16:54:59.000Z (over 8 years ago)
- Last Synced: 2025-03-24T12:56:20.244Z (7 months ago)
- Topics: aiff, audio, command-line, command-line-tool, mp3, portaudio, ruby, sound, wav
- Language: Ruby
- Homepage:
- Size: 4.44 MB
- Stars: 22
- Watchers: 4
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Audio Playback
A command line and Ruby tool for playing audio files
Under the hood the *portaudio* and *libsndfile* libraries are used, enabling the gem to be cross-platform on any systems where these libraries are available
## Installation
These packages must be installed first:
* libsndfile ([link](https://github.com/erikd/libsndfile))
* portaudio ([link](http://portaudio.com/docs/v19-doxydocs/pages.html))
Both libraries are available in *Homebrew*, *APT*, *Yum* as well as many other package managers. For those who wish to compile themselves or need more information about those packages, follow the links above for more information
Once those libraries are installed, install the gem itself using
gem install audio-playback
Or if you're using Bundler, add this to your Gemfile
gem "audio-playback"
## Usage
### Command line
`playback [filename] [options]`
#### options:
* `-l` Latency in seconds. Defaults to use the default latency for the selected output device
* `-b` Buffer size in bytes. Defaults to 4096
* `-c` Output audio to the given channel(s). Eg `-c 0,1` will direct audio to channels 0 and 1. Defaults to use channels 0 and 1 on the selected device
* `-d` Duration. Will stop after the given amount of time. Eg `-d 56` stops after 56 seconds of playback
* `-e` End position. Will stop at the given absolute time, irregardless of seek. Eg `-e 56` stops at 56 seconds. `-s 01:09:30 -e 01:10:00` stops at 1 hour 10 minutes after 30 seconds of playback
* `-o` Output device id or name. Defaults to the system default
* `-s` Seek to given time position. Eg `-s 56` seeks to 56 seconds and `-s 01:10:00` seeks to 1 hour 10 min.
* `-v` or `--verbose` Verbose
* `--loop` Loop playback continuously
* `--list-devices` List the available audio output devices
#### example:
`playback test/media/1-stereo-44100.wav -v -c 1`
### With Ruby
```ruby
require "audio-playback"
# Prompt the user to select an audio output
@output = AudioPlayback::Device::Output.gets
options = {
:channels => [0,1],
:latency => 1,
:output_device => @output
}
@playback = AudioPlayback.play("test/media/1-stereo-44100.wav", options)
# Play in the foreground
@playback.block
```
#### options:
* `:buffer_size` Buffer size in bytes. Defaults to 4096
* `:channel` or `:channels` Output audio to the given channel(s). Eg `:channels => [0,1]` will direct the audio to channels 0 and 1. Defaults to use channels 0 and 1 on the selected device
* `:latency` Latency in seconds. Defaults to use the default latency for the selected output device
* `:logger` Logger object
* `:output_device` Output device id or name
#### More Examples
More Ruby code examples:
* [List devices](https://github.com/arirusso/audio-playback/blob/master/examples/list_devices.rb)
* [Select a file and play](https://github.com/arirusso/audio-playback/blob/master/examples/select_and_play.rb)
* [Play multiple files in one stream simultaneously](https://github.com/arirusso/audio-playback/blob/master/examples/play_multiple_simultaneous.rb)
* [Play multiple files in one stream sequentially](https://github.com/arirusso/audio-playback/blob/master/examples/play_multiple_sequential.rb)
* [Play multiple files in multiple streams](https://github.com/arirusso/audio-playback/blob/master/examples/play_multiple_streams.rb)
* [Looping playback](https://github.com/arirusso/audio-playback/blob/master/examples/loop.rb)
## License
Licensed under Apache 2.0, See the file LICENSE
Copyright (c) 2015-2017 [Ari Russo](http://arirusso.com)