discorb-voice 0.1.0 → 0.1.1

data/lib/discorb/voice/extend.rb

@@ -1,64 +1,79 @@
-# frozen_string_literal: true
-
-module Discorb::Voice
-  # @private
-  module ClientVoicePrepend
-    attr_reader :voice_conditions
-
-    def initialize(*, **)
-      super
-      @voice_clients = Discorb::Dictionary.new
-      @voice_conditions = {}
-    end
-
-    def event_voice_server_update(data)
-      @log.debug("Received VOICE_SERVER_UPDATE")
-      client = Discorb::Voice::Client.new(self, data)
-      @voice_clients[data[:guild_id]] = client
-      client.connect_condition.wait
-      @voice_conditions[data[:guild_id]].signal client
-    end
-
-    def disconnect_voice(guild_id)
-      send_gateway(
-        4,
-        guild_id: guild_id,
-        channel_id: nil,
-
-      )
-    end
-
-    def connect_to(channel)
-      Async do
-        @log.debug("Connecting to #{channel.id}")
-        send_gateway(
-          4,
-          guild_id: channel.guild.id.to_s,
-          channel_id: channel.id.to_s,
-          self_mute: channel.guild.me.voice_state&.self_mute?,
-          self_deaf: channel.guild.me.voice_state&.self_deaf?,
-
-        )
-        condition = Async::Condition.new
-        @voice_conditions[channel.guild.id.to_s] = condition
-        condition.wait
-      end
-    end
-  end
-end
-
-class Discorb::Client
-  # @return [Discorb::Dictionary{String => Discorb::Voice::Client}] The voice clients.
-  attr_accessor :voice_clients
-
-  prepend Discorb::Voice::ClientVoicePrepend
-end
-
-class Discorb::Guild
-  # @!attribute [r] voice_client
-  #   @return [Discorb::Voice::Client] The voice client.
-  #   @return [nil] If the client is not connected to the voice server.
-  def voice_client
-    @client.voice_clients[@id.to_s]
-  end
-end
+# frozen_string_literal: true
+# rubocop:disable Style/Documentation
+
+module Discorb
+  module Voice
+    # @private
+    module ClientVoicePrepend
+      attr_reader :voice_conditions
+      attr_reader :voice_mutexes
+
+      def initialize(*, **)
+        super
+        @voice_clients = Discorb::Dictionary.new
+        @voice_conditions = {}
+        @voice_mutexes = {}
+      end
+
+      def event_voice_server_update(data)
+        @log.debug("Received VOICE_SERVER_UPDATE")
+        client = Discorb::Voice::Client.new(self, data)
+        @voice_clients[data[:guild_id]] = client
+        client.connect_condition.wait
+        @voice_conditions[data[:guild_id]].signal client
+      end
+
+      def disconnect_voice(guild_id)
+        send_gateway(
+          4,
+          guild_id: guild_id,
+          channel_id: nil,
+
+        )
+      end
+
+      def connect_to(channel)
+        Async do
+          @log.debug("Connecting to #{channel.id}")
+          send_gateway(
+            4,
+            guild_id: channel.guild.id.to_s,
+            channel_id: channel.id.to_s,
+            self_mute: channel.guild.me.voice_state&.self_mute?,
+            self_deaf: channel.guild.me.voice_state&.self_deaf?,
+
+          )
+          condition = Async::Condition.new
+          @voice_conditions[channel.guild.id.to_s] = condition
+          condition.wait
+        end
+      end
+    end
+  end
+
+  class Client
+    # @return [Discorb::Dictionary{String => Discorb::Voice::Client}] The voice clients.
+    attr_accessor :voice_clients
+
+    prepend Discorb::Voice::ClientVoicePrepend
+  end
+
+  class Guild
+    # @!attribute [r] voice_client
+    #   @return [Discorb::Voice::Client] The voice client.
+    #   @return [nil] If the client is not connected to the voice server.
+    def voice_client
+      @client.voice_clients[@id.to_s]
+    end
+  end
+
+  module Connectable
+    def connect
+      Async do
+        @client.connect_to(self).wait
+      end
+    end
+  end
+end
+
+# rubocop:enable Style/Documentation

data/lib/discorb/voice/ogg.rb

@@ -1,120 +1,121 @@
-module Discorb::Voice
-  #
-  # Represents a Ogg stream.
-  #
-  class OggStream
-    #
-    # Creates a new Ogg stream.
-    #
-    # @param [IO] io The audio ogg stream.
-    #
-    def initialize(io)
-      @io = io
-    end
-
-    #
-    # Enumerates the packets of the Ogg stream.
-    #
-    # @return [Enumerator<Discorb::Voice::OggStream::Page::Packet>] The packets of the Ogg stream.
-    #
-    def packets
-      Enumerator.new do |enum|
-        part = +""
-        raw_packets.each do |packet|
-          part << packet.data
-          unless packet.partial
-            enum << part
-            part = +""
-          end
-        end
-      end
-    end
-
-    #
-    # Enumerates the raw packets of the Ogg stream.
-    # This may include partial packets.
-    #
-    # @return [Enumerator<Discorb::Voice::OggStream::Page::Packet>] The raw packets of the Ogg stream.
-    #
-    def raw_packets
-      Enumerator.new do |enum|
-        loop do
-          # p c += 1
-          if @io.read(4) != "OggS"
-            break
-          end
-          pg = Page.new(@io)
-          pg.packets.each do |packet|
-            enum << packet
-          end
-          # enum << pg.packets.next
-        end
-      end
-    end
-
-    #
-    # Represents a page of the Ogg stream.
-    #
-    class Page
-      # @return [Struct] The struct of the packet
-      Packet = Struct.new(:data, :partial, :page)
-      # @return [Integer] The version of the page.
-      attr_reader :version
-      # @return [Integer] The header type of the page.
-      attr_reader :header_type
-      # @return [Integer] The granule position of the page.
-      attr_reader :granule_position
-      # @return [Integer] The bitstream serial number of the page.
-      attr_reader :bitstream_serial_number
-      # @return [Integer] The page sequence number of the page.
-      attr_reader :page_sequence_number
-      # @return [Integer] The CRC checksum of the page.
-      attr_reader :crc_checksum
-      # @return [Integer] The length of the page segment table.
-      attr_reader :page_segments
-      # @return [String] The body of the page.
-      attr_reader :body
-
-      #
-      # Creates a new page.
-      #
-      # @param [IO] io The audio ogg stream.
-      # @note This method will seek the io.
-      #
-      def initialize(io)
-        @version, @header_type, @granule_position, @bitstream_serial_number, @page_sequence_number, @crc_checksum, @page_segments =
-          io.read(23).unpack("CCQ<L<L<L<C")
-        @segtable = io.read(@page_segments)
-        len = @segtable.unpack("C*").sum
-        @body = io.read(len)
-      end
-
-      #
-      # Enumerates the packets of the page.
-      #
-      # @return [Enumerator<Discorb::Voice::OggStream::Page::Packet>] The packets of the page.
-      #
-      def packets
-        Enumerator.new do |enum|
-          offset = 0
-          length = 0
-          partial = true
-          @segtable.bytes.each do |seg|
-            if seg == 255
-              length += 255
-              partial = true
-            else
-              length += seg
-              partial = false
-              enum << Packet.new(@body[offset, length], partial, self)
-              offset += length
-              length = 0
-            end
-          end
-
-          enum << Packet.new(@body[offset, length], partial, self) if partial
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+module Discorb
+  module Voice
+  #
+  # Represents a Ogg stream.
+  #
+  class OggStream
+    #
+    # Creates a new Ogg stream.
+    #
+    # @param [IO] io The audio ogg stream.
+    #
+    def initialize(io)
+      @io = io
+    end
+
+    #
+    # Enumerates the packets of the Ogg stream.
+    #
+    # @return [Enumerator<Discorb::Voice::OggStream::Page::Packet>] The packets of the Ogg stream.
+    #
+    def packets
+      Enumerator.new do |enum|
+        part = +""
+        raw_packets.each do |packet|
+          part << packet.data
+          unless packet.partial
+            enum << part
+            part = +""
+          end
+        end
+      end
+    end
+
+    #
+    # Enumerates the raw packets of the Ogg stream.
+    # This may include partial packets.
+    #
+    # @return [Enumerator<Discorb::Voice::OggStream::Page::Packet>] The raw packets of the Ogg stream.
+    #
+    def raw_packets
+      Enumerator.new do |enum|
+        loop do
+          # p c += 1
+          break if @io.read(4) != "OggS"
+          pg = Page.new(@io)
+          pg.packets.each do |packet|
+            enum << packet
+          end
+          # enum << pg.packets.next
+        end
+      end
+    end
+
+    #
+    # Represents a page of the Ogg stream.
+    #
+    class Page
+      # @return [Struct] The struct of the packet
+      Packet = Struct.new(:data, :partial, :page)
+      # @return [Integer] The version of the page.
+      attr_reader :version
+      # @return [Integer] The header type of the page.
+      attr_reader :header_type
+      # @return [Integer] The granule position of the page.
+      attr_reader :granule_position
+      # @return [Integer] The bitstream serial number of the page.
+      attr_reader :bitstream_serial_number
+      # @return [Integer] The page sequence number of the page.
+      attr_reader :page_sequence_number
+      # @return [Integer] The CRC checksum of the page.
+      attr_reader :crc_checksum
+      # @return [Integer] The length of the page segment table.
+      attr_reader :page_segments
+      # @return [String] The body of the page.
+      attr_reader :body
+
+      #
+      # Creates a new page.
+      #
+      # @param [IO] io The audio ogg stream.
+      # @note This method will seek the io.
+      #
+      def initialize(io)
+        @version, @header_type, @granule_position, @bitstream_serial_number, @page_sequence_number, @crc_checksum, @page_segments =
+          io.read(23).unpack("CCQ<L<L<L<C")
+        @segtable = io.read(@page_segments)
+        len = @segtable.unpack("C*").sum
+        @body = io.read(len)
+      end
+
+      #
+      # Enumerates the packets of the page.
+      #
+      # @return [Enumerator<Discorb::Voice::OggStream::Page::Packet>] The packets of the page.
+      #
+      def packets
+        Enumerator.new do |enum|
+          offset = 0
+          length = 0
+          partial = true
+          @segtable.bytes.each do |seg|
+            if seg == 255
+              length += 255
+              partial = true
+            else
+              length += seg
+              partial = false
+              enum << Packet.new(@body[offset, length], partial, self)
+              offset += length
+              length = 0
+            end
+          end
+
+          enum << Packet.new(@body[offset, length], partial, self) if partial
+        end
+      end
+    end
+  end
+  end
+end

data/lib/discorb/voice/source.rb

@@ -1,110 +1,113 @@
-require "open3"
-require "tmpdir"
-
-module Discorb::Voice
-  #
-  # The source of audio data.
-  # @abstract
-  #
-  class Source
-    #
-    # The audio ogg stream. This MUST be implemented by subclasses.
-    #
-    # @return [#read] The audio ogg stream.
-    #
-    def io
-      raise NotImplementedError
-    end
-
-    #
-    # Clean up the source.
-    # This does nothing by default.
-    #
-    def cleanup
-      # noop
-    end
-  end
-
-  #
-  # Plays audio from a source, using FFmpeg.
-  # @note You must install FFmpeg and should be on the PATH.
-  #
-  class FFmpegAudio
-    attr_reader :stdin, :stdout, :stderr, :process
-
-    #
-    # Creates a new FFmpegAudio.
-    #
-    # @param [String, IO] source The source of audio data.
-    # @param [Integer] bitrate The bitrate of the audio.
-    # @param [{String => String}] extra_options Extra options for FFmpeg. This will be passed before `-i`.
-    # @param [{String => String}] extra_options2 Extra options for FFmpeg. This will be passed after `-i`.
-    #
-    def initialize(source, bitrate: 128, extra_options: {}, extra_options2: {})
-      if source.is_a?(String)
-        source_path = source
-        @tmp_path = nil
-      else
-        source_path = "#{Dir.tmpdir}/#{Process.pid}.#{source.object_id}"
-        @tmp_path = source_path
-        File.open(source_path, "wb") do |f|
-          while chunk = source.read(4096)
-            f.write(chunk)
-          end
-        end
-      end
-      args = %W[ffmpeg]
-      extra_options.each do |key, value|
-        args += ["-#{key}", "#{value}"]
-      end
-      args += %W[
-        -i #{source_path}
-        -f opus
-        -c:a libopus
-        -ar 48000
-        -ac 2
-        -b:a #{bitrate}k
-        -loglevel warning
-        -map_metadata -1]
-      extra_options2.each do |key, value|
-        args += ["-#{key}", "#{value}"]
-      end
-      args += %w[pipe:1]
-      @stdin, @stdout, @process = Open3.popen2(*args)
-    end
-
-    def io
-      @stdout
-    end
-
-    #
-    # Kills the FFmpeg process.
-    #
-    def cleanup
-      @process.kill
-      if @tmp_path
-        File.delete(@tmp_path)
-      end
-    end
-  end
-
-  #
-  # Plays audio from a ogg file.
-  #
-  class OggAudio
-    attr_reader :io
-
-    #
-    # Opens an ogg file.
-    #
-    # @param [String, IO] src The ogg file to open, or an IO object.
-    #
-    def initialize(src)
-      if src.is_a?(String)
-        @io = File.open(src, "rb")
-      else
-        @io = src
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+require "open3"
+require "tmpdir"
+
+module Discorb
+  module Voice
+    #
+    # The source of audio data.
+    # @abstract
+    #
+    class Source
+      #
+      # The audio ogg stream. This MUST be implemented by subclasses.
+      #
+      # @return [#read] The audio ogg stream.
+      #
+      def io
+        raise NotImplementedError
+      end
+
+      #
+      # Clean up the source.
+      # This does nothing by default.
+      #
+      def cleanup
+        # noop
+      end
+    end
+
+    #
+    # Plays audio from a source, using FFmpeg.
+    # @note You must install FFmpeg and should be on the PATH.
+    #
+    class FFmpegAudio
+      attr_reader :stdin, :stdout, :stderr, :process
+
+      #
+      # Creates a new FFmpegAudio.
+      #
+      # @param [String, IO] source The source of audio data.
+      # @param [Integer] bitrate The bitrate of the audio.
+      # @param [{String => String}] extra_options Extra options for FFmpeg. This will be passed before `-i`.
+      # @param [{String => String}] extra_options2 Extra options for FFmpeg. This will be passed after `-i`.
+      #
+      def initialize(source, bitrate: 128, extra_options: {}, extra_options2: {})
+        if source.is_a?(String)
+          source_path = source
+          @tmp_path = nil
+        else
+          source_path = "#{Dir.tmpdir}/#{Process.pid}.#{source.object_id}"
+          @tmp_path = source_path
+          File.open(source_path, "wb") do |f|
+            while chunk = source.read(4096)
+              f.write(chunk)
+            end
+          end
+        end
+        args = %w[ffmpeg]
+        extra_options.each do |key, value|
+          args += ["-#{key}", "#{value}"]
+        end
+        args += %W[
+          -i #{source_path}
+          -f opus
+          -c:a libopus
+          -ar 48000
+          -ac 2
+          -b:a #{bitrate}k
+          -loglevel warning
+          -map_metadata -1]
+        extra_options2.each do |key, value|
+          args += ["-#{key}", "#{value}"]
+        end
+        args += %w[pipe:1]
+        @stdin, @stdout, @process = Open3.popen2(*args)
+      end
+
+      def io
+        @stdout
+      end
+
+      #
+      # Kills the FFmpeg process, and closes io.
+      #
+      def cleanup
+        @process.kill
+        @stdin.close
+        @stdout.close
+        File.delete(@tmp_path) if @tmp_path
+      end
+    end
+
+    #
+    # Plays audio from a ogg file.
+    #
+    class OggAudio
+      attr_reader :io
+
+      #
+      # Opens an ogg file.
+      #
+      # @param [String, IO] src The ogg file to open, or an IO object.
+      #
+      def initialize(src)
+        @io = if src.is_a?(String)
+            File.open(src, "rb")
+          else
+            src
+          end
+      end
+    end
+  end
+end

data/lib/discorb/voice/version.rb

@@ -3,6 +3,6 @@
 module Discorb
   module Voice
     # @return [String] The version of the library.
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/lib/discorb/voice.rb

@@ -4,26 +4,26 @@ require "discorb"
 begin
   require "rbnacl"
 rescue LoadError
-  raise LoadError, <<~EOS, cause: nil
-                             Could not load libsodium library.
-                             Follow the instructions at https://github.com/discorb-lib/discorb-voice#install-libsodium
-                           EOS
+  raise LoadError, <<~ERROR, cause: nil
+                               Could not load libsodium library.
+                               Follow the instructions at https://github.com/discorb-lib/discorb-voice#install-libsodium
+                             ERROR
 end
 require "open3"
 begin
   ffmpeg_version = Open3.capture2e("ffmpeg -version")[0]
 rescue Errno::ENOENT
-  raise LoadError, <<~EOS, cause: nil
-                             Could not find ffmpeg.
-                             Follow the instructions at https://github.com/discorb-lib/discorb-voice#install-ffmpeg
-                           EOS
+  raise LoadError, <<~ERROR, cause: nil
+                               Could not find ffmpeg.
+                               Follow the instructions at https://github.com/discorb-lib/discorb-voice#install-ffmpeg
+                             ERROR
 else
-  line = ffmpeg_version.split("\n").find { |line| line.start_with?("configuration: ") }
+  line = ffmpeg_version.split("\n").find { |l| l.start_with?("configuration: ") }
   unless line.include? "--enable-libopus"
-    raise LoadError, <<~EOS, cause: nil
-                               Your ffmpeg version does not support opus.
-                               Install ffmpeg with opus support.
-                             EOS
+    raise LoadError, <<~ERROR, cause: nil
+                                 Your ffmpeg version does not support opus.
+                                 Install ffmpeg with opus support.
+                               ERROR
   end
 end
 require_relative "voice/version"

data/lib/discorb-voice.rb

@@ -1 +1,2 @@
-require "discorb/voice"
+# frozen_string_literal: true
+require "discorb/voice"