mp3gain 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2a58ef2ba5e808b606ae88b2d25ea56f3542fb4be85b93fddef2388262e8850c
+  data.tar.gz: fc19bc89f6c31b3cd9911d3b2cd917665f04661ea503d8ba7092ef31872f96c4
+SHA512:
+  metadata.gz: 503b57473afbb6b74a336a5435d3ed7e6b3ad31e1655a1c6054b52fb263b7ec5cad31690ce624944380276483e337f094af4cc9313884b64dd824a728d74b9ff
+  data.tar.gz: 15f99a78ae1cd832e3baa70dccd628864ff0fbe49b4d7c382676a11473161852594677002002062faecff1edaa2839db0069f4365c5cbd940ad1e88a824a3803

data/.gitignore

@@ -0,0 +1,56 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/.rubocop.yml

@@ -0,0 +1,14 @@
+Metrics/ParameterLists:
+  Enabled: false
+Layout/EmptyLinesAroundClassBody:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mp3gain.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+
+gem 'minitest', '~> 5.0'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Christian Feier
+
+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,44 @@
+# RubyMp3gain
+
+RubyMP3Gain is an [Mp3Gain](http://mp3gain.sourceforge.net/) wrapper written in Ruby.
+
+## Installation
+
+```shell
+gem build mp3gain.gemspec
+```
+And then execute:
+```shell
+$ gem install mp3gain-1.0.0.gem
+```
+Or from ruby gems using
+or
+```shell
+gem install mp3gain
+```
+
+## Usage
+
+```ruby
+require 'mp3gain'
+mp3gain = Mp3gain.init("path/to/MP3Gain/binary")
+## optional target db and preserve timestamps
+mp3gain = Mp3gain.init("aacgain", 100, preserve_timestamp: false)
+
+# print current version
+mp3gain.version 
+# analyze the gain of the given files
+mp3gain.analyze_gain(['path/to/file1', 'path/to/file2'])
+# delete stored tag infos of the given files
+mp3gain.delete_stored_tag_info(['path/to/file1', 'path/to/file2'])
+# apply track gain depending on the provided target DB
+mp3gain.apply_track_gain(['path/to/file1', 'path/to/file2'])
+# apply album gain depending on the provided target DB
+mp3gain.apply_album_gain(['path/to/file1', 'path/to/file2'])
+# apply the given gain 
+mp3gain.add_gain(['path/to/file1', 'path/to/file2'], 5)
+```
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/lib/mp3gain/add_gain_change.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Mp3gain
+  # data Object when gain is added
+  class AddGainChange
+
+    def initialize(file_path, gain_change)
+      @file_path = file_path
+      @gain_change = gain_change
+    end
+  end
+end

data/lib/mp3gain/apply_gain_change.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Mp3gain
+  # data object when gain is applied
+  class ApplyGainChange
+
+    attr_reader :file_path, :mp3_gain, :db_gain, :max_amplitude, :max_global_gain, :min_global_gain
+
+    def initialize(file_path, mp3_gain, db_gain, max_amplitude, max_global_gain, min_global_gain)
+      @file_path = file_path
+      @mp3_gain = mp3_gain
+      @db_gain = db_gain
+      @max_amplitude = max_amplitude
+      @max_global_gain = max_global_gain
+      @min_global_gain = min_global_gain
+    end
+
+    def clipping?
+      # if > 31000 -> clipping
+      @max_amplitude > 31_000
+    end
+  end
+end

data/lib/mp3gain/recommended_gain_change.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Mp3gain
+  # data object for the recommended gain change
+  class RecommendedGainChange
+
+    attr_reader :file_path, :track_mp3_gain, :track_db_gain, :max_amplitude, :max_global_gain
+    attr_accessor :album_changes
+
+    def initialize(file_path, track_mp3_gain, track_db_gain, max_amplitude, max_global_gain, min_global_gain)
+      @file_path = file_path
+      @track_mp3_gain = track_mp3_gain
+      @track_db_gain = track_db_gain
+      @max_amplitude = max_amplitude
+      @max_global_gain = max_global_gain
+      @min_global_gain = min_global_gain
+      @album_changes = nil
+    end
+
+    def clipping?
+      # if > 31000 -> clipping
+      @max_amplitude > 31_000
+    end
+  end
+end

data/lib/mp3gain.rb

@@ -0,0 +1,217 @@
+# frozen_string_literal: true
+
+require 'open3'
+
+require 'mp3gain/add_gain_change'
+require 'mp3gain/apply_gain_change'
+require 'mp3gain/recommended_gain_change'
+
+# wrapper for mp3gain http://mp3gain.sourceforge.net/
+module Mp3gain
+
+  def self.init(mp3gain_path,
+                target_db = 89,
+                preserve_timestamp: true)
+    Mp3gain.new(mp3gain_path, target_db, preserve_timestamp)
+  end
+
+  # Mp3gain entity to analyze and apply gain
+  class Mp3gain
+
+    MAX_FILES = 15
+
+    # constructor
+    #
+    # @param [String] mp3gain_path - path to mp3gain binary
+    # @param [Integer] target_db - the target db, default is 89 for mp3gain
+    # @param [Boolean] preserve_timestamp - keeps the existing timestamps when changing gain
+    def initialize(mp3gain_path,
+                   target_db = 89,
+                   preserve_timestamp = true)
+      @mp3gain_path = mp3gain_path
+      @target_db = target_db
+      @preserve_timestamp = preserve_timestamp
+    end
+
+    # returns the version of mp3gain
+    #
+    # @return the version as a String, e.g. 1.4.7
+    def version
+      cmd = [@mp3gain_path, '-v']
+
+      status, result = nil
+      Open3.popen3(*cmd) do |_, _, stderr, thread|
+        while (line = stderr.gets)
+          result = line.split.last
+        end
+
+        status = thread.value
+      end
+
+      throw RuntimeError.new('Could not determine version.') if status != 0 || result.nil?
+
+      result
+    end
+
+    # deletes the stored tag infos of the given files
+    #
+    # @param [Array<String>] files - given files
+    #
+    # @return [Boolean] true if deleted, else false
+    def delete_stored_tag_info(files)
+      file_size?(files)
+
+      cmd = [@mp3gain_path, '-s', 'd']
+      cmd << '-p' if @preserve_timestamp
+      cmd += files
+
+      status = nil
+      Open3.popen3(*cmd) do |_, _, _, thread|
+        status = thread.value
+      end
+
+      # rubocop:disable Style/NumericPredicate
+      status == 0
+      # rubocop:enable Style/NumericPredicate
+    end
+
+    # applies  the track gain to the given files
+    #
+    # @param [Array<String>] files - the given files
+    # @param [Boolean] until_no_clipping - ignores clipping warnings if false, otherwise stops if clipping occurred
+    #
+    # @return [Array<ApplyGainChange>] list of ApplyGainChange items
+    def apply_track_gain(files, until_no_clipping: false)
+      file_size?(files)
+
+      cmd = [@mp3gain_path, '-r', '-o', '-c']
+      cmd << '-p' if @preserve_timestamp
+      cmd << '-k' if until_no_clipping
+      cmd << '-d' << (@target_db - 89).to_s if !until_no_clipping && @target_db != 89
+      cmd += files
+
+      apply_gain(cmd)
+    end
+
+    # applies  the album gain to the given files
+    #
+    # @param [Array<String>] files - the given files
+    # @param [Boolean] until_no_clipping - ignores clipping warnings if false, otherwise stops if clipping occurred
+    #
+    # @return [Array<ApplyGainChange>] list of ApplyGainChange items
+    def apply_album_gain(files, until_no_clipping: false)
+      file_size?(files)
+
+      cmd = [@mp3gain_path, '-a', '-o', '-c']
+      cmd << '-p' if @preserve_timestamp
+      cmd << '-k' if until_no_clipping
+      cmd << '-d' << (@target_db - 89).to_s if !until_no_clipping && @target_db != 89
+      cmd += files
+
+      apply_gain(cmd)
+    end
+
+    # analyzes the given files and recommends the gain changes that should be applied
+    #
+    # @param [Array<String>] files - the given files to analyze
+    #
+    # @return [Array<RecommendGainChange>] a list oaf RecommendedGainChange items
+    def analyze_gain(files)
+      file_size?(files)
+
+      cmd = [@mp3gain_path, '-s', 'r', '-o']
+      cmd << '-p' if @preserve_timestamp
+      cmd << '-d' << (@target_db - 89).to_s if @target_db != 89
+      cmd += files
+
+      status = nil
+      result = []
+      album_changes = nil
+      Open3.popen3(*cmd) do |_, stdout, _, thread|
+        while (line = stdout.gets)
+          entries = line.strip.split("\t")
+          next if entries.length != 6 || entries[0] == 'File'
+
+          if entries[0] == '"Album"'
+            album_changes = RecommendedGainChange.new(nil, entries[1].to_i, entries[2].to_f, entries[3].to_f,
+                                                      entries[4].to_i, entries[5].to_i)
+            next
+          end
+
+          result << RecommendedGainChange.new(entries[0], entries[1].to_i, entries[2].to_f, entries[3].to_f,
+                                              entries[4].to_i, entries[5].to_i)
+        end
+
+        status = thread.value
+      end
+
+      throw RuntimeError.new('Could not analyze gain.') if status != 0
+
+      # apply album changes
+      result.each { |it| it.album_changes = album_changes }
+
+      result
+    end
+
+    # adds the specified gain to the given files
+    #
+    # @param [Array<String>] files - the given files
+    # @param [Integer] gain - the gain to add to each file
+    #
+    # @return [Array<AddGainChange>] a list of AddGain items
+    def add_gain(files, gain)
+      cmd = [@mp3gain_path, '-g', gain.to_s]
+      cmd << '-p' if @preserve_timestamp
+      cmd += files
+
+      status = nil
+      Open3.popen3(*cmd) do |_, _, _, thread|
+        status = thread.value
+      end
+
+      throw RuntimeError.new('Could not apply gain.') if status != 0
+
+      files.map { |file| AddGainChange.new(file, gain) }
+    end
+
+    # helper method to apply gain changes by executing the given command and parsing the output
+    #
+    # @param [Array<String>] cmd - the command to execute
+    #
+    # @return [Array<ApplyGainChange>] a list of ApplyGainChange items containing the change for each file
+    def apply_gain(cmd)
+      status = nil
+      result = []
+      Open3.popen3(*cmd) do |_, stdout, _, thread|
+        while (line = stdout.gets)
+          entries = line.strip.split("\t")
+          next if entries.length != 6 || entries[0] == 'File' || entries[0] == '"Album"'
+
+          result << ApplyGainChange.new(entries[0], entries[1].to_i, entries[2].to_f, entries[3].to_f,
+                                        entries[4].to_i, entries[5].to_i)
+        end
+
+        status = thread.value
+      end
+
+      throw RuntimeError.new('Could not apply gain.') if status != 0
+
+      result
+    end
+
+    # checks if the given list of files has less than 15 elements
+    #
+    # @param [Array<String>] files - given files
+    #
+    # @return [Boolean] true if size is ok, else false
+    def file_size?(files)
+      # rubocop:disable Style/GuardClause
+      if MAX_FILES < files.length
+        throw ArgumentError.new("Only max #{MAX_FILES} can be processed at once. Found #{files.length}")
+      end
+      # rubocop:enable Style/GuardClause
+    end
+
+    private :apply_gain, :file_size?
+  end
+end

data/mp3gain.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mp3gain'
+  spec.version       = '1.0.0'
+  spec.authors       = ['Christian Feier']
+  spec.email         = ['christian.feier@gmail.com']
+
+  spec.summary       = 'Simple wrapper for some common mp3gain console commands.'
+  spec.description   = 'Takes mp3gain/aacgain binary path as an argument and offers methods to analyze and modify the'\
+                       ' track/album gain of mp3 files.'
+  spec.homepage      = 'https://github.com/cfe86/RubyMp3gain'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 2.5.0'
+
+  spec.metadata['homepage_uri'] = 'https://github.com/cfe86/RubyMp3gain'
+  spec.metadata['source_code_uri'] = 'https://github.com/cfe86/RubyMp3gain'
+  spec.metadata['changelog_uri'] = 'https://github.com/cfe86/RubyMp3gain'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: mp3gain
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Christian Feier
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-11-13 00:00:00.000000000 Z
+dependencies: []
+description: Takes mp3gain/aacgain binary path as an argument and offers methods to
+  analyze and modify the track/album gain of mp3 files.
+email:
+- christian.feier@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/.DS_Store
+- lib/mp3gain.rb
+- lib/mp3gain/add_gain_change.rb
+- lib/mp3gain/apply_gain_change.rb
+- lib/mp3gain/recommended_gain_change.rb
+- mp3gain.gemspec
+homepage: https://github.com/cfe86/RubyMp3gain
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/cfe86/RubyMp3gain
+  source_code_uri: https://github.com/cfe86/RubyMp3gain
+  changelog_uri: https://github.com/cfe86/RubyMp3gain
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Simple wrapper for some common mp3gain console commands.
+test_files: []