Class: Wavify::Codecs::Base

Inherits:
Object
  • Object
show all
Defined in:
lib/wavify/codecs/base.rb,
sig/codecs.rbs

Overview

Abstract codec interface used by Registry and Audio.

Concrete codecs implement the class methods below.

Direct Known Subclasses

Aiff, Flac, OggVorbis, Raw, Wav

Class Method Summary collapse

Class Method Details

.available? ⇒ Boolean

Returns whether optional runtime dependencies for this codec are present.

Returns:

  • (Boolean) 


70
71
72
 
# File 'lib/wavify/codecs/base.rb', line 70

def available?
  true
end

.can_read?(_io_or_path) ⇒ Boolean

Returns whether this codec can read the given path/IO.

Parameters:

  • _io_or_path (String, IO)
  • io_or_path (String, IO)

Returns:

  • (Boolean)

Raises:

  • (NotImplementedError) 


18
19
20
 
# File 'lib/wavify/codecs/base.rb', line 18

def can_read?(_io_or_path)
  raise NotImplementedError
end

.metadata(_io_or_path) ⇒ Hash

Reads metadata (format and duration-related info) without full decode.

Parameters:

  • _io_or_path (String, IO)
  • io_or_path (String, IO)
  • options (Object)

Returns:

  • (Hash)

Raises:

  • (NotImplementedError) 


63
64
65
 
# File 'lib/wavify/codecs/base.rb', line 63

def metadata(_io_or_path)
  raise NotImplementedError
end

.read(_io_or_path, format: nil) ⇒ Wavify::Core::SampleBuffer

Reads a full audio buffer from a path/IO.

Parameters:

  • _io_or_path (String, IO)
  • format (Wavify::Core::Format, nil) (defaults to: nil)
  • io_or_path (String, IO)
  • options (Object)

Returns:

Raises:

  • (NotImplementedError) 


27
28
29
 
# File 'lib/wavify/codecs/base.rb', line 27

def read(_io_or_path, format: nil)
  raise NotImplementedError
end

.stream_read(_io_or_path, chunk_size: 4096) {|arg0| ... } ⇒ Enumerator

Streams decoded audio as chunked sample buffers.

Parameters:

  • _io_or_path (String, IO)
  • chunk_size (Integer) (defaults to: 4096) —

    chunk size in frames

  • io_or_path (String, IO)
  • options (Object)

Yields:

Yield Parameters:

Yield Returns:

  • (void)

Returns:

  • (Enumerator)

Raises:

  • (NotImplementedError) 


46
47
48
 
# File 'lib/wavify/codecs/base.rb', line 46

def stream_read(_io_or_path, chunk_size: 4096)
  raise NotImplementedError
end

.stream_write(_io_or_path, format:, **_codec_options) {|arg0| ... } ⇒ Enumerator, ...

Streams encoded chunks to a path/IO through a yielded writer.

Parameters:

Yields:

Yield Parameters:

  • arg0 (Object)

Yield Returns:

  • (void)

Returns:

  • (Enumerator, String, IO)

Raises:

  • (NotImplementedError) 


55
56
57
 
# File 'lib/wavify/codecs/base.rb', line 55

def stream_write(_io_or_path, format:, **_codec_options)
  raise NotImplementedError
end

.write(_io_or_path, _sample_buffer, format:, **_codec_options) ⇒ String, IO

Writes a full audio buffer to a path/IO.

Parameters:

Returns:

  • (String, IO)

Raises:

  • (NotImplementedError) 


37
38
39
 
# File 'lib/wavify/codecs/base.rb', line 37

def write(_io_or_path, _sample_buffer, format:, **_codec_options)
  raise NotImplementedError
end