tung-tea 0.3.1 → 0.4.0

data/README.rdoc

@@ -69,11 +69,11 @@ What's working:
 
 * Events/Input - done
 * Graphics - done
+* Sound - done
 
 What isn't done yet:
 
 * Fonts - support bitmap and TrueType fonts in ASCII
-* Sound - support loading and playing sound files
 
 
 == More information

data/doc/example/sound.rb

@@ -0,0 +1,101 @@
+# A demo that attempts to test all of Tea::Sound's functionality.
+
+require 'tea'
+
+puts <<TEST
+This is a simple sound demo.  Up to 2 sounds can play simultaneously.
+
+Keys:
+
+  [     - Switch to tone 1 (default)
+  ]     - Switch to tone 2
+
+  Right - Play tone
+  Left  - Stop
+  Down  - Pause
+  Up    - Resume (unpause)
+
+  Enter - Print tone's status (stopped/playing/paused)
+
+  p     - Pause all
+  r     - Resume (unpause) all
+  s     - Stop all
+
+  =     - Tone volume +1/8
+  -     - Tone volume -1/8
+  +     - Master volume +1/8
+  _     - Master volume -1/8
+
+  Esc   - Exit demo
+--
+TEST
+
+Tea.init
+Tea::Screen.set_mode 100, 100
+
+tone_sound = Tea::Sound.new('tone.wav')
+tones = [tone_sound, tone_sound.clone]
+
+which_tone = 0
+
+done = false
+until done
+  e = Tea::Event.get(true)
+  case e
+  when Tea::Kbd::Down
+    case e.key
+
+    when Tea::Kbd::OPEN_SQUARE_BRACKET
+      which_tone -= 1 if which_tone > 0
+      puts "Switched to tone ##{which_tone + 1}"
+    when Tea::Kbd::CLOSE_SQUARE_BRACKET
+      which_tone += 1 if which_tone < tones.length - 1
+      puts "Switched to tone ##{which_tone + 1}"
+
+    when Tea::Kbd::RIGHT
+      tones[which_tone].play
+      puts "Playing tone ##{which_tone + 1}"
+    when Tea::Kbd::LEFT
+      tones[which_tone].stop
+      puts "Stopping tone ##{which_tone + 1}"
+    when Tea::Kbd::DOWN
+      tones[which_tone].pause
+      puts "Pausing tone ##{which_tone + 1}"
+    when Tea::Kbd::UP
+      tones[which_tone].resume
+      puts "Resuming tone ##{which_tone + 1}"
+
+    when Tea::Kbd::ENTER
+      puts "Tone ##{which_tone + 1} is #{tones[which_tone].state.to_s}"
+
+    when Tea::Kbd::P
+      Tea::Sound.pause_all
+      puts "Pausing all sounds"
+    when Tea::Kbd::R
+      Tea::Sound.resume_all
+      puts "Resuming all sounds"
+    when Tea::Kbd::S
+      Tea::Sound.stop_all
+      puts "Stopping all sounds"
+
+    when Tea::Kbd::EQUALS
+      tones[which_tone].volume += 16
+      puts "Volume of tone ##{which_tone + 1} raised to #{tones[which_tone].volume} / 128"
+    when Tea::Kbd::MINUS
+      tones[which_tone].volume -= 16
+      puts "Volume of tone ##{which_tone + 1} lowered to #{tones[which_tone].volume} / 128"
+    when Tea::Kbd::PLUS
+      Tea::Sound.volume += 16
+      puts "Master volume raised to #{Tea::Sound.volume} / 128"
+    when Tea::Kbd::UNDERSCORE
+      Tea::Sound.volume -= 16
+      puts "Master volume lowered to #{Tea::Sound.volume} / 128"
+
+    when Tea::Kbd::ESCAPE
+      done = true
+
+    end
+  when Tea::App::Exit
+    done = true
+  end
+end

data/doc/reference.textile

@@ -286,7 +286,63 @@ Returns true when the right mouse button is held down.
 
 h1. Sound
 
-Nothing yet.
+h2. Tea::Sound
+
+A Sound represents a loaded audio file that can be played through the computer's speakers.
+
+For now, the supported formats are: OGG, WAV, AIFF, RIFF, VOC.
+
+h3. Tea::Sound.volume()
+
+Get the master volume.  Returns a value between 0 (min) and 128 (max) inclusive.
+
+h3. Tea::Sound.volume=(new_volume)
+
+Set the master volume.  new_volume should be between 0 (min) and 128 (max) inclusive.
+
+h3. Tea::Sound.pause_all()
+
+Pause all playing sounds.
+
+h3. Tea::Sound.resume_all()
+
+Resume all paused sounds.
+
+h3. Tea::Sound.stop_all()
+
+Stop all playing and paused sounds.
+
+h3. Tea::Sound.new(path)
+
+Load a new sound from an audio file.
+
+h3. Tea::Sound#volume()
+
+Get the volume of the sound.  Returns a value between 0 (min) and 128 (max) inclusive.
+
+h3. Tea::Sound#volume=(new_volume)
+
+Set the volume of the sound.  new_volume should be between 0 (min) and 128 (max) inclusive.
+
+h3. Tea::Sound#play(loops=0)
+
+Play the sound.  If it's already playing, cut it off and start over.  loops should be the number of times to repeat the sound; use -1 to repeat it forever.
+
+h3. Tea::Sound#pause()
+
+Pause the sound if it's playing, otherwise do nothing.
+
+h3. Tea::Sound#resume()
+
+Resume playing the sound if it was paused, otherwise do nothing.
+
+h3. Tea::Sound#stop()
+
+Stop the sound if it's playing, otherwise do nothing.
+
+h3. Tea::Sound#state()
+
+Check if the sound is stopped, playing or paused.  Returns one of Tea::Sound::STOPPED, Tea::Sound::PLAYING or Tea::Sound::PAUSED.
 
 
 h1. Fonts

data/lib/tea/c_bitmap.rb

@@ -41,6 +41,13 @@ module Tea
       @buffer.h
     end
 
+    # Convert the Bitmap's internal format to that of the screen to speed up
+    # drawing.  Intended for internal use, but calling it manually won't bring
+    # any harm.
+    def optimize_for_screen
+      @buffer = @buffer.display_format_alpha
+    end
+
     include Blitting
     def blitting_buffer
       @buffer
@@ -78,7 +85,7 @@ module Tea
       if Tea::Screen.mode_set?
         @buffer = @buffer.display_format_alpha
       else
-        Tea::Screen.on_set_mode lambda { @buffer = @buffer.display_format_alpha }
+        Tea::Screen.register_bitmap_for_optimizing self
       end
     rescue SDL::Error => e
       raise Tea::Error, e.message, e.backtrace
@@ -106,7 +113,7 @@ module Tea
       if Tea::Screen.mode_set?
         @buffer = @buffer.display_format_alpha
       else
-        Tea::Screen.on_set_mode lambda { @buffer = @buffer.display_format_alpha }
+        Tea::Screen.register_bitmap_for_optimizing self
       end
     rescue SDL::Error => e
       raise Tea::Error, e.message, e.backtrace

data/lib/tea/c_sound.rb

@@ -0,0 +1,145 @@
+# This file contains the Sound class.
+
+require 'sdl'
+
+require 'tea/c_error'
+
+#
+module Tea
+
+  # The Sound class allows loading and playing of audio files.
+  #
+  # Currently supported formats: OGG, WAV, AIFF, RIFF, VOC.
+  class Sound
+
+    # Sound states returned by Tea::Sound#state.
+    STOPPED = :STOPPED
+    PLAYING = :PLAYING
+    PAUSED = :PAUSED
+
+    # As per Ruby/SDL's mixer API.
+    VOLUME_MAX = 128
+
+    # Tracked because Ruby/SDL's mixer API can't get the channel volumes.
+    @@volume = VOLUME_MAX
+
+    # Tracks which Sound objects are playing in which channels, to report
+    # accurate playing state info.
+    @@channel_sound_ids = []
+
+    # Get the master volume.  Volume ranges from 0..128 inclusive.
+    def Sound.volume
+      @@volume
+    end
+
+    # Set the master volume.  new_volume should be between 0..128 inclusive.
+    def Sound.volume=(new_volume)
+      v = (new_volume >= 0) ? (new_volume <= VOLUME_MAX ? new_volume : VOLUME_MAX) : 0
+      SDL::Mixer.set_volume -1, new_volume
+      @@volume = v
+    end
+
+    # Pause all sound.
+    def Sound.pause_all
+      SDL::Mixer.pause -1
+    end
+
+    # Resume playing all paused sound.
+    def Sound.resume_all
+      SDL::Mixer.resume -1
+    end
+
+    # Stop all sounds, playing or paused.
+    def Sound.stop_all
+      SDL::Mixer.halt -1
+    end
+
+
+    # Load a sound file.
+    #
+    # May raise Tea::Error on failure.
+    def initialize(path)
+      @wave = SDL::Mixer::Wave.load(path)
+      @channel = -1
+
+      # Tracked because Ruby/SDL's mixer API can't get sound volumes.
+      @volume = VOLUME_MAX
+    rescue SDL::Error => e
+      raise Tea::Error, e.message, e.backtrace
+    end
+
+    # Get the sound's volume.  Volume ranges from 0..128 inclusive.
+    def volume
+      @volume
+    end
+
+    # Set the sound's volume.  new_volume should be between 0..128 inclusive.
+    def volume=(new_volume)
+      v = (new_volume >= 0) ? (new_volume <= VOLUME_MAX ? new_volume : VOLUME_MAX) : 0
+      @wave.set_volume v
+      @volume = v
+    end
+
+    # Play the sound.  If this sound is still playing, cut it off and start
+    # playing it from the start.
+    #
+    # loops should be the number of times to repeat playing the sound.  Use -1
+    # to loop the sound forever.
+    def play(loops=0)
+      # Cut off the sound if it's already playing.
+      SDL::Mixer.halt(@channel) if channel_valid?
+
+      @channel = SDL::Mixer.play_channel(-1, @wave, loops)
+      @@channel_sound_ids[@channel] = object_id
+    end
+
+    # Pause the sound if it's playing, otherwise do nothing.
+    def pause
+      SDL::Mixer.pause(@channel) if channel_valid?
+    end
+
+    # Resume the sound if it's paused, otherwise do nothing.
+    def resume
+      SDL::Mixer.resume(@channel) if channel_valid?
+    end
+
+    # Stop the sound if it's playing or paused, otherwise do nothing.
+    def stop
+      SDL::Mixer.halt(@channel) if channel_valid?
+    end
+
+    # Check if the sound is stopped, playing or paused.  Returns one of
+    # Tea::Sound::STOPPED, Tea::Sound::PLAYING or Tea::Sound::PAUSED.  A sound
+    # that isn't playing or paused is considered stopped.
+    def state
+      if channel_valid?
+        if SDL::Mixer.play?(@channel)
+          # For some reason, pause? returns 0 and 1 instead of true and false.
+          if SDL::Mixer.pause?(@channel) != 0
+            PAUSED
+          else
+            PLAYING
+          end
+        else
+          STOPPED
+        end
+      else
+        STOPPED
+      end
+    end
+
+    private
+
+    # Check if @channel really maps to this sound.  Returns the channel number
+    # if so, otherwise nil.
+    def channel_valid?
+      if @channel >= 0 && @@channel_sound_ids[@channel] == object_id
+        @channel
+      else
+        nil
+      end
+    end
+
+  end
+
+end

data/lib/tea/m_event_keyboard.rb

@@ -199,14 +199,19 @@ module Tea
         @key = sdl_keysym_to_key(sdl_event.sym)
         @mods = sdl_keymod_to_mods(sdl_event.mod)
 
-        # Ruby 1.9 uses UTF-8 Unicode encoding.  Below this, who knows how
-        # Unicode code points are interpreted?
         if sdl_event.unicode != 0
           unicode_field = "%c"
-          ruby_minor = RUBY_VERSION.match(/\.(\d+)\./)
-          if ruby_minor && ruby_minor[1].to_i >= 9
-            unicode_field = unicode_field.encode('utf-8')
+
+          # Ruby 1.9 uses UTF-8 Unicode encoding.  Otherwise, who knows how
+          # Unicode code points are interpreted?
+          if ruby_version_match = RUBY_VERSION.match(/(\d+)\.(\d+)\.\d+/)
+            ruby_major = ruby_version_match[1].to_i
+            ruby_minor = ruby_version_match[2].to_i
+            if ruby_major >= 1 && ruby_minor >= 9
+              unicode_field = unicode_field.encode('utf-8')
+            end
           end
+
           @char = unicode_field % sdl_event.unicode
         else
           @char = ''

data/lib/tea/mix_image_saving.rb

@@ -32,7 +32,7 @@ module Tea
         ext = extension_match[0]
         case ext
         when '.bmp'
-          image_saving_buffer.save_bmp(path)
+          image_saving_buffer.save_bmp path
         when '.png'
           image_saving_cheat_save path
         else

data/lib/tea/mix_primitive.rb

@@ -70,25 +70,18 @@ module Tea
 
       r, g, b, a = primitive_hex_to_rgba(color)
 
-      if a < 0xff
-        if options == nil || options[:mix] == nil
-          mix = :blend
-        else
-          unless [:blend, :replace].include?(options[:mix])
-            raise Tea::Error, "invalid mix option \"#{options[:mix]}\"", caller
-          end
-          mix = options[:mix]
-        end
+      if options == nil || options[:mix] == nil
+        mix = (a < 0xff) ? :blend : :replace
       else
-        mix = :replace
+        unless [:blend, :replace].include?(options[:mix])
+          raise Tea::Error, "invalid mix option \"#{options[:mix]}\"", caller
+        end
+        mix = (a < 0xff) ? options[:mix] : :replace
       end
 
       case mix
       when :blend
-        if a == 0xff
-          # Same as for mix == :replace
-          primitive_buffer.fill_rect x, y, w, h, primitive_rgba_to_color(r, g, b, a)
-        elsif primitive_buffer.class == SDL::Screen
+        if primitive_buffer.class == SDL::Screen
           # SGE's broken alpha blending doesn't matter on the screen, so
           # optimise for it.  rubysdl's draw_rect is off-by-one for width and
           # height, so compensate for that.
@@ -118,12 +111,13 @@ module Tea
         antialias = false
         mix = (a < 0xff) ? :blend : :replace
       else
-        antialias = options[:antialias] || false
-        mix = options[:mix] || ((a < 0xff) ? :blend : :replace)
-
-        unless [:blend, :replace].include?(mix)
+        if options[:mix] && [:blend, :replace].include?(options[:mix]) == false
           raise Tea::Error, "invalid mix option \"#{mix}\"", caller
         end
+
+        antialias = options[:antialias] || false
+        mix = (options[:mix] && a < 0xff) ? options[:mix] : :replace
+        mix = (a < 0xff) ? (options[:mix] ? options[:mix] : :blend) : :replace
       end
 
       if primitive_buffer.class == SDL::Screen
@@ -162,13 +156,13 @@ module Tea
         antialias = false
         mix = (a < 0xff) ? :blend : :replace
       else
-        outline = options[:outline] || false
-        antialias = options[:antialias] || false
-        mix = options[:mix] || ((a < 0xff) ? :blend : :replace)
-
-        unless [:blend, :replace].include?(mix)
+        if options[:mix] && [:blend, :replace].include?(options[:mix]) == false
           raise Tea::Error, "invalid mix option \"#{mix}\"", caller
         end
+
+        outline = options[:outline] || false
+        antialias = options[:antialias] || false
+        mix = (a < 0xff) ? (options[:mix] ? options[:mix] : :blend) : :replace
       end
 
       if primitive_buffer.class == SDL::Screen

data/lib/tea/o_screen.rb

@@ -1,7 +1,10 @@
 # This file contains the Screen class.
 
+require 'weakref'
+
 require 'sdl'
 
+require 'tea/c_bitmap'
 require 'tea/mix_blitting'
 require 'tea/mix_clipping'
 require 'tea/mix_grabbing'
@@ -20,12 +23,18 @@ module Tea
 
     # Set or change the screen video mode, giving a width * height screen buffer.
     def Screen.set_mode(width, height)
-      begin
-        @screen = SDL::Screen.open(width, height, BITS_PER_PIXEL, SDL::SWSURFACE)
-        @set_mode_callbacks.each { |c| c.call }
-      rescue SDL::Error => e
-        raise Tea::Error, e.message, e.backtrace
+      @screen = SDL::Screen.open(width, height, BITS_PER_PIXEL, SDL::SWSURFACE)
+
+      # Optimize Bitmaps that registered for it.
+      (0...(@bitmaps_to_optimize.length)).to_a.reverse.each do |opt_index|
+        begin
+          @bitmaps_to_optimize[opt_index].optimize_for_screen
+        rescue WeakRef::RefError
+          @bitmaps_to_optimize.delete_at opt_index
+        end
       end
+    rescue SDL::Error => e
+      raise Tea::Error, e.message, e.backtrace
     end
 
     # Check if Screen.set_mode has been called yet.
@@ -33,14 +42,12 @@ module Tea
       @screen ? true : false
     end
 
-    # Set a proc to be called when Screen.set_mode is called.  The proc will be
-    # called after the new screen mode is set.  The callback ordering is not
-    # defined, so don't make callbacks that depend on other callbacks being
-    # called first.
-    def Screen.on_set_mode(callback)
-      @set_mode_callbacks << callback
+    # Register a Bitmap object to be optimised to the Screen's format when a
+    # screen mode is set.
+    def Screen.register_bitmap_for_optimizing(bitmap)
+      @bitmaps_to_optimize << WeakRef.new(bitmap)
     end
-    @set_mode_callbacks = []
+    @bitmaps_to_optimize = []
 
     # Get the screen width in pixels.
     def Screen.w

data/lib/tea.rb

@@ -4,6 +4,7 @@ require 'sdl'
 
 require 'tea/c_bitmap'
 require 'tea/c_error'
+require 'tea/c_sound'
 require 'tea/m_event'
 require 'tea/o_screen'
 
@@ -16,14 +17,13 @@ module Tea
   #
   # May throw Tea::Error if initialisation fails.
   def Tea.init
-    begin
-      SDL.init(SDL::INIT_VIDEO)
+    SDL.init(SDL::INIT_VIDEO | SDL::INIT_AUDIO)
 
-      # Get typed characters from keys when pressed.
-      SDL::Event.enable_unicode
-    rescue SDL::Error => e
-      raise Tea::Error, e.message, e.backtrace
-    end
+    # Get typed characters from keys when pressed.
+    SDL::Event.enable_unicode
+    SDL::Mixer.open 44100, SDL::Mixer::DEFAULT_FORMAT, SDL::Mixer::DEFAULT_CHANNELS, 1024
+  rescue SDL::Error => e
+    raise Tea::Error, e.message, e.backtrace
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: tung-tea
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors: 
 - Tung Nguyen
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-29 00:00:00 -07:00
+date: 2009-09-02 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -69,6 +69,7 @@ files:
 - doc/example/smile_bounce.rb
 - doc/example/smile_move.rb
 - doc/example/smile_move_2.rb
+- doc/example/sound.rb
 - doc/example/state_app.rb
 - doc/example/state_keyboard.rb
 - doc/example/state_mouse.rb
@@ -78,6 +79,7 @@ files:
 - lib/tea.rb
 - lib/tea/c_bitmap.rb
 - lib/tea/c_error.rb
+- lib/tea/c_sound.rb
 - lib/tea/m_event.rb
 - lib/tea/m_event_app.rb
 - lib/tea/m_event_dispatch.rb
@@ -91,7 +93,6 @@ files:
 - lib/tea/o_screen.rb
 has_rdoc: false
 homepage: http://github.com/tung/tea
-licenses: 
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -113,7 +114,7 @@ requirements:
 - SDL, SGE
 - imagemagick
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 3
 summary: A simple game development library for Ruby.