lamer 0.1.2 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6bccc9f1c692bd735c7aa5b5a05fca525b81c37d9e28cc784aa1e89f04311167
+  data.tar.gz: 3523658b60c220c13b4e5414eeb06ec65ed6a0605091f89dbeda85d8c051d4bd
+SHA512:
+  metadata.gz: 7b9206a84102cedb93bcd1380d7b2bb101ac04aaca534512bbd3914e89869809bcd7b5ce20feefd79aed5b3e142f54c247c2f7c36b90cf9191d3e28562beaa11
+  data.tar.gz: cece25de9d528db0aae546fec498decaf807c64a58f1a242d850a353cf75447b282553e7d101dc3f2524aa062c31680a751442d88aa21532d3da55f34a5fb225

data/LICENSE

@@ -1,5 +1,5 @@
-Copyright (c) 2010 Chris Anderson, Mauricio Gomes
- 
+Copyright (c) 2025 Mauricio Gomes
+
 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
@@ -7,14 +7,14 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,45 +1,237 @@
-Lamer
-=====
+# Lamer
 
-### Ruby Wrapper Around the LAME Library
+Ruby FFI bindings for the LAME MP3 encoder library.
 
-Currently the program wraps around the [LAME](http://lame.sourceforge.net/) executable and exposes the LAME
-command line options to your Ruby program. 
+Encode audio to MP3 directly from Ruby without shelling out to a command line tool. Supports encoding from WAV files, raw PCM data, or re-encoding existing MP3 files.
 
-Todo
-----
+## Requirements
 
-* Documentation
-* Wrap the LAME library as an extension to remove the binary requirements
+- Ruby 3.2 or later
+- libmp3lame library installed on your system
 
-Install
--------
+## Installation
 
-   sudo gem install lamer
+First, install the LAME library:
 
-Prerequisites
--------------
+**macOS (Homebrew)**
 
-### LAME
+```bash
+brew install lame
+```
 
-[LAME](http://lame.sourceforge.net/) is a high quality MPEG Audio Layer III (MP3) encoder licensed under the LGPL. Below is
-a list of pre-built binaries and a link to the source code.
+**Ubuntu/Debian**
 
-* [OS X](http://web.me.com/krmathis/)
-* [openSUSE](http://packman.links2linux.org/package/lame)
-* [Ubuntu](https://help.ubuntu.com/community/Medibuntu)
-* [RHEL/CentOS/Fedora ](http://atrpms.net/name/lame/)
-* [Source](http://lame.sourceforge.net/download.php)
+```bash
+sudo apt-get install libmp3lame-dev
+```
 
-Credits
--------
+**Fedora/RHEL/CentOS**
 
-This wrapper is built around the code of [lame-encoder](http://lame-encoder.rubyforge.org/) by 
-Chris Anderson.
+```bash
+sudo dnf install lame-devel
+```
 
-Authors
--------
+Then add the gem to your Gemfile:
 
-* [Chris Anderson](http://github.com/jchris)
-* [Mauricio Gomes](http://github.com/mgomes)
+```ruby
+gem 'lamer'
+```
 
+Or install it directly:
+
+```bash
+gem install lamer
+```
+
+## Quick Start
+
+```ruby
+require 'lamer'
+
+# One-liner encoding
+Lamer.encode("input.wav", "output.mp3", bitrate: 192, mode: :stereo)
+
+# One-liner decoding
+Lamer.decode("input.mp3", "output.wav")
+
+# With ID3 tags
+Lamer.encode("input.wav", "output.mp3", bitrate: 192, id3: { title: "My Song", artist: "My Artist" })
+
+# Block syntax for more control
+Lamer.encode("input.wav", "output.mp3") do |l|
+  l.bitrate(256)
+  l.vbr_quality(2)
+  l.id3(title: "My Song", artist: "My Artist", album: "My Album")
+end
+```
+
+## Usage
+
+### Basic Encoding
+
+```ruby
+require 'lamer'
+
+lamer = Lamer.new
+lamer.bitrate(128)
+lamer.input_file("audio.wav")
+lamer.output_file("audio.mp3")
+lamer.convert!
+```
+
+### VBR Encoding
+
+```ruby
+lamer = Lamer.new
+lamer.vbr_quality(2)  # 0 = best quality, 9 = smallest file
+lamer.input_file("audio.wav")
+lamer.output_file("audio.mp3")
+lamer.convert!
+```
+
+### Setting Quality and Mode
+
+```ruby
+lamer = Lamer.new
+lamer.bitrate(320)
+lamer.encode_quality(:high)  # or 0-9, where 0 is best
+lamer.mode(:stereo)          # :mono, :stereo, :joint, :auto
+lamer.input_file("audio.wav")
+lamer.output_file("audio.mp3")
+lamer.convert!
+```
+
+### ID3 Tags
+
+```ruby
+lamer = Lamer.new
+lamer.bitrate(192)
+lamer.id3(
+  title: "Song Title",
+  artist: "Artist Name",
+  album: "Album Name",
+  year: 2024,
+  track_number: 1,
+  genre: "Rock"
+)
+lamer.input_file("audio.wav")
+lamer.output_file("audio.mp3")
+lamer.convert!
+```
+
+### Re-encoding MP3 Files
+
+```ruby
+lamer = Lamer.new
+lamer.bitrate(64)
+lamer.mode(:mono)
+lamer.input_file("highquality.mp3")
+lamer.output_file("lowquality.mp3")
+lamer.convert!
+```
+
+### Decoding MP3 to WAV
+
+```ruby
+lamer = Lamer.new
+lamer.decode_mp3!
+lamer.input_file("audio.mp3")
+lamer.output_file("audio.wav")
+lamer.decode!
+```
+
+### In-Memory Encoding
+
+Encode PCM samples directly without file I/O:
+
+```ruby
+lamer = Lamer.new
+lamer.bitrate(128)
+
+# 16-bit signed integer samples
+left_channel = [0, 1000, 2000, 3000, ...]
+right_channel = [0, 1000, 2000, 3000, ...]
+
+mp3_data = lamer.encode_buffer(left_channel, right_channel)
+File.binwrite("output.mp3", mp3_data)
+```
+
+### Float Sample Encoding
+
+For audio processing pipelines that use floating point samples:
+
+```ruby
+lamer = Lamer.new
+lamer.bitrate(256)
+
+# Float samples in range -1.0 to 1.0
+left_channel = [0.0, 0.5, 1.0, 0.5, ...]
+right_channel = [0.0, 0.5, 1.0, 0.5, ...]
+
+mp3_data = lamer.encode_float_buffer(left_channel, right_channel)
+```
+
+## Available Options
+
+### Bitrate
+
+Valid bitrates in kbps: 32, 40, 48, 56, 64, 80, 96, 112, 128, 160, 192, 224, 256, 320
+
+```ruby
+lamer.bitrate(128)
+```
+
+### Sample Rate
+
+Valid sample rates in kHz: 8, 11.025, 12, 16, 22.05, 24, 32, 44.1, 48
+
+```ruby
+lamer.sample_rate(44.1)
+```
+
+### VBR Quality
+
+Values 0-9, where 0 is highest quality and 9 is smallest file size.
+
+```ruby
+lamer.vbr_quality(2)
+```
+
+### Encoding Quality
+
+Values 0-9, where 0 is slowest/best and 9 is fastest/worst. Also accepts :high (2) and :fast (7).
+
+```ruby
+lamer.encode_quality(:high)
+```
+
+### Channel Mode
+
+Available modes: :mono, :stereo, :joint, :auto, :mid_side
+
+```ruby
+lamer.mode(:joint)
+```
+
+### Filters
+
+Set highpass and lowpass filter frequencies in kHz:
+
+```ruby
+lamer.highpass(0.1)   # 100 Hz
+lamer.lowpass(16.0)   # 16 kHz
+```
+
+## Version Information
+
+```ruby
+Lamer.lame_version  # Returns the LAME library version string
+```
+
+## Author
+
+[Mauricio Gomes](http://github.com/mgomes)
+
+## License
+
+MIT License

data/lib/lamer/decoder.rb

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+
+class Lamer
+  class Decoder
+    # LAME can return up to 1152 samples per MP3 frame, but when decoding
+    # a large chunk it can return many frames worth of samples at once.
+    # Using a larger buffer to handle typical MP3 files.
+    PCM_BUFFER_SIZE = 1152 * 128
+    MP3_READ_SIZE = 16384
+
+    attr_reader :hip, :mp3data
+
+    def initialize
+      @hip = FFI.hip_decode_init
+      raise Error, "Failed to initialize HIP decoder" if @hip.null?
+
+      @mp3data = FFI::Mp3Data.new
+      @initialized = false
+
+      ObjectSpace.define_finalizer(self, self.class.release(@hip))
+    end
+
+    def self.release(hip)
+      proc { FFI.hip_decode_exit(hip) unless hip.null? }
+    end
+
+    def decode_file(input_path, output_path)
+      File.open(input_path, "rb") do |input|
+        File.open(output_path, "wb") do |output|
+          left_buf = ::FFI::MemoryPointer.new(:short, PCM_BUFFER_SIZE)
+          right_buf = ::FFI::MemoryPointer.new(:short, PCM_BUFFER_SIZE)
+          mp3_buf = ::FFI::MemoryPointer.new(:uchar, MP3_READ_SIZE)
+
+          first_frame = true
+          channels = 2
+          sample_rate = 44100
+
+          until input.eof?
+            data = input.read(MP3_READ_SIZE)
+            break if data.nil? || data.empty?
+
+            mp3_buf.put_bytes(0, data)
+
+            if first_frame
+              samples = FFI.hip_decode_headers(@hip, mp3_buf, data.bytesize, left_buf, right_buf, @mp3data)
+              if samples > 0 || @mp3data[:header_parsed] != 0
+                channels = @mp3data[:stereo]
+                sample_rate = @mp3data[:samplerate]
+                write_wav_header(output, channels, sample_rate)
+                first_frame = false
+              end
+            else
+              samples = FFI.hip_decode(@hip, mp3_buf, data.bytesize, left_buf, right_buf)
+            end
+
+            next unless samples > 0
+
+            left_samples = left_buf.read_array_of_int16(samples)
+
+            if channels == 2
+              right_samples = right_buf.read_array_of_int16(samples)
+              interleaved = left_samples.zip(right_samples).flatten
+              output.write(interleaved.pack("s*"))
+            else
+              output.write(left_samples.pack("s*"))
+            end
+          end
+
+          finalize_wav_header(output, channels)
+        end
+      end
+
+      true
+    end
+
+    def decode_buffer(mp3_data)
+      left_buf = ::FFI::MemoryPointer.new(:short, PCM_BUFFER_SIZE)
+      right_buf = ::FFI::MemoryPointer.new(:short, PCM_BUFFER_SIZE)
+      mp3_buf = ::FFI::MemoryPointer.new(:uchar, mp3_data.bytesize)
+      mp3_buf.put_bytes(0, mp3_data)
+
+      all_left = []
+      all_right = []
+
+      offset = 0
+      remaining = mp3_data.bytesize
+
+      while remaining > 0
+        chunk_size = [remaining, MP3_READ_SIZE].min
+        chunk_ptr = mp3_buf + offset
+
+        samples = if !@initialized
+          result = FFI.hip_decode_headers(@hip, chunk_ptr, chunk_size, left_buf, right_buf, @mp3data)
+          @initialized = true if result >= 0 || @mp3data[:header_parsed] != 0
+          result
+        else
+          FFI.hip_decode(@hip, chunk_ptr, chunk_size, left_buf, right_buf)
+        end
+
+        if samples > 0
+          all_left.concat(left_buf.read_array_of_int16(samples))
+          all_right.concat(right_buf.read_array_of_int16(samples)) if stereo?
+        end
+
+        offset += chunk_size
+        remaining -= chunk_size
+      end
+
+      {
+        left: all_left,
+        right: stereo? ? all_right : nil,
+        channels: @mp3data[:stereo],
+        sample_rate: @mp3data[:samplerate],
+        bitrate: @mp3data[:bitrate]
+      }
+    end
+
+    def stereo?
+      @mp3data[:stereo] == 2
+    end
+
+    def sample_rate
+      @mp3data[:samplerate]
+    end
+
+    def bitrate
+      @mp3data[:bitrate]
+    end
+
+    private
+
+    def write_wav_header(file, channels, sample_rate)
+      bits_per_sample = 16
+      byte_rate = sample_rate * channels * bits_per_sample / 8
+      block_align = channels * bits_per_sample / 8
+
+      file.write("RIFF")
+      file.write([0].pack("V")) # placeholder for file size
+      file.write("WAVE")
+
+      file.write("fmt ")
+      file.write([16].pack("V"))
+      file.write([1].pack("v")) # PCM
+      file.write([channels].pack("v"))
+      file.write([sample_rate].pack("V"))
+      file.write([byte_rate].pack("V"))
+      file.write([block_align].pack("v"))
+      file.write([bits_per_sample].pack("v"))
+
+      file.write("data")
+      file.write([0].pack("V")) # placeholder for data size
+    end
+
+    def finalize_wav_header(file, channels)
+      file_size = file.size
+      data_size = file_size - 44
+
+      file.seek(4)
+      file.write([file_size - 8].pack("V"))
+
+      file.seek(40)
+      file.write([data_size].pack("V"))
+    end
+  end
+end