audio_hero 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a011c7136feae07c844a2a5e40d3c3ffe8e5bf01
-  data.tar.gz: 5b5d6d327129a36b52c3ed89dea2feb55d19e1da
+  metadata.gz: f3648b9480f862ec47b982e8883f1d8e329ee9a3
+  data.tar.gz: 8b1228ca980943bb77a1e80c631271c73e7086e1
 SHA512:
-  metadata.gz: 9ba8a92edf5eef4c73e70736148842db4aa63fa2750cb934b2eff44b5b9f3ce994aa440b9811c41741d81ee575c58751ff54601bc9ff22b8a2a891e854ad4645
-  data.tar.gz: 6eb38e772b7b5573cc2fa2daf957d26155475d13c38640be957aca9d6802e65c9aab9152eb290cf5f91961a384fccf5172cd5b9d1b15286342664a70e711aa1d
+  metadata.gz: 02d4bbb19b2754a205459014bfeb62ce02e6709f672f0a23762d3a445ebe1ad30a27f8061fb764bf169065ff670599c28cd1bee14278d45e13fea2be5ae03287
+  data.tar.gz: 4cd6164c3d846ac9f12bc0edb7c9caa9e3cfa2821b2406fb83bb0a4ed31dce0944d50814f28a7e911c1ec1fa7fe11d516fe04299184844be2764c5aabc30dfa6

data/README.md

@@ -1,11 +1,15 @@
 # AudioHero
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/audio_hero`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This is a ruby wrapper for [sox](http://sox.sourceforge.net/), the swiss army knife for audio.
+I've implemented sensible defaults for basic operations so converting mp3 to wav is as simple as:
+```ruby
+AudioHero::Sox.new(mp3file).convert
+```
 
 ## Installation
 
+Requirements: Obviously, make sure your system has sox installed already.
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -22,7 +26,66 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+###Convert
+
+Return the converted audio as ruby temp file object
+
+```ruby
+file = open("url/or/path/to/audio/file")
+
+new_file = AudioHero::Sox.new(file).convert({output_options: "-c 1", output_format: "mp3", channel: "left"})
+# Optional: Close the file after you are done for garbage collection.
+new_file.close!
+
+# With no options hash it will runs this command by default: `sox -t input.mp3 -c 1 -b 16 -r 16k out.wav`
+AudioHero::Sox.new(file).convert
+```
+Options(hash):
+  * channel (set "left", "right", or leave blank for stereo)
+  * input_format (default to "mp3")
+  * output_format (default to "wav")
+  * output_options (default to "-c 1 -b 16 -r 16k", single channel, 16hz, 16bits)
+  * gc (no default, set to "true" to auto close! input file)
+
+###Remove Silence
+
+```ruby
+file = AudioHero::Sox.new(file).remove_silence({input_format: "wav", gc: "true"})
+```
+Options(hash):
+  * silence_duration (default to 0.1 seconds)
+  * silence_level (default to 0.03%)
+  * input_format (default to "mp3")
+  * output_format (default to "wav")
+  * gc (no default, set to "true" to auto close! input file)
+
+###Split into multiple files by silence
+
+```ruby
+file_array = AudioHero::Sox.new(file).split_by_silence({input_format: "wav", gc: "true"})
+# file_array == ["path/to/out001.wav", "path/to/out002.wav"]
+```
+Options(hash):
+  * silence_duration (default to 0.1 seconds)
+  * silence_level (default to 0.03%)
+  * input_format (default to "mp3")
+  * output_format (default to "wav")
+  * file2 (path to second audio file, I use this to split both channels of an audio file at one go, require a modified sox that will not overwrite file1's output. Eg. my modified sox output [milliseconds].wav instead of 001.wav)
+  * gc (no default, set to "true" to auto close! input file)
+
+###Custom Command
+
+Run any sox command with this method.
+```ruby
+file = AudioHero::Sox.new(file).command({global: "-V3", input_option: "-t mp3", output_option: "-c 1", effect: "remix 0 1", gc: "true"})
+# Command generated: `sox -V3 -t mp3 input.mp3 -c 1 output.wav remix 0 1`
+```
+Options(hash):
+  * global (sox global options, inserted right after `sox`)
+  * input_options (sox input options, inserted before input file)
+  * output_options (sox output options, inserted before output file)
+  * effect (sox effect, inserted after output file)
+  * gc (no default, set to "true" to auto close! input file)
 
 ## Development
 
@@ -32,7 +95,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/audio_hero. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/litenup/audio_hero. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
 
 
 ## License

data/lib/audio_hero/version.rb

@@ -1,3 +1,3 @@
 module AudioHero
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/audio_hero.rb

@@ -45,6 +45,7 @@ module AudioHero
       rescue => e
         raise AudioHeroError, "There was an error converting #{@basename} to #{output_format}"
       end
+      src.close! if options[:gc] == "true"
       dst
     end
 
@@ -71,6 +72,7 @@ module AudioHero
       rescue => e
         raise AudioHeroError, "There was an error converting #{@basename} to #{output_format}"
       end
+      src.close! if options[:gc] == "true"
       dst
     end
 
@@ -105,6 +107,7 @@ module AudioHero
       rescue => e
         raise AudioHeroError, "There was an error splitting #{@basename}"
       end
+      src.close! && src2.close! if options[:gc] == "true"
       Dir["#{dir}/**/*#{format}"]
     end
 
@@ -133,7 +136,8 @@ module AudioHero
       rescue => e
         raise AudioHeroError, "There was an error excuting command: #{command}"
       end
-      dir
+      src.close! if options[:gc] == "true"
+      dst
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: audio_hero
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - litenup