lame 0.0.3 → 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b1dbd68980ebd6f4bddace81b1c4a3f5a3ea6e92c0b88ea159ba4552ee26bf89
+  data.tar.gz: 9974a5a4d7cae8bf8c5511bcdc64391ccbbc0dd1fad3a6c61be6733f60fd5b5d
+SHA512:
+  metadata.gz: 253e7848d81e9dea55800b37c54f6e239bfb7d3ca7eb5679ebe3ead683918c3856052adf09d5c9b05666685afd08348b27b1529c7643f4f0c43f47063ed55241
+  data.tar.gz: 88592750da789b2c01f8dc9a9aa93386b56aeb4597cf0d1495aa8042257e6107f4a753b27c2974e3161e26f19072b1c8b0aae4e859975a3f035c9e93751460f3

data/.github/workflows/ci.yml

@@ -0,0 +1,47 @@
+name: CI
+
+on:
+  push:
+    branches: [ main, master ]
+  pull_request:
+    branches: [ main, master ]
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version:
+          - '3.3'
+          - '3.4'
+          - '4.0'
+          - 'ruby-head'
+          - 'jruby'
+          - 'truffleruby'
+
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+
+      - name: Install system dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -qq libmp3lame-dev
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+
+      - name: Run tests
+        run: bundle exec rake
+
+      - name: Upload coverage to Coveralls
+        if: matrix.ruby-version == '3.4'
+        uses: coverallsapp/github-action@v2
+        with:
+          file: coverage/lcov.info

data/.travis.yml

@@ -1,13 +1,12 @@
 language: ruby
 rvm:
+  - 2.2.0
+  - 2.1.5
   - 2.0.0
   - 1.9.3
-  - 1.8.7
-  - rbx-18mode
-  - rbx-19mode
+  - rbx-2.2.7
   - ruby-head
   - jruby-19mode
-  - jruby-18mode
   - jruby-head
 before_install:
 - sudo apt-get install -qq libmp3lame-dev

data/README.md

@@ -1,13 +1,15 @@
 # LAME
 
-[![Build Status](https://travis-ci.org/rdvdijk/lame.png?branch=master)](https://travis-ci.org/rdvdijk/lame)
-[![Code Climate](https://codeclimate.com/github/rdvdijk/lame.png)](https://codeclimate.com/github/rdvdijk/lame)
+[![Gem Version](https://badge.fury.io/rb/lame.png)](http://badge.fury.io/rb/lame)
+[![Build Status](https://github.com/rdvdijk/lame/actions/workflows/ci.yml/badge.svg)](https://github.com/rdvdijk/lame/actions/workflows/ci.yml)
 [![Coverage Status](https://coveralls.io/repos/rdvdijk/lame/badge.png?branch=master)](https://coveralls.io/r/rdvdijk/lame)
 
 FFI powered library for the [LAME MP3 encoder](http://lame.sourceforge.net/).
 
 ## Installation
 
+### Installing the gem
+
 Add this line to your application's Gemfile:
 
     gem 'lame'
@@ -20,6 +22,16 @@ Or install it yourself as:
 
     $ gem install lame
 
+### Installing LAME
+
+To use this gem, you need to have the LAME development library (`libmp3lame-dev`) installed.
+
+Ubuntu/Debian: `sudo apt-get install libmp3lame-dev`
+
+Mac OS X with Homebrew: `brew install lame`
+
+Or build it from source, visit the [LAME website](http://lame.sourceforge.net/).
+
 ## Usage
 
 Create a default `LAME::Encoder` with default settings:
@@ -54,27 +66,28 @@ See all encoding methods in the Encoding section below.
 
 ### Configuration
 
-(work in progress)
+Here are all the encoding configuration options. The values use here are the
+defaults. You can set any option prior to encoding.
 
 ```ruby
-# These are the defaults:
 encoder.configure do |config|
+  config.bitrate                     = 128
+  config.quality                     = 3
+  config.mode                        = :join_stereo
+
   config.number_of_samples           = 4294967295
-  config.input_samplerate            = 44100
   config.number_of_channels          = 2
+  config.input_samplerate            = 44100
+  config.output_samplerate           = 44100
   config.scale                       = 0.95
   config.scale_left                  = 1.0
   config.scale_left                  = 1.0
-  config.output_samplerate           = 44100
   config.analysis                    = false
   config.decode_only                 = false
-  config.quality                     = 3
-  config.mode                        = :join_stereo
   config.force_mid_side              = false
   config.free_format                 = false
   config.replay_gain                 = false
   config.decode_on_the_fly           = false
-  config.bitrate                     = 128
   config.preset                      = :EXTREME # no LAME default
   config.copyright                   = false
   config.original                    = true
@@ -89,11 +102,11 @@ encoder.configure do |config|
   config.emphasis                    = false
 
   # auto-detected by default
-  config.asm_optimization.mmx     = true
-  config.asm_optimization.amd3now = true
-  config.asm_optimization.sse     = true
+  config.asm_optimization.mmx       = true
+  config.asm_optimization.amd_3dnow = true
+  config.asm_optimization.sse       = true
 
-  # these values can't be "unset" once set to true
+  # these options can't be "unset" once set to true
   config.id3.v2              = false
   config.id3.v1_only         = false
   config.id3.v2_only         = false
@@ -101,6 +114,15 @@ encoder.configure do |config|
   config.id3.v2_padding      = false
   config.id3.v2_padding_size = 128
 
+  config.id3.write_automatic = true
+  config.id3.title           = nil
+  config.id3.artist          = nil
+  config.id3.album           = nil
+  config.id3.year            = nil
+  config.id3.comment         = nil
+  config.id3.track           = nil
+  config.id3.genre           = nil
+
   config.quantization.reservoir      = true
   config.quantization.comp           = 9
   config.quantization.comp_short     = 9
@@ -136,8 +158,8 @@ end
 
 ### Encoding
 
-See `spec/integration/encoding_spec.rb` for an example how to encode a WAV file
-to an MP3 file.
+See [`encoding_spec.rb`](spec/integration/encoding_spec.rb) for examples how
+to encode a WAV file to an MP3 file.
 
 The available encoding functions are:
 
@@ -174,13 +196,23 @@ The `left` and `right` are arrays of sample values for the given data type.
 
 ### Decoding
 
-See `spec/integration/decoding_spec.rb` for an example how to decode an MP3 file
-to an WAV file.
+See [`decoding_spec.rb`](spec/integration/decoding_spec.rb) for examples how
+to decode an MP3 file to an WAV file.
 
 ### Development
 
 This section contains some references used during development of this gem.
 
+#### Testing
+
+Run the unit tests with rspec:
+
+    $ rspec
+
+Run the integration tests by using the `slow` tag:
+
+    $ rspec -t slow
+
 #### ID3v2 tags
 
 To use ID3v2 tags in files, see this post on the `lame-dev` mailing list:
@@ -195,7 +227,7 @@ So:
 4. Write id3v1 tag at end of file
 5. Write vbr 'lametag' at start of audio (using the size of the id3v2 tag)
 
-See the example code in `spec/integration/encoding_spec.rb` for an example.
+See the example code in [`encoding_spec.rb`](spec/integration/encoding_spec.rb).
 
 #### Decoding
 
@@ -225,7 +257,7 @@ After this, we are ready to decode MP3 data.
 5. Handle the decoded audio.
 6. Now repeat this process (`GOTO 1`) until the end of the MP3 file.
 
-See the example code in `spec/integration/decoding_spec.rb` for an example.
+See the example code in [`decoding_spec.rb`](spec/integration/decoding_spec.rb).
 
 ## Contributing