https://github.com/aidewoode/wahwah

Ruby gem for reading audio metadata
https://github.com/aidewoode/wahwah

audio flac id3 metadata mp3 mp4 music ogg opus ruby tagging wav wma

Last synced: 5 days ago
JSON representation

Ruby gem for reading audio metadata

• Host: GitHub
• URL: https://github.com/aidewoode/wahwah
• Owner: aidewoode
• License: mit
• Created: 2019-07-05T10:29:30.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-09-09T12:46:22.000Z (2 months ago)
• Last Synced: 2024-09-09T15:23:41.525Z (2 months ago)
• Topics: audio, flac, id3, metadata, mp3, mp4, music, ogg, opus, ruby, tagging, wav, wma
• Language: Ruby
• Homepage:
• Size: 592 KB
• Stars: 121
• Watchers: 4
• Forks: 6
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# WahWah

[![CI](https://github.com/aidewoode/wahwah/actions/workflows/ci.yml/badge.svg)](https://github.com/aidewoode/wahwah/actions/workflows/ci.yml)

[![Coverage Status](https://coveralls.io/repos/github/aidewoode/wahwah/badge.svg?branch=master)](https://coveralls.io/github/aidewoode/wahwah?branch=master)

[![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)

WahWah is an audio metadata reader Ruby gem, it supports many popular formats including mp3(ID3 v1, v2.2, v2.3, v2.4), m4a, ogg, oga, opus, wav, flac and wma.

WahWah is written in pure Ruby, and without any dependencies.

## Installation

Add this line to your application's Gemfile:

```ruby

gem "wahwah"

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install wahwah

## Compatibility

WahWah support Ruby 2.7+

## Usage

WahWah is so easy to use.

```ruby

require "wahwah"

# Get metadata from an audio file path

tag = WahWah.open("/files/example.wav")

# Or from IO like object

File.open("/files/example.wav") do |file|

  tag = WahWah.open(file)

end

# Supported attributes

tag.title       # => "song title"

tag.artist      # => "artist name"

tag.album       # => "album name"

tag.albumartist # => "albumartist name"

tag.composer    # => "composer name"

tag.comments    # => ["comment", "another comment"]

tag.track       # => 1

tag.track_total # => 10

tag.genre       # => "Rock"

tag.year        # => "1984"

tag.disc        # => 1

tag.disc_total  # => 2

tag.lyrics      # => "song lyrics"

tag.duration    # => 256.1 (in seconds)

tag.bitrate     # => 192 (in kbps)

tag.sample_rate # => 44100 (in Hz)

tag.bit_depth   # => 16 (in bits, only for PCM formats)

tag.file_size   # => 976700 (in bytes)

tag.images      # => [{ :type => :cover_front, :mime_type => 'image/jpeg', :data => 'image data binary string' }]

# Get all support formats

WahWah.support_formats # => ["mp3", "ogg", "oga", "opus", "wav", "flac", "wma", "m4a"]

```