doomfire 0.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ecbc683e034fa23927451cf7792b1b234ad41d45681a1eb59d05759f44b65304
-  data.tar.gz: 7823ae5ad2eb86a5d090bd914193ae7c56c9b92b19b411457e6c3600884fd2fd
+  metadata.gz: 67bdf9fa995a19a70b46f2707adc899ee31780968ffb9f1d0fe4544f6f225313
+  data.tar.gz: 9d1234e1894955dd50614b9bbf85edcb0a2665980baac220fb23696568e27792
 SHA512:
-  metadata.gz: 41592477937ec6d1fc954646117f9044c76714701eaa5a6784d509b6d70a12386afd84a25cc64db3840c4fd11dac6db82ec40c8637b8f01c67760e45b8a57eed
-  data.tar.gz: 59087d4f46cb35fb1146a33f42cd43638d08c690a7cc2dd45456aa364c97d1fe5c8d77bdc3b0041a44b2ed3252b78452d98d7aa30f9c10553b9d5eeb794866ef
+  metadata.gz: e596f6b9b137e0343a106a2ee6d9371389ad88c0877ebbe7f72a919ecd60488c0012afb71ee63fa6b3dc226607d37ca32ffeafe139114e14e328f6df37a0fb66
+  data.tar.gz: f9e5d75205b31479ffffdb22014e2f965223dd58c9aa0fab17b5e7b5581b8ba2f5d2d932d3af3daa31b7892ad67563733e18ffc876276926403071f0273b253c

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.3.0
+
+- [ ] SDL output in progress.
+- [ ] Improve SDL performance
+- [ ] https://stackoverflow.com/questions/20753726/rendering-pixels-from-array-of-rgb-values-in-sdl-1-2/36504803#36504803
+
 # 0.2.0
 
 Terminal class now only works in the terminal and the new Spinner class should be used in the rake tasks. That should actually be a major version update to be honest but in 0.x versions I assume it's expected things can break.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    doomfire (0.2)
+    doomfire (0.3.0)
       paint
 
 GEM

data/exe/doomfire

@@ -4,5 +4,21 @@
 require 'rubygems'
 require 'bundler/setup'
 require 'doomfire'
+require 'optparse'
 
-Doomfire::Terminal.new.run
+options = {}
+OptionParser.new do |opts|
+  opts.banner = 'Usage: doomfire [options]'
+
+  options[:sdl] = false
+  opts.on('--sdl', 'Execute SDL version') do
+    options[:sdl] = true
+  end
+
+  opts.on('-h', '--help', 'Display this screen') do
+    puts opts
+    exit
+  end
+end.parse!
+
+options[:sdl] ? Doomfire::SDL.new.run : Doomfire::Terminal.new.run

data/lib/doomfire/base.rb

@@ -41,8 +41,6 @@ module Doomfire
       [255, 255, 255]
     ].freeze
 
-    FIRE_HEIGHT = 35
-
     attr_reader :exit_requested, :pixels, :fire_width
 
     def initialize
@@ -81,7 +79,7 @@ module Doomfire
     end
 
     def update_pixels
-      (1...FIRE_HEIGHT).to_a.reverse.each do |x|
+      (1...@fire_height).to_a.reverse.each do |x|
         (0...@fire_width).each do |y|
           spread_fire(x * @fire_width + y)
         end
@@ -90,13 +88,14 @@ module Doomfire
 
     def initialize_pixels
       @pixels = []
-      last_line = @fire_width * (FIRE_HEIGHT - 1)
+      last_line = @fire_width * (@fire_height - 1)
       @pixels.fill(0, 0...last_line)
       @pixels.fill(34, last_line..(last_line + @fire_width))
     end
 
     def prepare_output
       @fire_width = 80
+      @fire_height = 35
     end
 
     def fire_loop

data/lib/doomfire/ffi_sdl.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'fiddle'
+require 'fiddle/import'
+
+module Doomfire
+  # very minimal FFI bindings for libSDL2
+  module FFI_SDL
+    extend Fiddle::Importer
+
+    dlload 'libSDL2.dylib'
+
+    typealias 'Uint32', :int
+    typealias 'Uint16', :int
+    typealias 'Uint8', :int
+
+    SDL_INIT_VIDEO = 0x00000020
+    SDL_WINDOW_OPENGL = 0x00000000
+    SDL_WINDOWPOS_UNDEFINED = 0x1FFF0000 | 0
+    SDL_WINDOWPOS_CENTERED = 0x2FFF0000 | 0
+    SDL_QUIT = 0x100
+    SDL_KEYDOWN = 0x300
+    SDL_PIXELFORMAT_ARGB8888 = 372_645_892
+    SDL_TEXTUREACCESS_STATIC = 0
+    SDL_TEXTUREACCESS_STREAMING = 1
+
+    SDL_Event = union [
+      'Uint32 type'
+    ]
+
+    # basic SDL functions - creating windows, events etc
+    extern 'int SDL_Init(Uint32 flags)'
+    extern 'void* SDL_CreateWindow(const char *title, int x, int y, int w, int h, Uint32 flags)'
+    extern 'void* SDL_CreateRenderer(void* window, int index, Uint32 flags)'
+    extern 'int SDL_PollEvent(void* event)'
+    extern 'int SDL_RenderClear(void* renderer)'
+    extern 'void SDL_RenderPresent(void* renderer)'
+    extern 'void SDL_Quit(void)'
+
+    # software-accelerated rendering
+    extern 'int SDL_SetRenderDrawColor(void* renderer, Uint8 r, Uint8 g, Uint8 b, Uint8 a)'
+    extern 'int SDL_RenderDrawPoint(void* renderer, int x, int y)'
+
+    # textures are hardware accelerated
+    extern 'void* SDL_CreateTexture(void* renderer, Uint32 format, int access, int w, int h)'
+    extern 'int SDL_RenderCopy(void* renderer, void* texture, const void* srcrect, const void* dstrect)'
+    extern 'int SDL_UpdateTexture(void* texture, const void* rect, const void* pixels, int pitch)'
+  end
+end

data/lib/doomfire/sdl.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+require 'pry'
+
+module Doomfire
+  # Output to a separate SDL window
+  class SDL < Base
+    extend Doomfire::FFI_SDL
+
+    ARGB = [
+      0x00000000,
+      0x00070707,
+      0xFF1F0707,
+      0xFF2F0F07,
+      0xFF571707,
+      0xFF671F07,
+      0xFF771F07,
+      0xFF8F2707,
+      0xFF9F2F07,
+      0xFFAF3F07,
+      0xFFBF4707,
+      0xFFC74707,
+      0xFFDF4F07,
+      0xFFDF5707,
+      0xFFDF5707,
+      0xFFD7670F,
+      0xFFCF6F0F,
+      0xFFCF770F,
+      0xFFCF7F0F,
+      0xFFCF8717,
+      0xFFC78717,
+      0xFFC78F17,
+      0xFFC7971F,
+      0xFFBF9F1F,
+      0xFFBF9F1F,
+      0xFFBFA727,
+      0xFFBFA727,
+      0xFFBFAF2F,
+      0xFFB7AF2F,
+      0xFFB7B72F,
+      0xFFB7B737,
+      0xFFCFCF6F,
+      0xFFDFDF9F,
+      0xFFEFEFC7,
+      0xFFFFFFFF
+    ].freeze
+
+    def run
+      fire_loop
+    end
+
+    def stop
+      @exit_requested = true
+    end
+
+    private
+
+    def fire_loop
+      loop do
+        next if @event.nil? || @window.nil? || @renderer.nil? || @texture.nil?
+
+        FFI_SDL.SDL_PollEvent(@event)
+        @exit_requested = true if @event.type == FFI_SDL::SDL_QUIT
+
+        if @exit_requested
+          stop_fire if @counter.zero?
+          break if @counter == 60
+
+          @counter += 1
+        end
+
+        clear
+        update_pixels
+        print_pixels
+      end
+
+      clear_screen
+    end
+
+    def update_pixels
+      (0..@fire_width).each do |x|
+        (1...@fire_height).each do |y|
+          spread_fire(y * @fire_width + x)
+        end
+      end
+
+      @texdata = @pixels.map { |val| ARGB[val] }
+      @texptr = Fiddle::Pointer[@texdata.pack('L*')]
+    end
+
+    def prepare_output
+      @fire_width = 640
+      @fire_height = 480
+
+      FFI_SDL.SDL_Init(FFI_SDL::SDL_INIT_VIDEO)
+      @window = FFI_SDL.SDL_CreateWindow(
+        'Doomfire.rb',
+        FFI_SDL::SDL_WINDOWPOS_UNDEFINED,
+        FFI_SDL::SDL_WINDOWPOS_UNDEFINED,
+        @fire_width,
+        @fire_height,
+        FFI_SDL::SDL_WINDOW_OPENGL
+      )
+      @renderer = FFI_SDL.SDL_CreateRenderer(@window, -1, 0)
+      @texture = FFI_SDL.SDL_CreateTexture(
+        @renderer,
+        FFI_SDL::SDL_PIXELFORMAT_ARGB8888,
+        FFI_SDL::SDL_TEXTUREACCESS_STREAMING,
+        @fire_width,
+        @fire_height
+      )
+      @event = FFI_SDL::SDL_Event.malloc
+    end
+
+    def clear
+      FFI_SDL.SDL_RenderClear(@renderer)
+    end
+
+    def print_pixels
+      FFI_SDL.SDL_UpdateTexture(@texture, nil, @texptr, 4 * @fire_width)
+      FFI_SDL.SDL_RenderCopy(@renderer, @texture, 0, 0)
+      FFI_SDL.SDL_RenderPresent(@renderer)
+    end
+
+    def clear_screen
+      FFI_SDL.SDL_Quit()
+    end
+  end
+end

data/lib/doomfire/spinner.rb

@@ -16,6 +16,7 @@ module Doomfire
     private
 
     def prepare_output
+      @fire_height = 35
       @fire_width = Doomfire::WindowSize.new.terminal_width
       Paint.mode = 0xFFFFFF
       clear_screen

data/lib/doomfire/terminal.rb

@@ -19,7 +19,7 @@ module Doomfire
       loop do
         if @exit_requested
           stop_fire if @counter.zero?
-          break if @counter == FIRE_HEIGHT
+          break if @counter == @fire_height
 
           @counter += 1
         end
@@ -33,6 +33,7 @@ module Doomfire
     end
 
     def prepare_output
+      @fire_height = 35
       @fire_width = Doomfire::WindowSize.new.terminal_width
       Paint.mode = 0xFFFFFF
       Kernel.trap('INT') { @exit_requested = true }
@@ -45,7 +46,7 @@ module Doomfire
     end
 
     def print_pixels
-      (0...FIRE_HEIGHT).each do |x|
+      (0...@fire_height).each do |x|
         (0...@fire_width).each do |y|
           print Paint[' ', nil, RGB[@pixels[x * @fire_width + y]]]
         end

data/lib/doomfire/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Doomfire
-  VERSION = '0.2'
+  VERSION = '0.3.0'
 end

data/lib/doomfire.rb

@@ -3,5 +3,7 @@
 require 'doomfire/base'
 require 'doomfire/terminal'
 require 'doomfire/spinner'
+require 'doomfire/ffi_sdl'
+require 'doomfire/sdl'
 require 'doomfire/version'
 require 'doomfire/window_size'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: doomfire
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: 0.3.0
 platform: ruby
 authors:
 - Marcin Ruszkiewicz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-29 00:00:00.000000000 Z
+date: 2019-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: paint
@@ -99,11 +99,12 @@ files:
 - Rakefile
 - doomfire.gemspec
 - examples/long.rake
-- examples/sdl_test.rb
 - examples/terminal.png
 - exe/doomfire
 - lib/doomfire.rb
 - lib/doomfire/base.rb
+- lib/doomfire/ffi_sdl.rb
+- lib/doomfire/sdl.rb
 - lib/doomfire/spinner.rb
 - lib/doomfire/terminal.rb
 - lib/doomfire/version.rb

data/examples/sdl_test.rb

@@ -1,57 +0,0 @@
-require 'fiddle'
-require 'fiddle/import'
-require 'pry'
-
-module SDL
-  extend Fiddle::Importer
-
-  dlload 'libSDL2.dylib'
-
-  typealias 'Uint32', :int
-  typealias 'Uint16', :int
-  typealias 'Uint8', :int
-
-  SDL_INIT_VIDEO = 0x00000020
-  SDL_WINDOW_OPENGL = 0x00000000
-  SDL_WINDOWPOS_UNDEFINED = 0x1FFF0000 | 0
-  SDL_WINDOWPOS_CENTERED = 0x2FFF0000 | 0
-  SDL_QUIT = 0x100
-  SDL_KEYDOWN = 0x300
-  SDL_PIXELFORMAT_ARGB8888 = 0
-  SDL_TEXTUREACCESS_STATIC = 0
-
-  SDL_Event = union [
-    'Uint32 type'
-  ]
-
-  extern 'int SDL_Init(Uint32 flags)'
-  extern 'void* SDL_CreateWindow(const char *title, int x, int y, int w, int h, Uint32 flags)'
-  extern 'void* SDL_CreateRenderer(void* window, int index, Uint32 flags)'
-  extern 'void* SDL_CreateTexture(void* renderer, Uint32 format, int access, int w, int h)'
-  extern 'int SDL_WaitEvent(void* event)'
-  extern 'void SDL_Quit(void)'
-  extern 'void SDL_DestroyWindow(void* window)'
-  extern 'void SDL_DestroyRenderer(void* renderer)'
-  extern 'void SDL_DestroyTexture(void* texture)'
-end
-
-# https://dzone.com/articles/sdl2-pixel-drawing
-# http://wiki.libsdl.org/SDL_Init
-# https://github.com/davidsiaw/SDL2/blob/master/include/SDL_stdinc.h
-# http://ruby-doc.org/stdlib-2.6.3/libdoc/fiddle/rdoc/Fiddle.html#method-c-dlopen
-# https://www.honeybadger.io/blog/use-any-c-library-from-ruby-via-fiddle-the-ruby-standard-librarys-best-kept-secret/
-# https://bitbucket.org/dandago/gigilabs/src/master/Sdl2PixelDrawing/Sdl2PixelDrawing/main.cpp
-
-SDL.SDL_Init(SDL::SDL_INIT_VIDEO)
-window = SDL.SDL_CreateWindow("Doomfire.rb", SDL::SDL_WINDOWPOS_UNDEFINED, SDL::SDL_WINDOWPOS_UNDEFINED, 640, 480, SDL::SDL_WINDOW_OPENGL)
-renderer = SDL.SDL_CreateRenderer(window, -1, 0)
-texture = SDL.SDL_CreateTexture(renderer, SDL::SDL_PIXELFORMAT_ARGB8888, SDL::SDL_TEXTUREACCESS_STATIC, 640, 480)
-
-event = SDL::SDL_Event.malloc
-quit = false
-
-until quit
-  SDL.SDL_WaitEvent(event)
-
-  quit = true if event.type == SDL::SDL_QUIT
-end