lamer 0.1.2 → 1.0.0

data/lib/lamer.rb

@@ -1,119 +1,250 @@
+# frozen_string_literal: true
+
+require_relative "lamer/version"
+require_relative "lamer/error"
+require_relative "lamer/ffi"
+require_relative "lamer/encoder"
+require_relative "lamer/decoder"
+
+# Lamer is a Ruby wrapper around the LAME MP3 encoder library via FFI.
 class Lamer
-  
-  # These constants come from the LAME documentation
-  MP3_Bitrates = [32, 40, 48, 56, 64, 80, 96, 112, 128, 160, 192, 224, 256, 320]
-  Sample_Rates = [8, 11.025, 12, 16, 22.05, 24, 32, 44.1, 48]
-  Encoding_Quality = (0..9)
-  VBR_Quality = (0..6)
-  Channels = {:mono => 'm', :stereo => 's', :joint => 'j', :auto => 'a', :mid_side => 'f'}
-  Replay_Gain = {:fast => "--replaygain-fast", :accurate => "--replaygain-accurate", 
-                 :none => "--noreplaygain", :clip_detect =>  "--clipdetect", :default => nil}
-
-  attr_accessor :options, :id3_options 
-  
-  def initialize
+  # Valid MP3 bitrates in kbps
+  MP3_BITRATES = [32, 40, 48, 56, 64, 80, 96, 112, 128, 160, 192, 224, 256, 320].freeze
+
+  # Valid sample rates in kHz
+  SAMPLE_RATES = [8, 11.025, 12, 16, 22.05, 24, 32, 44.1, 48].freeze
+
+  # Valid encoding quality values (0 = best/slowest, 9 = worst/fastest)
+  ENCODING_QUALITY = (0..9).freeze
+
+  # Valid VBR quality values (0 = best, 9 = worst)
+  VBR_QUALITY = (0..9).freeze
+
+  # Channel mode mappings
+  CHANNELS = {
+    mono: :mono,
+    stereo: :stereo,
+    joint: :joint_stereo,
+    auto: :joint_stereo,
+    mid_side: :dual_channel
+  }.freeze
+
+  # Replay gain options (not directly supported in FFI, kept for API compatibility)
+  REPLAY_GAIN = {
+    fast: :fast,
+    accurate: :accurate,
+    none: :none,
+    clip_detect: :clip_detect,
+    default: nil
+  }.freeze
+
+  attr_accessor :options, :id3_options
+
+  def initialize(input = nil, output = nil, **opts)
     @options = {}
+    @id3_options = nil
+    @input_file = nil
+    @output_file = nil
+
+    input_file(input) if input
+    output_file(output) if output
+
+    opts.each do |key, value|
+      case key
+      when :bitrate then bitrate(value)
+      when :sample_rate then sample_rate(value)
+      when :quality then encode_quality(value)
+      when :vbr then vbr_quality(value)
+      when :mode then mode(value)
+      when :id3 then id3(value)
+      when :highpass then highpass(value)
+      when :lowpass then lowpass(value)
+      end
+    end
+
+    yield self if block_given?
   end
-  
-  def argument_list
-    @options.delete :id3_version unless @id3_options
-    @options.collect {|k,v| v}.join(' ')
+
+  # Convenience class method for encoding
+  def self.encode(input, output, **opts, &block)
+    encoder = new(input, output, **opts, &block)
+    encoder.convert!
   end
-  
-  def command_line
-    raise ArgumentError, "No input file specified." unless @input_file
-    ['lame', argument_list, @input_file, @output_file, id3_arguments].select{|x| !(x.nil? || x.empty?)}.join(' ')
+
+  # Convenience class method for decoding
+  def self.decode(input, output)
+    decoder = new
+    decoder.decode_mp3!
+    decoder.input_file(input)
+    decoder.output_file(output)
+    decoder.decode!
   end
-  
-  def convert!
-    system command_line
+
+  # Set the output bitrate in kbps
+  def bitrate(kbps)
+    raise ArgumentError, "legal bitrates: #{MP3_BITRATES.join(', ')}" unless MP3_BITRATES.include?(kbps)
+
+    @options[:bitrate] = kbps
   end
-  
-  # methods for setting options on the encoder
-  
+
+  # Set the output sample rate in kHz
   def sample_rate(rate)
-    raise ArgumentError unless Sample_Rates.include? rate
-    @options[:sample_rate] = "--resample #{rate}"
-  end
-  
-  def bitrate(kbps)
-    raise ArgumentError, "legal bitrates: #{MP3_Bitrates.join(', ')}" unless MP3_Bitrates.include? kbps
-    @options[:bitrate] = "-b #{kbps}"
+    raise ArgumentError, "legal sample rates: #{SAMPLE_RATES.join(', ')}" unless SAMPLE_RATES.include?(rate)
+
+    @options[:out_samplerate] = (rate * 1000).to_i
   end
-  
+
+  # Set encoding quality (0 = best/slowest, 9 = worst/fastest)
+  # Also accepts :high (2) and :fast (7) as shortcuts
   def encode_quality(quality)
-    quality_keys = Hash.new { |h,k| k }.merge( { :high => 2, :fast => 7 } )
-    quality = quality_keys[quality]
-    raise ArgumentError, "legal qualities: #{Encoding_Quality.to_a.join(', ')}" unless Encoding_Quality.include? quality
-    @options[:encode_quality] = "-q #{quality}"
+    quality_map = { high: 2, fast: 7 }
+    quality = quality_map[quality] || quality
+    raise ArgumentError, "legal qualities: #{ENCODING_QUALITY.to_a.join(', ')}" unless ENCODING_QUALITY.include?(quality)
+
+    @options[:quality] = quality
   end
-  
+
+  # Set VBR quality (0 = best, 9 = worst)
   def vbr_quality(quality)
-    raise ArgumentError, "legal qualities: #{VBR_Quality.to_a.join(', ')}" unless VBR_Quality.include? quality
-    @options[:vbr_quality], @options[:vbr] = "-V #{quality}", "-v"
+    raise ArgumentError, "legal qualities: #{VBR_QUALITY.to_a.join(', ')}" unless VBR_QUALITY.include?(quality)
+
+    @options[:vbr_quality] = quality
+    @options[:vbr] = true
   end
-  
+
+  # Set channel mode (:mono, :stereo, :joint, :auto, :mid_side)
   def mode(channels)
-    @options[:mode] = Channels[channels] ? "-m #{Channels[channels]}" : nil
+    @options[:mode] = CHANNELS[channels]
   end
 
+  # Set replay gain mode (kept for API compatibility)
   def replay_gain(gain)
-    @options[:replay_gain] = Replay_Gain[gain]
+    @options[:replay_gain] = REPLAY_GAIN[gain]
   end
 
-  # options for dealing with the input and output files
-
+  # Set the input file path
   def input_file(filename)
     @input_file = filename
-    mark_as_copy! if filename =~ /\.mp3$/
+    mark_as_copy! if filename =~ /\.mp3$/i
   end
-  
+
+  # Set the output file path
   def output_file(filename)
     @output_file = filename
   end
 
-  def decode_mp3!
-    @options.clear
-    @options[:decode_mp3] = "--decode"
-  end
-  
-  def output_ogg!
-    @options[:output_ogg] = "--ogg"
-  end
-  
+  # Mark input as MP3 (for re-encoding)
   def input_mp3!
-    @options[:input_mp3] = "--mp3input"
+    @options[:input_mp3] = true
     mark_as_copy!
   end
-  
+
+  # Set input as raw PCM data
   def input_raw(sample_rate, swapbytes = false)
-    @options[:input_raw] = "-r -s #{sample_rate}#{' -x' if swapbytes}"
+    @options[:input_raw] = true
+    @options[:in_samplerate] = (sample_rate * 1000).to_i
+    @options[:swapbytes] = swapbytes
   end
-  
+
+  # Mark the output as a copy (for MP3 to MP3 encoding)
   def mark_as_copy!
-    @options[:copy] = "-o"
-  end
-  
-  # id3 options
-  
-  def id3 options 
-    @id3_options = @id3_options ? @id3_options.merge(options) : options
-  end
-  
-  def id3_arguments
-    id3_fields = { :title => 'tt', :artist => 'ta', :album => 'tl', 
-                  :year => 'ty', :comment => 'tc', :track_number => 'tn',
-                  :genre => 'tg' }
-    return nil if @id3_options.nil? || @id3_options.empty?
-    @id3_options.select{|k,v| id3_fields[k]}.collect {|k,v| "--#{id3_fields[k]} #{v}"}.join(' ')
-  end
-  
-  def id3_version_only version
-    @options[:id3_version] = "--id3v#{version}-only"
-  end
-  
+    @options[:copy] = true
+  end
+
+  # Set ID3 tag options
+  def id3(opts)
+    @id3_options = @id3_options ? @id3_options.merge(opts) : opts
+  end
+
+  # Set ID3 version (1 or 2 only)
+  def id3_version_only(version)
+    @id3_options ||= {}
+    @id3_options[:version] = version
+  end
+
+  # Add ID3v2 tags
   def id3_add_v2!
-    @options[:id3_version] = "--add-id3v2"
+    @id3_options ||= {}
+    @id3_options[:add_v2] = true
+  end
+
+  # Set highpass filter frequency in kHz
+  def highpass(width)
+    @options[:highpass] = (width * 1000).to_i
+  end
+
+  # Set lowpass filter frequency in kHz
+  def lowpass(width)
+    @options[:lowpass] = (width * 1000).to_i
+  end
+
+  # Encode the input file to MP3
+  def convert!
+    raise ArgumentError, "No input file specified." unless @input_file
+
+    encoder = Encoder.new(@options)
+    encoder.apply_id3(@id3_options) if @id3_options && !@id3_options.empty?
+
+    output = @output_file || @input_file.sub(/\.[^.]+$/, ".mp3")
+    encoder.encode_file(@input_file, output)
+
+    true
+  end
+
+  # Encode PCM samples directly to MP3 data (new capability)
+  # left_samples and right_samples are arrays of 16-bit signed integers
+  def encode_buffer(left_samples, right_samples = nil)
+    encoder = Encoder.new(@options)
+    encoder.apply_id3(@id3_options) if @id3_options && !@id3_options.empty?
+
+    result = encoder.encode_short(left_samples, right_samples)
+    result + encoder.flush
+  end
+
+  # Encode interleaved PCM samples directly to MP3 data
+  def encode_buffer_interleaved(interleaved_samples)
+    encoder = Encoder.new(@options)
+    encoder.apply_id3(@id3_options) if @id3_options && !@id3_options.empty?
+
+    result = encoder.encode_short_interleaved(interleaved_samples)
+    result + encoder.flush
+  end
+
+  # Encode float samples directly to MP3 data (new capability)
+  # samples are arrays of floats in range -1.0 to 1.0
+  def encode_float_buffer(left_samples, right_samples = nil)
+    encoder = Encoder.new(@options)
+    encoder.apply_id3(@id3_options) if @id3_options && !@id3_options.empty?
+
+    result = encoder.encode_float(left_samples, right_samples)
+    result + encoder.flush
+  end
+
+  # Get LAME library version
+  def self.lame_version
+    FFI.get_lame_version
+  end
+
+  # Set decode mode for converting MP3 to WAV
+  def decode_mp3!
+    @options.clear
+    @options[:decode_mp3] = true
+  end
+
+  # Decode an MP3 file to WAV
+  # Must call decode_mp3! first, then input_file and output_file
+  def decode!
+    raise ArgumentError, "No input file specified." unless @input_file
+    raise ConfigurationError, "Call decode_mp3! before decode!" unless @options[:decode_mp3]
+
+    decoder = Decoder.new
+    output = @output_file || @input_file.sub(/\.mp3$/i, ".wav")
+    decoder.decode_file(@input_file, output)
+  end
+
+  # Decode MP3 data to PCM samples
+  def decode_buffer(mp3_data)
+    decoder = Decoder.new
+    decoder.decode_buffer(mp3_data)
   end
-  
-end
+end

metadata

@@ -1,71 +1,67 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: lamer
-version: !ruby/object:Gem::Version 
-  version: 0.1.2
+version: !ruby/object:Gem::Version
+  version: 1.0.0
 platform: ruby
-authors: 
-- Chris Anderson
+authors:
 - Mauricio Gomes
-autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-02-09 00:00:00 -05:00
-default_executable: 
-dependencies: []
-
-description: Ruby wrapper for the LAME library. Currently wraps around the LAME executable so you can use LAME in your Ruby programs.
-email: mauricio@edge14.com
+date: 2025-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+description: Native Ruby bindings to libmp3lame via FFI. Encode audio to MP3 directly
+  from Ruby without shelling out.
+email:
+- mauricio@edge14.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files: []
+files:
 - LICENSE
 - README.md
-files: 
-- LICENSE
-- README.md
-- Rakefile
-- VERSION
-- lamer.gemspec
 - lib/lamer.rb
-- spec/decoding_spec.rb
-- spec/encoding_spec.rb
-- spec/lamer_spec.rb
-- spec/output.mp3
-- spec/spec_helper.rb
-- spec/test.mp3
-has_rdoc: true
-homepage: http://github.com/mgomes/lamer
-licenses: []
-
-post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-require_paths: 
+- lib/lamer/decoder.rb
+- lib/lamer/encoder.rb
+- lib/lamer/error.rb
+- lib/lamer/ffi.rb
+- lib/lamer/ffi/enums.rb
+- lib/lamer/ffi/functions.rb
+- lib/lamer/ffi/library.rb
+- lib/lamer/version.rb
+homepage: https://github.com/mgomes/lamer
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/mgomes/lamer
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.3.5
-signing_key: 
-specification_version: 3
-summary: Ruby wrapper for the LAME library
-test_files: 
-- spec/decoding_spec.rb
-- spec/encoding_spec.rb
-- spec/lamer_spec.rb
-- spec/spec_helper.rb
+rubygems_version: 3.6.6
+specification_version: 4
+summary: Ruby FFI bindings for the LAME MP3 encoder
+test_files: []

data/Rakefile

@@ -1,33 +0,0 @@
-require 'rubygems'
-require 'rake'
-
-begin
-	require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-		gem.name = "lamer"
-		gem.summary = "Ruby wrapper for the LAME library"
-		gem.description = "Ruby wrapper for the LAME library. Currently wraps around the LAME executable so you can use LAME in your Ruby programs."
-		gem.email = "mauricio@edge14.com"
-		gem.homepage = "http://github.com/mgomes/lamer"
-		gem.authors = ["Chris Anderson", "Mauricio Gomes"]
-	end
-	Jeweler::GemcutterTasks.new
-rescue LoadError
-	puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
-end
-
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-	spec.libs << 'lib' << 'spec'
-	spec.spec_files = FileList['spec/**/*_spec.rb']
-end
-
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-	spec.libs << 'lib' << 'spec'
-	spec.pattern = 'spec/**/*_spec.rb'
-	spec.rcov = true
-end
-
-task :spec => :check_dependencies
-
-task :default => :spec

data/VERSION

@@ -1 +0,0 @@
-0.1.2

data/lamer.gemspec

@@ -1,55 +0,0 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{lamer}
-  s.version = "0.1.2"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Chris Anderson", "Mauricio Gomes"]
-  s.date = %q{2010-02-09}
-  s.description = %q{Ruby wrapper for the LAME library. Currently wraps around the LAME executable so you can use LAME in your Ruby programs.}
-  s.email = %q{mauricio@edge14.com}
-  s.extra_rdoc_files = [
-    "LICENSE",
-     "README.md"
-  ]
-  s.files = [
-    "LICENSE",
-     "README.md",
-     "Rakefile",
-     "VERSION",
-     "lamer.gemspec",
-     "lib/lamer.rb",
-     "spec/decoding_spec.rb",
-     "spec/encoding_spec.rb",
-     "spec/lamer_spec.rb",
-     "spec/output.mp3",
-     "spec/spec_helper.rb",
-     "spec/test.mp3"
-  ]
-  s.homepage = %q{http://github.com/mgomes/lamer}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
-  s.summary = %q{Ruby wrapper for the LAME library}
-  s.test_files = [
-    "spec/decoding_spec.rb",
-     "spec/encoding_spec.rb",
-     "spec/lamer_spec.rb",
-     "spec/spec_helper.rb"
-  ]
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-    else
-    end
-  else
-  end
-end
-

data/spec/decoding_spec.rb

@@ -1,18 +0,0 @@
-require File.dirname(__FILE__) + '/spec_helper'
-
-describe "A Lamer, used for decoding," do
-	before(:each) do
-	  @la = Lamer.new
-	end
-
-	it "should decode mp3s" do
-	  @la.decode_mp3!
-	  @la.options[:decode_mp3].should == "--decode"
-	end
-
-	it "should decode mp3s without other options" do
-	  @la.vbr_quality 4
-	  @la.decode_mp3!
-	  @la.options.length.should == 1
-	end
-end