opus-ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fca9e603f46d71ec76f1754d72e57f4330d6b891
+  data.tar.gz: 777e900ed821b7e9df95e1b80d69c6f0fe22bcd9
+SHA512:
+  metadata.gz: 5513a93a70ff8b21125dd6c318409ec48f3fb15cc56d5e3a6f6bdcb237cfcb708eb33797f07c7a632f799f03a8943bda698f7854ba7c2192f2712b625fb28707
+  data.tar.gz: 3a55dce53e1c7eb09832a9dd4479f137bea576fcef35956768babf2f24ccb2e10c814207e33f21c0bfc0a752ac7e70d0b5f3e9664c43da2c7ac7cd0b452daa1d

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-gemset

@@ -0,0 +1 @@
+opus_ruby_gem

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in opus-ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Matthew Perry
+
+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,42 @@
+# opus-ruby
+
+OPUS-Ruby is a Ruby Gem for working with the OPUS Audio Codec.
+OPUS-Ruby uses the Ruby-FFI extension to wrap the native OPUS library code.
+This means that you must have OPUS installed in order for this gem to work.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'opus-ruby'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install opus-ruby
+
+## Usage
+
+    # Create new encoder with a sample rate of 48 kHz, a frame size of 480 bytes and 1 channel
+    encoder = Opus::Encoder.new 48000, 480, 1
+    # Set the bitrate to 32 kbit/s
+    encoder.bitrate = 32000
+    # Set the VBR rate to 0 (CBR)
+    encoder.vbr_rate = 0
+
+    # Encode some raw audio
+    encoded = encoder.encode(raw_audio, 960)
+
+    # Safely destroy encoder
+    encoder.destroy
+
+## 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/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/opus-ruby.rb

@@ -0,0 +1,44 @@
+require 'ffi'
+require 'opus-ruby/version'
+require 'opus-ruby/encoder'
+
+module Opus
+  extend FFI::Library
+
+  ffi_lib 'opus'
+
+  module Constants
+    OPUS_OK                               = 0
+    OPUS_BAD_ARG                          = -1
+    OPUS_BUFFER_TOO_SMALL                 = -2
+    OPUS_INTERNAL_ERROR                   = -3
+    OPUS_INVALID_PACKET                   = -4
+    OPUS_UNIMPLEMENTED                    = -5
+    OPUS_INVALID_STATE                    = -6
+    OPUS_ALLOC_FAIL                       = -7
+    OPUS_APPLICATION_VOIP                 = 2048
+    OPUS_APPLICATION_AUDIO                = 2049
+    OPUS_APPLICATION_RESTRICTED_LOWDELAY  = 2051
+    OPUS_SIGNAL_VOICE                     = 3001
+    OPUS_SIGNAL_MUSIC                     = 3002
+    OPUS_SET_BITRATE_REQUEST              = 4002
+    OPUS_SET_VBR_REQUEST                  = 4006
+    OPUS_RESET_STATE                      = 4028
+  end
+
+  attach_function :opus_encoder_get_size, [:int], :int
+  attach_function :opus_encoder_create, [:int32, :int, :int, :pointer], :pointer
+  attach_function :opus_encoder_init, [:pointer, :int32, :int, :int], :int
+  attach_function :opus_encode, [:pointer, :pointer, :int, :pointer, :int32], :int32
+  attach_function :opus_encode_float, [:pointer, :pointer, :int, :pointer, :int32], :int32
+  attach_function :opus_encoder_destroy, [:pointer], :void
+  attach_function :opus_encoder_ctl, [:pointer, :int, :varargs], :int
+
+  attach_function :opus_decoder_get_size, [:int], :int
+  attach_function :opus_decoder_create, [:int32, :int, :pointer], :pointer
+  attach_function :opus_decoder_init, [:pointer, :int32, :int], :int
+  attach_function :opus_decode, [:pointer, :pointer, :int32, :pointer, :int, :int], :int
+  attach_function :opus_decode_float, [:pointer, :pointer, :int32, :pointer, :int, :int], :int
+  attach_function :opus_decoder_ctl, [:pointer, :int, :varargs], :int
+  attach_function :opus_decoder_destroy, [:pointer], :void
+end

data/lib/opus-ruby/encoder.rb

@@ -0,0 +1,40 @@
+module Opus
+  class Encoder
+    attr_reader :sample_rate, :frame_size, :channels,
+                :vbr_rate, :bitrate
+
+    def initialize(sample_rate, frame_size, channels)
+      @sample_rate = sample_rate
+      @frame_size = frame_size
+      @channels = channels
+
+      @encoder = Opus.opus_encoder_create sample_rate, channels, Constants::OPUS_APPLICATION_AUDIO, nil
+    end
+
+    def destroy
+      Opus.opus_encoder_destroy @encoder
+    end
+
+    def reset
+      Opus.opus_encoder_ctl @encoder, Opus::Constants::OPUS_RESET_STATE, :pointer, nil
+    end
+
+    def vbr_rate=(value)
+      @vbr_rate = value
+      Opus.opus_encoder_ctl @encoder, Opus::Constants::OPUS_SET_VBR_REQUEST, :int32, value
+    end
+
+    def bitrate=(value)
+      @bitrate = value
+      Opus.opus_encoder_ctl @encoder, Opus::Constants::OPUS_SET_BITRATE_REQUEST, :int32, value
+    end
+
+    def encode(data, size)
+      out = FFI::MemoryPointer.new :char, data.size + 1
+      buf = FFI::MemoryPointer.new :char, data.size + 1
+      buf.put_string 0, data
+      len = Opus.opus_encode @encoder, buf, @frame_size, out, size
+      out.read_string_length len
+    end
+  end
+end

data/lib/opus-ruby/version.rb

@@ -0,0 +1,3 @@
+module Opus
+  VERSION = "0.0.1"
+end

data/opus-ruby.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'opus-ruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "opus-ruby"
+  spec.version       = Opus::VERSION
+  spec.authors       = ["Matthew Perry"]
+  spec.email         = ["muffinman616@gmail.com"]
+  spec.description   = %q{Ruby FFI Gem for the OPUS Audio Codec}
+  spec.summary       = %q{Ruby FFI wrapper for the OPUS Audio Codec C library for audio encoding}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency "ffi"
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: opus-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matthew Perry
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-23 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: ffi
+  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'
+description: Ruby FFI Gem for the OPUS Audio Codec
+email:
+- muffinman616@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/opus-ruby.rb
+- lib/opus-ruby/encoder.rb
+- lib/opus-ruby/version.rb
+- opus-ruby.gemspec
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby FFI wrapper for the OPUS Audio Codec C library for audio encoding
+test_files: []