ffi-openmpt 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cff9c1335f501d6c4567b5f3fd9f314413426608f2fd83ff43c40cd8ac3430d5
-  data.tar.gz: 6bc3d44745d502705a18b8b85bf6608ac94f9315ed4dcfb4b8bf56f048462709
+  metadata.gz: 5d30e0517446c3cf2bfabeefd2d7b3ec0db4485a27a8ee6564a854826c5a5e90
+  data.tar.gz: eb85f0fc61a052cfc7d032634a3229d4527d1579931d67e3e23c1ed1b658e8b1
 SHA512:
-  metadata.gz: 39aa9577df5787ffb062a2a0045e4fc2f374343a32246f6f383bcfde63ad7722c3b99b01f0affe244e68973c80a59905a95c3339865f2ed9f74dd7cfd730a504
-  data.tar.gz: 72e57d5e865ab26e44b72727b9bb2a05a05b930a4c5a4155fbdcb753c07c965647a32d1abf4565a18ee95ea9e3581ea57df4d294182982a2dfda9685440ca690
+  metadata.gz: ef774fbdfa2c3c80d39dee216fdf09ad894a79a8f6f1895c09101460c622239d5257cdf046bb790f097f4bf7350aa234739e1ffe7fd73e993a7910e7b90f2167
+  data.tar.gz: 26f6137c8f81ea90c1ebe205ed8fa2686c022d5b959d828275a323fc5116ef0b60073b6b1de7ca7fc6b59cd0d06af5eb91c035a57496a399fe0765757c6f5cdf

data/.travis.yml

@@ -4,15 +4,15 @@ language: ruby
 cache: bundler
 
 before_install:
-  - gem install bundler -v 1.16.1
+  - gem install bundler -v 2.0.1
   - ./test/install-libopenmpt.sh
   - export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$TRAVIS_BUILD_DIR/usr/lib
 
 rvm:
-  - 2.2.10
   - 2.3.8
   - 2.4.5
-  - 2.5.3
+  - 2.5.5
+  - 2.6.2
   - rbx-3
   - ruby-head
 
@@ -29,7 +29,5 @@ matrix:
   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,29 @@
 # Changes log for the Ruby OpenMPT library (ffi-openmpt)
 
+## Version 0.4.0
+
+* Update the minimum ruby version to 2.3.
+* Update to use bundler 2.0.1.
+* Update the string example in README.md.
+* Simplify the API string code example.
+* Add sample_name to the ruby interface.
+* Align info method names with the C++ API.
+* Ensure memory is always freed in String::get.
+* Ensure memory is always freed in Module methods.
+* Ensure memory is always freed in OpenMPT methods.
+* Update the memory handling code example in the README.
+* Use `warn` not `puts` for error messages in mod-2-raw.
+* Fix wording of an error message in mod-2-raw.
+* Add Module#sample_names to the ruby interface.
+* Add a note in Module::new about MemoryPointer.
+* Remove Module#sample_name. It's not in the C++ API.
+* Generalize getting name lists from a mod.
+* Add Module#instrument_names to the ruby interface.
+* Add Module#pattern_names to the ruby interface.
+* Add Module#order_names to the ruby interface.
+* Add Module#channel_names to the ruby interface.
+* Add Module#subsong_names to the ruby interface.
+
 ## Version 0.3.0
 
 * Wrap the libopenmpt module read mono functions.

data/README.md

@@ -55,17 +55,20 @@ Not all `libopenmpt` methods are wrapped yet, but enough functionality is suppli
 `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
-ptr = openmpt_get_string('url')
-str = ptr.read_string
-openmpt_free_string(ptr)
+begin
+  ptr = FFI::OpenMPT::API.openmpt_get_string('url')
+  str = ptr.read_string
+ensure
+  FFI::OpenMPT::API.openmpt_free_string(ptr)
+end
+
 puts str
 ```
 
 The ruby interface handles all this for you:
 
 ```ruby
-str = FFI::OpenMPT.string(:url)
+str = FFI::OpenMPT::String.get(:url)
 puts str
 ```
 
@@ -127,7 +130,7 @@ Until this library reaches version 1.0.0 the API may be subject to breaking chan
 
 The Ruby OpenMPT code (ffi-openmpt) is released under the BSD licence.
 
-Copyright (c) 2018, Robert Haines
+Copyright (c) 2018, 2019 Robert Haines
 All rights reserved.
 
 See LICENCE for more details.

data/examples/mod-2-raw

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-# Copyright (c) 2018 Robert Haines.
+# Copyright (c) 2018, 2019 Robert Haines.
 #
 # Licensed under the BSD License. See LICENCE for details.
 
@@ -9,7 +9,7 @@ require 'ffi/openmpt'
 
 def get_filename(var)
   if var.nil?
-    puts 'Please supply a filename to interrogate.'
+    warn 'Please supply a filename to convert.'
     exit(1)
   end
 
@@ -28,13 +28,13 @@ end
 
 # Does this file exist? Is it readable?
 unless ::File.readable?(mod_path)
-  puts "'#{mod_path}' does not exist, or is not readable."
+  warn "'#{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?'
+  warn 'libopenmpt can not open this file. Are you sure it is a mod?'
   exit(1)
 end
 

data/examples/mod-info

@@ -45,10 +45,10 @@ end
   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}"
+  puts "Subsongs...: #{mod.num_subsongs}"
+  puts "Channels...: #{mod.num_channels}"
+  puts "Orders.....: #{mod.num_orders}"
+  puts "Patterns...: #{mod.num_patterns}"
+  puts "Instruments: #{mod.num_instruments}"
+  puts "Samples....: #{mod.num_samples}"
 end

data/ffi-openmpt.gemspec

@@ -28,11 +28,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.2.0'
+  spec.required_ruby_version = '>= 2.3.0'
 
   spec.add_runtime_dependency 'ffi', '~> 1.9'
 
-  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'bundler', '~> 2.0.1'
   spec.add_development_dependency 'coveralls', '~> 0.8'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'rake', '~> 10.0'

data/lib/ffi/openmpt/module.rb

@@ -19,6 +19,7 @@ module FFI
 
         # Allocate a reusable single int buffer.
         # This is for use by the 'get_render_params'-type calls.
+        # FFI::MemoryPointer is garbage collected automatically.
         @int_value = ::FFI::MemoryPointer.new(:int, 1)
       end
 
@@ -45,36 +46,60 @@ module FFI
         openmpt_module_get_duration_seconds(@mod)
       end
 
-      def subsongs
+      def num_subsongs
         return if closed?
         openmpt_module_get_num_subsongs(@mod)
       end
 
-      def channels
+      def subsong_names
+        get_names(num_subsongs, :openmpt_module_get_subsong_name)
+      end
+
+      def num_channels
         return if closed?
         openmpt_module_get_num_channels(@mod)
       end
 
-      def orders
+      def channel_names
+        get_names(num_channels, :openmpt_module_get_channel_name)
+      end
+
+      def num_orders
         return if closed?
         openmpt_module_get_num_orders(@mod)
       end
 
-      def patterns
+      def order_names
+        get_names(num_orders, :openmpt_module_get_order_name)
+      end
+
+      def num_patterns
         return if closed?
         openmpt_module_get_num_patterns(@mod)
       end
 
-      def instruments
+      def pattern_names
+        get_names(num_patterns, :openmpt_module_get_pattern_name)
+      end
+
+      def num_instruments
         return if closed?
         openmpt_module_get_num_instruments(@mod)
       end
 
-      def samples
+      def instrument_names
+        get_names(num_instruments, :openmpt_module_get_instrument_name)
+      end
+
+      def num_samples
         return if closed?
         openmpt_module_get_num_samples(@mod)
       end
 
+      def sample_names
+        get_names(num_samples, :openmpt_module_get_sample_name)
+      end
+
       def repeat_count
         openmpt_module_get_repeat_count(@mod)
       end
@@ -98,20 +123,18 @@ module FFI
 
       def metadata_keys
         ptr = openmpt_module_get_metadata_keys(@mod)
-        str = ptr.read_string
+        ptr.read_string.split(';').map(&:to_sym)
+      ensure
         openmpt_free_string(ptr)
-
-        str.split(';').map(&:to_sym)
       end
 
       def metadata(key)
         return if closed? || !metadata_keys.include?(key)
 
         ptr = openmpt_module_get_metadata(@mod, key.to_s)
-        str = ptr.read_string
+        ptr.read_string
+      ensure
         openmpt_free_string(ptr)
-
-        str
       end
 
       def gain
@@ -231,6 +254,15 @@ module FFI
         @closed = (mod.address == 0)
         mod
       end
+
+      def get_names(num, get)
+        (0...num).reduce([]) do |acc, i|
+          ptr = send(get, @mod, i)
+          acc << ptr.read_string
+        ensure
+          openmpt_free_string(ptr)
+        end
+      end
     end
   end
 end

data/lib/ffi/openmpt/openmpt.rb

@@ -17,10 +17,9 @@ module FFI
 
     def self.supported_extensions
       ptr = API.openmpt_get_supported_extensions
-      exts = ptr.read_string.split(';').map(&:to_sym)
+      ptr.read_string.split(';').map(&:to_sym)
+    ensure
       API.openmpt_free_string(ptr)
-
-      exts
     end
 
     def self.extension_supported?(ext)
@@ -33,10 +32,9 @@ module FFI
 
     def self.error_string(error)
       ptr = API.openmpt_error_string(error)
-      str = ptr.read_string
+      ptr.read_string
+    ensure
       API.openmpt_free_string(ptr)
-
-      str
     end
 
     def self.probe_file(filename)

data/lib/ffi/openmpt/string.rb

@@ -34,10 +34,9 @@ module FFI
 
       def self.get(key)
         ptr = API.openmpt_get_string(key.to_s)
-        str = ptr.read_string
+        ptr.read_string
+      ensure
         API.openmpt_free_string(ptr)
-
-        str
       end
 
       def self.method_missing(name, *args)

data/lib/ffi/openmpt/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ffi-openmpt
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Robert Haines
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-24 00:00:00.000000000 Z
+date: 2019-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.0.1
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -139,7 +139,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="