carrierwave-audio 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 49be079517a1eb28406b25ccca4a0060bd179c6e
+  data.tar.gz: 2700deff88842e204e30d388c4a31024259f39c7
+SHA512:
+  metadata.gz: e515174ee12fe72e4a2964fb9d91d7276ef86ddb6ee00bbb19f85bc31b3f95105f3ebc9fefa8951f677644d4f40177308db7b646184cac8d5bbb54c4ac944841
+  data.tar.gz: 25510a82ccf5ee7fc64cad64ab1127f4d8cf7b2345881bec62dee7b871a93e254d5ad235c3eeb83e1d035650546a4c60afb8b22b27a288eac34d904aa3f2cb13

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jiri Kolarik
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,105 @@
+# CarrierWave::Audio
+
+Simple SoX wrapper for CarrierWave uploader that allows audio file conversion and watermarking
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'carrierwave-audio'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install carrierwave-audio
+
+## Usage
+
+Include CarrierWave::Audio into your CarrierWave uploader class:
+
+```ruby
+class VideoUploader < CarrierWave::Uploader::Base
+  include CarrierWave::Audio
+end
+```
+
+This gem provides two new processors for uploading audio files, `convert` and `watermark`. 
+
+### Convert
+
+If you'd like to convert from your initially uploaded file-type to a different one, use `convert` like so:
+
+```ruby
+  version :mp3 do
+    process :convert => [:mp3]
+
+    def full_filename(for_file)
+      "#{super.chomp(File.extname(super))}.mp3"
+    end
+  end
+```
+
+`process :convert` accepts two parameters:
+
+```ruby
+  process :convert => [output_format, output_options]
+```
+
+`output_format` - Optional. The only currently available option is the default, `:mp3`.
+
+`output_options` - Optional. Sox options for the output file (see [ruby-sox](https://github.com/TMXCredit/ruby-sox) and the [SoX documentation](http://sox.sourceforge.net/sox.pdf)). Defaults to:
+
+```ruby
+  {
+    type: output_format.to_s,
+    rate: 44100,
+    channels: 2,
+    compression: 128
+  }
+```
+
+### Watermark
+
+If you'd like to add a watermark over the top of your file, use `watermark` like so:
+
+```ruby
+  version :watermarked do
+    process :watermark => ["#{Rails.root}/db/watermark.mp3"]
+
+    def full_filename(for_file)
+      "#{super.chomp(File.extname(super))}.mp3"
+    end
+  end
+```
+
+`process :watermark` accepts three parameters:
+
+```ruby
+  process :watermark => [watermark_file_path, output_format, output_options]
+```
+
+`watermark_file_path` - REQUIRED. Path to where your watermarked file is stored
+
+`output_format` - Optional. The only currently available option is the default, `:mp3`.
+
+`output_options` - Optional. Sox options for the output file (see [ruby-sox](https://github.com/TMXCredit/ruby-sox) and the [SoX documentation](http://sox.sourceforge.net/sox.pdf)). Defaults to:
+
+```ruby
+  {
+    type: output_format.to_s,
+    rate: 44100,
+    channels: 2,
+    compression: 128
+  }
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/carrierwave-audio.rb

@@ -0,0 +1 @@
+require 'carrierwave/audio'

data/lib/carrierwave/audio.rb

@@ -0,0 +1,97 @@
+require 'carrierwave'
+require 'ruby-sox'
+require 'soxi/wrapper'
+
+module CarrierWave
+  module Audio
+    module ClassMethods
+      extend ActiveSupport::Concern
+
+      def convert output_format = :mp3, output_options = {}
+        process convert: [ output_format, output_options ]
+      end
+
+      def watermark watermark_file_path, output_format = :mp3, output_options = {}
+        process watermark: [ watermark_file_path, output_format, output_options ]
+      end
+    end
+
+    def convert output_format = :mp3, output_options = {}
+      format = sanitized_format(output_format)
+      ext = File.extname(current_path)
+      input_options = { type: ext.gsub(/\./, '') }
+      current_filename_without_extension = File.basename(current_path, ext)
+      tmp_path = File.join File.dirname(current_path), "tmp_#{current_filename_without_extension}_#{Time.current.to_i}.#{format}"
+      convert_file(current_path, input_options, tmp_path, default_output_options(format).merge(output_options))
+      File.rename tmp_path, current_path
+      set_content_type format
+    end
+
+    def watermark watermark_file_path, output_format = :mp3, output_options = {}
+      format = sanitized_format(output_format)
+      ext = File.extname(current_path)
+      watermark_ext = File.extname(watermark_file_path)
+      input_options = { type: ext.gsub(/\./, '') }
+      watermark_options = { type: watermark_ext.gsub(/\./, '') }
+      current_filename_without_extension = File.basename(current_path, ext)
+
+      # Normalize file to -6dB
+      normalized_tmp_path = File.join File.dirname(current_path), "tmp_norm_#{current_filename_without_extension}_#{Time.current.to_i}.#{input_options[:type]}"
+      convert_file(current_path, input_options, normalized_tmp_path, input_options, { gain: "-n -6" })
+
+      # Combine normalized file and watermark, normalizing final product to 0dB
+      final_tmp_path = File.join File.dirname(current_path), "tmp_wtmk_#{current_filename_without_extension}_#{Time.current.to_i}.#{format}"
+      converter = Sox::Cmd.new(combine: :mix)
+      converter.add_input normalized_tmp_path, input_options
+      converter.add_input watermark_file_path, watermark_options
+      converter.set_output final_tmp_path, default_output_options(format).merge(output_options)
+      converter.set_effects({ trim: "0 #{Soxi::Wrapper.file(current_path).seconds}", gain: "-n" })
+      converter.run
+      File.rename final_tmp_path, current_path
+      set_content_type format
+    end
+
+    private
+
+    def convert_file input_file_path, input_options, output_file_path, output_options, fx = {}
+      converter = Sox::Cmd.new
+      converter.add_input input_file_path, input_options
+      converter.set_output output_file_path, output_options
+      converter.set_effects fx
+      converter.run
+    end
+
+    def sanitized_format format
+      supported_formats = [:mp3]
+      if supported_formats.include?(format.to_sym)
+        format.to_s
+      else
+        raise CarrierWave::ProcessingError.new("Unsupported audio format #{format}. Only conversion to #{supported_formats.to_sentence} allowed.")
+      end
+    end
+
+    def default_output_options format
+      if format.to_sym == :mp3
+        {
+          type: format.to_s,
+          rate: 44100,
+          channels: 2,
+          compression: 128
+        }
+      else
+        {
+          type: format.to_s,
+          rate: 44100,
+          channels: 2
+        }
+      end
+    end
+
+    def set_content_type format
+      case format.to_sym
+      when :mp3
+        self.file.instance_variable_set(:@content_type, "audio/mpeg3")
+      end
+    end
+  end
+end

data/lib/carrierwave/audio/version.rb

@@ -0,0 +1,5 @@
+module CarrierWave
+  module Audio
+    VERSION = '1.0.0'
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: carrierwave-audio
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Trevor Hinesley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: carrierwave
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-sox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: soxi-wrapper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: CarrierWave Audio
+email:
+- trevor@trevorhinesley.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/carrierwave-audio.rb
+- lib/carrierwave/audio.rb
+- lib/carrierwave/audio/version.rb
+homepage: https://github.com/TrevorHinesley/carrierwave-audio
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Simple SoX wrapper for CarrierWave uploader that allows audio file conversion
+  and watermarking
+test_files: []