ffi-openmpt 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06607b1145d777c793ee96ca49e70132f74dd3ec2289957909519a109a64f7d7
-  data.tar.gz: f5ef317907e2ff4866a1d0832ba64b820f409dc03dce32613321bc3767cc5c9b
+  metadata.gz: cff9c1335f501d6c4567b5f3fd9f314413426608f2fd83ff43c40cd8ac3430d5
+  data.tar.gz: 6bc3d44745d502705a18b8b85bf6608ac94f9315ed4dcfb4b8bf56f048462709
 SHA512:
-  metadata.gz: 5a03b9aa048cfcb588e36b147b396d04653fb5d55780d2f6ff879954ae7d0a783ee414c003477f3b5e3693c930baad0d400c755a428bc5aa2528264f9c7064fb
-  data.tar.gz: bd5d1f18bdaa730e22b38f281d2281c3eb544631a79fedf10dc32bc1f7e897afe3a54da726c83cc7f19398f527fc9810f5038ff9df0a1dd04ec1b86663c8a86c
+  metadata.gz: 39aa9577df5787ffb062a2a0045e4fc2f374343a32246f6f383bcfde63ad7722c3b99b01f0affe244e68973c80a59905a95c3339865f2ed9f74dd7cfd730a504
+  data.tar.gz: 72e57d5e865ab26e44b72727b9bb2a05a05b930a4c5a4155fbdcb753c07c965647a32d1abf4565a18ee95ea9e3581ea57df4d294182982a2dfda9685440ca690

data/.gitignore

@@ -7,4 +7,6 @@
 /spec/reports/
 /tmp/
 
+/.vscode/
+
 Gemfile.lock

data/.travis.yml

@@ -1,7 +1,6 @@
+dist: xenial
 language: ruby
 
-sudo: false
-
 cache: bundler
 
 before_install:
@@ -11,13 +10,26 @@ before_install:
 
 rvm:
   - 2.2.10
-  - 2.3.7
-  - 2.4.4
-  - 2.5.1
+  - 2.3.8
+  - 2.4.5
+  - 2.5.3
   - rbx-3
   - ruby-head
 
+env:
+  - TEST_LIBOPENMPT_VERSION=0.3.11
+  - TEST_LIBOPENMPT_VERSION=0.3.12
+
 matrix:
+  fast_finish: true
   allow_failures:
     - rvm: rbx-3
     - rvm: ruby-head
+    - env: TEST_LIBOPENMPT_VERSION=0.3.12
+  exclude:
+    - rvm: rbx-3
+      env: TEST_LIBOPENMPT_VERSION=0.3.12
+    - rvm: 2.2.10
+      env: TEST_LIBOPENMPT_VERSION=0.3.12
+    - rvm: 2.3.8
+      env: TEST_LIBOPENMPT_VERSION=0.3.12

data/CHANGES.md

@@ -1,5 +1,24 @@
 # Changes log for the Ruby OpenMPT library (ffi-openmpt)
 
+## Version 0.3.0
+
+* Wrap the libopenmpt module read mono functions.
+* Add mono read (short/float) calls to the ruby interface.
+* Move the string get method to its own namespace.
+* Allow getting informational strings directly.
+* Wrap Module#metadata_keys.
+* Directly query module metadata keys.
+* Update test version of libopenmpt to 0.3.13.
+* Parameterize the test libopenmpt version.
+* Update Travis config to use latest rubies.
+* Turn on `fast_finish` in the Travis config.
+* Switch to use latest dist (Xenial) in Travis.
+* Test multiple versions of the libopenmpt library.
+* Wrap libopenmpt module repeat functions.
+* Add repeat_count to the ruby interface.
+* Wrap libopenmpt module positional calls.
+* Add positional calls to the ruby interface.
+
 ## Version 0.2.0
 
 * Add a Gem version badge to the README.md.

data/ffi-openmpt.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = 'A Ruby library to interface with libopenmpt.'
   spec.description   = 'libopenmpt is a library to render tracker music ' \
-    '(MOD, XM, S3M, IT MPTM and dozens of other legacy formats) to a ' \
+    '(MOD, XM, S3M, IT, MPTM and dozens of other legacy formats) to a ' \
     'PCM audio stream. See https://openmpt.org/ for more information.'
   spec.homepage      = 'https://github.com/hainesr/ffi-openmpt'
   spec.license       = 'BSD'

data/lib/ffi/openmpt.rb

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

data/lib/ffi/openmpt/api.rb

@@ -139,7 +139,24 @@ module FFI
       attach_function :openmpt_module_set_render_param,
                       [:pointer, :int, :int], :int
 
+      # Repeat module calls
+      attach_function :openmpt_module_get_repeat_count, [:pointer], :int
+      attach_function :openmpt_module_set_repeat_count, [:pointer, :int], :void
+
+      # Positional module calls
+      attach_function :openmpt_module_get_position_seconds, [:pointer], :double
+      attach_function :openmpt_module_set_position_seconds,
+                      [:pointer, :double], :double
+      attach_function :openmpt_module_set_position_order_row,
+                      [:pointer, :int, :int], :double
+
       # Read module calls
+      attach_function :openmpt_module_read_mono,
+                      [:pointer, :int, :int, :pointer],
+                      :int
+      attach_function :openmpt_module_read_float_mono,
+                      [:pointer, :int, :int, :pointer],
+                      :int
       attach_function :openmpt_module_read_stereo,
                       [:pointer, :int, :int, :pointer, :pointer],
                       :int

data/lib/ffi/openmpt/module.rb

@@ -10,20 +10,6 @@ module FFI
 
       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)
@@ -32,7 +18,7 @@ module FFI
         @sample_rate = sample_rate
 
         # Allocate a reusable single int buffer.
-        # This for use by the 'get_render_params'-type calls.
+        # This is for use by the 'get_render_params'-type calls.
         @int_value = ::FFI::MemoryPointer.new(:int, 1)
       end
 
@@ -89,9 +75,43 @@ module FFI
         openmpt_module_get_num_samples(@mod)
       end
 
+      def repeat_count
+        openmpt_module_get_repeat_count(@mod)
+      end
+
+      def repeat_count=(count)
+        openmpt_module_set_repeat_count(@mod, count)
+      end
+
+      def position
+        return if closed?
+        openmpt_module_get_position_seconds(@mod)
+      end
+
+      def position=(param)
+        if param.is_a?(Array)
+          openmpt_module_set_position_order_row(@mod, param[0], param[1])
+        else
+          openmpt_module_set_position_seconds(@mod, param)
+        end
+      end
+
+      def metadata_keys
+        ptr = openmpt_module_get_metadata_keys(@mod)
+        str = ptr.read_string
+        openmpt_free_string(ptr)
+
+        str.split(';').map(&:to_sym)
+      end
+
       def metadata(key)
-        return if closed? || !METADATA_KEYS.include?(key)
-        get_openmpt_string(:openmpt_module_get_metadata, key.to_s)
+        return if closed? || !metadata_keys.include?(key)
+
+        ptr = openmpt_module_get_metadata(@mod, key.to_s)
+        str = ptr.read_string
+        openmpt_free_string(ptr)
+
+        str
       end
 
       def gain
@@ -150,6 +170,14 @@ module FFI
         )
       end
 
+      def read_mono(frames, buffer)
+        openmpt_module_read_mono(@mod, @sample_rate, frames, buffer)
+      end
+
+      def read_float_mono(frames, buffer)
+        openmpt_module_read_float_mono(@mod, @sample_rate, frames, buffer)
+      end
+
       def read_stereo(frames, left, right)
         openmpt_module_read_stereo(@mod, @sample_rate, frames, left, right)
       end
@@ -187,7 +215,7 @@ module FFI
       end
 
       def respond_to_missing?(name, *all)
-        METADATA_KEYS.include?(name) || super
+        metadata_keys.include?(name) || super
       end
 
       private
@@ -203,14 +231,6 @@ module FFI
         @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

@@ -15,14 +15,6 @@ module FFI
       [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)
@@ -32,8 +24,7 @@ module FFI
     end
 
     def self.extension_supported?(ext)
-      supported = API.openmpt_is_extension_supported(ext.to_s)
-      supported == 1
+      API.openmpt_is_extension_supported(ext.to_s) == 1
     end
 
     def self.transient_error?(error)

data/lib/ffi/openmpt/string.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2018 Robert Haines.
+#
+# Licensed under the BSD License. See LICENCE for details.
+
+module FFI
+  module OpenMPT
+    module String
+      KEYS = [
+        :library_version,
+        :library_version_major,
+        :library_version_minor,
+        :library_version_patch,
+        :library_version_prerel,
+        :library_version_is_release,
+        :library_features,
+        :core_version,
+        :source_url,
+        :source_date,
+        :source_revision,
+        :source_is_modified,
+        :source_has_mixed_revisions,
+        :source_is_package,
+        :build,
+        :build_compiler,
+        :credits,
+        :contact,
+        :license,
+        :url,
+        :support_forum_url,
+        :bugtracker_url
+      ].freeze
+
+      def self.get(key)
+        ptr = API.openmpt_get_string(key.to_s)
+        str = ptr.read_string
+        API.openmpt_free_string(ptr)
+
+        str
+      end
+
+      def self.method_missing(name, *args)
+        respond_to?(name) ? get(name) : super
+      end
+
+      def self.respond_to_missing?(name, *all)
+        KEYS.include?(name) || super
+      end
+    end
+  end
+end

data/lib/ffi/openmpt/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ffi-openmpt
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Robert Haines
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-02 00:00:00.000000000 Z
+date: 2019-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -94,7 +94,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.54'
-description: libopenmpt is a library to render tracker music (MOD, XM, S3M, IT MPTM
+description: libopenmpt is a library to render tracker music (MOD, XM, S3M, IT, MPTM
   and dozens of other legacy formats) to a PCM audio stream. See https://openmpt.org/
   for more information.
 email:
@@ -125,6 +125,7 @@ files:
 - lib/ffi/openmpt/api.rb
 - lib/ffi/openmpt/module.rb
 - lib/ffi/openmpt/openmpt.rb
+- lib/ffi/openmpt/string.rb
 - lib/ffi/openmpt/version.rb
 homepage: https://github.com/hainesr/ffi-openmpt
 licenses: