autoeq_loader 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 346a6e9bed32516e67ec52fd7123d6023548e11dbe4bbbfc9295e07b227766c1
+  data.tar.gz: a5339c5c4445c26093c7ad78e1204dffe8688bcc84552d6bcc0ced67bbf2e5f0
+SHA512:
+  metadata.gz: 60f4c8c38347d0f1155fed40cfbe03fe2a09c51d4a4564b074e82550075b00981658cdb0f8bb76fa1e3f63ddf7ebb200ee5c2aee07c8ca1e381dae7e820e3a6a
+  data.tar.gz: b45151fa222fc2892aac9afa4eaaf47304bb3da09fbd5251d41e737e3abfcbf4202cb58727a2de26cf06433d769890a2fc45dfb3374a7bc6e63a2a74d118c69f

data/.gitignore

@@ -0,0 +1,9 @@
+/Gemfile.lock
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 John Labovitz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,74 @@
+# AutoEQ::Loader
+
+This is a Ruby gem that works with the collection of headphone equalizations generated by the [AutoEQ](https://autoeq.app) project. With the gem, you can load the full set of equalizations, find one or more equalizations by name, and generate **audio filter** strings. These strings can then be used with projects like [MPV](https://mpv.io), [FFmpeg](https://ffmpeg.org), or other projects that use [libavfilter](https://ffmpeg.org/libavfilter.html) to process audio. Canonical information about filters can be found at [FFmpeg Filters Documentation](https://ffmpeg.org/ffmpeg-filters.html).
+
+You will need to have AutoEQ's `results` directory stored somewhere on your system. You can get it by cloning the [AutoEQ Git repository](https://github.com/jaakkopasanen/AutoEq) or by downloading one of the [releases](https://github.com/jaakkopasanen/AutoEq/tags). Then you will find the `results` directory in the top level. Consult the [README file](https://github.com/jaakkopasanen/AutoEq/blob/master/results/README.md) there for details on the results.
+
+This gem uses the `ParametricEQ.txt` files from the `results` directory, each of which contain:
+
+- A relative volume (aka 'preamp') to adjust the audio, to compensate for equalizations that effectively change the overall volume.
+- One or more EQ filters that describe the type, frequency, gain, and width of a particular equalization to apply.
+
+The `load_equalizers` class method returns an array of equalizers found in the specified directory, each of which has a name derived from the filename. There's no attempt to interpret or modify the names, so it's best to consult the original files if you're unsure of the naming conventions.
+
+An equalizer is converted to an audio filter string simply by calling its `#to_s` method, or by interpreting it a string context that will implicitly call `#to_s`. A filter string looks like this:
+
+```
+volume=-3.8dB,equalizer=f=105:g=1.4:w=0.7:t=q,equalizer=f=8313:g=2.9:w=1.52:t=q,equalizer=f=126:g=-2.0:w=0.83:t=q,equalizer=f=3198:g=3.4:w=2.66:t=q,equalizer=f=2019:g=-2.0:w=1.8:t=q,equalizer=f=10000:g=-5.2:w=0.7:t=q,equalizer=f=529:g=-1.0:w=1.59:t=q,equalizer=f=1042:g=1.1:w=2.59:t=q,equalizer=f=5337:g=-1.5:w=4.59:t=q,equalizer=f=6646:g=2.8:w=5.93:t=q
+```
+
+The actual EQ file for each equalizer is loaded lazily, only when the `#to_s` method is called.
+
+The `#to_s` method has one optional parameter: a boolean to indicate whether the equalizer should be enabled or not. If enabled (the default), then both a volume filter and an equalizer filter is returned. If disabled, only the volume filter is returned. This is to handle cases where an equalizer may be toggled off or on, but maintain the overall volume level.
+
+
+## Installation
+
+Install the gem and add to your application's `Gemfile` by executing:
+
+    $ bundle add autoeq_loader
+
+If Bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install autoeq_loader
+
+
+## Usage
+
+```ruby
+require 'autoeq_loader'
+
+# load the equalizers
+equalizers = AutoEQLoader.load_equalizers('~/src/AutoEQ/results')
+
+# find an equalizer for the FiiO FH7 headphones
+eq = equalizers.find { |e| e.name =~ /fh7/i }
+
+# show its name
+puts eq.name
+
+# run MPV with the filter
+system(
+  'mpv',
+  "--af=#{eq.to_s}",
+  'my-music-file.mp4')
+```
+
+See the [`examples`](examples) directory for more.
+
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake test` to run the tests.
+
+To release a new version, update the version number in `autoeq-loader.gemspec`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jslabovitz/autoeq_loader.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+Bundler.require
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/*_test.rb']
+end
+
+task :default => :test

data/autoeq-loader.gemspec

@@ -0,0 +1,21 @@
+Gem::Specification.new do |s|
+  s.name          = 'autoeq_loader'
+  s.version       = '0.1'
+  s.author        = 'John Labovitz'
+  s.email         = 'johnl@johnlabovitz.com'
+
+  s.summary       = %q{Loads AutoEQ measurements and makes audio filters}
+  s.description   = %q{AutoEQLoader loads AutoEQ measurements and makes audio filters.}
+  s.homepage      = 'http://github.com/jslabovitz/autoeq_loader'
+  s.license       = 'MIT'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_path  = 'lib'
+
+  s.add_development_dependency 'bundler', '~> 2.4'
+  s.add_development_dependency 'minitest', '~> 5.18'
+  s.add_development_dependency 'minitest-power_assert', '~> 0.3'
+  s.add_development_dependency 'rake', '~> 13.0'
+end

data/examples/readme.rb

@@ -0,0 +1,16 @@
+require 'autoeq_loader'
+
+# load the equalizers
+equalizers = AutoEQLoader.load_equalizers('~/src/AutoEQ/results')
+
+# find an equalizer for the FiiO FH7 headphones
+eq = equalizers.find { |e| e.name =~ /fh7/i }
+
+# show its name
+puts eq.name
+
+# run MPV with the filter
+system(
+  'mpv',
+  "--af=#{eq.to_s}",
+  'my-music-file.mp4')

data/examples/show-all.rb

@@ -0,0 +1,9 @@
+require 'autoeq_loader'
+
+equalizers = AutoEQLoader.load_equalizers('~/src/AutoEQ/results')
+
+equalizers.each do |eq|
+  puts eq.name
+  puts eq
+  puts
+end

data/lib/autoeq_loader.rb

@@ -0,0 +1,63 @@
+class AutoEQLoader
+
+  attr_reader :name
+
+  def self.load_equalizers(dir)
+    dir = File.expand_path(dir)
+    Dir.glob('**/*ParametricEQ.txt', base: dir, sort: false).map do |file|
+      new(File.join(dir, file))
+    end.sort
+  end
+
+  def initialize(file)
+    @file = file
+    @name = File.basename(File.dirname(file))
+    @volume_filter = @equalizer_filters = nil
+  end
+
+  def load
+    @volume_filter = VolumeFilter.new(0.0)
+    @equalizer_filters = []
+    File.open(@file) do |io|
+      io.readlines.map { |l| l.sub(/#.*/, '') }.map(&:strip).reject(&:empty?).each do |line|
+        case line
+        when /^Preamp: ([-.\d]+) dB$/
+          @volume_filter = VolumeFilter.new($1.to_f)
+        when /^Filter \d+: ON .+? Fc (\d+) Hz Gain ([-.\d]+) dB Q ([-.\d]+)$/
+          @equalizer_filters << ParametricEqualizerFilter.new($1.to_i, $2.to_f, $3.to_f, 'q')
+        else
+          warn "#{@file}: Ignoring unknown eq line: #{line.inspect}"
+        end
+      end
+    end
+  end
+
+  def <=>(other)
+    @name <=> other.name
+  end
+
+  def to_s(enabled=true)
+    load unless @volume_filter
+    [
+      @volume_filter,
+      enabled ? @equalizer_filters : nil,
+    ].flatten.compact.map(&:to_s).join(',')
+  end
+
+  class VolumeFilter < Struct.new(:volume)
+
+    def to_s
+      "volume=#{volume}dB"
+    end
+
+  end
+
+  class ParametricEqualizerFilter < Struct.new(:f, :g, :w, :t)
+
+    def to_s
+      "equalizer=%s" % %w[f g w t].map { |k| '%s=%s' % [k, send(k)] }.join(':')
+    end
+
+  end
+
+end

data/test/autoeq_test.rb

@@ -0,0 +1,47 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
+
+require 'minitest/autorun'
+require 'minitest/power_assert'
+
+require 'autoeq_loader'
+
+class AutoEQLoader
+
+  class Test < MiniTest::Test
+
+    SourceDir = '~/src/AutoEQ/results'
+
+    def setup
+      @equalizers = AutoEQLoader.load_equalizers(SourceDir)
+      @eq = @equalizers.find { |e| e.name =~ /fh7/i }
+    end
+
+    def test_load
+      assert { @equalizers }
+      assert { !@equalizers.empty? }
+    end
+
+    def test_find
+      assert { @eq }
+      assert { @eq.name == 'FiiO FH7' }
+    end
+
+    def test_enabled
+      assert { @eq }
+      filter = @eq.to_s
+      assert { filter =~ /^volume=[\-\.\d+]+dB,equalizer=f/ }
+    end
+
+    def test_disabled
+      assert { @eq }
+      filter = @eq.to_s(false)
+      assert { filter =~ /^volume=[\-\.\d+]+dB$/ }
+    end
+
+    def test_load_all
+      @equalizers.map(&:load)
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: autoeq_loader
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- John Labovitz
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.18'
+- !ruby/object:Gem::Dependency
+  name: minitest-power_assert
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: AutoEQLoader loads AutoEQ measurements and makes audio filters.
+email: johnl@johnlabovitz.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- autoeq-loader.gemspec
+- examples/readme.rb
+- examples/show-all.rb
+- lib/autoeq_loader.rb
+- test/autoeq_test.rb
+homepage: http://github.com/jslabovitz/autoeq_loader
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.13
+signing_key:
+specification_version: 4
+summary: Loads AutoEQ measurements and makes audio filters
+test_files:
+- test/autoeq_test.rb