frusdl 0.0.1

data/README

@@ -0,0 +1,51 @@
+###########################################
+# FRUSDL - Ffi RUby SDL bindings - README #
+###########################################
+ 
+ 
+What is it?
+===========
+Wafer-thin bindings to SDL, SDL_image, SDL_ttf, SDL_mixer, SDL_gfx, and 
+SGE for MRI, Jruby, Rubinius, ... using FFI. You will be able to easily port 
+your Ruby/SDL games to JRuby.  
+
+For now, only a  few high-level, Ruby/SDL compatible objects are available. 
+But the low level wrappers should work fine for experimenting, or even to program a 
+quick demo game. 
+
+Goal 
+=====
+
+Source code compatibility with Ruby/SDL 2.0.1 or higher, but with lower level 
+functions available. All help for towards this goal is welcome. 
+ 
+Version 
+=======
+
+  0.0.1
+
+Requirements
+============ 
+ * Ruby: MRI 1.9.1 or higher, JRuby 1.1.6 or higher. Rubinius currently untested.
+ * FFI: Version 0.2.0 or higher or MRI. 
+ * The shared libraries for SDL 1.2.x, SDL_image, SDL_ttf, SDL_mixer, SDL_gfx 
+   or SGE should be installed properly on your system.
+   
+Documentation
+=============
+   
+None yet. Check out the documentation of SDL itself, since the 
+low level interface to sdl in Frusdl::Low should be mostly compatible with 
+the C way of doing things, if you include Frusdl::Low. Alternatively, 
+use the source, Ruke. ^_^  
+
+License 
+=======
+
+ZLIB license. Please note that SDL has a LGPL license. However, FRUSDL
+uses dynamic linking, so , I think it should be fine.
+
+Contact
+=======
+
+beoran AT rubyforge POINT org

data/lib/frusdl.rb

@@ -0,0 +1,145 @@
+# 
+# Frusdl : Wafer-thin bindings to SDL, SDL_image, SDL_ttf, SDL_mixer, SDL_gfx,
+#          and SGE for MRI, Jruby, Rubinius, ... using FFI
+#
+# Goal: source code compatibility with Ruby/SDL 2.0.1, 
+#       but with lower level functions available.
+# 
+# Version: 0.0.1
+#
+# Requirements:
+# * Ruby ( MRI or JRUBY 1.1.6 or higher)
+# * FFI  ( version 0.2.0 or higher or MRI) 
+# * The shared libraries for SDL 1.2.x, SDL_image, SDL_ttf, SDL_mixer, SDL_gfx 
+#   or SGE should be installed properly on your system.
+#
+# Licence: ZLIB license. 
+#       
+# Frusdl
+# 
+# Copyright (c) 2008, Bjorn De Meyer
+#
+# 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.
+
+
+
+begin
+  require 'rubygems' 
+rescue 
+  # try to load Rubygems, but don't care if it fails. 
+end
+
+require 'ffi'
+# We need FFI
+
+
+module Frusdl
+  # Low level FFI functions and structures
+  autoload :Low     , 'frusdl/low'
+  # Meta programming helper that makes writing wrappers easier.
+  autoload :Wrap    , 'frusdl/wrap'
+  # High level SDL wrapper, compatible with Ruby/SDL, unimplemented for now.
+  autoload :SDL     , 'frusdl/sdl'
+end 
+
+
+# Source code compatibility with Ruby/SDL
+unless defined? SDL
+#  SDL = Frusdl
+end
+
+
+
+
+
+
+if $0 == __FILE__
+  
+  def peek_at_proc
+      puts `ps u -p #{Process.pid}`
+  end
+
+  
+
+  include Frusdl::Low
+  
+  puts SDL.SDL_getenv('HOME')
+  
+  
+  fontname = '/usr/share/fonts/liberation/LiberationSerif-Regular.ttf'
+  Frusdl::SDL.init(Frusdl::SDL::INIT_EVERYTHING)
+  p Frusdl::SDL::Screen.driver_name
+  p Frusdl::SDL::Screen.list_modes(nil, SDL::SDL_FULLSCREEN)
+  info = Frusdl::SDL::Screen.info
+  p info.video_mem
+  p info.current_w
+  p info.current_h
+  p info.pixel_format.alpha
+  # at_exit { SDL.SDL_Quit() }
+  TTF.TTF_Init()
+  at_exit { TTF.TTF_Quit() }
+  fontp     = TTF.TTF_OpenFont(fontname, 20)
+  screen2   = Frusdl::SDL::Screen.open(640, 480, 32, SDL::SDL_HWSURFACE | SDL::SDL_DOUBLEBUF )
+  p screen2.w
+  p screen2.h
+  screenp   = screen2.pointer   
+  # screenp   = SDL.SDL_SetVideoMode(640, 480, 32, SDL::SDL_HWSURFACE | SDL::SDL_DOUBLEBUF )
+  # surf = SDL.SDL_CreateRGBSurface(0, 32, 32, 32, 0x000000FF,  0x0000FF00,  0x00FF0000,  0xFF000000)
+  
+  njoy      =  SDL.SDL_NumJoysticks()
+  puts "You have a joystick: " if njoy == 1
+  puts "You have #{njoy} joysticks: " if njoy > 1
+  puts "No joysticks found!" if njoy < 1
+  for i in (0...njoy) do
+    puts SDL.SDL_JoystickName(i)
+  end 
+  
+  peek_at_proc
+
+  screen        = SDL::SDL_Surface.new(screenp)
+  rect          = SDL::SDL_Rect.new
+  screen_format = SDL::SDL_PixelFormat.new(screen[:format])
+  white         = SDL::SDL_MapRGB(screen_format, 255,255,255)
+  blue          = SDL::SDL_MapRGB(screen_format, 0, 0, 128)
+  p screen_format[:bitsperpixel]  
+  rect[:w]      = 640
+  rect[:h]      = 20  
+  mesg          = "SDL and Ruby are sitting on a tree... K I S S I N G!"
+  textp         = TTF.TTF_RenderUTF8_Blended(fontp, mesg, white)
+  event         = SDL::SDL_Event.new
+  
+  loop do
+    polled = SDL.SDL_PollEvent(event.pointer)
+      if polled > 0 
+        break if event[:type] == SDL::SDL_QUIT
+      end   
+    SDL.SDL_FillRect(screen.pointer, rect.pointer, blue)
+    # SGE.sge_FilledEllipse(screenp, 300, 100, 10, 20, blue) 
+    SDL.SDL_UpperBlit(textp, nil, screen, rect)       
+    screen2.flip
+    # And flip the screen
+  end
+
+  SDL.SDL_FreeSurface(textp)
+  # Free the rendered text surface.
+  GC.start # force collection
+  puts "End" 
+  peek_at_proc
+end
+

data/lib/frusdl/low.rb

@@ -0,0 +1,30 @@
+# Copyright (c) 2008, Bjorn De Meyer
+#
+# 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.
+
+module Frusdl
+  module Low
+    autoload :IMG, 'frusdl/low/img'
+    autoload :GFX, 'frusdl/low/gfx'
+    autoload :MIX, 'frusdl/low/mix'
+    autoload :SDL, 'frusdl/low/sdl'
+    autoload :SGE, 'frusdl/low/sge'
+    autoload :TTF, 'frusdl/low/ttf'
+  end
+end

data/lib/frusdl/low/gfx.rb

@@ -0,0 +1,95 @@
+# Copyright (c) 2008, Bjorn De Meyer
+#
+# 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.
+
+module Frusdl
+  module Low
+    # Alternative graphics primitives library 
+    module GFX
+      extend FFI::Library
+      ffi_lib('SDL_gfx')  
+    
+      attach_function :pixelColor   , [:pointer, :short, :short, :ulong], :int
+      attach_function :pixelRGBA    , [:pointer, :short, :short, :uchar, :uchar, :uchar, :uchar], :int
+      attach_function :hlineColor   , [:pointer, :short, :short, :short, :ulong], :int
+      attach_function :hlineRGBA    , [:pointer, :short, :short, :short, :uchar, :uchar, :uchar, :uchar], :int
+      attach_function :vlineColor   , [:pointer, :short, :short, :short, :ulong], :int
+      attach_function :vlineRGBA    , [:pointer, :short, :short, :short, :uchar, :uchar, :uchar, :uchar], :int
+      attach_function :rectangleColor, [:pointer, :short, :short, :short, :short, :ulong], :int
+      attach_function :rectangleRGBA , [:pointer, :short, :short, :short, :short, :uchar, :uchar, :uchar, :uchar], :int
+      attach_function :boxColor     , [:pointer, :short, :short, :short, :short, :ulong], :int
+      attach_function :boxRGBA      , [:pointer, :short, :short, :short, :short, :uchar, :uchar, :uchar, :uchar], :int
+      attach_function :lineColor    , [:pointer, :short, :short, :short, :short, :ulong], :int
+      attach_function :lineRGBA     , [:pointer, :short, :short, :short, :short, :uchar, :uchar, :uchar, :uchar], :int
+      attach_function :aalineColor  , [:pointer, :short, :short, :short, :short, :ulong], :int
+      attach_function :aalineRGBA   , [:pointer, :short, :short, :short, :short, :uchar, :uchar, :uchar, :uchar], :int  
+      attach_function :circleColor  , [:pointer, :short, :short, :short, :ulong], :int
+      attach_function :circleRGBA   , [:pointer, :short, :short, :short, :uchar, :uchar, :uchar, :uchar], :int
+      attach_function :aacircleColor, [:pointer, :short, :short, :short, :ulong], :int
+      attach_function :aacircleRGBA , [:pointer, :short, :short, :short, :uchar, :uchar, :uchar, :uchar], :int
+      attach_function :filledCircleColor,  [:pointer, :short, :short, :short, :ulong], :int
+      attach_function :filledCircleRGBA , [:pointer, :short, :short, :short, :uchar, :uchar, :uchar, :uchar], :int
+      attach_function :ellipseColor     , [:pointer, :short, :short, :short, :short, :ulong], :int
+      attach_function :ellipseRGBA      , [:pointer, :short, :short, :short, :short, :uchar, :uchar, :uchar, :uchar], :int
+      attach_function :aaellipseColor   , [:pointer, :short, :short, :short, :short, :ulong], :int
+      attach_function :aaellipseRGBA    , [:pointer, :short, :short, :short, :short, :uchar, :uchar, :uchar, :uchar], :int
+    
+      attach_function :pieColor   , [:pointer, :short, :short, :short, :short, :short, :ulong], :int
+      attach_function :pieRGBA    , [:pointer, :short, :short, :short, :short, :short, :uchar, :uchar, :uchar, :uchar], :int
+      attach_function :filledPieColor, [:pointer, :short, :short, :short, :short, :short, :ulong], :int
+      attach_function :filledPieRGBA , [:pointer, :short, :short, :short, :short, :short, :uchar, :uchar, :uchar, :uchar], :int
+      attach_function :trigonColor   , [:pointer, :short, :short, :short, :short, :short, :short, :ulong], :int
+      attach_function :trigonRGBA    , [:pointer, :short, :short, :short, :short, :short, :short, :uchar, :uchar, :uchar, :uchar], :int
+      attach_function :aatrigonColor , [:pointer, :short, :short, :short, :short, :short, :short, :ulong], :int
+      attach_function :aatrigonRGBA  , [:pointer, :short, :short, :short, :short, :short, :short, :uchar, :uchar, :uchar, :uchar], :int
+      attach_function :filledTrigonColor, [:pointer, :short, :short, :short, :short, :short, :short, :ulong], :int
+      attach_function :filledTrigonRGBA , [:pointer, :short, :short, :short, :short, :short, :short, :uchar, :uchar, :uchar, :uchar], :int
+      attach_function :polygonColor, [:pointer, :pointer, :pointer, :int, :ulong], :int
+      attach_function :polygonRGBA , [:pointer, :pointer, :pointer, :int, :uchar, :uchar, :uchar, :uchar], :int
+      attach_function :aapolygonColor, [:pointer, :pointer, :pointer, :int, :ulong], :int
+      attach_function :aapolygonRGBA , [:pointer, :pointer, :pointer, :int, :uchar, :uchar, :uchar, :uchar], :int
+      attach_function :filledPolygonColor, [:pointer, :pointer, :pointer, :int, :ulong], :int
+      attach_function :filledPolygonRGBA , [:pointer, :pointer, :pointer, :int, :uchar, :uchar, :uchar, :uchar], :int
+      attach_function :texturedPolygon, [:pointer, :pointer, :pointer, :int, :pointer, :int, :int], :int
+      attach_function :bezierColor, [:pointer, :pointer, :pointer, :int, :int, :ulong], :int
+      attach_function :bezierRGBA , [:pointer, :pointer, :pointer, :int, :int, :uchar, :uchar, :uchar, :uchar], :int
+    
+      SMOOTHING_OFF = 0
+      SMOOTHING_ON  = 1
+    
+      # Rotates and zoomes a 32bit or 8bit 'src' surface to newly created 'dst' surface.
+      attach_function :rotozoomSurface  , [:pointer, :double, :double, :int], :pointer
+      attach_function :rotozoomSurfaceXY, [:pointer, :double, :double, :double, :int], :pointer
+      # Returns the size of the target surface for a rotozoomSurface() call
+      attach_function :rotozoomSurfaceSize, [:int, :int, :double, :double, :pointer, :pointer], :void
+      attach_function :rotozoomSurfaceSizeXY, [:int, :int, :double, :double, :double, :pointer, :pointer], :void
+      # Zoomes a 32bit or 8bit 'src' surface to newly created 'dst' surface.
+      attach_function :zoomSurface, [:pointer, :double, :double, :int], :pointer
+      # Returns the size of the target surface for a zoomSurface() call
+      attach_function :zoomSurfaceSize, [:int, :int, :double, :double, :pointer, :pointer], :void
+      # Shrinks a 32bit or 8bit 'src' surface to a newly created 'dst' surface.
+      attach_function :shrinkSurface, [:pointer, :int, :int], :pointer 
+    
+    
+    end
+
+
+
+  end
+end    

data/lib/frusdl/low/img.rb

@@ -0,0 +1,10 @@
+module Frusdl
+  module Low
+    module IMG
+      extend FFI::Library
+      ffi_lib('SDL_image')
+      attach_function :IMG_Load, [:string], :pointer
+      attach_function :IMG_Load_RW, [:pointer, :int], :pointer
+    end
+  end
+end    

data/lib/frusdl/low/mix.rb

@@ -0,0 +1,138 @@
+# Copyright (c) 2008, Bjorn De Meyer
+#
+# 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.
+
+module Frusdl
+  module Low
+    module MIX
+      extend FFI::Library
+      ffi_lib('SDL_mixer')
+      class Mix_Chunk < FFI::Struct
+        layout :allocated => :int,
+              :abuf      => :pointer,
+              :alen      => :ulong, 
+              :volume    => :uchar
+      end
+    
+      MIX_NO_FADING   = 0
+      MIX_FADING_OUT  = 1
+      MIX_FADING_IN   = 2
+    
+      MUS_NONE        = 0
+      MUS_CMD         = 1
+      MUS_WAV         = 2
+      MUS_MOD         = 3
+      MUS_MID         = 4
+      MUS_OGG         = 5
+      MUS_MP3         = 6
+    
+      class Mix_Music < FFI::Struct
+        layout :fake => :pointer
+      end
+    
+      attach_function :Mix_OpenAudio, [:int, :ushort, :int, :int], :int
+      attach_function :Mix_AllocateChannels, [:int], :int
+      attach_function :Mix_QuerySpec, [:pointer, :pointer, :pointer], :int
+      # Load a wave file or a music (.mod .s3m .it .xm) file 
+      attach_function :Mix_LoadWAV_RW, [:pointer, :int], :pointer
+      def self.Mix_LoadWAV(filename) 
+        Mix_LoadWAV_RW(SDL_RWFromFile(filename, "rb"), 1)
+      end
+      
+      attach_function :Mix_LoadMUS, [:string], :pointer
+      attach_function :Mix_LoadMUS_RW, [:pointer], :pointer
+      # Free an audio chunk previously loaded 
+      attach_function :Mix_FreeChunk, [:pointer], :void
+      attach_function :Mix_FreeMusic, [:pointer], :void
+      attach_function :Mix_GetMusicType, [:pointer], :int
+      # skipped Mix_SetPostMix
+      # skipped extern Mix_HookMusic
+      # skiped  Mix_HookMusicFinished
+      # skipped Mix_GetMusicHookData(void);
+      # skipped Mix_ChannelFinished
+      MIX_CHANNEL_POST = -2
+      # skipped Mix_RegisterEffect
+      # skipped Mix_UnregisterEffect
+      # skipped Mix_UnregisterAllEffects 
+      # define MIX_EFFECTSMAXSPEED  "MIX_EFFECTSMAXSPEED"
+      attach_function :Mix_SetPanning, [:int, :uchar, :uchar], :int
+      attach_function :Mix_SetPosition, [:int, :short, :uchar], :int
+      attach_function :Mix_SetDistance, [:int, :uchar], :int
+      attach_function :Mix_SetReverseStereo, [:int, :int], :int  
+      attach_function :Mix_ReserveChannels, [:int], :int
+      attach_function :Mix_GroupChannel  , [:int, :int], :int
+      attach_function :Mix_GroupChannels , [:int, :int, :int], :int
+      attach_function :Mix_GroupAvailable, [:int], :int
+      attach_function :Mix_GroupCount    , [:int], :int
+      attach_function :Mix_GroupOldest   , [:int], :int
+      attach_function :Mix_GroupNewer    , [:int], :int
+    
+      def self.Mix_PlayChannel(channel,chunk,loops) 
+        Mix_PlayChannelTimed(channel,chunk,loops,-1)
+      end
+    
+      attach_function :Mix_PlayChannelTimed   , [:int, :pointer, :int, :int], :int 
+      attach_function :Mix_PlayMusic          , [:pointer, :int], :int
+      # Fade in music or a channel over "ms" milliseconds
+      attach_function :Mix_FadeInMusic        , [:pointer, :int, :int], :int
+      attach_function :Mix_FadeInMusicPos     , [:pointer, :int, :int, :double]   , :int
+      attach_function :Mix_FadeInChannelTimed , [:int, :pointer, :int, :int, :int], :int
+      
+      def self.Mix_FadeInChannel(channel, chunk, loops, ms)
+        Mix_FadeInChannelTimed(channel,chunk,loops,ms,-1)
+      end
+      # Set volume
+      attach_function :Mix_Volume         , [:int    , :int], :int 
+      attach_function :Mix_VolumeChunk    , [:pointer, :int , :int], :int
+      attach_function :Mix_VolumeMusic    , [:int], :int
+      # Halt playing of a particular channel 
+      attach_function :Mix_HaltChannel    , [:int], :int
+      attach_function :Mix_HaltGroup      , [:int], :int
+      attach_function :Mix_HaltMusic      , [], :int
+      # Change the expiration delay for a particular channel.
+      attach_function :Mix_ExpireChannel  , [:int, :int], :int
+      # Halt a channel, fading it out progressively till it's silent
+      attach_function :Mix_FadeOutChannel , [:int, :int], :int
+      attach_function :Mix_FadeOutGroup   , [:int, :int], :int  
+      attach_function :Mix_FadeOutMusic   , [:int], :int
+      # Query the fading status of a channel
+      attach_function :Mix_FadingMusic    , []    , :int
+      attach_function :Mix_FadingChannel  , [:int], :int
+      # Pause/Resume a particular channel or music. 
+      attach_function :Mix_Pause          , [:int], :void
+      attach_function :Mix_Resume         , [:int], :void
+      attach_function :Mix_Paused         , [:int], :void
+      attach_function :Mix_PauseMusic     , [], :void
+      attach_function :Mix_ResumeMusic    , [], :void
+      attach_function :Mix_RewindMusic    , [], :void
+      attach_function :Mix_PausedMusic    , [], :int
+      attach_function :Mix_SetMusicPosition , [:double], :int
+      # Check the status of a specific channel.
+      attach_function :Mix_Playing          , [:int], :int 
+      attach_function :Mix_PlayingMusic     , [], :int
+      # Stop music and set external music playback command
+      attach_function :Mix_SetMusicCMD      , [:string], :int
+      # Skipping MIKMOD synchro values.
+      # Get the Mix_Chunk currently associated with a mixer channel
+      attach_function :Mix_GetChunk         , [:int], :pointer
+      # Close the mixer, halting all playing audio 
+      attach_function :Mix_CloseAudio       , [:void], :void 
+    end
+  end
+end