core

KO | EN

gitlite — search

#shell #chatbot #privacy #web #mysql #security #developer-tools #ui #awesome-list #markdown

(★ 9)

Custom Audio and Youtube Parser Engine for ArchiveTune

File Explorer

ZIP Download

.gitignore
build.gradle.kts
LICENSE
README.md

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Version

File

Link

Example

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h1>ArchiveTune Core</h1>

InnerTube API client for YouTube Music.
 
 The core library powering <a href="https://github.com/rukamori/ArchiveTune">ArchiveTune</a> — a high-performance, privacy-focused YouTube Music client for Android.

</div>

## Overview

This is the standalone InnerTube API core extracted from [ArchiveTune](https://github.com/rukamori/ArchiveTune). It provides a complete Ktor-based HTTP client for interacting with YouTube Music's InnerTube API, including request signing, response parsing, fixed-proxy support, and playback authentication.

## Features

- **Full API Coverage** — search, browse, library, playlist management, playback, and account interactions
- **Ktor Client** — built on Ktor with OkHttp engine, content negotiation, brotli encoding, and DNS-over-HTTPS
- **Response Parsing** — complete set of Kotlinx Serialization models for InnerTube responses
- **Page Parsers** — domain-level parsers that transform raw JSON into typed page objects
- **Proxy Support** — optional fixed HTTP or SOCKS proxy configuration
- **Playback Auth** — PO token management for authenticated playback
- **NewPipe Integration** — optional cipher deobfuscation and stream URL extraction via NewPipe Extractor

## Architecture

The diagram below shows how this library fits into the ArchiveTune app and how data flows through the layers.

```mermaid
flowchart TB
 subgraph Android["ArchiveTune App (Android)"]
 UI["Jetpack Compose UI Screens & Components"]
 VM["ViewModels State holders"]
 SVC["Services MusicService, Player"]
 DB["Room Database Local cache"]
 end

subgraph Core["core (this library)"]
 YT["YouTube.kt High-level API singleton"]
 IT["InnerTube.kt Ktor HTTP client"]
 MB["MusicBackend.kt API contract"]

subgraph Models["Models"]
 REQ["Request bodies (SearchBody, PlayerBody, ...)"]
 RES["Response models (PlayerResponse, BrowseResponse, ...)"]
 end

subgraph Pages["Pages"]
 PARSERS["Page parsers (AlbumPage, ArtistPage, SearchPage, ...)"]
 end

AUTH["PlaybackAuthState PO token & cookie management"]
 UTILS["Utils"]
 end

subgraph External["External"]
 YTM["YouTube Music InnerTube API"]
 NEWPIPE["NewPipe Extractor Cipher / stream URL"]
 BANDCAMP["Bandcamp / SoundCloud (via NewPipe)"]
 end

UI --> VM --> SVC
    SVC --> YT
    YT --> IT
    YT --> MB
    MB --> IT
    IT --> Models
    IT --> Pages
    IT --> AUTH
    IT --> UTILS
    IT -->|HTTP / Ktor| YTM
    IT -->|Stream decryption| NEWPIPE
    NEWPIPE --> BANDCAMP
    VM --> DB
```

**Data flow:**
1. User interacts with ArchiveTune's Compose UI
2. ViewModels & Services call `YouTube.*` methods
3. `YouTube` delegates to `InnerTube` via the `MusicBackend` interface
4. `InnerTube` builds signed requests, sends them via Ktor to YouTube Music's InnerTube API
5. Raw JSON responses are deserialized into typed response models
6. Page parsers transform structured responses into domain page objects
7. For playback, stream URLs are decrypted via NewPipe Extractor (optional)

## Package Structure

```
moe.rukamori.archivetune.innertube/
├── InnerTube.kt              — Core HTTP client
├── YouTube.kt                — High-level API singleton (main entry point)
├── MusicBackend.kt           — API contract interface
├── PlaybackAuthState.kt      — Authentication state model
├── SearchFilter.kt           — Search filter parameter helpers
├── LibraryFilter.kt          — Library filter parameter helpers
├── models/                   — Response data models (JSON deserialization targets)
│   ├── body/                 — Request body models
│   └── response/             — Response wrapper models
├── pages/                    — Page parsers (response-to-domain transformation)
├── proxy/                    — Proxy rotation and configuration
└── utils/                    — Shared utilities
```

## Dependencies

- **Ktor Client** 3.5.0 — HTTP client core, OkHttp engine, content negotiation, brotli encoding, JSON serialization
- **OkHttp** 5.3.2 — DNS-over-HTTPS support
- **Kotlinx Serialization** — JSON deserialization
- **NewPipe Extractor** 0.26.2 — stream URL extraction, cipher deobfuscation, Bandcamp/SoundCloud search
- **re2j** 1.8 — Google RE2 regular expressions
- **Rhino** 1.9.1 — JavaScript engine (cipher operations)

## Usage

```kotlin
// Search
val results = YouTube.search("query", SearchFilter.SONGS)

// Browse
val home = YouTube.home()
val album = YouTube.album("browse_id")
val artist = YouTube.artist("browse_id")
val playlist = YouTube.playlist("playlist_id")

// Player
val player = YouTube.player("video_id", "playlist_id", YouTubeClient.WEB)

// Playlist management
YouTube.createPlaylist("My Playlist", "description")
YouTube.addToPlaylist("playlist_id", listOf("video_id"))

// Auth
YouTube.authState = PlaybackAuthState(cookie = "...", visitorData = "...")
```

## License

[GNU General Public License v3.0](LICENSE)

core

Owner Repos

File Explorer

# Use via CDN

Was this content helpful?

Recent Feedback

core

Owner Repos

File Explorer

# Use via CDN

Was this content helpful?

Recent Feedback

Download README