discordrb 1.6.6 → 1.7.0

data/lib/discordrb/version.rb

@@ -1,5 +1,5 @@
 # Discordrb and all its functionality, in this case only the version.
 module Discordrb
   # The current version of discordrb.
-  VERSION = '1.6.6'.freeze
+  VERSION = '1.7.0'.freeze
 end

data/lib/discordrb/voice/encoder.rb

@@ -11,19 +11,8 @@ module Discordrb::Voice
   # This class conveniently abstracts opus and ffmpeg/avconv, for easy implementation of voice sending. It's not very
   # useful for most users, but I guess it can be useful sometimes.
   class Encoder
-    # The volume that should be used with future ffmpeg conversions. If ffmpeg is used, this can be specified as:
-    #
-    #  * A number, where `1` is no change in volume, `0` is completely silent, `0.5` is half the default volume and `2` is twice the default.
-    #  * A string representation of the above number.
-    #  * A string representing a change in gain given in decibels, in the format `-6dB` or `6dB`.
-    #
-    # If avconv is used (see #use_avconv) then it can only be given as a number from `0` to `1`, where `1` is no change
-    # and `0` is completely silent.
-    # @return [String, Number] the volume for future playbacks, `1.0` by default.
-    attr_accessor :volume
-
     # Whether or not avconv should be used instead of ffmpeg. If possible, it is recommended to use ffmpeg instead,
-    # as it is better supported and has a wider range of possible volume settings (see #volume).
+    # as it is better supported.
     # @return [true, false] whether avconv should be used instead of ffmpeg.
     attr_accessor :use_avconv
 
@@ -32,7 +21,6 @@ module Discordrb::Voice
       @sample_rate = 48_000
       @frame_size = 960
       @channels = 2
-      @volume = 1.0
 
       if OPUS_AVAILABLE
         @opus = Opus::Encoder.new(@sample_rate, @frame_size, @channels)
@@ -41,6 +29,12 @@ module Discordrb::Voice
       end
     end
 
+    # Set the opus encoding bitrate
+    # @param value [Integer] The new bitrate to use, in bits per second (so 64000 if you want 64 kbps)
+    def bitrate=(value)
+      @opus.bitrate = value
+    end
+
     # Encodes the given buffer using opus.
     # @param buffer [String] An unencoded PCM (s16le) buffer.
     # @return [String] A buffer encoded using opus.
@@ -53,13 +47,33 @@ module Discordrb::Voice
       @opus.destroy
     end
 
+    # Adjusts the volume of a given buffer of s16le PCM data.
+    # @param buf [String] An unencoded PCM (s16le) buffer.
+    # @param mult [Float] The volume multiplier, 1 for same volume.
+    # @return [String] The buffer with adjusted volume, s16le again
+    def adjust_volume(buf, mult)
+      # We don't need to adjust anything if the buf is nil so just return in that case
+      return unless buf
+
+      # buf is s16le so use 's<' for signed, 16 bit, LE
+      result = buf.unpack('s<*').map do |sample|
+        sample *= mult
+
+        # clamp to s16 range
+        [32_767, [-32_768, sample].max].min
+      end
+
+      # After modification, make it s16le again
+      result.pack('s<*')
+    end
+
     # Encodes a given file (or rather, decodes it) using ffmpeg. This accepts pretty much any format, even videos with
     # an audio track. For a list of supported formats, see https://ffmpeg.org/general.html#Audio-Codecs. It even accepts
     # URLs, though encoding them is pretty slow - I recommend to make a stream of it and then use {#encode_io} instead.
     # @param file [String] The path or URL to encode.
     # @return [IO] the audio, encoded as s16le PCM
     def encode_file(file)
-      command = "#{ffmpeg_command} -loglevel 0 -i \"#{file}\" -f s16le -ar 48000 -ac 2 #{ffmpeg_volume} pipe:1"
+      command = "#{ffmpeg_command} -loglevel 0 -i \"#{file}\" -f s16le -ar 48000 -ac 2 pipe:1"
       IO.popen(command)
     end
 
@@ -69,7 +83,7 @@ module Discordrb::Voice
     # @return [IO] the audio, encoded as s16le PCM
     def encode_io(io)
       ret_io, writer = IO.pipe
-      command = "#{ffmpeg_command} -loglevel 0 -i - -f s16le -ar 48000 -ac 2 #{ffmpeg_volume} pipe:1"
+      command = "#{ffmpeg_command} -loglevel 0 -i - -f s16le -ar 48000 -ac 2 pipe:1"
       spawn(command, in: io, out: writer)
       ret_io
     end
@@ -79,9 +93,5 @@ module Discordrb::Voice
     def ffmpeg_command
       @use_avconv ? 'avconv' : 'ffmpeg'
     end
-
-    def ffmpeg_volume
-      @use_avconv ? "-vol #{(@volume * 256).ceil}" : "-af volume=#{@volume}"
-    end
   end
 end

data/lib/discordrb/voice/network.rb

@@ -5,20 +5,19 @@ require 'json'
 
 begin
   require 'rbnacl'
-  $rbnacl_available = true
+  RBNACL_AVAILABLE = true
 rescue LoadError
   puts "libsodium not available! You can continue to use discordrb as normal but voice support won't work.
         Read https://github.com/meew0/discordrb/wiki/Installing-libsodium for more details."
-  $rbnacl_available = false
+  RBNACL_AVAILABLE = false
 end
 
-
 module Discordrb::Voice
   # Signifies to Discord that encryption should be used
-  ENCRYPTED_MODE = 'xsalsa20_poly1305'
+  ENCRYPTED_MODE = 'xsalsa20_poly1305'.freeze
 
   # Signifies to Discord that no encryption should be used
-  PLAIN_MODE = 'plain'
+  PLAIN_MODE = 'plain'.freeze
 
   # Represents a UDP connection to a voice server. This connection is used to send the actual audio data.
   class VoiceUDP
@@ -70,9 +69,7 @@ module Discordrb::Voice
       header = [0x80, 0x78, sequence, time, @ssrc].pack('CCnNN')
 
       # Encrypt data, if necessary
-      if encrypted?
-        buf = encrypt_audio(header, buf)
-      end
+      buf = encrypt_audio(header, buf) if encrypted?
 
       send_packet(header + buf)
     end
@@ -122,7 +119,7 @@ module Discordrb::Voice
     # @param session [String] The voice session ID Discord sends over the regular websocket
     # @param endpoint [String] The endpoint URL to connect to
     def initialize(channel, bot, token, session, endpoint)
-      fail 'RbNaCl is unavailable - unable to create voice bot! Please read https://github.com/meew0/discordrb/wiki/Installing-libsodium' unless $rbnacl_available
+      fail 'RbNaCl is unavailable - unable to create voice bot! Please read https://github.com/meew0/discordrb/wiki/Installing-libsodium' unless RBNACL_AVAILABLE
 
       @channel = channel
       @bot = bot
@@ -223,8 +220,6 @@ module Discordrb::Voice
         @ws_data = packet['d']
         @ready = true
         @udp.secret_key = @ws_data['secret_key'].pack('C*')
-      else
-        # irrelevant opcode, ignore
       end
     end
 

data/lib/discordrb/voice/voice_bot.rb

@@ -48,6 +48,25 @@ module Discordrb::Voice
     # @return [true, false] whether adjustment lengths should be averaged with the respective previous value.
     attr_accessor :adjust_average
 
+    # Disable the debug message for length adjustment specifically, as it can get quite spammy with very low intervals
+    # @see #adjust_interval
+    # @return [true, false] whether length adjustment debug messages should be printed
+    attr_accessor :adjust_debug
+
+    # If this value is set, no length adjustments will ever be done and this value will always be used as the length
+    # (i. e. packets will be sent every N seconds). Be careful not to set it too low as to not spam Discord's servers.
+    # The ideal length is 20 ms (accessible by the {Discordrb::Voice::IDEAL_LENGTH} constant), this value should be
+    # slightly lower than that because encoding + sending takes time. Note that sending DCA files is significantly
+    # faster than sending regular audio files (usually about four times as fast), so you might want to set this value
+    # to something else if you're sending a DCA file.
+    # @return [Float] the packet length that should be used instead of calculating it during the adjustments, in ms.
+    attr_accessor :length_override
+
+    # The factor the audio's volume should be multiplied with. `1` is no change in volume, `0` is completely silent,
+    # `0.5` is half the default volume and `2` is twice the default.
+    # @return [Float] the volume for audio playback, `1.0` by default.
+    attr_accessor :volume
+
     def initialize(channel, bot, token, session, endpoint, encrypted)
       @bot = bot
       @ws = VoiceWS.new(channel, bot, token, session, endpoint)
@@ -55,27 +74,19 @@ module Discordrb::Voice
       @udp.encrypted = encrypted
 
       @sequence = @time = 0
+      @skips = 0
 
       @adjust_interval = 100
       @adjust_offset = 10
       @adjust_average = false
+      @adjust_debug = true
+
+      @volume = 1.0
 
       @encoder = Encoder.new
       @ws.connect
     end
 
-    # Set the volume. Only applies to future playbacks
-    # @see Encoder#volume=
-    def volume=(value)
-      @encoder.volume = value
-    end
-
-    # @see Encoder#volume
-    # @return [Integer, String] the current encoder volume.
-    def volume
-      @encoder.volume
-    end
-
     # @return [true, false] whether audio data sent will be encrypted.
     def encrypted?
       @udp.encrypted?
@@ -92,6 +103,13 @@ module Discordrb::Voice
       @paused = false
     end
 
+    # Skips to a later time in the song. It's impossible to go back without replaying the song.
+    # @param secs [Float] How many seconds to skip forwards. Skipping will always be done in discrete intervals of
+    #   0.05 seconds, so if the given amount is smaller than that, it will be rounded up.
+    def skip(secs)
+      @skips += (secs * (1000 / IDEAL_LENGTH)).ceil
+    end
+
     # Sets whether or not the bot is speaking (green circle around user).
     # @param value [true, false] whether or not the bot should be speaking.
     def speaking=(value)
@@ -103,8 +121,7 @@ module Discordrb::Voice
     def stop_playing
       @was_playing_before = @playing
       @speaking = false
-      @io.close if @io
-      @io = nil
+      @playing = false
       sleep IDEAL_LENGTH / 1000.0 if @was_playing_before
     end
 
@@ -122,8 +139,34 @@ module Discordrb::Voice
     # @param encoded_io [IO] A stream of raw PCM data (s16le)
     def play(encoded_io)
       stop_playing if @playing
-      @io = encoded_io
-      play_internal
+      @retry_attempts = 3
+
+      play_internal do
+        buf = nil
+
+        # Read some data from the buffer
+        begin
+          buf = encoded_io.readpartial(DATA_LENGTH) if encoded_io
+        rescue EOFError
+          @bot.debug('EOF while reading, breaking immediately')
+          break
+        end
+
+        # Check whether the buffer has enough data
+        if !buf || buf.length != DATA_LENGTH
+          @bot.debug("No data is available! Retrying #{@retry_attempts} more times")
+          break if @retry_attempts == 0
+
+          @retry_attempts -= 1
+          next
+        end
+
+        # Adjust volume
+        buf = @encoder.adjust_volume(buf, @volume) if @volume != 1.0
+
+        # Encode data
+        @encoder.encode(buf)
+      end
     end
 
     # Plays an encoded audio file of arbitrary format to the channel.
@@ -140,6 +183,31 @@ module Discordrb::Voice
       play @encoder.encode_io(io)
     end
 
+    # Plays a stream of audio data in the DCA format. This format has the advantage that no recoding has to be
+    # done - the file contains the data exactly as Discord needs it.
+    # @see https://github.com/bwmarrin/dca
+    # @see #play
+    def play_dca(file)
+      stop_playing if @playing
+
+      @bot.debug "Reading DCA file #{file}"
+      input_stream = open(file)
+
+      # Play the data, without re-encoding it to opus
+      play_internal do
+        begin
+          # Read header
+          header = input_stream.read(2).unpack('S')[0]
+        rescue EOFError
+          @bot.debug 'Finished DCA parsing'
+          break
+        end
+
+        # Read bytes
+        input_stream.read(header)
+      end
+    end
+
     alias_method :play_stream, :play_io
 
     private
@@ -148,36 +216,24 @@ module Discordrb::Voice
     def play_internal
       count = 0
       @playing = true
-      @retry_attempts = 3
 
       # Default play length (ms), will be adjusted later
       @length = IDEAL_LENGTH
 
       self.speaking = true
       loop do
-        if count % @adjust_interval == @adjust_offset
-          # Starting from the tenth packet, perform length adjustment every 100 packets (2 seconds)
-          @length_adjust = Time.now.nsec
-        end
+        # Starting from the tenth packet, perform length adjustment every 100 packets (2 seconds)
+        should_adjust_this_packet = (count % @adjust_interval == @adjust_offset)
 
-        break unless @playing
-        break unless @io
+        # If we should adjust, start now
+        @length_adjust = Time.now.nsec if should_adjust_this_packet
 
-        # Read some data from the buffer
-        buf = nil
-        begin
-          buf = @io.readpartial(DATA_LENGTH) if @io
-        rescue EOFError
-          @bot.debug('EOF while reading, breaking immediately')
-          break
-        end
-
-        # Check whether the buffer has enough data
-        if !buf || buf.length != DATA_LENGTH
-          @bot.debug("No data is available! Retrying #{@retry_attempts} more times")
-          break if @retry_attempts == 0
+        break unless @playing
 
-          @retry_attempts -= 1
+        # If we should skip, get some data, discard it and go to the next iteration
+        if @skips > 0
+          @skips -= 1
+          yield
           next
         end
 
@@ -186,16 +242,27 @@ module Discordrb::Voice
         (@sequence + 10 < 65_535) ? @sequence += 1 : @sequence = 0
         (@time + 9600 < 4_294_967_295) ? @time += 960 : @time = 0
 
-        # Encode the packet and send it
-        @udp.send_audio(@encoder.encode(buf), @sequence, @time)
+        # Get packet data
+        buf = yield
+        next unless buf
+
+        # Track intermediate adjustment so we can measure how much encoding contributes to the total time
+        @intermediate_adjust = Time.now.nsec if should_adjust_this_packet
+
+        # Send the packet
+        @udp.send_audio(buf, @sequence, @time)
 
         # Set the stream time (for tracking how long we've been playing)
         @stream_time = count * @length / 1000
 
-        # Perform length adjustment
-        if @length_adjust
+        if @length_override # Don't do adjustment because the user has manually specified an override value
+          @length = @length_override
+        elsif @length_adjust # Perform length adjustment
+          # Define the time once so it doesn't get inaccurate
+          now = Time.now.nsec
+
           # Difference between length_adjust and now in ms
-          ms_diff = (Time.now.nsec - @length_adjust) / 1_000_000.0
+          ms_diff = (now - @length_adjust) / 1_000_000.0
           if ms_diff >= 0
             @length = if @adjust_average
                         (IDEAL_LENGTH - ms_diff + @length) / 2.0
@@ -203,7 +270,9 @@ module Discordrb::Voice
                         IDEAL_LENGTH - ms_diff
                       end
 
-            @bot.debug("Length adjustment: new length #{@length}")
+            # Track the time it took to encode
+            encode_ms = (@intermediate_adjust - @length_adjust) / 1_000_000.0
+            @bot.debug("Length adjustment: new length #{@length} (measured #{ms_diff}, #{(100 * encode_ms) / ms_diff}% encoding)") if @adjust_debug
           end
           @length_adjust = nil
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: discordrb
 version: !ruby/object:Gem::Version
-  version: 1.6.6
+  version: 1.7.0
 platform: ruby
 authors:
 - meew0
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-13 00:00:00.000000000 Z
+date: 2016-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faye-websocket
@@ -136,6 +136,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.7.6
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.36.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.36.0
 description: A Ruby implementation of the Discord (https://discordapp.com) API.
 email:
 - ''
@@ -164,9 +192,13 @@ files:
 - lib/discordrb/await.rb
 - lib/discordrb/bot.rb
 - lib/discordrb/commands/command_bot.rb
+- lib/discordrb/commands/container.rb
 - lib/discordrb/commands/events.rb
 - lib/discordrb/commands/parser.rb
+- lib/discordrb/commands/rate_limiter.rb
+- lib/discordrb/container.rb
 - lib/discordrb/data.rb
+- lib/discordrb/errors.rb
 - lib/discordrb/events/await.rb
 - lib/discordrb/events/bans.rb
 - lib/discordrb/events/channel_create.rb
@@ -183,7 +215,6 @@ files:
 - lib/discordrb/events/presence.rb
 - lib/discordrb/events/typing.rb
 - lib/discordrb/events/voice_state_update.rb
-- lib/discordrb/exceptions.rb
 - lib/discordrb/logger.rb
 - lib/discordrb/permissions.rb
 - lib/discordrb/token_cache.rb