Skip to main content

Gamdl (Extended Glomatico's Apple Music Downloader)

PyPI version Python versions License Downloads

A command-line app for downloading Apple Music songs, music videos and post videos.

Join our Discord Server: https://discord.gg/aBjMEZ9tnq

🚀 Extended Features

  • 👥 Multi-Valued Artists - Individual track and album artist tagging (artists, albumartists)
  • 🎼 Individual Composers - Multi-valued composer credits (©wrt)
  • 🏷️ Extended Industry Identifiers - Official ISRC (isrc), UPC/Barcode (barcode), and Record Label (label) tagging
  • 💿 Release Type Classification - Accurate categorization into single, ep, compilation, and album (releasetype)
  • 🌐 Audio Language & Album Date - Native BCP 47 language tagging (audioLocale) and album-level releasedate

✨ Features

  • 🎵 High-Quality Songs - Download songs in AAC 256kbps and other codecs
  • 🎬 High-Quality Music Videos - Download music videos in resolutions up to 4K
  • 📝 Synced Lyrics - Download synced lyrics in LRC, SRT, or TTML formats
  • 🏷️ Rich Metadata - Automatic tagging with comprehensive metadata
  • 🎤 Artist Support - Download all albums or music videos from an artist
  • ⚙️ Highly Customizable - Extensive configuration options for advanced users

📋 Prerequisites

Required

Optional Dependencies

Wrapper

Run the Wrapper v2 server for wrapper-backed account, playback, and decryption requests. Enable it with --use-wrapper or use_wrapper = true. Configure wrapper HTTP account/playback calls with --wrapper-url or wrapper_url, and configure WV2D batch TCP decrypt with --wrapper-decrypt-host / --wrapper-decrypt-port.

gamdl builds a private Rust extension from gamdl/downloader/ammuxer as gamdl._ammuxer. That native media engine handles wrapper TCP decrypt/reassembly plus MP4/M4A writing and muxing; Python remains responsible for the CLI, downloads, metadata tagging, and high-level orchestration.

The wrapper is recommended when using the alac song codec. ALAC can be attempted without wrapper, but it probably won't work due to API limitations.

Note:

  • When using the Wrapper, you'll be asked to insert your credentials to login if you haven't already.
  • Newer wrapper-v2 builds use HTTP JSON for account/playback and WV2D batch TCP port 10020 for decrypt.
  • Song codecs other than alac do not require the wrapper.
  • Cookies can be skipped when using the wrapper.

N_m3u8DL-RE

Use N_m3u8DL-RE as a faster download alternative to the default yt-dlp download mode. Enable it with --download-mode nm3u8dlre or download_mode = nm3u8dlre.

If the executable is not available in your system PATH, set its location with --nm3u8dlre-path or nm3u8dlre_path.

N_m3u8DL-RE also needs FFmpeg. If the FFmpeg executable is not available in your system PATH, set its location with --ffmpeg-path or ffmpeg_path.

📦 Installation

  1. Install Gamdl via pip:

    pip install gamdl-ext
    
  2. Set up the cookies file:

    • Place the cookies file in the working directory as cookies.txt, or
    • Specify the path using --cookies-path or in the config file
  3. Optional: Set up dependencies (only if you need the functionality) See the Optional Dependencies section to determine which optional tools you need.

🚀 Usage

gamdl [OPTIONS] URLS...

Supported URL Types

  • Songs (Catalog/Library)
  • Albums (Catalog/Library)
  • Playlists (Catalog/Library)
  • Music Videos (Catalog/Library)
  • Artists
  • Post Videos
  • Apple Music Classical

Examples

Download a song:

gamdl-ext "https://music.apple.com/us/album/never-gonna-give-you-up-2022-remaster/1624945511?i=1624945512"

Download an album:

gamdl-ext "https://music.apple.com/us/album/whenever-you-need-somebody-2022-remaster/1624945511"

Download from an artist:

gamdl-ext "https://music.apple.com/us/artist/rick-astley/669771"

Interactive Prompt Controls:

Key Action
Arrow keys Move selection
Space Toggle selection
Ctrl + A Select all
Enter Confirm selection

⚙️ Configuration

Configure Gamdl using command-line arguments or a config file.

Config file location:

  • Linux: ~/.gamdl/config.ini
  • Windows: %USERPROFILE%\.gamdl\config.ini

The file is created automatically on first run. Command-line arguments override config values.

Configuration Options

Option Description Default
General Options
--read-urls-as-txt, -r Read URLs from text files false
--config-path Config file path <home>/.gamdl/config.ini
--log-level Logging level INFO
--log-file Log file path -
--no-exceptions Don't print exceptions false
--artist-auto-select Automatically select artist content to download (artist URLs) -
--database-path Path to the SQLite database file for registering downloaded media -
--no-config-file, -n Don't use a config file false
Apple Music Options
--cookies-path, -c Cookies file path ./cookies.txt
--wrapper-url Wrapper HTTP control base URL http://127.0.0.1
--wrapper-decrypt-host Wrapper TCP decrypt host 127.0.0.1
--wrapper-decrypt-port Wrapper TCP decrypt port 10020
--language, -l Metadata language en-US
Interface Options
--cover-format Cover format jpg
--cover-size Cover size in pixels 1200
--wvd-path .wvd file path -
--use-wrapper Use wrapper for account, playback, and decryption requests false
Song Options
--synced-lyrics-format Comma-separated synced lyrics format lrc
--song-codec-priority Comma-separated codec priority aac-web
--use-album-date Use album release date for songs false
--no-synced-lyrics Don't download synced lyrics false
--synced-lyrics-only Download only synced lyrics false
Music Video Options
--music-video-resolution Max music video resolution 1080p
--music-video-codec-priority Comma-separated codec priority h264,h265
--music-video-remux-format Music video remux format m4v
Post Video Options
--uploaded-video-quality Post video quality best
Download & Path Options
--output-path, -o Output directory path ./Apple Music
--temp-path Temporary directory path .
--nm3u8dlre-path N_m3u8DL-RE executable path N_m3u8DL-RE
--ffmpeg-path FFmpeg executable path ffmpeg
--download-mode Download mode ytdlp
Template Options
--album-folder-template Album folder template {album_artist}/{album}
--compilation-folder-template Compilation folder template Compilations/{album}
--no-album-folder-template No album folder template {artist}/Unknown Album
--playlist-folder-template Playlist folder template Playlists/{playlist_artist}
--single-disc-file-template Single disc file template {track:02d} {title}
--multi-disc-file-template Multi disc file template {disc}-{track:02d} {title}
--no-album-file-template No album file template {title}
--playlist-file-template Playlist file template {playlist_title}
--date-tag-template Date tag template %Y-%m-%dT%H:%M:%SZ
--exclude-tags Comma-separated tags to exclude -
--truncate Max filename length -
File Output Options
--overwrite Overwrite existing files false
--save-cover, -s Save cover as separate file false
--save-playlist Save M3U8 playlist file false

Template Variables

Tags for templates and exclude-tags:

  • album, album_artist, album_id
  • artist, artist_id
  • composer, composer_id
  • date (supports strftime format: {date:%Y})
  • disc, disc_total
  • media_type
  • playlist_artist, playlist_id, playlist_title, playlist_track
  • title, title_id
  • track, track_total

Tags for exclude-tags only:

  • album_sort, artist_sort, composer_sort, title_sort
  • album_artists, artists, comment, compilation, copyright, cover, gapless, genre, genre_id, isrc, language, lyrics, rating, record_label, release_date, releasetype, storefront, upc, xid
  • all (special: skip all tagging)

Logging Level

  • DEBUG, INFO, WARNING, ERROR

Download Mode

  • ytdlp, nm3u8dlre

[!NOTE]

  • yt-dlp is only used as a file download library. Media is still fetched directly from Apple Music's servers, and yt-dlp is only responsible for handling the file download process.

Cover Format

  • jpg
  • png
  • raw - Raw format as provided by the artist (requires save_cover to be enabled as it doesn't embed covers into files)

Metadata Language

Use ISO 639-1 language codes (e.g., en-US, es-ES, ja-JP, pt-BR). Don't always work for music videos.

Song Codecs

Web:

  • aac-web - AAC 256kbps 44.1kHz
  • aac-he-web - AAC-HE 64kbps 44.1kHz

Non-web (alac can be attempted without wrapper, but it probably won't work due to API limitations):

  • aac - AAC 256kbps up to 48kHz
  • aac-he - AAC-HE 64kbps up to 48kHz
  • aac-binaural - AAC 256kbps binaural
  • aac-downmix - AAC 256kbps downmix
  • aac-he-binaural - AAC-HE 64kbps binaural
  • aac-he-downmix - AAC-HE 64kbps downmix
  • atmos - Dolby Atmos 768kbps
  • ac3 - AC3 640kbps
  • alac - ALAC up to 24-bit/192kHz
  • ask - Interactive codec selection

Synced Lyrics Format

  • elrc - Enhanced LRC format
  • lrc
  • srt - SubRip subtitle format (more accurate timing)
  • ttml - Native Apple Music format (not compatible with most media players)

Music Video Codecs

  • h264
  • h265
  • ask - Interactive codec selection

Music Video Resolutions

  • H.264: 240p, 360p, 480p, 540p, 720p, 1080p
  • H.265 only: 1440p, 2160p

Music Video Remux Formats

  • m4v, mp4

Post Video Quality

  • best - Up to 1080p with AAC 256kbps
  • ask - Interactive quality selection

Artist Auto-Select Options

  • main-albums
  • compilation-albums
  • live-albums
  • singles-eps
  • all-albums
  • top-songs
  • music-videos

🐍 Embedding

Use Gamdl as a library in your Python projects:

import asyncio

from gamdl.api import AppleMusicApi
from gamdl.downloader import (
    AppleMusicBaseDownloader,
    AppleMusicDownloader,
    AppleMusicMusicVideoDownloader,
    AppleMusicSongDownloader,
    AppleMusicUploadedVideoDownloader,
)
from gamdl.interface import (
    AppleMusicBaseInterface,
    AppleMusicInterface,
    AppleMusicMusicVideoInterface,
    AppleMusicSongInterface,
    AppleMusicUploadedVideoInterface,
)


async def main():
    # Create AppleMusicApi instance from cookies
    apple_music_api = await AppleMusicApi.create_from_netscape_cookies(
        cookies_path="cookies.txt",
    )

    # Check subscription
    if not apple_music_api.active_subscription:
        print("No active Apple Music subscription")
        return

    # Create base interface
    base_interface = await AppleMusicBaseInterface.create(
        apple_music_api=apple_music_api,
    )

    # Create specialized interfaces
    song_interface = AppleMusicSongInterface(
        base=base_interface,
    )
    music_video_interface = AppleMusicMusicVideoInterface(
        base=base_interface,
    )
    uploaded_video_interface = AppleMusicUploadedVideoInterface(
        base=base_interface,
    )

    # Create main interface
    interface = AppleMusicInterface(
        song=song_interface,
        music_video=music_video_interface,
        uploaded_video=uploaded_video_interface,
    )

    # Create base downloader
    base_downloader = AppleMusicBaseDownloader(
        interface=interface,
    )

    # Create specialized downloaders
    song_downloader = AppleMusicSongDownloader(base=base_downloader)
    music_video_downloader = AppleMusicMusicVideoDownloader(
        base=base_downloader,
    )
    uploaded_video_downloader = AppleMusicUploadedVideoDownloader(base=base_downloader)

    # Create main downloader
    downloader = AppleMusicDownloader(
        song=song_downloader,
        music_video=music_video_downloader,
        uploaded_video=uploaded_video_downloader,
    )

    # Download from URL
    url = "https://music.apple.com/us/album/never-gonna-give-you-up-2022-remaster/1624945511?i=1624945512"

    download_queue = []
    async for media in downloader.get_download_item_from_url(url):
        download_queue.append(media)

    for download_item in download_queue:
        try:
            await downloader.download(download_item)
        except Exception as e:
            print(f"Error downloading: {e}")


if __name__ == "__main__":
    asyncio.run(main())

📄 License

MIT License - see LICENSE file for details

🤝 Contributing

Currently, I'm not interested in reviewing pull requests that change or add features. Only critical bug fixes will be considered. However, feel free to open issues for bugs or feature requests.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gamdl_ext-3.8.5.1.tar.gz (79.2 kB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

gamdl_ext-3.8.5.1-cp310-abi3-win_arm64.whl (359.2 kB view details)

Uploaded CPython 3.10+Windows ARM64

gamdl_ext-3.8.5.1-cp310-abi3-win_amd64.whl (370.1 kB view details)

Uploaded CPython 3.10+Windows x86-64

gamdl_ext-3.8.5.1-cp310-abi3-manylinux_2_34_x86_64.whl (506.4 kB view details)

Uploaded CPython 3.10+manylinux: glibc 2.34+ x86-64

gamdl_ext-3.8.5.1-cp310-abi3-manylinux_2_34_aarch64.whl (494.7 kB view details)

Uploaded CPython 3.10+manylinux: glibc 2.34+ ARM64

gamdl_ext-3.8.5.1-cp310-abi3-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl (824.2 kB view details)

Uploaded CPython 3.10+macOS 10.12+ universal2 (ARM64, x86-64)macOS 10.12+ x86-64macOS 11.0+ ARM64

File details

Details for the file gamdl_ext-3.8.5.1.tar.gz.

File metadata

  • Download URL: gamdl_ext-3.8.5.1.tar.gz
  • Upload date:
  • Size: 79.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for gamdl_ext-3.8.5.1.tar.gz
Algorithm Hash digest
SHA256 b2557d3bc5b20628378e6c81df60b7ad10105067247963434e457002f2db3140
MD5 b29a34bcf9e29df5e9aa070de1cb6730
BLAKE2b-256 6d38633125047b6782055d42a9063378600ed8074789736d132f66d626c52cb2

See more details on using hashes here.

Provenance

The following attestation bundles were made for gamdl_ext-3.8.5.1.tar.gz:

Publisher: python-publish.yml on rocketguedes/gamdl-ext

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file gamdl_ext-3.8.5.1-cp310-abi3-win_arm64.whl.

File metadata

  • Download URL: gamdl_ext-3.8.5.1-cp310-abi3-win_arm64.whl
  • Upload date:
  • Size: 359.2 kB
  • Tags: CPython 3.10+, Windows ARM64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for gamdl_ext-3.8.5.1-cp310-abi3-win_arm64.whl
Algorithm Hash digest
SHA256 83cd2c7982da97b5b111b21850b228ffbbe91b0498c879bcf3646edfdb590dbb
MD5 c21789ef81cc16e7a545569ef4d7b626
BLAKE2b-256 252753fb3dbfa3845bb8a14a81d40c56de58a101c8b2d0e48c919cad30acda76

See more details on using hashes here.

Provenance

The following attestation bundles were made for gamdl_ext-3.8.5.1-cp310-abi3-win_arm64.whl:

Publisher: python-publish.yml on rocketguedes/gamdl-ext

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file gamdl_ext-3.8.5.1-cp310-abi3-win_amd64.whl.

File metadata

  • Download URL: gamdl_ext-3.8.5.1-cp310-abi3-win_amd64.whl
  • Upload date:
  • Size: 370.1 kB
  • Tags: CPython 3.10+, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for gamdl_ext-3.8.5.1-cp310-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 c41ea37267bb36302686d5b50601edb8e7149e26de05161a0f92ff04c9ddd882
MD5 051cf42fa8f0ca8102978b99b9cfa1d3
BLAKE2b-256 96bd38f294b48f4f77fd969e5ca582539f56355ce2cb87453787b29103a6aa87

See more details on using hashes here.

Provenance

The following attestation bundles were made for gamdl_ext-3.8.5.1-cp310-abi3-win_amd64.whl:

Publisher: python-publish.yml on rocketguedes/gamdl-ext

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file gamdl_ext-3.8.5.1-cp310-abi3-manylinux_2_34_x86_64.whl.

File metadata

File hashes

Hashes for gamdl_ext-3.8.5.1-cp310-abi3-manylinux_2_34_x86_64.whl
Algorithm Hash digest
SHA256 773de0aa98d00f236757678ac58e1d2c3ae72c95ef161d4f8e9ff9c28bf40bf6
MD5 2e7ba28b5d1c890976855c276ea7ca88
BLAKE2b-256 9159990f636633b9507931d4403153386a1a695b4fbbb3e88ee5b499d0e6c5c0

See more details on using hashes here.

Provenance

The following attestation bundles were made for gamdl_ext-3.8.5.1-cp310-abi3-manylinux_2_34_x86_64.whl:

Publisher: python-publish.yml on rocketguedes/gamdl-ext

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file gamdl_ext-3.8.5.1-cp310-abi3-manylinux_2_34_aarch64.whl.

File metadata

File hashes

Hashes for gamdl_ext-3.8.5.1-cp310-abi3-manylinux_2_34_aarch64.whl
Algorithm Hash digest
SHA256 0c715f844d90a9cc70de9d3ea68df21b97f24c11138d6c54a6e7529ddd05a689
MD5 db57e0079882e4e9c369703bc90136aa
BLAKE2b-256 4ec5f5a22fbf555a9437026fece0f02cd8d8ddad4bb12e730c1e2e640481acdb

See more details on using hashes here.

Provenance

The following attestation bundles were made for gamdl_ext-3.8.5.1-cp310-abi3-manylinux_2_34_aarch64.whl:

Publisher: python-publish.yml on rocketguedes/gamdl-ext

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file gamdl_ext-3.8.5.1-cp310-abi3-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl.

File metadata

File hashes

Hashes for gamdl_ext-3.8.5.1-cp310-abi3-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl
Algorithm Hash digest
SHA256 ccefaed2918733fa931c56e0c6c5cbfbeb2bfe8664a1594d01cd85c69fe41674
MD5 bb71d6168aaa8331464fa983277b829d
BLAKE2b-256 f81c2672660a6ddaba209d38c2875286bcda2ee2966c58421624897d058b7dc2

See more details on using hashes here.

Provenance

The following attestation bundles were made for gamdl_ext-3.8.5.1-cp310-abi3-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl:

Publisher: python-publish.yml on rocketguedes/gamdl-ext

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

3.8.5.1 This release

6 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page