| File | % covered | Lines | Relevant Lines | Lines covered | Lines missed | Avg. Hits / Line |
|---|---|---|---|---|---|---|
| lib/discid.rb | 96.77 % | 202 | 31 | 30 | 1 | 9.90 |
| lib/discid/disc.rb | 94.74 % | 225 | 76 | 72 | 4 | 6.36 |
| lib/discid/disc_error.rb | 100.00 % | 21 | 2 | 2 | 0 | 1.00 |
| lib/discid/lib.rb | 73.47 % | 132 | 49 | 36 | 13 | 1.35 |
| lib/discid/track.rb | 100.00 % | 135 | 25 | 25 | 0 | 12.16 |
-
# Copyright (C) 2013-2017, 2019, 2025 Philipp Wolfer
-
#
-
# This program is free software: you can redistribute it and/or modify
-
# it under the terms of the GNU Lesser General Public License as published by
-
# the Free Software Foundation, either version 3 of the License, or
-
# (at your option) any later version.
-
#
-
# This program is distributed in the hope that it will be useful,
-
# but WITHOUT ANY WARRANTY; without even the implied warranty of
-
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-
# GNU Lesser General Public License for more details.
-
#
-
# You should have received a copy of the GNU Lesser General Public License
-
# along with this program. If not, see <http://www.gnu.org/licenses/>.
-
-
1
require 'discid/lib'
-
1
require 'discid/disc'
-
1
require 'discid/version'
-
-
# The DiscId module allows calculating DiscIDs (MusicBrainz and freedb)
-
# for Audio CDs. Additionally the library can extract the MCN/UPC/EAN and
-
# the ISRCs from disc.
-
#
-
# The main interface for using this module are the {read} and {put}
-
# methods which both return an instance of {Disc}. {read} allows you to
-
# read the data from an actual CD drive while {put} allows you to
-
# calculate the DiscID for a previously read CD TOC.
-
#
-
# Depending on the version of libdiscid and the operating system used
-
# additional features like reading the MCN or ISRCs from the disc
-
# might be available. You can check for supported features with {feature?}.
-
#
-
# @see http://musicbrainz.org/doc/libdiscid#Feature_Matrix
-
#
-
# @example Read the TOC, MCN and ISRCs
-
# require 'discid'
-
#
-
# device = "/dev/cdrom"
-
# disc = DiscId.read(device, :mcn, :isrc)
-
#
-
# # Print information about the disc:
-
# puts "DiscID : #{disc.id}"
-
# puts "FreeDB ID : #{disc.freedb_id}"
-
# puts "Total length: #{disc.seconds} seconds"
-
# puts "MCN : #{disc.mcn}"
-
#
-
# # Print information about individual tracks:
-
# disc.tracks do |track|
-
# puts "Track ##{track.number}"
-
# puts " Length: %02d:%02d (%i sectors)" %
-
# [track.seconds / 60, track.seconds % 60, track.sectors]
-
# puts " ISRC : %s" % track.isrc
-
# end
-
#
-
# @example Get the DiscID for an existing TOC
-
# require 'discid'
-
#
-
# first_track = 1
-
# sectors = 82255
-
# offsets = [150, 16157, 35932, 57527]
-
# disc = DiscId.put(first_track, sectors, offsets)
-
# puts disc.id # Output: E5VLOkhodzhvsMlK8LSNVioYOgY-
-
#
-
# @example Check for supported MCN feature
-
# disc = DiscId.read(nil, :mcn)
-
# puts "MCN: #{disc.mcn}" if DiscId.feature?(:mcn)
-
1
module DiscId
-
-
# Read the disc in the given CD-ROM/DVD-ROM drive extracting only the
-
# TOC and additionally specified features.
-
#
-
# This function reads the disc in the drive specified by the given device
-
# identifier. If the device is `nil`, the default device, as returned by
-
# {default_device}, is used.
-
#
-
# This function will always read the TOC, but additional features like `:mcn`
-
# and `:isrc` can be set using the features parameter. You can set multiple
-
# features.
-
#
-
# @example Read only the TOC:
-
# disc = DiscId.read(device)
-
#
-
# @example Read the TOC, MCN and ISRCs:
-
# disc = DiscId.read(device, :mcn, :isrc)
-
#
-
# @note libdiscid >= 0.5.0 is required for the feature selection to work.
-
# Older versions will allways read MCN and ISRCs when supported. See
-
# {http://musicbrainz.org/doc/libdiscid#Feature_Matrix} for a list of
-
# supported features by version and platform.
-
#
-
# @raise [TypeError] `device` can not be converted to a String.
-
# @raise [DiscError] Error reading from `device`. `Exception#message` contains
-
# error details.
-
# @param device [String] The device identifier. If set to `nil` {default_device}
-
# will be used.
-
# @param features [:mcn, :isrc] List of features to use.
-
# `:read` is always implied.
-
# @return [Disc]
-
1
def self.read(device = nil, *features)
-
3
disc = Disc.new
-
3
disc.read device, *features
-
disc
-
end
-
-
# Provides the TOC of a known CD.
-
#
-
# This function may be used if the TOC has been read earlier and you want to
-
# calculate the disc ID afterwards, without accessing the disc drive.
-
#
-
# @raise [DiscError] The TOC could not be set. `Exception#message`contains
-
# error details.
-
# @param first_track [Integer] The number of the first audio track on the
-
# disc (usually one).
-
# @param sectors [Integer] The total number of sectors on the disc.
-
# @param offsets [Array] An array with track offsets (sectors) for each track.
-
# @return [Disc]
-
1
def self.put(first_track, sectors, offsets)
-
10
disc = Disc.new
-
10
disc.put first_track, sectors, offsets
-
7
disc
-
end
-
-
# Parses a TOC string and returns a [Disc] instance for it.
-
#
-
# This function can be used if you already have a TOC string like e.g.
-
# `1 11 242457 150 44942 61305 72755 96360 130485 147315 164275 190702 205412 220437`
-
#
-
# @raise [DiscError] The TOC string was invalid and could not be parsed.
-
# @param toc [String] A TOC string in the format `1 11 242457 150 44942 61305 72755 96360 130485 147315 164275 190702 205412 220437`.
-
# @return [Disc]
-
1
def self.parse(toc)
-
8
raise DiscError, "Invalid TOC #{toc.inspect}" if toc.nil? || toc.empty?
-
-
begin
-
6
parts = toc.split(' ')
-
6
first_track = Integer(parts[0])
-
6
sectors = Integer(parts[2])
-
29
offsets = parts[3..-1].map{|i| Integer(i)}
-
rescue ArgumentError, TypeError => e
-
2
raise DiscError, e
-
end
-
4
put(first_track, sectors, offsets)
-
end
-
-
# Return the name of the default disc drive for this operating system.
-
#
-
# @return [String] An operating system dependent device identifier
-
1
def self.default_device
-
1
Lib.default_device
-
end
-
-
# Check if a certain feature is implemented on the current platform.
-
#
-
# You can obtain a list of supported features with {feature_list}.
-
#
-
# @note libdiscid >= 0.5.0 required. Older versions will return `true`
-
# for `:read` and `false` for anything else.
-
#
-
# @param feature [:read, :mcn, :isrc]
-
# @return [Boolean] True if the feature is implemented and false if not.
-
1
def self.feature?(feature)
-
8
feature = feature.to_sym if feature.respond_to? :to_sym
-
8
feature_list.include? feature
-
end
-
-
# Provide has_feature? for backward compatibility
-
1
singleton_class.alias_method :has_feature?, :feature?
-
-
# A list of features supported by the current platform.
-
#
-
# Currently the following features are available:
-
#
-
# * :read
-
# * :mcn
-
# * :isrc
-
#
-
# @note libdiscid >= 0.5.0 required. Older versions will return only [:read].
-
#
-
# @return [Array<Symbol>]
-
1
def self.feature_list
-
36
Lib::Features.symbols.select {|f| Lib.has_feature(f) == 1}
-
end
-
-
# Converts sectors to seconds.
-
#
-
# According to the red book standard 75 sectors are one second.
-
#
-
# @private
-
# @param sectors [Integer] Number of sectors
-
# @return [Integer] The seconds
-
1
def self.sectors_to_seconds(sectors)
-
147
(sectors.to_f / 75).truncate
-
end
-
-
# The libdiscid version.
-
#
-
# @note This will only give meaningful results for libdiscid 0.4.0
-
# and higher. For lower versions this constant will always have
-
# the value "libdiscid < 0.4.0".
-
1
LIBDISCID_VERSION = Lib.get_version_string
-
-
end
-
# Copyright (C) 2013-2014, 2021, 2025 Philipp Wolfer
-
#
-
# This program is free software: you can redistribute it and/or modify
-
# it under the terms of the GNU Lesser General Public License as published by
-
# the Free Software Foundation, either version 3 of the License, or
-
# (at your option) any later version.
-
#
-
# This program is distributed in the hope that it will be useful,
-
# but WITHOUT ANY WARRANTY; without even the implied warranty of
-
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-
# GNU Lesser General Public License for more details.
-
#
-
# You should have received a copy of the GNU Lesser General Public License
-
# along with this program. If not, see <http://www.gnu.org/licenses/>.
-
-
1
require 'ffi'
-
1
require 'discid/disc_error'
-
1
require 'discid/lib'
-
1
require 'discid/track'
-
-
#
-
1
module DiscId
-
# This class holds information about a disc (TOC, MCN, ISRCs).
-
#
-
# Use {DiscId#read} or {DiscId#put} to initialize an instance of {Disc}.
-
1
class Disc
-
-
# The device from which this disc object was read.
-
1
attr_reader :device
-
-
# @private
-
1
def initialize
-
15
pointer = Lib.new
-
15
@handle = FFI::AutoPointer.new(pointer, Lib.method(:free))
-
15
@read = false
-
15
@tracks = nil
-
end
-
-
# @private
-
1
def read(device, *features)
-
3
@read = false
-
3
device = DiscId.default_device if device.nil?
-
-
3
unless device.respond_to? :to_s
-
1
raise TypeError, 'wrong argument type (expected String)'
-
end
-
-
2
@device = device.to_s
-
2
flags = Lib.features_to_int features
-
2
result = Lib.read @handle, @device, flags
-
-
2
raise DiscError, Lib.get_error_msg(@handle) if result == 0
-
-
@read = true
-
end
-
-
# @private
-
1
def put(first_track, sectors, offsets)
-
10
@read = false
-
10
@device = nil
-
10
last_track = first_track - 1 + offsets.length
-
-
# discid_put expects always an offsets array with exactly 100 elements.
-
10
FFI::MemoryPointer.new(:int, 100) do |p|
-
10
if last_track > offsets.length
-
2
offsets = Array.new(last_track - offsets.length, 0) + offsets
-
end
-
10
p.write_array_of_int(([sectors] + offsets)[0, 100])
-
10
result = Lib.put @handle, first_track, last_track, p
-
-
10
raise DiscError, Lib.get_error_msg(@handle) if result == 0
-
-
7
@read = true
-
end
-
end
-
-
# The MusicBrainz DiscID.
-
#
-
# @return [String] The DiscID or `nil` if no ID was yet read.
-
1
def id
-
10
Lib.get_id @handle if @read
-
end
-
-
# The FreeDB DiscID.
-
#
-
# @return [String] The DiscID or `nil` if no ID was yet read.
-
1
def freedb_id
-
1
Lib.get_freedb_id @handle if @read
-
end
-
-
# The number of the first track on this disc.
-
#
-
# @return [Integer] The number of the first track or `nil` if no ID was yet read.
-
1
def first_track_number
-
7
Lib.get_first_track_num @handle if @read
-
end
-
-
# The number of the last track on this disc.
-
#
-
# @return [Integer] The number of the last track or `nil` if no ID was yet read.
-
1
def last_track_number
-
39
Lib.get_last_track_num @handle if @read
-
end
-
-
# The length of the disc in sectors.
-
#
-
# @return [Integer] Sectors or `nil` if no ID was yet read.
-
1
def sectors
-
4
Lib.get_sectors @handle if @read
-
end
-
-
# The length of the disc in seconds.
-
#
-
# @return [Integer] Seconds or `nil` if no ID was yet read.
-
1
def seconds
-
3
DiscId.sectors_to_seconds(sectors) if @read
-
end
-
-
# The media catalogue number on the disc, if present.
-
#
-
# Requires libdiscid >= 0.5. If not supported this method will always
-
# return `nil`.
-
#
-
# @note libdiscid >= 0.3.0 required. Older versions will always return nil.
-
# Not available on all platforms, see
-
# {http://musicbrainz.org/doc/libdiscid#Feature_Matrix}.
-
#
-
# @return [String] MCN or `nil` if no ID was yet read.
-
1
def mcn
-
1
Lib.get_mcn @handle if @read
-
end
-
-
# Return a string representing CD Table Of Contents (TOC).
-
#
-
# The TOC suitable as a value of the toc parameter when accessing the
-
# MusicBrainz Web Service. This enables fuzzy searching when the actual
-
# DiscID is not found.
-
#
-
# Note that this is the unencoded value, which still contains spaces.
-
#
-
# For libdiscid >= 0.6 the native implementation will be used. For older
-
# versions falls back to extract the TOC from {Disc#submission_url}.
-
#
-
# @since 1.3
-
#
-
# @raise [RuntimeError] get_toc_string is unsupported by libdiscid and
-
# could not get extracted from {Disc#submission_url}
-
# @return [String] The TOC string or `nil` if no ID was yet read.
-
1
def toc_string
-
4
return nil unless @read
-
-
4
result = Lib.get_toc_string @handle
-
4
unless result
-
# probably an old version of libdiscid (< 0.6.0)
-
# gather toc string from submission_url
-
match = /toc=([0-9+]+)/.match submission_url
-
-
raise "can't get toc string from submission url" unless match
-
-
result = match[1].tr('+', ' ')
-
end
-
-
4
result
-
end
-
-
# An URL for submitting the DiscID to MusicBrainz.
-
#
-
# The URL leads to an interactive disc submission wizard that guides the
-
# user through the process of associating this disc's DiscID with a release
-
# in the MusicBrainz database.
-
#
-
# @return [String] Submission URL
-
1
def submission_url
-
1
Lib.get_submission_url @handle if @read
-
end
-
-
# DiscID to String conversion. Same as calling the method {#id} but guaranteed
-
# to return a string.
-
#
-
# @return [String] The disc ID as a string or an empty string if no ID
-
# was yet read.
-
1
def to_s
-
3
id.to_s
-
end
-
-
# Returns an array of {Track} objects. Each Track object contains
-
# detailed information about the track.
-
#
-
# Returns always `nil` if no ID was yet read. The block won't be
-
# called in this case.
-
#
-
# @yield [Track] If a block is given this method returns `nil` and
-
# instead iterates over the block calling the block with one argument.
-
# @yieldreturn [nil]
-
# @return [Array<Track>] Array of {Track} objects.
-
1
def tracks(&block)
-
7
return unless @read
-
-
5
read_tracks if @tracks.nil?
-
-
5
return @tracks unless block
-
-
1
@tracks.each(&block)
-
1
nil
-
end
-
-
1
private
-
-
1
def read_tracks
-
3
track_number = first_track_number - 1
-
3
@tracks = []
-
-
3
while track_number < last_track_number
-
30
track_number += 1
-
30
isrc = Lib.get_track_isrc(@handle, track_number)
-
30
offset = Lib.get_track_offset(@handle, track_number)
-
30
length = Lib.get_track_length(@handle, track_number)
-
30
track_info = Track.new(track_number, offset, length, isrc)
-
-
30
@tracks << track_info
-
end
-
end
-
-
end
-
end
-
# Copyright (C) 2013-2014 Philipp Wolfer
-
#
-
# This program is free software: you can redistribute it and/or modify
-
# it under the terms of the GNU Lesser General Public License as published by
-
# the Free Software Foundation, either version 3 of the License, or
-
# (at your option) any later version.
-
#
-
# This program is distributed in the hope that it will be useful,
-
# but WITHOUT ANY WARRANTY; without even the implied warranty of
-
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-
# GNU Lesser General Public License for more details.
-
#
-
# You should have received a copy of the GNU Lesser General Public License
-
# along with this program. If not, see <http://www.gnu.org/licenses/>.
-
-
#
-
1
module DiscId
-
# This exception is thrown on errors reading the disc or setting the TOC.
-
1
class DiscError < StandardError
-
end
-
end
-
# Copyright (C) 2013, 2025 Philipp Wolfer
-
#
-
# This program is free software: you can redistribute it and/or modify
-
# it under the terms of the GNU Lesser General Public License as published by
-
# the Free Software Foundation, either version 3 of the License, or
-
# (at your option) any later version.
-
#
-
# This program is distributed in the hope that it will be useful,
-
# but WITHOUT ANY WARRANTY; without even the implied warranty of
-
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-
# GNU Lesser General Public License for more details.
-
#
-
# You should have received a copy of the GNU Lesser General Public License
-
# along with this program. If not, see <http://www.gnu.org/licenses/>.
-
-
1
require "ffi"
-
-
#
-
1
module DiscId
-
-
# This module encapsulates the C interface for libdiscid using FFI.
-
# The Lib module is intended for internal use only and should be
-
# considered private.
-
#
-
# @private
-
1
module Lib
-
1
extend FFI::Library
-
1
ffi_lib %w[discid libdiscid.so.0 libdiscid.0.dylib]
-
-
1
attach_function :new, :discid_new, [], :pointer
-
-
1
attach_function :free, :discid_free, [:pointer], :void
-
-
begin
-
1
attach_function :read, :discid_read_sparse, %i[pointer string uint], :int
-
rescue FFI::NotFoundError
-
attach_function :legacy_read, :discid_read, %i[pointer string], :int
-
-
def self.read(handle, device, _features)
-
legacy_read(handle, device)
-
end
-
end
-
-
1
attach_function :put, :discid_put, %i[pointer int int pointer], :int
-
-
1
attach_function :get_error_msg, :discid_get_error_msg, [:pointer], :string
-
-
1
attach_function :get_id, :discid_get_id, [:pointer], :string
-
-
1
attach_function :get_freedb_id, :discid_get_freedb_id, [:pointer], :string
-
-
1
attach_function :get_submission_url, :discid_get_submission_url, [:pointer], :string
-
-
1
attach_function :default_device, :discid_get_default_device, [], :string
-
-
1
attach_function :get_first_track_num, :discid_get_first_track_num, [:pointer], :int
-
-
1
attach_function :get_last_track_num, :discid_get_last_track_num, [:pointer], :int
-
-
1
attach_function :get_sectors, :discid_get_sectors, [:pointer], :int
-
-
1
attach_function :get_track_offset, :discid_get_track_offset, %i[pointer int], :int
-
-
1
attach_function :get_track_length, :discid_get_track_length, %i[pointer int], :int
-
-
begin
-
1
attach_function :get_toc_string, :discid_get_toc_string, [:pointer], :string
-
rescue FFI::NotFoundError
-
def self.get_toc_string
-
nil
-
end
-
end
-
-
begin
-
1
attach_function :get_mcn, :discid_get_mcn, [:pointer], :string
-
rescue FFI::NotFoundError
-
def self.get_mcn(_handle)
-
nil
-
end
-
end
-
-
begin
-
1
attach_function :get_track_isrc, :discid_get_track_isrc, %i[pointer int], :string
-
rescue FFI::NotFoundError
-
def self.get_track_isrc(_handle, _track)
-
nil
-
end
-
end
-
-
1
Features = enum(:feature, [:read, 1 << 0,
-
:mcn, 1 << 1,
-
:isrc, 1 << 2])
-
-
begin
-
1
attach_function :has_feature, :discid_has_feature, [:feature], :int
-
rescue FFI::NotFoundError
-
def self.has_feature(feature)
-
feature.to_sym == :read ? 1 : 0
-
end
-
end
-
-
# attach_function :get_feature_list, :discid_get_feature_list, [:pointer], :void
-
-
begin
-
1
attach_function :get_version_string, :discid_get_version_string, [], :string
-
rescue FFI::NotFoundError
-
def self.get_version_string
-
'libdiscid < 0.4.0'
-
end
-
end
-
-
1
def self.features_to_int(features)
-
6
feature_flags = 0
-
6
features.each do |feature|
-
4
if feature.respond_to? :to_sym
-
4
feature = feature.to_sym
-
4
feature_flags = add_feature_to_flags(feature_flags, feature)
-
end
-
end
-
-
6
feature_flags
-
end
-
-
1
def self.add_feature_to_flags(flags, feature)
-
flags |= self::Features[feature] if
-
4
self::Features.symbols.include?(feature) && has_feature(feature)
-
4
flags
-
end
-
-
1
private_class_method :add_feature_to_flags
-
end
-
end
-
# Copyright (C) 2008-2023, 2025 Philipp Wolfer
-
#
-
# This program is free software: you can redistribute it and/or modify
-
# it under the terms of the GNU Lesser General Public License as published by
-
# the Free Software Foundation, either version 3 of the License, or
-
# (at your option) any later version.
-
#
-
# This program is distributed in the hope that it will be useful,
-
# but WITHOUT ANY WARRANTY; without even the implied warranty of
-
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-
# GNU Lesser General Public License for more details.
-
#
-
# You should have received a copy of the GNU Lesser General Public License
-
# along with this program. If not, see <http://www.gnu.org/licenses/>.
-
-
#
-
1
module DiscId
-
-
# This class holds information about a single track.
-
#
-
# Currently this includes the following fields:
-
#
-
# * number: The number of the track on the disc.
-
# * sectors: Length of the track in sectors.
-
# * offset: Start position of the track on the disc in sectors.
-
# * end_sector: End position of the track on the disc in sectors.
-
# * seconds: Length of the track in seconds.
-
# * start_time: Start position of the track on the disc in seconds.
-
# * end_time: End position of the track on the disc in seconds.
-
# * isrc: The track's ISRC (International Standard Recordings Code)
-
# if available.
-
#
-
# You can access all fields either directly or with the square bracket
-
# notation:
-
#
-
# track = Track.new(1, 150, 16007)
-
# puts track.sectors # 16007
-
# puts track[:sectors] # 16007
-
#
-
# @see DiscId::Disc#tracks
-
1
class Track
-
-
# The number of the track on the disc.
-
#
-
# @return [Integer]
-
1
attr_reader :number
-
-
# Length of the track in sectors.
-
#
-
# @return [Integer]
-
1
attr_reader :sectors
-
-
# Start position of the track on the disc in sectors.
-
#
-
# @return [Integer]
-
1
attr_reader :offset
-
-
# ISRC number of the track.
-
#
-
# @note libdiscid >= 0.3.0 required. Older versions will always return nil.
-
# Not available on all platforms, see
-
# {http://musicbrainz.org/doc/libdiscid#Feature_Matrix}.
-
#
-
# @return [String]
-
1
attr_reader :isrc
-
-
# Initializes a new Track object.
-
1
def initialize(number, offset, sectors, isrc)
-
34
@number = number
-
34
@offset = offset
-
34
@sectors = sectors
-
34
@isrc = isrc
-
end
-
-
# End position of the track on the disc in sectors.
-
#
-
# @return [Integer]
-
1
def end_sector
-
54
offset + sectors
-
end
-
-
# Length of the track in seconds.
-
#
-
# @return [Integer]
-
1
def seconds
-
27
DiscId.sectors_to_seconds(sectors)
-
end
-
-
# Start position of the track on the disc in seconds.
-
#
-
# @return [Integer]
-
1
def start_time
-
27
DiscId.sectors_to_seconds(offset)
-
end
-
-
# End position of the track on the disc in seconds.
-
#
-
# @return [Integer]
-
1
def end_time
-
27
DiscId.sectors_to_seconds(end_sector)
-
end
-
-
# Allows access to all fields similar to accessing values in a hash.
-
#
-
# Example:
-
#
-
# track = Track.new(1, 150, 16007)
-
# puts track.sectors # 16007
-
# puts track[:sectors] # 16007
-
1
def [](key)
-
9
if %i[number sectors offset end_sector
-
seconds start_time end_time isrc].include?(key.to_sym)
-
8
method(key).call
-
end
-
end
-
-
# Converts the Track into a Hash.
-
#
-
# @return [Hash]
-
1
def to_h
-
{
-
2
number: number,
-
sectors: sectors,
-
offset: offset,
-
end_sector: end_sector,
-
seconds: seconds,
-
start_time: start_time,
-
end_time: end_time,
-
isrc: isrc
-
}
-
end
-
-
1
alias to_hash to_h
-
end
-
end