audioman package

Subpackages

• audioman.effect package
  • Submodules
  • audioman.effect.adjustable_fade module
    • AdjustableFade
      • AdjustableFade.OPTIONS
      • AdjustableFade.__init__()
      • AdjustableFade.cos_curve()
      • AdjustableFade.cosine_curve()
      • AdjustableFade.curve_adjust()
      • AdjustableFade.get()
      • AdjustableFade.linear()
      • AdjustableFade.linear_fade()
      • AdjustableFade.scale_curve()
      • AdjustableFade.simple_curve()
  • audioman.effect.effect module
    • Effect
      • Effect.OPTIONS
      • Effect.__init__()
      • Effect.get()
  • Module contents

Submodules

audioman.audio module

class audioman.audio.Audio(file: str | ndarray = array([], dtype=float64), sample_rate: int | None = None)

Bases: object

__init__(file: str | ndarray = array([], dtype=float64), sample_rate: int | None = None) → None

Audio object. This is used to manipulate audio samples. Please note, self.filename is usually lost when editing audio.

Parameters:

• file (str | numpy.ndarray, optional) – File to load, or samples as numpy array. Defaults to numpy.array([]).

• sample_rate (int, optional) – Sample rate. Defaults to file sample rate or 44000.

add_silence(start: int = 0, length: int | None = None) → Audio

Add silence to audio.

Parameters:

• start (int, optional) – Start sample to start the audio at. If it’s less than -1, then it will start at the end. Defaults to 0.

• length (int, optional) – Silence length in samples. Defaults to None.

Returns:

New Audio with silence.

Return type:

Audio

apply_effect(effect: Effect, start: int = 0)

Apply effect.

Parameters:

• effect (Effect) – Effect to apply to audio. This effect must be an object that inherits from the Effect class.

• start (int, optional) – Where to start the effect in the audio in samples. Defaults to 0.

Returns:

New Audio with applied effect.

Return type:

Audio

Raises:

TypeError – effects must inherit from the Effect class

apply_scaler(scaler: ndarray, start: int = 0) → Audio

Apply a scaler to the audio samples.

Parameters:

• scaler (numpy.ndarray) – Scaler to apply to the audio samples.

• start (int, optional) – Where to apply the scaler in samples. Defaults to 0.

Returns:

New Audio with applied scaler

Return type:

Audio

property cache_filename: str

The cache filename to use when using the .unload() method.

Returns:

filename

Return type:

str

property channels: int

Number of audio channels.

Returns:

Number of audio channels.

Return type:

int

convert_to_sample_rate(sample_rate: int)

I want this to be able to convert a sound to a different sample rate without changing how it sounds. However, right now it just sets the sample rate without changing the samples.

Parameters:

sample_rate (int) – new sample rate

Raises:

• TypeError – sample_rate must be ‘int’

• ValueError – sample_rate must be greater than 0

copy() → Audio

Copy this audio into a new Audio object.

Returns:

New Audio object.

Return type:

Audio

property length: int

Length of audio in samples.

Returns:

Number of samples.

Return type:

int

mix(audio2: Audio) → Audio

Mix audio together. This will overlay this audio and the new audio onto each other, so they play at the same time.

Parameters:

audio2 (Audio) – Audio to mix into this audio.

Returns:

New mixed audio.

Return type:

Audio

read(filename: str | None = None)

Read audio file.

Parameters:

filename (str, optional) – File to read. Defaults to self.filename.

Raises:

• FileNotFoundError – file not found

• IsADirectoryError – path specified is a directory

property samples: ndarray

Audio samples as numpy array.

Returns:

Numpy array. Shape is (channels, length)

Return type:

numpy.ndarray

samples_to_seconds(duration: int, sample_rate: int | None = None) → float

Converts samples to seconds.

Parameters:

• duration (int) – Duration in samples

• sample_rate (int, optional) – Sample rate. Defaults to self.sample_rate.

Returns:

Seconds.

Return type:

float

save(filename: str | None = None, file_format=None, ffmpeg_options: str | None = None)

Save file. If the filename is specified, it override .filename attribute.

Parameters:

• filename (str, optional) – File to save audio to. Defaults to self.filename.

• file_format (str, optional) – File format to save the audio to. Defaults to None.

• ffmpeg_options (str, optional) – Custom ffmpeg export options. Defaults to ‘-i “{input}” “{output}”’.

Raises:

TypeError – filename must be str

Custom ffmpeg options

This is the ffmpeg export command. The input will be formatted with the input, output, format, and metadata. It will use the standard python formatting.

Custom ffmpeg options can be used to add compression, custom codecs, and processing that is not easily done using just the samples.

Examples: -i "{input}" "{output}" -i "{input}" -acodec flac -compression_level 12 "{output}" -i "{input}" -compression_level 12 "{output}"

It can even be used to add an image to audio and make a video from it. -loop 1 -i "img.jpg" -i "{input}" -shortest "{output_name}.{extension}"

Make sure to use ``{input}`` and ``{output}`` or ``{output_name}.{extension}`` as ``output`` is used when saving tags.

Please note: ffmpeg options will include -hide_banner, and -y. Files will be replaced without confirmation.

seconds_to_samples(duration: float, sample_rate: int | None = None) → int

Convert seconds to samples.

Parameters:

• duration (float) – Duration in seconds.

• sample_rate (int, optional) – Sample rate. Defaults to self.sample_rate.

Returns:

duration in samples

Return type:

int

split(middle: int | None = None)

Split audio by middle sample

Parameters:

middle (int, optional) – Middle sample to split by. Defaults to half.

Returns:

Split audio.

Return type:

tuple[Audio,Audio]

trim(start: int = 0, length: int | None = None)

Trim audio to specified length from start.

Parameters:

• start (int, optional) – Start in samples. Defaults to 0.

• length (int, optional) – Length in samples. If not specified, the start will act as the length. Defaults to None.

Returns:

trimmed audio.

Return type:

Audio

unload()

Unload audio samples to save memory. This will also create a temporary wav file in the os temp directory. When you try to access the samples, this temporary file will be loaded (or at least it will try to load it).

audioman.audio_tags module

class audioman.audio_tags.AudioTags(file: str | None = None)

Bases: dict

__init__(file: str | None = None) → None

Audio metadata tags. This serves as a way to set audio metadata on different file formats.

Parameters:

file (str, optional) – File to import metadata tags from. This can be file path, or filelike object. Defaults to None.

expand()

Expand tags to include all available tag names. This creates a new dict with all the values, not an AudioTags object.

Returns:

Tags.

Return type:

dict[str,str | list[str]]

get(tag: str, default: Any | None = None)

Get tag value.

Parameters:

• tag (str) – Tag name.

• default (Any, optional) – Default value if tag does not exist. Defaults to None.

Raises:

TypeError – tag must be str

Returns:

tag value.

Return type:

str | list[str]

load(file: str | None = None)

Load file.

Parameters:

file (str, optional) – File can be path to file, or file object. Defaults to self.filename.

property picture: Image | None

Audio picture.

Returns:

PIL Image

Return type:

PIL.Image | None

Set: image (PIL.Image | str | bytes | filelike | None): Image to set to. Can be PIL Image, path to file, file bytes, filelike object, or None.

pop(k[, d]) → v, remove specified key and return the corresponding value.

If the key is not found, return the default if given; otherwise, raise a KeyError.

save(file: str | None = None)

Save tags to file.

Parameters:

file (str, optional) – File to save tags to. Can be file path or filelike object. Defaults to self.filename.

Raises:

AttributeError – must provide file

set(tag: str, value: str | list) → None

Set tag value.

Parameters:

• tag (str) – Tag name.

• value (str | list) – Tag value.

setdefault(tag: str, default: str | None = None)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update([E, ]**F) → None.  Update D from dict/iterable E and F.

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

Module contents