mumble-ruby 0.0.3 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 79af7c6bca2313c1ad4cb6f2d0efd7e51c87bdbd
+  data.tar.gz: a0404c3814bccddf1c69a31c5f81dab76fc1d9d4
+SHA512:
+  metadata.gz: 187c1eef9e026080cec54984d8ba6c9159c31b8a28f23c31a53e391771b25b72b0dbcff29e79c2976e7918d97d6ab58cfd07c9ac167260baf9743fee51b46339
+  data.tar.gz: c6838e53b31f8bd390acc090a5c96bbfb32071861e1d80317ee7c013d5c140d17cfee86e671e0722c3aae798393336cf47d3bc260ec741990ed0117eb2836c44

data/.ruby-gemset

@@ -0,0 +1 @@
+mumble_ruby_gem

data/.ruby-version

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

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.rdoc

@@ -14,8 +14,9 @@ There is huge room for improvement in this library and I am willing to accept al
 
 == REQUIREMENTS:
 
-* Ruby >= 1.9.2
-* CELT Audio Codec Library version 0.7
+* Ruby >= 2.1.0
+* OPUS Audio Codec
+* Murur server > 1.2.4
 
 == BASIC USAGE:
 

data/lib/mumble-ruby.rb

@@ -1,4 +1,4 @@
-require 'celt-ruby'
+require 'opus-ruby'
 require 'active_support/inflector.rb'
 require 'mumble-ruby/version'
 require 'mumble-ruby/messages.rb'

data/lib/mumble-ruby/audio_stream.rb

@@ -9,8 +9,7 @@ module Mumble
       @file = File.open(file, 'rb')
       @conn = connection
       @seq = 0
-      @num_frames = 6
-      @compressed_size = [@encoder.vbr_rate / 800, 127].min
+      @compressed_size = 960
       @pds = PacketDataStream.new
       @volume = 1.0
 
@@ -47,16 +46,13 @@ module Mumble
       @seq %= 1000000 # Keep sequence number reasonable for long runs
 
       @pds.rewind
-      @seq += @num_frames
+      @seq += 1
       @pds.put_int @seq
 
-      @num_frames.times do |i|
-        frame = @queue.pop
-        len = frame.size
-        len = len | 0x80 if i < @num_frames - 1
-        @pds.append len
-        @pds.append_block frame
-      end
+      frame = @queue.pop
+      len = frame.size
+      @pds.put_int len
+      @pds.append_block frame
 
       size = @pds.size
       @pds.rewind

data/lib/mumble-ruby/client.rb

@@ -1,17 +1,17 @@
 require 'thread'
+require 'hashie'
 
 module Mumble
   class ChannelNotFound < StandardError; end
   class UserNotFound < StandardError; end
   class NoSupportedCodec < StandardError; end
 
-  CODEC_ALPHA = 0
-  CODEC_BETA = 3
-
   class Client
     attr_reader :host, :port, :username, :password, :users, :channels
 
-    def initialize(host, port=64738, username="Ruby Client", password="")
+    CODEC_OPUS = 4
+
+    def initialize(host, port=64738, username="RubyClient", password="")
       @host = host
       @port = port
       @username = username
@@ -41,11 +41,11 @@ module Mumble
     end
 
     def me
-      @users[@session]
+      users[@session]
     end
 
     def current_channel
-      @channels[me.channel_id]
+      channels[me.channel_id]
     end
 
     def stream_raw_audio(file)
@@ -97,15 +97,16 @@ module Mumble
     end
 
     def find_user(name)
-      @users.values.find { |u| u.name == name }
+      users.values.find { |u| u.name == name }
     end
 
     def find_channel(name)
-      @channels.values.find { |u| u.name == name }
+      channels.values.find { |c| c.name == name }
     end
 
     private
     def spawn_thread(sym)
+      Thread.abort_on_exception = true
       Thread.new { loop { send sym } }
     end
 
@@ -129,31 +130,39 @@ module Mumble
         @session = message.session
       end
       on_channel_state do |message|
-        @channels[message.channel_id] = message
+        if channel = channels[message.channel_id]
+          channel.merge! message.to_hash
+        else
+          channels[message.channel_id] = Hashie::Mash.new(message.to_hash)
+        end
       end
       on_channel_remove do |message|
-        @channels.delete(message.channel_id)
+        channels.delete(message.channel_id)
       end
       on_user_state do |message|
-        @users[message.session] = message
+        if user = users[message.session]
+          user.merge! message.to_hash
+        else
+          users[message.session] = Hashie::Mash.new(message.to_hash)
+        end
       end
       on_user_remove do |message|
-        @users.delete(message.session)
+        users.delete(message.session)
       end
       on_codec_version do |message|
-        codec_negotiation(message.alpha, message.beta)
+        codec_negotiation(message)
       end
     end
 
     def create_encoder
-      @encoder = Celt::Encoder.new 48000, 480, 1
-      @encoder.prediction_request = 0
-      @encoder.vbr_rate = 60000
+      @encoder = Opus::Encoder.new 48000, 480, 1
+      @encoder.vbr_rate = 0 # CBR
+      @encoder.bitrate = 32000 # 32 kbit/s
     end
 
     def version_exchange
       send_version({
-        version: encode_version(1, 2, 3),
+        version: encode_version(1, 2, 5),
         release: "mumble-ruby #{Mumble::VERSION}",
         os: %x{uname -o}.strip,
         os_version: %x{uname -v}.strip
@@ -164,15 +173,12 @@ module Mumble
       send_authenticate({
         username: @username,
         password: @password,
-        celt_versions: [@encoder.bitstream_version]
+        opus: true
       })
     end
 
-    def codec_negotiation(alpha, beta)
-      @codec = case @encoder.bitstream_version
-               when alpha then Mumble::CODEC_ALPHA
-               when beta then Mumble::CODEC_BETA
-               end
+    def codec_negotiation(message)
+      @codec = CODEC_OPUS if message.opus
     end
 
     def channel_id(channel)
@@ -191,7 +197,7 @@ module Mumble
 
     def user_session(user)
       id = case user
-           when Messages::ChannelState
+           when Messages::UserState
              user.session
            when Fixnum
              user

data/lib/mumble-ruby/connection.rb

@@ -11,7 +11,7 @@ module Mumble
     end
 
     def connect
-      context = OpenSSL::SSL::SSLContext.new
+      context = OpenSSL::SSL::SSLContext.new(:TLSv1)
       context.verify_mode = OpenSSL::SSL::VERIFY_NONE
       tcp_sock = TCPSocket.new @host, @port
       @sock = OpenSSL::SSL::SSLSocket.new tcp_sock, context
@@ -53,12 +53,12 @@ module Mumble
     private
     def send_data(data)
       @write_lock.synchronize do
-        @sock.syswrite data
+        @sock.write data
       end
     end
 
     def read_data(len)
-      @sock.sysread len
+      @sock.read len
     end
 
     def message(obj)

data/lib/mumble-ruby/messages.rb

@@ -1,5 +1,5 @@
 ### Generated by rprotoc. DO NOT EDIT!
-### <proto file: Mumble.proto>
+### <proto file: mumble.proto>
 
 require 'protobuf/message/message'
 require 'protobuf/message/enum'
@@ -8,7 +8,7 @@ require 'protobuf/message/extend'
 
 module Mumble
   module Messages
-    ::Protobuf::OPTIONS[:optimize_for] = :SPEED
+    ::Protobuf::OPTIONS[:"optimize_for"] = :SPEED
     HEADER_FORMAT = "nN"
 
     @@sym_to_type = {
@@ -36,7 +36,8 @@ module Mumble
       codec_version: 21,
       user_stats: 22,
       request_blob: 23,
-      server_config: 24
+      server_config: 24,
+      suggest_config: 25
     }
 
     @@type_to_sym = @@sym_to_type.invert
@@ -78,6 +79,7 @@ module Mumble
       optional :string, :password, 2
       repeated :string, :tokens, 3
       repeated :int32, :celt_versions, 4
+      optional :bool, :opus, 5, :default => false
     end
     class Ping < ::Protobuf::Message
       defined_in __FILE__
@@ -123,6 +125,12 @@ module Mumble
       optional :uint32, :max_bandwidth, 2
       optional :string, :welcome_text, 3
       optional :uint64, :permissions, 4
+    end
+     class SuggestConfig < ::Protobuf::Message
+      defined_in __FILE__
+      optional :uint32, :version, 1
+      optional :bool,   :positional, 2
+      optional :bool,   :push_to_talk, 3
     end
     class ChannelRemove < ::Protobuf::Message
       defined_in __FILE__
@@ -207,6 +215,7 @@ module Mumble
         MissingCertificate = value(:MissingCertificate, 7)
         UserName = value(:UserName, 8)
         ChannelFull = value(:ChannelFull, 9)
+        NestingLimit = value(:NestingLimit, 10)
       end
       optional :uint32, :permission, 1
       optional :uint32, :channel_id, 2
@@ -254,7 +263,7 @@ module Mumble
       optional :bytes, :client_nonce, 2
       optional :bytes, :server_nonce, 3
     end
-    class ContextActionAdd < ::Protobuf::Message
+    class ContextActionModify < ::Protobuf::Message
       defined_in __FILE__
       class Context < ::Protobuf::Enum
         defined_in __FILE__
@@ -262,9 +271,15 @@ module Mumble
         Channel = value(:Channel, 2)
         User = value(:User, 4)
       end
+      class Operation < ::Protobuf::Enum
+        defined_in __FILE__
+        Add = value(:Add, 0)
+        Remove = value(:Remove, 1)
+      end
       required :string, :action, 1
-      required :string, :text, 2
+      optional :string, :text, 2
       optional :uint32, :context, 3
+      optional :Operation, :operation, 4
     end
     class ContextAction < ::Protobuf::Message
       defined_in __FILE__
@@ -305,6 +320,7 @@ module Mumble
       required :int32, :alpha, 1
       required :int32, :beta, 2
       required :bool, :prefer_alpha, 3, :default => true
+      optional :bool, :opus, 4, :default => false
     end
     class UserStats < ::Protobuf::Message
       defined_in __FILE__
@@ -333,6 +349,13 @@ module Mumble
       optional :uint32, :onlinesecs, 16
       optional :uint32, :idlesecs, 17
       optional :bool, :strong_certificate, 18, :default => false
+      optional :bool, :opus, 19, :default => false
+    end
+    class SuggestConfig < ::Protobuf::Message
+      defined_in __FILE__
+      optional :uint32, :version, 1
+      optional :bool, :positional, 2
+      optional :bool, :push_to_talk, 3
     end
     class RequestBlob < ::Protobuf::Message
       defined_in __FILE__

data/lib/mumble-ruby/mumble.proto

@@ -18,6 +18,7 @@ message Authenticate {
 	optional string password = 2;
 	repeated string tokens = 3;
 	repeated int32 celt_versions = 4;
+	optional bool opus = 5 [default = false];
 }
 
 message Ping {
@@ -144,6 +145,7 @@ message PermissionDenied {
 		MissingCertificate = 7;
 		UserName = 8;
 		ChannelFull = 9;
+		NestingLimit = 10;
 	}
 	optional uint32 permission = 1;
 	optional uint32 channel_id = 2;
@@ -190,15 +192,20 @@ message CryptSetup {
 	optional bytes server_nonce = 3;
 }
 
-message ContextActionAdd {
+message ContextActionModify {
 	enum Context {
 		Server = 0x01;
 		Channel = 0x02;
 		User = 0x04;
 	}
+	enum Operation {
+		Add = 0;
+		Remove = 1;
+	}
 	required string action = 1;
-	required string text = 2;
+	optional string text = 2;
 	optional uint32 context = 3;
+	optional Operation operation = 4;
 }
 
 message ContextAction {
@@ -237,6 +244,7 @@ message CodecVersion {
 	required int32 alpha = 1;
 	required int32 beta = 2;
 	required bool prefer_alpha = 3 [default = true];
+	optional bool opus = 4 [default = false];
 }
 
 message UserStats {
@@ -267,6 +275,13 @@ message UserStats {
 	optional uint32 onlinesecs = 16;
 	optional uint32 idlesecs = 17;
 	optional bool strong_certificate = 18 [default = false];
+	optional bool opus = 19 [default = false];
+}
+
+message SuggestConfig {
+	optional uint32 version = 1;
+	optional bool positional = 2;
+	optional bool push_to_talk = 3;
 }
 
 message RequestBlob {

data/lib/mumble-ruby/version.rb

@@ -1,3 +1,3 @@
 module Mumble
-  VERSION = "0.0.3"
+  VERSION = "1.0.0"
 end

data/mumble-ruby.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |gem|
   gem.version       = Mumble::VERSION
 
   gem.add_dependency "activesupport"
-  gem.add_dependency "celt-ruby"
   gem.add_dependency "ruby_protobuf"
+  gem.add_dependency "hashie"
+  gem.add_dependency "opus-ruby"
 end

metadata

@@ -1,49 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: mumble-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.3
-  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors:
 - Matthew Perry
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-28 00:00:00.000000000 Z
+date: 2014-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &16063820 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *16063820
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: celt-ruby
-  requirement: &16063320 !ruby/object:Gem::Requirement
-    none: false
+  name: ruby_protobuf
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *16063320
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: ruby_protobuf
-  requirement: &16062600 !ruby/object:Gem::Requirement
-    none: false
+  name: hashie
+  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: opus-ruby
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *16062600
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby API for interacting with a mumble server
 email:
 - perrym5@rpi.edu
@@ -51,9 +73,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rvmrc
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
 - Gemfile
+- LICENSE.txt
 - README.rdoc
 - Rakefile
 - lib/mumble-ruby.rb
@@ -67,26 +91,25 @@ files:
 - mumble-ruby.gemspec
 homepage: http://www.github.com/perrym5/mumble-ruby
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Implements the mumble VOIP protocol in ruby for more easily writing clients.
 test_files: []

data/.rvmrc

@@ -1 +0,0 @@
-rvm use --create ruby-1.9.3-p0@mumble_ruby_gem