Source code for harmonize.utils.source_decoders

# Original https://github.com/devoxin/Lavalink.py/blob/development/lavalink/source_decoders.py

from __future__ import annotations

from typing import Callable, TYPE_CHECKING

if TYPE_CHECKING:
    from .reader import DataReader
    
__all__ = (
    "decode_probe_info",
    "decode_lavasrc_fields",
    "DEFAULT_DECODER_MAPPING"
)




def decode_probe_info(reader: DataReader) -> dict[str, any]:
    """
    Decodes the probe information from the provided DataReader.

    Parameters
    ----------
        reader : :class:`harmonize.utils.DataReader`
            The DataReader object containing the probe information.

    Returns
    -------
        dict[str, any]

    Note
    ----
        The dictionary contains the following key and its corresponding value:

        - 'probe_info': The probe information as a string.
    """
    probe_info = reader.read_utf().decode()
    return {'probeInfo': probe_info}





def decode_lavasrc_fields(reader: DataReader) -> dict[str, any]:
    """
    Decodes the Lava Source fields from the provided DataReader.

    Parameters
    ----------
        reader : :class:`harmonize.utils.DataReader`
            The DataReader object containing the source data.

    Returns
    -------
        dict[str, any]

    Note
    ----
        The dictionary contains the following keys and their corresponding values:

        - 'albumName': The name of the album.

        - 'albumUrl': The URL of the album.

        - 'artistUrl': The URL of the artist.

        - 'artistArtworkUrl': The URL of the artist's artwork.

        - 'previewUrl': The URL of the preview.

        - 'isPreview': A boolean indicating whether the source is a preview.
    """
    if reader.remaining <= 8:
        return {}

    album_name = reader.read_nullable_utf()
    album_url = reader.read_nullable_utf()
    artist_url = reader.read_nullable_utf()
    artist_artwork_url = reader.read_nullable_utf()
    preview_url = reader.read_nullable_utf()
    is_preview = reader.read_boolean()

    return {
        'albumName': album_name,
        'albumUrl': album_url,
        'artistUrl': artist_url,
        'artistArtworkUrl': artist_artwork_url,
        'previewUrl': preview_url,
        'isPreview': is_preview
    }



DEFAULT_DECODER_MAPPING: dict[str, Callable[[DataReader], dict[str, any]]] = {
    'http': decode_probe_info,
    'local': decode_probe_info,
    'deezer': decode_lavasrc_fields,
    'spotify': decode_lavasrc_fields,
    'applemusic': decode_lavasrc_fields,
    'yandexmusic': decode_lavasrc_fields,
    'vkmusic': decode_lavasrc_fields
}