rb_sdl2 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 101f794f351d219f8cc70180a9f02cd57c11c507e8542fad5d83c2e4635ea7cd
+  data.tar.gz: fc7e00d5985c46af575e81cdbd2bfd177464f14eeb111e2dfae41cdaffb75e51
+SHA512:
+  metadata.gz: 0dd39b4cb9da230fd7d63556a3db53be3d28eeee972a5a54aa945cffa246501d3684112d72b8f8b5f3f76cee58d47e21a226998ae791390c4f98d53222aa4cda
+  data.tar.gz: dca9330ed249b66a6b21ad6bc42a42a14cd014f95757529d3f9e14f927f0ca89c9989960e3403511ecb58d315ed28829ca8fa9a61e30a934250ee3cefc22d207

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-10-10
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,17 @@
+Copyright (C) 2021 shinokaro
+
+This software is provided 'as-is', without any express or implied
+warranty.  In no event will the authors be held liable for any damages
+arising from the use of this software.
+
+Permission is granted to anyone to use this software for any purpose,
+including commercial applications, and to alter it and redistribute it
+freely, subject to the following restrictions:
+
+1. The origin of this software must not be misrepresented; you must not
+   claim that you wrote the original software. If you use this software
+   in a product, an acknowledgment in the product documentation would be
+   appreciated but is not required.
+2. Altered source versions must be plainly marked as such, and must not be
+   misrepresented as being the original software.
+3. This notice may not be removed or altered from any source distribution.

data/README.md

@@ -0,0 +1,40 @@
+# RbSDL2
+
+RbSDL2 は [SDL](https://www.libsdl.org) (Simple DirectMedia Layer) の機能を
+Ruby オブジェクトとして提供します。
+
+SDL 2.0.16 移行を対象としています。この Gem には SDL は含まれていません。
+利用する際は環境に合わせて SDL を用意してください。
+
+## Installation
+
+    $ gem install rb_sdl2
+
+## Usage
+
+```ruby
+require 'rb_sdl2'
+
+include RbSDL2
+
+RbSDL2.load('SDL2 Library path') # SDL を読み込みます。必ず必要です。
+RbSDL2.init # SDL を初期化します。
+
+image = Surface.load("image.bmp") # 画像をメモリーに読み込みます。画像形式は BMP のみです。
+window = Window.new("Title")
+window.update { |s| s.blit(image) } # Window へ画像を描画します。
+
+RbSDL2.loop do
+  break if Event.quit? # ユーザがウィンドウを閉じたことを検出します。
+  # キーボードの A キーを押したか調べます。押していればダイアログボックスを表示します。
+  window.info_alert("Message") if Keyboard.key?("A")
+  # マウスのボタン（種類問わず）を押したか調べます。押していればダイアログボックスを表示します。
+  window.error_alert("Message from mouse") if Mouse.any_button?
+  Timer.delay(33) # SDL のタイマーを使用して 33 ミリ秒間、停止します。
+end
+# 終了の際に SDL から得たポインターのことは考えなくてよい。 SDL_Quit() も不要。
+```
+
+## License
+
+Zlib

data/lib/rb_sdl2/audio/audio_allowed_changes.rb

@@ -0,0 +1,17 @@
+module RbSDL2
+  class Audio
+    module AudioAllowedChanges
+      class << self
+        def to_num(any_change: false, channels_change: false, format_change: false,
+                   frequency_change: false, samples_change: false)
+          0 |
+            (any_change ? ::SDL2::SDL_AUDIO_ALLOW_ANY_CHANGE : 0) |
+            (channels_change ? ::SDL2::SDL_AUDIO_ALLOW_CHANNELS_CHANGE : 0) |
+            (format_change ? ::SDL2::SDL_AUDIO_ALLOW_FORMAT_CHANGE : 0) |
+            (frequency_change ? ::SDL2::SDL_AUDIO_ALLOW_FREQUENCY_CHANGE : 0) |
+            (samples_change ? ::SDL2::SDL_AUDIO_ALLOW_SAMPLES_CHANGE : 0)
+        end
+      end
+    end
+  end
+end

data/lib/rb_sdl2/audio/audio_buffer.rb

@@ -0,0 +1,49 @@
+module RbSDL2
+  class Audio
+    class AudioBuffer
+      class AudioBufferPointer < ::FFI::AutoPointer
+        def self.release(ptr) = ::SDL2::SDL_FreeWAV(ptr)
+      end
+
+      class << self
+        require_relative '../rw_ops'
+
+        def load(file) = RWOps.new(file, "rb") { |rw| load_rw(rw) }
+
+        require_relative 'audio_spec'
+
+        # load_rw は与えられたオブジェクトをオートクローズしません。
+        def load_rw(rw)
+          spec = AudioSpec.new
+          buf = ::FFI::MemoryPointer.new(:pointer)
+          len = ::FFI::MemoryPointer.new(:uint32)
+          err = ::SDL2::SDL_LoadWAV_RW(rw, 0, spec, buf, len)
+          raise RbSDL2Error if err.null?
+          new(AudioBufferPointer.new(buf.read_pointer), len.read_uint32, spec)
+        end
+      end
+
+      def initialize(ptr, size, spec)
+        @ptr = ptr
+        @size = size
+        @spec = spec
+      end
+
+      attr_reader :size
+      alias length size
+
+      attr_reader :spec
+
+      require 'forwardable'
+      extend Forwardable
+      def_delegators :spec, *%i(channels format frequency)
+
+      require_relative 'audio_format'
+      include AudioFormat
+
+      def to_ptr = @ptr
+
+      def to_str = @ptr.read_bytes(size)
+    end
+  end
+end

data/lib/rb_sdl2/audio/audio_device.rb

@@ -0,0 +1,44 @@
+module RbSDL2
+  class Audio
+    class AudioDevice
+      class << self
+        def devices(capture = false)
+          is_capture = IS_CAPTURE.(capture)
+          ::SDL2.SDL_GetNumAudioDevices(is_capture).times.map do |num|
+            ptr = ::SDL2.SDL_GetAudioDeviceName(num, is_capture)
+            raise RbSDL2Error if ptr.null?
+
+            spec = AudioSpec.new
+            # SDL_GetAudioDeviceSpec は SDL_GetNumAudioDevices の最新の呼び出しを反映する。
+            err = ::SDL2.SDL_GetAudioDeviceSpec(num, is_capture, spec)
+            raise RbSDL2Error if err != 0
+
+            new(ptr.read_string.force_encoding(Encoding::UTF_8), capture, spec)
+          end
+        end
+      end
+
+      def initialize(name, capture, spec)
+        @capture = CAPTURE.(capture)
+        @name = name
+        @spec = spec
+      end
+
+      attr_reader :capture
+
+      attr_reader :name
+      alias to_s name
+
+      attr_reader :spec
+
+      require 'forwardable'
+      extend Forwardable
+      def_delegators :spec, *%i(channels format frequency)
+
+      require_relative 'audio_format'
+      include AudioFormat
+
+      def unknown? = channels == 0 && format == 0 && frequency == 0
+    end
+  end
+end

data/lib/rb_sdl2/audio/audio_format.rb

@@ -0,0 +1,23 @@
+module RbSDL2
+  class Audio
+    module AudioFormat
+      class << self
+        def to_num(signed: true, big_endian: false, bit_size: 16, float: false)
+          num = 0 |
+            (big_endian ? ::SDL2::SDL_AUDIO_MASK_ENDIAN : 0) |
+            (bit_size & ::SDL2::SDL_AUDIO_MASK_BITSIZE) |
+            (signed ? ::SDL2::SDL_AUDIO_MASK_SIGNED : 0)
+          num | (float ? ::SDL2::SDL_AUDIO_MASK_DATATYPE & ::SDL2::SDL_AUDIO_MASK_SIGNED : 0)
+        end
+      end
+
+      def big_endian? = ::SDL2::SDL_AUDIO_MASK_ENDIAN & format != 0
+
+      def bit_size = ::SDL2::SDL_AUDIO_MASK_BITSIZE & format
+
+      def float? = ::SDL2::SDL_AUDIO_MASK_DATATYPE & format != 0
+
+      def signed? = ::SDL2::SDL_AUDIO_MASK_SIGNED & format != 0
+    end
+  end
+end

data/lib/rb_sdl2/audio/audio_spec.rb

@@ -0,0 +1,29 @@
+module RbSDL2
+  class Audio
+    class AudioSpec
+      require_relative 'audio_format'
+
+      def initialize(channels: 0, format: 0, freq: 0, frequency: freq, samples: 0)
+        @st = ::SDL2::SDL_AudioSpec.new
+        @st[:channels] = channels
+        @st[:format] = format
+        @st[:freq] = frequency
+        @st[:samples] = samples
+      end
+
+      def size = @st[:size]
+      alias chunk_size size
+
+      def channels = @st[:channels]
+
+      def format = @st[:format]
+
+      def freq = @st[:freq]
+      alias frequency freq
+
+      def samples = @st[:samples]
+
+      def to_ptr = @st.to_ptr
+    end
+  end
+end

data/lib/rb_sdl2/audio.rb

@@ -0,0 +1,132 @@
+module RbSDL2
+  class Audio
+    IS_CAPTURE = -> (capture) { capture ? 1 : 0 }
+    CAPTURE = -> (capture) { capture ? true : false }
+    # AudioStream, AudioCallback の実装は行っていない。
+    # AudioCallback は Ruby 側からまともに使う方法がない。
+    # AudioStream はリアルタイムなリサンプラー、リフォーマッターとして使えるがこれが本当に必要か判らない。
+    class << self
+      def current
+        ptr = ::SDL2.SDL_GetCurrentAudioDriver
+        raise RbSDL2Error, "Audio subsystem has not been initialized" if ptr.null?
+        ptr.read_string
+      end
+
+      require_relative 'audio/audio_device'
+
+      def devices = AudioDevice.devices
+
+      def drivers
+        ::SDL2.SDL_GetNumAudioDrivers.times.map do |num|
+          ptr = ::SDL2.SDL_GetAudioDriver(num)
+          raise RbSDL2Error if ptr.null?
+          ptr.read_string
+        end
+      end
+
+      def init(driver)
+        raise RbSDL2Error if ::SDL2.SDL_AudioInit(driver) < 0
+      end
+
+      require_relative 'audio/audio_buffer'
+
+      def load(...) = AudioBuffer.load(...)
+
+      require_relative 'audio/audio_allowed_changes'
+      require_relative 'audio/audio_format'
+      require_relative 'audio/audio_spec'
+
+      def new(device = nil, capture = false, allowed_changes: {}, channels: 2, format: {},
+              frequency: 48_000, samples: 0)
+        want = AudioSpec.new(channels: channels, format: AudioFormat.to_num(**format),
+                             frequency: frequency, samples: samples)
+        have = AudioSpec.new
+        id = ::SDL2.SDL_OpenAudioDevice(device&.to_s, IS_CAPTURE.(capture), want, have,
+                                        AudioAllowedChanges.to_num(**allowed_changes))
+        raise RbSDL2Error if id == 0
+        super(id, capture, have)
+      end
+      alias open new
+
+      def quit = ::SDL2.SDL_AudioQuit
+    end
+
+    def initialize(id, capture, spec)
+      @capture = CAPTURE.(capture)
+      @closed = false
+      @id = id
+      @spec = spec
+    end
+
+    def capture? = @capture
+
+    def clear
+      raise IOError if closed?
+      ::SDL2.SDL_ClearQueuedAudio(self)
+    end
+
+    def close
+      ::SDL2.SDL_CloseAudioDevice(id) unless @closed
+      @closed = true
+      nil
+    end
+
+    def closed? = @closed
+
+    attr_reader :id
+    alias to_int id
+
+    def pause
+      raise IOError if closed?
+      ::SDL2.SDL_PauseAudioDevice(id, 1)
+    end
+
+    def play
+      raise IOError if closed?
+      ::SDL2.SDL_PauseAudioDevice(id, 0)
+    end
+
+    def read(len)
+      raise IOError if closed?
+      ptr = ::FFI::MemoryPointer.new(len)
+      size = ::SDL2.SDL_DequeueAudio(id, ptr, len)
+      ptr.read_bytes(size)
+    end
+
+    def size
+      raise IOError if closed?
+      ::SDL2.SDL_GetQueuedAudioSize(id)
+    end
+    alias length size
+
+    attr_reader :spec
+
+    require 'forwardable'
+    extend Forwardable
+    def_delegators :spec, *%i(channels chunk_size format frequency samples)
+
+    require_relative 'audio/audio_format'
+    include AudioFormat
+
+    def status
+      raise IOError if closed?
+      ::SDL2.SDL_GetAudioDeviceStatus(id)
+    end
+
+    module AudioStatus
+      def paused? = ::SDL2::SDL_AUDIO_PAUSED == status
+
+      def playing? = ::SDL2::SDL_AUDIO_PLAYING == status
+
+      def stopped? = ::SDL2::SDL_AUDIO_STOPPED == status
+    end
+    include AudioStatus
+
+    def write(data)
+      raise IOError if closed?
+      err = ::SDL2.SDL_QueueAudio(id, data, data.size)
+      raise RbSDL2Error if err < 0
+      data.size
+    end
+  end
+end

data/lib/rb_sdl2/clipboard.rb

@@ -0,0 +1,44 @@
+module RbSDL2
+  module Clipboard
+    class << self
+      def clear = self.text = nil
+
+      # イベントを pump したとき外部からのクリップボード取得が行われる。
+      # その際に SDL_CLIPBOARDUPDATE イベントがキューに入る。これはイベントコールバックで捕獲できる。
+      # 読み出し時にクリップボードの内容はクリアーされない。
+      def text
+        # SDL_GetClipboardText は NULL ポインターを戻さない。返すべき内容がない場合は空の文字列を戻す。
+        ::SDL2.SDL_GetClipboardText.read_string.force_encoding(Encoding::UTF_8)
+      ensure
+        # SDL_GetClipboardText は呼び出されるたびに OS から取得したクリップボードの内容を SDL 内部に保存し、
+        # それをさらにコピーしたものを戻す。
+        # アプリケーション側は取得した文字列ポインタを必ず開放しなければならない。
+        ::SDL2.SDL_free(ptr)
+      end
+
+      # クリップボードの内容を戻す。text メソッドと違い読み出し後にクリップボードの内容をクリアーする。
+      def text!
+        str = text
+        clear
+        str
+      end
+
+      # クリップボードへ書き込む。クリップボードはパブリックであり他のアプリケーションから取得できる。
+      # 当然、SDL もこの書き込みを補足する。
+      # クリップボードの読み出しを行わずに、大量のクリップボード書き込みを行うと SDL はエラーを戻す。
+      # このエラーは SDL からではなく OS から戻るエラーである。書き込み上限や既に書き込んだ回数を知る方法はない。
+      # また、アプリケーション側でクリップボードを読み出しても制限を回避できない。
+      # （OS に保存されたクリップボードはパブリックなコピーでありユーザが取り出さなければそのコピーは消えないだろう）
+      def text=(obj)
+        raise RbSDL2Error if ::SDL2.SDL_SetClipboardText(obj&.to_s&.encode(Encoding::UTF_8)) < 0
+      end
+
+      # クリップボードに内容があるか確認をする。
+      # これはアプリケーションがクリップボードを読み出しても内容はクリアーされないため、
+      # クリップボードの更新を知るためには実装を工夫する必要がある。
+      # もっとも簡単な方法は、クリップボードの内容を読み込み度に Clipboard.text = nil を実行し、
+      # クリップボードをクリアする。
+      def text? = ::SDL2.SDL_HasClipboardText == ::SDL2::SDL_TRUE
+    end
+  end
+end

data/lib/rb_sdl2/cpu_info.rb

@@ -0,0 +1,39 @@
+module RbSDL2
+  module CPUInfo
+    class << self
+      def cpu_count = ::SDL2.SDL_GetCPUCount
+
+      def cpu_cache_line_size = ::SDL2.SDL_GetCPUCacheLineSize
+
+      def system_ram = ::SDL2.SDL_GetSystemRAM
+
+      def rdtsc? = ::SDL2.SDL_HasRDTSC == ::SDL2::SDL_TRUE
+
+      def altivec? = ::SDL2.SDL_HasAltiVec == ::SDL2::SDL_TRUE
+
+      def mmx? = ::SDL2.SDL_HasMMX == ::SDL2::SDL_TRUE
+
+      def _3dnow? = ::SDL2.SDL_Has3DNow == ::SDL2::SDL_TRUE
+
+      def sse? = ::SDL2.SDL_HasSSE == ::SDL2::SDL_TRUE
+
+      def sse2? = ::SDL2.SDL_HasSSE2 == ::SDL2::SDL_TRUE
+
+      def sse3? = ::SDL2.SDL_HasSSE3 == ::SDL2::SDL_TRUE
+
+      def sse41? = ::SDL2.SDL_HasSSE41 == ::SDL2::SDL_TRUE
+
+      def sse42? = ::SDL2.SDL_HasSSE42 == ::SDL2::SDL_TRUE
+
+      def avx? = ::SDL2.SDL_HasAVX == ::SDL2::SDL_TRUE
+
+      def avx2? = ::SDL2.SDL_HasAVX2 == ::SDL2::SDL_TRUE
+
+      def avx512f = ::SDL2.SDL_HasAVX512F == ::SDL2::SDL_TRUE
+
+      def armsimd? = ::SDL2.SDL_HasARMSIMD == ::SDL2::SDL_TRUE
+
+      def neon? = ::SDL2.SDL_HasNEON == ::SDL2::SDL_TRUE
+    end
+  end
+end

data/lib/rb_sdl2/cursor/color_cursor.rb

@@ -0,0 +1,19 @@
+module RbSDL2
+  module Cursor
+    require_relative 'cursor_class'
+
+    class ColorCursor < CursorClass
+      class << self
+        require_relative 'cursor_pointer'
+
+        def new(surface, hot_x = 0, hot_y = 0)
+          # SDL_CreateColorCursor は与えられた surface をコピーする。
+          # 呼び出し後に引数に与えた surface オブジェクトは安全に開放できる。
+          ptr = CursorPointer.new(::SDL2.SDL_CreateColorCursor(surface, hot_x, hot_y))
+          raise RbSDL2Error if ptr.null?
+          super(ptr)
+        end
+      end
+    end
+  end
+end

data/lib/rb_sdl2/cursor/cursor_class.rb

@@ -0,0 +1,24 @@
+module RbSDL2
+  module Cursor
+    class CursorClass
+      def initialize(ptr)
+        @ptr = ptr
+      end
+
+      def current! = Cursor.current = self
+
+      def current? = Cursor.current?(self)
+
+      def hide = Cursor.hide
+
+      def show
+        current!
+        Cursor.show
+      end
+
+      def shown? = Cursor.shown? && current?
+
+      def to_ptr = @ptr
+    end
+  end
+end

data/lib/rb_sdl2/cursor/cursor_pointer.rb

@@ -0,0 +1,12 @@
+module RbSDL2
+  module Cursor
+    class CursorPointer < ::FFI::AutoPointer
+      class << self
+        # カーソルポインターはいつでも開放してよい。
+        # SDL はカレントカーソルが開放されたときはデフォルトカーソルをカレントカーソルに設定する。
+        # デフォルトカーソルは SDL_FreeCursorを呼び出しても開放されない。
+        def release(ptr) = ::SDL2.SDL_FreeCursor(ptr)
+      end
+    end
+  end
+end

data/lib/rb_sdl2/cursor/default_cursor.rb

@@ -0,0 +1,18 @@
+module RbSDL2
+  module Cursor
+    require_relative 'cursor_class'
+
+    class DefaultCursor < CursorClass
+      class << self
+        def new
+          ptr = ::SDL2.SDL_GetDefaultCursor
+          raise RbSDL2Error if ptr.null?
+          super(ptr)
+        end
+      end
+
+      require 'singleton'
+      include Singleton
+    end
+  end
+end

data/lib/rb_sdl2/cursor/system_cursor.rb

@@ -0,0 +1,45 @@
+module RbSDL2
+  module Cursor
+    require_relative 'cursor_class'
+
+    class SystemCursor < CursorClass
+      require_relative 'cursor_pointer'
+
+      @cursors = Array.new(::SDL2::SDL_NUM_SYSTEM_CURSORS)
+
+      class << self
+        private def new(id)
+          return @cursors[id] if @cursors[id]
+
+          ptr = CursorPointer.new(::SDL2.SDL_CreateSystemCursor(id))
+          raise RbSDL2Error if ptr.null?
+          @cursors[id] = super(ptr)
+        end
+
+        def arrow_cursor = new(::SDL2::SDL_SYSTEM_CURSOR_ARROW)
+
+        def crosshair_cursor = new(::SDL2::SDL_SYSTEM_CURSOR_CROSSHAIR)
+
+        def hand_cursor = new(::SDL2::SDL_SYSTEM_CURSOR_HAND)
+
+        def i_beam_cursor = new(::SDL2::SDL_SYSTEM_CURSOR_IBEAM)
+
+        def no_cursor = new(::SDL2::SDL_SYSTEM_CURSOR_NO)
+
+        def size_all_cursor = new(SDL_SYSTEM_CURSOR_SIZEALL)
+
+        def size_ne_sw_cursor = new(::SDL2::SDL_SYSTEM_CURSOR_SIZENESW)
+
+        def size_ns_cursor = new(::SDL2::SDL_SYSTEM_CURSOR_SIZENS)
+
+        def size_nw_se_cursor = new(::SDL2::SDL_SYSTEM_CURSOR_SIZENWSE)
+
+        def size_we_cursor = new(::SDL2::SDL_SYSTEM_CURSOR_SIZEWE)
+
+        def wait_cursor = new(::SDL2::SDL_SYSTEM_CURSOR_WAIT)
+
+        def wait_arrow_cursor = new(::SDL2::SDL_SYSTEM_CURSOR_WAITARROW)
+      end
+    end
+  end
+end

data/lib/rb_sdl2/cursor.rb

@@ -0,0 +1,39 @@
+module RbSDL2
+  module Cursor
+    # カーソルポインターが外部から設定される場合があるため、現在のカーソルを取得する方法を提供しない。
+    class << self
+      require_relative 'cursor/color_cursor'
+      def color_cursor(...) = ColorCursor.new(...)
+
+      def current=(cursor)
+        ::SDL2.SDL_SetCursor(cursor)
+      end
+
+      def current?(cursor)
+        ::SDL2.SDL_GetCursor == cursor.to_ptr
+      end
+
+      require_relative 'cursor/default_cursor'
+      def default_cursor = DefaultCursor.instance
+
+      def hide = ::SDL2.SDL_ShowCursor(::SDL2::SDL_DISABLE)
+
+      def show = ::SDL2.SDL_ShowCursor(::SDL2::SDL_ENABLE)
+
+      def shown? = ::SDL2.SDL_ShowCursor(::SDL2::SDL_QUERY) == ::SDL2::SDL_ENABLE
+
+      def update
+        self.current = nil
+        self
+      end
+    end
+
+    require 'forwardable'
+    extend SingleForwardable
+    require_relative 'cursor/system_cursor'
+    def_single_delegators :SystemCursor,
+                          *%i(arrow_cursor crosshair_cursor hand_cursor i_beam_cursor no_cursor
+                          size_all_cursor size_ne_sw_cursor size_ns_cursor size_nw_se_cursor
+                          size_we_cursor wait_cursor wait_arrow_cursor)
+  end
+end