retrograph_easy 0.1

data/lib/retrograph/easy/app.rb

@@ -0,0 +1,257 @@
+# retrograph/easy/app
+# 
+# Copyright (c) 2009  MenTaLguY <mental@rydia.net>
+# 
+# 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.
+#
+
+require 'sdl'
+require 'retrograph/easy/display'
+require 'retrograph/easy/periodic'
+require 'retrograph/easy/sprites'
+require 'retrograph/easy/controllers'
+
+module Retrograph
+module Easy
+
+class Quit < Exception
+  def initialize(message="User quit")
+    super(message)
+  end
+end
+
+class App
+  def initialize(display)
+    @_retrograph_held_event = nil
+    @_retrograph_display = display
+    @_retrograph_sprite_manager = SpriteManager.new(display)
+    @_retrograph_controller_manager = ControllerManager.new
+    @_retrograph_controllers =
+      @_retrograph_controller_manager.controllers.freeze
+    @_retrograph_periodic_manager = PeriodicManager.new
+  end
+
+  attr_reader :_retrograph_controllers
+  alias_method :controllers, :_retrograph_controllers
+  remove_method :_retrograph_controllers
+
+  def title(new_title)
+    @_retrograph_display.title = new_title
+    self
+  end
+
+  def start(label, interval, phases=1)
+    @_retrograph_periodic_manager.start label, interval, phases
+    nil
+  end
+
+  def stop(label)
+    @_retrograph_periodic_manager.stop label
+    nil
+  end
+
+  def frame_for?(label)
+    @_retrograph_periodic_manager.frame_for? label
+  end
+
+  def phase_of(label)
+    @_retrograph_periodic_manager.phase_of label
+  end
+
+  def already?(label)
+    @_retrograph_periodic_manager.already? label
+  end
+
+  def clear_sprites
+    @_retrograph_sprite_manager.clear_sprites
+    self
+  end
+
+  def sprite(x, y, pattern, flags)
+    @_retrograph_sprite_manager.add_sprite(x, y, pattern, flags)
+  end
+
+  def multi_sprite(x, y, pattern, width_tiles, height_tiles, flags)
+    @_retrograph_sprite_manager.add_multi_sprite(x, y, pattern, width_tiles, height_tiles, flags)
+  end
+
+  def sprite_group(x, y, width, height, flags)
+    @_retrograph_sprite_manager.add_sprite_group(x, y, width, height, flags) do
+      yield
+    end
+  end
+
+  def palette_entry_rgb(index, r, g, b)
+    r = (r * 255).round if Float === r
+    g = (g * 255).round if Float === g
+    b = (b * 255).round if Float === b
+    raise RangeError, "index out of range" if index < 0 or index > 31
+    entry = ((r >> 2) & 0x30) |
+            ((g >> 4) & 0x0c) |
+            ((b >> 6) & 0x03)
+    palette_entry(index, entry)
+    self
+  end
+
+  def palette_entry(index, entry)
+    @_retrograph_display.write_vdu_byte(0x7f00+index, entry)
+  end
+
+  def reset_vdu
+    write_vdu(0x0000, "\000" * 0x4000)
+    self
+  end
+
+  def vdu_mode(mode)
+    write_vdu_byte(0x7ff8, mode)
+    self
+  end
+
+  def write_vdu(offset, data)
+    @_retrograph_display.write_vdu(offset, data)
+    self
+  end
+
+  def write_vdu_byte(offset, byte)
+    @_retrograph_display.write_vdu_byte(offset, byte)
+    self
+  end
+
+  def tile_pattern_1bit(base, index, data)
+    @_retrograph_display.write_vdu(base + index * 8, data)
+    self
+  end
+
+  def tile_pattern_2bit(base, index, data)
+    @_retrograph_display.write_vdu(base + index * 16, data)
+    self
+  end
+
+  def tile_pattern_4bit(base, index, data)
+    @_retrograph_display.write_vdu(base + index * 32, data)
+    self
+  end
+
+  def sprite_pattern(base, index, data)
+    tile_pattern_4bit(base + 0x2000, index, data)
+    self
+  end
+
+  def wait_scanlines(count)
+    @_retrograph_display.wait_scanlines(count)
+    self
+  end
+
+  def quit
+    raise Quit
+  end
+
+  def _suspend
+    while event = SDL::Event2.wait
+      case event
+      when SDL::Event2::Quit
+        quit
+      when SDL::Event2::Active
+        if event.gain and event.state == 2
+          break
+        end
+      end
+    end
+    while event = SDL::Event2.wait
+      case event
+      when SDL::Event2::Quit
+        quit
+      when SDL::Event2::KeyDown
+        case event.sym
+        when SDL::Key::RALT, SDL::Key::LALT
+          # ignore alt presses
+        else
+          @_retrograph_held_event = event
+          break
+        end
+      end
+    end
+  end
+  private :_suspend
+
+  def each_of_n_frames(n_frames)
+    each_frame(n_frames) { yield }
+  end
+
+  def each_frame(n_frames=nil)
+    count = 0
+    @_retrograph_display.each_frame do
+      break if n_frames == count
+      while event = (@_retrograph_held_event || SDL::Event2.poll)
+        @_retrograph_held_event = nil
+        case event
+        when SDL::Event2::Quit
+          quit
+        when SDL::Event2::Active
+          if not event.gain and event.state == 2
+            _suspend
+            next
+          end
+        when SDL::Event2::KeyDown
+          @_retrograph_controller_manager.key_pressed(event.sym)
+          if (event.mod & SDL::Key::MOD_ALT).nonzero?
+            case event.sym
+            when SDL::Key::RETURN
+              @_retrograph_display.toggle_fullscreen
+            when SDL::Key::F4
+              quit
+            when SDL::Key::TAB
+              if @_retrograph_display.managed and @_retrograph_display.fullscreen
+                @_retrograph_display.minimize
+              end
+            end
+          end
+          case event.sym
+          when SDL::Key::ESCAPE
+            quit
+          when SDL::Key::F11
+            @_retrograph_display.toggle_fullscreen
+          end
+        when SDL::Event2::KeyUp
+          @_retrograph_controller_manager.key_released(event.sym)
+        end
+      end
+      yield
+      @_retrograph_periodic_manager.tick()
+      count += 1 if n_frames
+    end
+  end
+end
+
+@display = Display.new
+
+class << self
+  def app(&block)
+    begin
+      @display.open do
+        app = App.new(@display)
+        app.instance_eval &block
+      end
+    rescue Quit
+    end
+  end
+end
+
+end
+end

data/lib/retrograph/easy/constants.rb

@@ -0,0 +1,35 @@
+# retrograph/easy/constants
+# 
+# Copyright (c) 2009  MenTaLguY <mental@rydia.net>
+# 
+# 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.
+#
+
+module Retrograph
+module Easy
+
+TEXT_MODE_A = 0
+TEXT_MODE_B = 1
+GRAPHICS_MODE_A = 2
+GRAPHICS_MODE_B = 3
+ENABLE_SPRITES = 1 << 3
+ENABLE_BG = 1 << 2
+
+end
+end

data/lib/retrograph/easy/controllers.rb

@@ -0,0 +1,184 @@
+# retrograph/easy/controllers
+# 
+# Copyright (c) 2009  MenTaLguY <mental@rydia.net>
+# 
+# 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.
+#
+
+module Retrograph
+module Easy
+
+class Rocker
+  attr_reader :state
+
+  def initialize(minus_state, neutral_state, plus_state)
+    @minus_state = minus_state
+    @neutral_state = neutral_state
+    @plus_state = plus_state
+    @state = @neutral_state
+    @both_pressed = false
+  end
+
+  def plus_pressed
+    @both_pressed = true if @state != @neutral_state
+    @state = @plus_state
+    self
+  end
+
+  def minus_pressed
+    @both_pressed = true if @state != @neutral_state
+    @state = @minus_state
+    self
+  end
+
+  def plus_released
+    if @both_pressed
+      @both_pressed = false
+      @state = @minus_state
+    else
+      @state = @neutral_state
+    end
+    self
+  end
+
+  def minus_released
+    if @both_pressed
+      @both_pressed = false
+      @state = @plus_state
+    else
+      @state = @neutral_state
+    end
+    self
+  end
+end
+
+button_names = %w(up down left right a b select start)
+controller_fields = button_names.map { |n| "#{n}_pressed".intern } +
+                    [:horizontal, :vertical]
+
+Controller = Struct.new *controller_fields
+Controller.class_eval do
+  FIELD_DEFAULTS = button_names.map { false } + [0, 0]
+
+  def initialize
+    super(*FIELD_DEFAULTS)
+  end
+
+  for name in button_names
+    field = "#{name}_pressed".intern
+    alias_method "#{field}?".intern, field
+  end
+end
+
+class ControllerManager
+  KEYMAP = {
+    SDL::Key::UP => :up,
+    SDL::Key::DOWN => :down,
+    SDL::Key::LEFT => :left,
+    SDL::Key::RIGHT => :right,
+    SDL::Key::LCTRL => :a,
+    SDL::Key::RCTRL => :a,
+    SDL::Key::SPACE => :b,
+    SDL::Key::LSHIFT => :select,
+    SDL::Key::RSHIFT => :select,
+    SDL::Key::TAB => :select,
+    SDL::Key::RETURN => :start,
+    SDL::Key::W => :up,
+    SDL::Key::S => :down,
+    SDL::Key::D => :right,
+    SDL::Key::A => :left,
+    SDL::Key::Z => :select,
+    SDL::Key::X => :b,
+    SDL::Key::C => :a,
+    SDL::Key::COMMA => :a,
+    SDL::Key::PERIOD => :b,
+    SDL::Key::SLASH => :select
+  }
+
+  def initialize
+    @controllers = (0...2).map { Controller.new }
+    @horizontal = @controllers.map { Rocker.new(-1, 0, 1) }
+    @vertical = @controllers.map { Rocker.new(-1, 0, 1) }
+  end
+
+  def controllers
+    @controllers.dup
+  end
+
+  def key_pressed(key)
+    case KEYMAP[key]
+    when :up
+      @controllers[0].up_pressed = true
+      @vertical[0].minus_pressed
+      @controllers[0].vertical = @vertical[0].state
+    when :down
+      @controllers[0].down_pressed = true
+      @vertical[0].plus_pressed
+      @controllers[0].vertical = @vertical[0].state
+    when :left
+      @controllers[0].left_pressed = true
+      @horizontal[0].minus_pressed
+      @controllers[0].horizontal = @horizontal[0].state
+    when :right
+      @controllers[0].right_pressed = true
+      @horizontal[0].plus_pressed
+      @controllers[0].horizontal = @horizontal[0].state
+    when :a
+      @controllers[0].a_pressed = true
+    when :b
+      @controllers[0].b_pressed = true
+    when :select
+      @controllers[0].select_pressed = true
+    when :start
+      @controllers[0].start_pressed = true
+    end
+  end
+
+  def key_released(key)
+    case KEYMAP[key]
+    when :up
+      @controllers[0].up_pressed = false
+      @vertical[0].minus_pressed
+      @controllers[0].vertical = @vertical[0].state
+    when :down
+      @controllers[0].down_pressed = false
+      @vertical[0].plus_released
+      @controllers[0].vertical = @vertical[0].state
+    when :left
+      @controllers[0].left_pressed = false
+      @horizontal[0].minus_released
+      @controllers[0].horizontal = @horizontal[0].state
+    when :right
+      @controllers[0].right_pressed = false
+      @horizontal[0].plus_released
+      @controllers[0].horizontal = @horizontal[0].state
+    when :a
+      @controllers[0].a_pressed = false
+    when :b
+      @controllers[0].b_pressed = false
+    when :select
+      @controllers[0].select_pressed = false
+    when :start
+      @controllers[0].start_pressed = false
+    end
+  end
+end
+
+end
+end

data/lib/retrograph/easy/display.rb

@@ -0,0 +1,173 @@
+# retrograph/easy/display
+# 
+# Copyright (c) 2009  MenTaLguY <mental@rydia.net>
+# 
+# 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.
+#
+
+require 'retrograph/sdl'
+
+module Retrograph
+module Easy
+
+FRAMES_PER_SECOND = 25
+FRAME_TIME_MS = 1000/FRAMES_PER_SECOND
+
+class Display
+  BEZEL_THICKNESS = 16
+
+  def initialize(sdl=SDL, vdu_class=VDU)
+    @sdl = sdl
+    @vdu = nil
+    @vdu_class = vdu_class
+    @surface = nil
+    @managed = false
+    @fullscreen = false
+    @old_fullscreen = false
+    @screen = nil
+    @bezel_image = nil
+    @title = "Retrograph application"
+  end
+
+  attr_reader :title
+  attr_reader :fullscreen
+  attr_reader :managed
+
+  def title=(value)
+    @title = value.to_s
+    @sdl::WM.set_caption(@title, @title)
+    value
+  end
+
+  def fullscreen=(value)
+    @fullscreen = !!value
+    value
+  end
+
+  def toggle_fullscreen
+    @fullscreen = !@fullscreen
+    nil
+  end
+
+  def write_vdu(offset, data)
+    @vdu.write(offset, data)
+  end
+
+  def write_vdu_byte(offset, byte)
+    @vdu.write_byte(offset, byte)
+  end
+
+  def wait_scanlines(count)
+    @vdu.wait_scanlines(count)
+  end
+
+  def each_frame
+    while true
+      start_time = @sdl.get_ticks
+      @surface = @vdu.render_frame_sdl { yield }
+      _set_mode if @managed and @old_fullscreen != @fullscreen
+      @old_fullscreen = @fullscreen
+      _update_screen
+      end_time = @sdl.get_ticks
+      sleep_time = FRAME_TIME_MS - (end_time - start_time)
+      sleep(sleep_time / 1000.0) if sleep_time > 0
+    end
+  end
+
+  def open 
+    @sdl.init SDL::INIT_VIDEO
+    info = @sdl::Screen.info
+    @managed = info.wm_available
+    @vdu = @vdu_class.new
+    @surface = @vdu.render_frame_sdl
+    _set_mode
+    if block_given?
+      begin
+        yield
+      ensure
+        close
+      end
+    else
+      nil
+    end
+  end
+
+  def minimize
+    @sdl::WM.iconify
+    nil
+  end
+
+  def close
+    nil
+  end
+
+  def _bezel_func(d)
+    ((1.0-(d-0.5)*2))**2 + 0.07
+  end
+  private :_bezel_func
+
+  def _generate_bezel
+    bezel_color = @bezel_image.format.map_rgb(8, 8, 8)
+    clear_color = @bezel_image.format.map_rgb(255, 255, 255)
+    @bezel_image.fill_rect(0, 0, OUTPUT_WIDTH, OUTPUT_HEIGHT, clear_color)
+    for i in 0...BEZEL_THICKNESS
+      section = _bezel_func(i.to_f / (BEZEL_THICKNESS-1))
+      section = 1.0 if section > 1.0
+      hlength = (OUTPUT_WIDTH / 2 * section).to_i
+      vlength = (OUTPUT_HEIGHT / 2 * section).to_i
+      @bezel_image.fill_rect(0, i, hlength, 1, bezel_color)
+      @bezel_image.fill_rect(0, OUTPUT_HEIGHT - 1 - i, hlength, 1, bezel_color)
+      @bezel_image.fill_rect(OUTPUT_WIDTH - hlength, i, hlength, 1, bezel_color)
+      @bezel_image.fill_rect(OUTPUT_WIDTH - hlength, OUTPUT_HEIGHT - 1 - i, hlength, 1, bezel_color)
+      @bezel_image.fill_rect(i, 0, 1, vlength, bezel_color)
+      @bezel_image.fill_rect(OUTPUT_WIDTH - 1 - i, 0, 1, vlength, bezel_color)
+      @bezel_image.fill_rect(i, OUTPUT_HEIGHT - vlength, 1, vlength, bezel_color)
+      @bezel_image.fill_rect(OUTPUT_WIDTH - 1 - i, OUTPUT_HEIGHT - vlength, 1, vlength, bezel_color)
+    end
+    @bezel_image.set_color_key(SDL::SRCCOLORKEY | SDL::RLEACCEL, clear_color)
+  end
+  private :_generate_bezel
+
+  def _set_mode
+    flags = SDL::HWSURFACE | SDL::DOUBLEBUF
+    flags |= SDL::FULLSCREEN if fullscreen?
+    @screen = @sdl::Screen.open(OUTPUT_WIDTH, OUTPUT_HEIGHT, 32, flags)
+    @bezel_image = @sdl::Surface.new(0, OUTPUT_WIDTH, OUTPUT_HEIGHT,
+                                     @screen.format)
+    _generate_bezel
+    @sdl::WM.set_caption(@title, @title)
+    @sdl::Mouse.hide
+    _update_screen
+  end
+  private :_set_mode
+
+  def _update_screen
+    @sdl::Surface.blit(@surface, 0, 0, 0, 0, @screen, 0, 0)
+    @sdl::Surface.blit(@bezel_image, 0, 0, 0, 0, @screen, 0, 0)
+    @screen.flip
+  end
+  private :_update_screen
+
+  def fullscreen?
+    not @managed or @fullscreen
+  end
+end
+
+end
+end