Project

chaussettes

0.0
No commit activity in last 3 years
No release in over 3 years
chaussettesjamis/chaussettesHomepageDocumentationSource CodeBug TrackerWiki
A wrapper around the sox audio manipulation utility
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
2,802
Stars
9
Forks
1
Watchers
2
 Releases
Current version
1.0.0
Total releases
1
First release
2017-01-01
Latest release
2017-01-01
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2017-01-01
Reverse Dependencies
1

 Dependencies

Development

minitest
>= 0
rake
>= 0
 Project Readme

Chaussettes

Chaussettes is a wrapper around the command-line sox utility. It enables you to manipulate audio by programmatically constructing a sox operation, including multiple effect chains and various supported input and output streams.

Installation

Simply gem install it.

$ gem install chaussettes

It has no other dependencies, although it won't work very well if you don't also install sox, which you can grab here: http://sox.sourceforge.net/.

Usage

To find out information about an existing clip, you can use the Chaussettes::Info class:

require 'chaussettes'

info = Chaussettes::Info.new('hello.mp3')
p info.duration # 192.3 (seconds)

To programmatically construct a sox command-line, use the Chaussettes::Clip class:

require 'chaussettes'

clip = Chaussettes::Clip.new do |c|
  c.mix
  c.in 'music-track.mp3'
  c.in 'narration.wav'
  c.out 'soundtrack.wav'
end

clip.run
# sox --combine mix music-track.mp3 narration.wav soundtrack.wav

Each input and output can also accept options, which ought to be chained onto the corresponding input:

clip = Chaussettes::Clip.new do |c|
  c.mix
  c.in('music-track.mp3').volume(0.5)
  c.in 'narration.wav'
  c.out('soundtrack.wav').bits(16).rate(44_100).channels(2)
end

clip.run
# sox --combine mix \
#     --volume 0.5 music-track.mp3 \
#     narration.wav \
#     --bits 16 --rate 44100 --channels 2 soundtrack.wav

Furthermore, you can also chain effects to the clip:

clip = Chaussettes::Clip.new do |c|
  c.mix
  c.in 'music-track.mp3'
  c.in 'narration.wav'
  c.out 'soundtrack.wav'
  c.chain.trim(0, 10).pad(1.5)
end
# sox --combine mix \
#     music-track.mp3 narration.wav soundtrack.wav \
#     trim 0 10 pad 1.5

(Note that not all effects supported by sox are implemented by Chaussettes...yet)

And multiple effect chains may be applied, for potentially complex effects:

clip = Chaussettes::Clip.new do |c|
  c.mix
  c.in 'music-track.mp3'
  c.in 'narration.wav'
  c.out 'soundtrack.wav'
  c.chain.trim(0, 10).pad(1.5)
  c.chain.newfile
  c.chain.restart
end
# sox --combine mix \
#     music-track.mp3 narration.wav soundtrack.wav \
#     trim 0 10 pad 1.5 : newfile : restart

Inputs may be other clip instances, too:

music = Chaussettes::Clip.new do |c|
  c.in 'music-track.mp3'
  c.out(device: :stdout).type(:wav)
  c.chain.fade(0, 10, 0.5)
end

clip = Chaussettes::Clip.new do |c|
  c.mix
  c.in(music).volume(0.5).type(:wav)
  c.in 'narration.wav'
  c.out 'soundtrack.wav'
end
# sox --combine mix \
#     --volume 0.5 --type wav "|sox music-track.mp3 --type wav - fade 0 10 0.5" \
#     narration.wav soundtrack.wav

Author

Jamis Buck jamis@jamisbuck.org