ffi-openmpt 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1051eb2d63c430d769cba4769ad283817d1b615276d5529d6bd4e4f253ceb57e
-  data.tar.gz: 32518a3a258ac8bc43b9da89aa91f750f874dbc70349c7e541f3d1637e67a583
+  metadata.gz: 06607b1145d777c793ee96ca49e70132f74dd3ec2289957909519a109a64f7d7
+  data.tar.gz: f5ef317907e2ff4866a1d0832ba64b820f409dc03dce32613321bc3767cc5c9b
 SHA512:
-  metadata.gz: 6f5f6fa54e93a5e93e0f8e8364a2cc00b8a285abd168546269783b7c877f6b395462f255f2ac33a5a74e2758ac5dac526dfdffac2544486ebf913a51f7e45a2a
-  data.tar.gz: 1dd220d1b5d7271b11e6d8daff950f017af642bf67ca1716d164d3b9516cd8bdd3ff6995ed0a418edb22ad4869380546c91c7fb67e7933536a0d0cb545d23da2
+  metadata.gz: 5a03b9aa048cfcb588e36b147b396d04653fb5d55780d2f6ff879954ae7d0a783ee414c003477f3b5e3693c930baad0d400c755a428bc5aa2528264f9c7064fb
+  data.tar.gz: bd5d1f18bdaa730e22b38f281d2281c3eb544631a79fedf10dc32bc1f7e897afe3a54da726c83cc7f19398f527fc9810f5038ff9df0a1dd04ec1b86663c8a86c

data/.rubocop.yml

@@ -22,6 +22,14 @@ Layout/EmptyLinesAroundClassBody:
 Layout/EmptyLinesAroundModuleBody:
   Enabled: false
 
+# Don't enforce things like #positive? due to older rubies not supporting it
+Style/NumericPredicate:
+  EnforcedStyle: comparison
+
+Style/MixinUsage:
+  Exclude:
+    - 'examples/**/*'
+
 # Allow compact child definitions in the tests for brevity.
 Style/ClassAndModuleChildren:
   Exclude:
@@ -34,10 +42,24 @@ Metrics/AbcSize:
 
 # Set a more reasonable method length and ignore failures in the tests.
 Metrics/MethodLength:
+  Max: 15
   Exclude:
     - 'test/**/*.rb'
 
 # Set a more reasonable class length and ignore failures in the tests.
 Metrics/ClassLength:
+  Max: 200
+  Exclude:
+    - 'test/**/*.rb'
+
+# Set a more reasonable module length and ignore failures in the tests.
+# Also allow the API module to be very long as it just maps lots of methods.
+Metrics/ModuleLength:
+  Exclude:
+    - 'lib/ffi/openmpt/api.rb'
+    - 'test/**/*.rb'
+
+# Set a more reasonable block length and ignore failures in the tests.
+Metrics/BlockLength:
   Exclude:
     - 'test/**/*.rb'

data/CHANGES.md

@@ -1,5 +1,60 @@
 # Changes log for the Ruby OpenMPT library (ffi-openmpt)
 
+## Version 0.2.0
+
+* Add a Gem version badge to the README.md.
+* Wrap the libopenmpt module probing functions.
+* Enforce comparisons, not predicates, for older rubies.
+* Wrap libopenmpt informational function: get subsongs.
+* Wrap libopenmpt informational function: get channels.
+* Wrap libopenmpt informational function: get orders.
+* Wrap libopenmpt informational function: get patterns.
+* Wrap libopenmpt informational function: get instruments.
+* Wrap libopenmpt informational function: get samples.
+* Wrap libopenmpt informational function: subsong names.
+* Wrap libopenmpt informational function: channel names.
+* Wrap libopenmpt informational function: order names.
+* Wrap libopenmpt informational function: pattern names.
+* Wrap libopenmpt informational function: instrument names.
+* Wrap libopenmpt informational function: sample names.
+* Wrap libopenmpt render parameter functions.
+* Add an example script to read mod information.
+* Document the mod-info example in the README.
+* Use File.binread to load module data in the example.
+* Rename the example script to show that it uses the API.
+* Start ruby-like interface to a mod: Module.
+* Add the metadata method to the ruby interface.
+* Add duration to the ruby interface.
+* Add the simple informational calls to the ruby interface.
+* Replicate the 'mod-info' example with the ruby interface.
+* Add notion of a closed mod to the ruby interface.
+* Catch a closed mod and return in the ruby interface.
+* Allow access to the metadata via ruby interface methods.
+* Use the new metadata method mappings in mod-info.
+* Update README with details of the second example script.
+* Add the get_string library call to the ruby interface.
+* Add the extensions library call to the ruby interface.
+* Add the supported_extension? library call to the ruby interface.
+* Move the module probe function to the OpenMPT namespace.
+* Get render param 'gain' in the ruby interface.
+* Set render param 'gain' in the ruby interface.
+* Get render param 'stereo_separation' in the ruby interface.
+* Set render param 'stereo_separation' in the ruby interface.
+* Get render param 'interpolation_filter' in the ruby interface.
+* Set render param 'interpolation_filter' in the ruby interface.
+* Get render param 'volume_ramping' in the ruby interface.
+* Set render param 'volume_ramping' in the ruby interface.
+* Add transient_error? call to the ruby interface.
+* Add error_string call to the ruby interface.
+* Change supported_extensions to return list of Symbols.
+* Add sample_rate instance variable to Module.
+* Add missing tests for a closed module.
+* Add stereo read (short) calls to the ruby interface.
+* Add stereo read (float) calls to the ruby interface.
+* Add a 'mod-2-raw' ruby interface example script.
+* Add a note to the README about finding libopenmpt.
+* Update the README with information about the ruby interface.
+
 ## Version 0.1.0
 
 * Add Code of Conduct.

data/README.md

@@ -7,6 +7,7 @@ A ruby interface to `libopenmpt` - part of [OpenMPT][mpt-home].
 
 See the [libopenmpt homepage][lib-home] for more information.
 
+[![Gem Version](https://badge.fury.io/rb/ffi-openmpt.svg)](https://badge.fury.io/rb/ffi-openmpt)
 [![Build Status](https://travis-ci.org/hainesr/ffi-openmpt.svg?branch=master)](https://travis-ci.org/hainesr/ffi-openmpt)
 [![Maintainability](https://api.codeclimate.com/v1/badges/919bd8b421798dbd2719/maintainability)](https://codeclimate.com/github/hainesr/ffi-openmpt/maintainability)
 [![Coverage Status](https://coveralls.io/repos/github/hainesr/ffi-openmpt/badge.svg?branch=master)](https://coveralls.io/github/hainesr/ffi-openmpt)
@@ -21,7 +22,7 @@ You must have `libopenmpt` installed. On Ubuntu this is done with:
 $ sudo apt install libopenmpt0
 ```
 
-You do not need the `libopenmpt` development libraries to be installed.
+You do not need the `libopenmpt` development libraries to be installed. If this library fails to find `libopenmpt` on your platform it might be due to it being named something slightly different. Please [raise an issue][issues] to let me know.
 
 Instructions for installing `libopenmpt` from source are available on the [libopenmpt homepage][lib-home].
 
@@ -45,13 +46,13 @@ $ gem install ffi-openmpt
 
 ### Usage
 
-The library wraps the C `libopenmpt` API directly: methods have the same name and signature as their C counterparts. A more friendly ruby-like interface is in development, which will hide the FFI details as much as possible.
+The library wraps the C `libopenmpt` API directly: methods have the same name and signature as their C counterparts. A more friendly ruby-like interface is also available, which hides the FFI details as much as possible.
 
 Not all `libopenmpt` methods are wrapped yet, but enough functionality is supplied to load a module, interogate it and render it to a PCM stream.
 
 #### A note on strings returned by `libopenmpt`
 
-`libopenmpt` manages the memory of any strings it returns. This means that you must free up such memory explicitly after you have finished with them. Such strings are returned to ruby as [`FFI::Pointer`][ffi-pointer] objects, so the string value can be copied to a ruby string as follows:
+`libopenmpt` manages the memory of any strings it returns. This means that you must free up such memory explicitly after you have finished with them when using the C API. Such strings are returned to ruby as [`FFI::Pointer`][ffi-pointer] objects, so the string value can be copied to a ruby string as follows:
 
 ```ruby
 include FFI::OpenMPT::API
@@ -61,6 +62,63 @@ openmpt_free_string(ptr)
 puts str
 ```
 
+The ruby interface handles all this for you:
+
+```ruby
+str = FFI::OpenMPT.string(:url)
+puts str
+```
+
+### Example scripts
+
+Scripts in the `examples` directory show how to use both the C and ruby APIs. You will need to make sure that `ffi-openmpt` is on your `RUBYLIB` path, or run the examples with `bundle exec`.
+
+#### `mod-info` and `mod-info-api`
+
+Display information about a mod file, for example:
+
+```shell
+$ ./mod-info lastsun.mod
+
+Ruby OpenMPT (ffi-openmpt) file interrogator.
+---------------------------------------------
+
+Filename...: lastsun.mod
+Size.......: 106k
+Type.......: mod
+Format.....: Generic Amiga / PC MOD file
+Tracker....: Master Soundtracker 1.0
+Title......: the last sun
+Duration...: 3:56.4
+Subsongs...: 1
+Channels...: 4
+Orders.....: 35
+Patterns...: 20
+Intruments.: 0
+Samples....: 15
+```
+
+Both `mod-info` and `mod-info-api` output exactly the same data. `mod-info` uses the ruby interface, and `mod-info-api` uses the mapped `libopenmpt` C API directly.
+
+#### `mod-2-raw`
+
+Render a mod to a raw stereo PCM file. Use the `--float` switch to generate 32 bit float data, or omit for 16bit int data. For example:
+
+```shell
+$ ./mod-2-raw --float lastsun.mod
+
+Ruby OpenMPT (ffi-openmpt) Mod to Raw PCM Converter.
+----------------------------------------------------
+
+Filename...: lastsun.mod
+Size.......: 106k
+Type.......: mod
+Output type: float.raw
+Output size: 88687k
+```
+
+The raw output format is simply a blob of `float` or `short` data. The left and right stereo channels are interleaved. The sample rate used is 48,000Hz.
+
 ### Library versions
 
 Until this library reaches version 1.0.0 the API may be subject to breaking changes. When version 1.0.0 is released, then the principles of [semantic versioning][semver] will be applied.

data/examples/mod-2-raw

@@ -0,0 +1,72 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Copyright (c) 2018 Robert Haines.
+#
+# Licensed under the BSD License. See LICENCE for details.
+
+require 'ffi/openmpt'
+
+def get_filename(var)
+  if var.nil?
+    puts 'Please supply a filename to interrogate.'
+    exit(1)
+  end
+
+  var.chomp
+end
+
+param = get_filename(ARGV[0])
+
+if param == '--float'
+  mod_path = get_filename(ARGV[1])
+  float = true
+else
+  mod_path = param
+  float = false
+end
+
+# Does this file exist? Is it readable?
+unless ::File.readable?(mod_path)
+  puts "'#{mod_path}' does not exist, or is not readable."
+  exit(1)
+end
+
+# Can libopenmpt open this file?
+unless ::FFI::OpenMPT.probe_file(mod_path)
+  puts 'libopenmpt can not open this file. Are you sure it is a mod?'
+  exit(1)
+end
+
+frames_per_read = 1_024
+if float
+  raw_type = 'float.raw'
+  buffer = ::FFI::MemoryPointer.new(:float, frames_per_read * 2)
+  method = :read_interleaved_float_stereo
+else
+  raw_type = 'int16.raw'
+  buffer = ::FFI::MemoryPointer.new(:int16, frames_per_read * 2)
+  method = :read_interleaved_stereo
+end
+
+puts
+puts 'Ruby OpenMPT (ffi-openmpt) Mod to Raw PCM Converter.'
+puts '----------------------------------------------------'
+puts
+puts "Filename...: #{::File.basename(mod_path)}"
+puts "Size.......: #{::File.size(mod_path) / 1_024}k"
+
+::FFI::OpenMPT::Module.open(mod_path) do |mod|
+  puts "Type.......: #{mod.type}"
+  puts "Output type: #{raw_type}"
+
+  ::File.open(mod_path + '.' + raw_type, 'wb') do |file|
+    loop do
+      count = mod.send(method, frames_per_read, buffer)
+      break if count == 0
+      file.write(buffer.read_bytes(count * buffer.type_size * 2))
+    end
+  end
+end
+
+puts "Output size: #{::File.size(mod_path + '.' + raw_type) / 1_024}k"

data/examples/mod-info

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Copyright (c) 2018 Robert Haines.
+#
+# Licensed under the BSD License. See LICENCE for details.
+
+require 'ffi/openmpt'
+
+if ARGV[0].nil?
+  puts 'Please supply a filename to interrogate.'
+  exit(1)
+end
+
+mod_path = ARGV[0].chomp
+
+# Does this file exist? Is it readable?
+unless ::File.readable?(mod_path)
+  puts "'#{mod_path}' does not exist, or is not readable."
+  exit(1)
+end
+
+mod_file = ::File.basename(mod_path)
+mod_size = ::File.size(mod_path) / 1_024
+
+# Can libopenmpt open this file?
+unless ::FFI::OpenMPT.probe_file(mod_path)
+  puts 'libopenmpt can not open this file. Are you sure it is a mod?'
+  exit(1)
+end
+
+::FFI::OpenMPT::Module.open(mod_path) do |mod|
+  duration = mod.duration
+  duration_mins = duration.floor / 60
+  duration_secs = duration % 60
+
+  puts
+  puts 'Ruby OpenMPT (ffi-openmpt) file interrogator.'
+  puts '---------------------------------------------'
+  puts
+  puts "Filename...: #{mod_file}"
+  puts "Size.......: #{mod_size}k"
+  puts "Type.......: #{mod.type}"
+  puts "Format.....: #{mod.type_long}"
+  puts "Tracker....: #{mod.tracker}"
+  puts "Title......: #{mod.title}"
+  puts "Duration...: #{duration_mins}:#{duration_secs.round(3)}"
+  puts "Subsongs...: #{mod.subsongs}"
+  puts "Channels...: #{mod.channels}"
+  puts "Orders.....: #{mod.orders}"
+  puts "Patterns...: #{mod.patterns}"
+  puts "Instruments: #{mod.instruments}"
+  puts "Samples....: #{mod.samples}"
+end

data/examples/mod-info-api

@@ -0,0 +1,105 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Copyright (c) 2018 Robert Haines.
+#
+# Licensed under the BSD License. See LICENCE for details.
+
+require 'ffi/openmpt'
+
+include ::FFI::OpenMPT::API
+
+def check_mod_error(mod)
+  error = openmpt_module_error_get_last(mod)
+  return if error == OPENMPT_ERROR_OK
+
+  trans = openmpt_error_is_transient(error)
+  message_ptr = openmpt_module_error_get_last_message(mod)
+  message = message_ptr.read_string
+  openmpt_free_string(message_ptr)
+
+  if trans == 0
+    puts "Error! '#{message}'. Exiting."
+    exit(1)
+  else
+    puts "Warning: '#{message}'. Trying to carry on."
+  end
+end
+
+if ARGV[0].nil?
+  puts 'Please supply a filename to interrogate.'
+  exit(1)
+end
+
+mod_path = ARGV[0].chomp
+
+# Does this file exist? Is it readable?
+unless ::File.readable?(mod_path)
+  puts "'#{mod_path}' does not exist, or is not readable."
+  exit(1)
+end
+
+mod_data = ::File.binread(mod_path)
+mod_file = ::File.basename(mod_path)
+mod_size = mod_data.bytesize / 1_024
+
+# Can libopenmpt open this file?
+probe_size = openmpt_probe_file_header_get_recommended_size
+probe_result = openmpt_probe_file_header(
+  OPENMPT_PROBE_FILE_HEADER_FLAGS_DEFAULT,
+  mod_data.byteslice(0, probe_size),
+  probe_size,
+  mod_data.bytesize,
+  LogSilent, nil, ErrorIgnore, nil, nil, nil
+)
+
+unless probe_result == OPENMPT_PROBE_FILE_HEADER_RESULT_SUCCESS
+  puts 'libopenmpt can not open this file. Are you sure it is a mod?'
+  exit(1)
+end
+
+puts
+puts 'Ruby OpenMPT (ffi-openmpt) file interrogator.'
+puts '---------------------------------------------'
+puts
+puts "Filename...: #{mod_file}"
+puts "Size.......: #{mod_size}k"
+
+# Load the mod.
+mod = openmpt_module_create_from_memory2(
+  mod_data,
+  mod_data.bytesize,
+  LogSilent, nil, ErrorIgnore, nil, nil, nil, nil
+)
+check_mod_error(mod)
+
+# Mod metadata.
+[
+  ['type', 'Type.......:'],
+  ['type_long', 'Format.....:'],
+  ['tracker', 'Tracker....:'],
+  ['title', 'Title......:']
+].each do |key, display|
+  value = openmpt_module_get_metadata(mod, key)
+  puts "#{display} #{value.read_string}"
+  openmpt_free_string(value)
+end
+
+# Mod duration.
+duration = openmpt_module_get_duration_seconds(mod)
+duration_mins = duration.floor / 60
+duration_secs = duration % 60
+puts "Duration...: #{duration_mins}:#{duration_secs.round(3)}"
+
+# Other Mod information.
+[
+  [:openmpt_module_get_num_subsongs, 'Subsongs...:'],
+  [:openmpt_module_get_num_channels, 'Channels...:'],
+  [:openmpt_module_get_num_orders, 'Orders.....:'],
+  [:openmpt_module_get_num_patterns, 'Patterns...:'],
+  [:openmpt_module_get_num_instruments, 'Intruments.:'],
+  [:openmpt_module_get_num_samples, 'Samples....:']
+].each do |func, display|
+  value = send(func, mod)
+  puts "#{display} #{value}"
+end

data/lib/ffi/openmpt.rb

@@ -14,3 +14,4 @@ end
 require 'ffi/openmpt/version'
 require 'ffi/openmpt/api'
 require 'ffi/openmpt/openmpt'
+require 'ffi/openmpt/module'

data/lib/ffi/openmpt/api.rb

@@ -76,17 +76,69 @@ module FFI
                       :pointer
       attach_function :openmpt_module_destroy, [:pointer], :void
 
-      # Informational/error module calls
+      # Informational module calls
       attach_function :openmpt_module_get_duration_seconds, [:pointer], :double
       attach_function :openmpt_module_get_metadata_keys, [:pointer], :pointer
       attach_function :openmpt_module_get_metadata,
                       [:pointer, :string], :pointer
+      attach_function :openmpt_module_get_num_subsongs, [:pointer], :int
+      attach_function :openmpt_module_get_subsong_name,
+                      [:pointer, :int], :pointer
+      attach_function :openmpt_module_get_num_channels, [:pointer], :int
+      attach_function :openmpt_module_get_channel_name,
+                      [:pointer, :int], :pointer
+      attach_function :openmpt_module_get_num_orders, [:pointer], :int
+      attach_function :openmpt_module_get_order_name,
+                      [:pointer, :int], :pointer
+      attach_function :openmpt_module_get_num_patterns, [:pointer], :int
+      attach_function :openmpt_module_get_pattern_name,
+                      [:pointer, :int], :pointer
+      attach_function :openmpt_module_get_num_instruments, [:pointer], :int
+      attach_function :openmpt_module_get_instrument_name,
+                      [:pointer, :int], :pointer
+      attach_function :openmpt_module_get_num_samples, [:pointer], :int
+      attach_function :openmpt_module_get_sample_name,
+                      [:pointer, :int], :pointer
+
+      # Error module calls
       attach_function :openmpt_module_error_get_last, [:pointer], :int
       attach_function :openmpt_module_error_set_last, [:pointer, :int], :void
       attach_function :openmpt_module_error_get_last_message,
                       [:pointer], :pointer
       attach_function :openmpt_module_error_clear, [:pointer], :void
 
+      # Probe module calls
+      OPENMPT_PROBE_FILE_HEADER_FLAGS_NONE          = 0x0
+      OPENMPT_PROBE_FILE_HEADER_FLAGS_MODULES       = 0x1
+      OPENMPT_PROBE_FILE_HEADER_FLAGS_CONTAINERS    = 0x2
+      OPENMPT_PROBE_FILE_HEADER_FLAGS_DEFAULT       =
+        (OPENMPT_PROBE_FILE_HEADER_FLAGS_MODULES |
+          OPENMPT_PROBE_FILE_HEADER_FLAGS_CONTAINERS)
+
+      OPENMPT_PROBE_FILE_HEADER_RESULT_FAILURE      = 0
+      OPENMPT_PROBE_FILE_HEADER_RESULT_SUCCESS      = 1
+      OPENMPT_PROBE_FILE_HEADER_RESULT_WANTMOREDATA = -1
+      OPENMPT_PROBE_FILE_HEADER_RESULT_ERROR        = -255
+
+      attach_function :openmpt_probe_file_header_get_recommended_size, [], :int
+      attach_function :openmpt_probe_file_header,
+                      [
+                        :uint, :pointer, :int, :uint, :pointer, :pointer,
+                        :pointer, :pointer, :pointer, :pointer
+                      ],
+                      :int
+
+      # Render param module calls
+      OPENMPT_MODULE_RENDER_MASTERGAIN_MILLIBEL        = 1
+      OPENMPT_MODULE_RENDER_STEREOSEPARATION_PERCENT   = 2
+      OPENMPT_MODULE_RENDER_INTERPOLATIONFILTER_LENGTH = 3
+      OPENMPT_MODULE_RENDER_VOLUMERAMPING_STRENGTH     = 4
+
+      attach_function :openmpt_module_get_render_param,
+                      [:pointer, :int, :pointer], :int
+      attach_function :openmpt_module_set_render_param,
+                      [:pointer, :int, :int], :int
+
       # Read module calls
       attach_function :openmpt_module_read_stereo,
                       [:pointer, :int, :int, :pointer, :pointer],

data/lib/ffi/openmpt/module.rb

@@ -0,0 +1,216 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2018 Robert Haines.
+#
+# Licensed under the BSD License. See LICENCE for details.
+
+module FFI
+  module OpenMPT
+    class Module
+
+      include API
+
+      METADATA_KEYS = [
+        :type,
+        :type_long,
+        :container,
+        :container_long,
+        :tracker,
+        :artist,
+        :title,
+        :date,
+        :message,
+        :message_raw,
+        :warnings
+      ].freeze
+
+      attr_reader :sample_rate
+
+      def initialize(filename, sample_rate = 48_000)
+        @closed = false
+        @mod = read_mod(filename)
+        @sample_rate = sample_rate
+
+        # Allocate a reusable single int buffer.
+        # This for use by the 'get_render_params'-type calls.
+        @int_value = ::FFI::MemoryPointer.new(:int, 1)
+      end
+
+      def self.open(filename)
+        m = new(filename)
+
+        if block_given?
+          begin
+            yield m
+          ensure
+            m.close
+          end
+        end
+
+        m
+      end
+
+      def sample_rate=(rate)
+        @sample_rate = rate if (8_000..192_000).cover?(rate)
+      end
+
+      def duration
+        return if closed?
+        openmpt_module_get_duration_seconds(@mod)
+      end
+
+      def subsongs
+        return if closed?
+        openmpt_module_get_num_subsongs(@mod)
+      end
+
+      def channels
+        return if closed?
+        openmpt_module_get_num_channels(@mod)
+      end
+
+      def orders
+        return if closed?
+        openmpt_module_get_num_orders(@mod)
+      end
+
+      def patterns
+        return if closed?
+        openmpt_module_get_num_patterns(@mod)
+      end
+
+      def instruments
+        return if closed?
+        openmpt_module_get_num_instruments(@mod)
+      end
+
+      def samples
+        return if closed?
+        openmpt_module_get_num_samples(@mod)
+      end
+
+      def metadata(key)
+        return if closed? || !METADATA_KEYS.include?(key)
+        get_openmpt_string(:openmpt_module_get_metadata, key.to_s)
+      end
+
+      def gain
+        success = openmpt_module_get_render_param(
+          @mod, OPENMPT_MODULE_RENDER_MASTERGAIN_MILLIBEL, @int_value
+        )
+
+        success == 1 ? @int_value.read_int : nil
+      end
+
+      def gain=(value)
+        openmpt_module_set_render_param(
+          @mod, OPENMPT_MODULE_RENDER_MASTERGAIN_MILLIBEL, value
+        )
+      end
+
+      def stereo_separation
+        success = openmpt_module_get_render_param(
+          @mod, OPENMPT_MODULE_RENDER_STEREOSEPARATION_PERCENT, @int_value
+        )
+
+        success == 1 ? @int_value.read_int : nil
+      end
+
+      def stereo_separation=(value)
+        openmpt_module_set_render_param(
+          @mod, OPENMPT_MODULE_RENDER_STEREOSEPARATION_PERCENT, value
+        )
+      end
+
+      def interpolation_filter
+        success = openmpt_module_get_render_param(
+          @mod, OPENMPT_MODULE_RENDER_INTERPOLATIONFILTER_LENGTH, @int_value
+        )
+
+        success == 1 ? @int_value.read_int : nil
+      end
+
+      def interpolation_filter=(value)
+        openmpt_module_set_render_param(
+          @mod, OPENMPT_MODULE_RENDER_INTERPOLATIONFILTER_LENGTH, value
+        )
+      end
+
+      def volume_ramping
+        success = openmpt_module_get_render_param(
+          @mod, OPENMPT_MODULE_RENDER_VOLUMERAMPING_STRENGTH, @int_value
+        )
+
+        success == 1 ? @int_value.read_int : nil
+      end
+
+      def volume_ramping=(value)
+        openmpt_module_set_render_param(
+          @mod, OPENMPT_MODULE_RENDER_VOLUMERAMPING_STRENGTH, value
+        )
+      end
+
+      def read_stereo(frames, left, right)
+        openmpt_module_read_stereo(@mod, @sample_rate, frames, left, right)
+      end
+
+      def read_interleaved_stereo(frames, buffer)
+        openmpt_module_read_interleaved_stereo(
+          @mod, @sample_rate, frames, buffer
+        )
+      end
+
+      def read_float_stereo(frames, left, right)
+        openmpt_module_read_float_stereo(
+          @mod, @sample_rate, frames, left, right
+        )
+      end
+
+      def read_interleaved_float_stereo(frames, buffer)
+        openmpt_module_read_interleaved_float_stereo(
+          @mod, @sample_rate, frames, buffer
+        )
+      end
+
+      def close
+        return if closed?
+        @closed = true
+        openmpt_module_destroy(@mod)
+      end
+
+      def closed?
+        @closed
+      end
+
+      def method_missing(name, *args)
+        respond_to?(name) ? metadata(name) : super
+      end
+
+      def respond_to_missing?(name, *all)
+        METADATA_KEYS.include?(name) || super
+      end
+
+      private
+
+      def read_mod(filename)
+        data = ::File.binread(filename)
+        mod = openmpt_module_create_from_memory2(
+          data,
+          data.bytesize,
+          LogSilent, nil, ErrorIgnore, nil, nil, nil, nil
+        )
+
+        @closed = (mod.address == 0)
+        mod
+      end
+
+      def get_openmpt_string(method, *args)
+        ptr = send(method, @mod, *args)
+        str = ptr.read_string
+        openmpt_free_string(ptr)
+
+        str
+      end
+    end
+  end
+end

data/lib/ffi/openmpt/openmpt.rb

@@ -14,5 +14,53 @@ module FFI
     def self.core_version
       [API.openmpt_get_core_version].pack('L>').unpack('CCCC')
     end
+
+    def self.string(key)
+      ptr = API.openmpt_get_string(key.to_s)
+      str = ptr.read_string
+      API.openmpt_free_string(ptr)
+
+      str
+    end
+
+    def self.supported_extensions
+      ptr = API.openmpt_get_supported_extensions
+      exts = ptr.read_string.split(';').map(&:to_sym)
+      API.openmpt_free_string(ptr)
+
+      exts
+    end
+
+    def self.extension_supported?(ext)
+      supported = API.openmpt_is_extension_supported(ext.to_s)
+      supported == 1
+    end
+
+    def self.transient_error?(error)
+      API.openmpt_error_is_transient(error) == 1
+    end
+
+    def self.error_string(error)
+      ptr = API.openmpt_error_string(error)
+      str = ptr.read_string
+      API.openmpt_free_string(ptr)
+
+      str
+    end
+
+    def self.probe_file(filename)
+      probe_size = API.openmpt_probe_file_header_get_recommended_size
+      data = ::File.binread(filename, probe_size)
+      data_size = ::File.size(filename)
+      probe_result = API.openmpt_probe_file_header(
+        API::OPENMPT_PROBE_FILE_HEADER_FLAGS_DEFAULT,
+        data,
+        data.bytesize,
+        data_size,
+        API::LogSilent, nil, API::ErrorIgnore, nil, nil, nil
+      )
+
+      probe_result == API::OPENMPT_PROBE_FILE_HEADER_RESULT_SUCCESS
+    end
   end
 end

data/lib/ffi/openmpt/version.rb

@@ -6,6 +6,6 @@
 
 module FFI
   module OpenMPT
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ffi-openmpt
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Robert Haines
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-25 00:00:00.000000000 Z
+date: 2018-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -117,9 +117,13 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/mod-2-raw
+- examples/mod-info
+- examples/mod-info-api
 - ffi-openmpt.gemspec
 - lib/ffi/openmpt.rb
 - lib/ffi/openmpt/api.rb
+- lib/ffi/openmpt/module.rb
 - lib/ffi/openmpt/openmpt.rb
 - lib/ffi/openmpt/version.rb
 homepage: https://github.com/hainesr/ffi-openmpt