# kimcrowing/iptv architecture

> Architecture diagram of the GitHub repository kimcrowing/iptv, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-02-08). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/kimcrowing/iptv
- Repository: https://github.com/kimcrowing/iptv

## Overview

##### Project Type and Purpose
- This is a Kotlin-based, Gradle-built library (“ReVanced Patcher”) whose sole responsibility is to patch Android APKs.
- There is no UI layer here—this is a headless engine that powers other tools (CLI, Manager, Library) by exposing a modular patching API.

##### File‐Structure Analysis
- Top-Level:
- api/ – API descriptor for publishing
- docs/ & README.md – extensive user and developer docs
- src/main/kotlin/app/revanced/patcher – core engine code
- src/main/resources – version properties
- src/test/kotlin – unit tests
- Within src/main/kotlin/app/revanced/patcher:
- Patcher.kt, PatcherConfig.kt, PatcherContext.kt, PatcherResult.kt – façade and orchestration
- Fingerprint.kt, InternalApi.kt, PackageMetadata.kt – APK introspection & loading
- patch/ – core Patch abstraction, contexts (BytecodePatchContext, ResourcePatchContext)
- extensions/ – patch-writing helpers
- util/ – pure utilities (ClassMerger, MethodNavigator, ProxyClassList)
- util/proxy/* – mutable type proxies to build or transform class structures
- util/smali – InlineSmaliCompiler, label support for injecting smali

##### Key Insights from README
- Core features: disassemble/assemble Dalvik bytecode, decode/build APK resources, read/write arbitrary files.
- Modular patch API: each patch is a self-contained unit that targets bytecode, resources, or files.
- Designed for extensibility: new patches live in the “patch” package and plug into the engine.

##### Components
a. Main Components
- Consumer (ReVanced‐CLI, ReVanced‐Manager, other host)
- Patcher API (Patcher, PatcherConfig)
- APK Loader & Fingerprinter (InternalApi, Fingerprint, PackageMetadata)
- Patch Manager (loads Patch implementations, Option models)
- Bytecode Engine (BytecodePatchContext + InlineSmaliCompiler)
- Resource Engine (ResourcePatchContext + APK resource decoder/encoder)
- File Patcher (arbitrary file read/write from APK)
- Utility Modules (ClassMerger, MethodNavigator, ProxyClassList & proxies)
- Output Writer (rebuild APK, emit PatcherResult)

b. Relationships & Data Flow
1. Consumer → Patcher API: supply APK path & PatcherConfig
2. Patcher API → APK Loader: load metadata, compute fingerprint
3. Patcher API → Patch Manager: enumerate enabled patches
4. For each Patch:
– Bytecode patches go through Bytecode Engine
– Resource patches go through Resource Engine
– File patches go through File Patcher
– All use Utility Modules as needed
5. Engines emit transformed artifacts back to PatcherContext
6. Patcher API → Output Writer: rebuild patched APK & produce PatcherResult

c. Architectural Patterns & Principles
- Modular Plugin Pattern: patches implement a common Patch interface and register themselves via internal API.
- Facade: Patcher.kt hides complex engine details behind a simple entry point.
- Builder/Configurator: PatcherConfig encapsulates all options for enabling/disabling patches or engines.
- Layered Design: clear separation between API layer, core orchestration, engine implementations, and low-level utilities.

d. Key Technologies & Frameworks
- Kotlin & Gradle/Kotlin DSL
- smali/baksmali integration (InlineSmaliCompiler)
- APK resource decoder/encoder (aapt2 or third-party libs, implied)
- JUnit & Kotlin test libraries for unit tests

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% External Entities
    Consumer["Consumer (CLI/Manager/Library)"]:::external
    APK["APK File"]:::external

    %% Facade / API Layer
    subgraph "Facade (API)"
        Patcher["Patcher"]:::facade
        Config["PatcherConfig"]:::facade
        Context["PatcherContext"]:::facade
    end

    %% APK Loader & Fingerprinter
    subgraph "APK Loader & Fingerprinter"
        InternalApi["InternalApi"]:::facade
        Fingerprint["Fingerprint"]:::facade
        PackageMetadata["PackageMetadata"]:::facade
    end

    %% Patch Management
    subgraph "Patch Manager"
        PatchManager["Patch Manager"]:::facade
        PatchInterface["Patch Interface"]:::facade
        OptionModel["Option Model"]:::facade
    end

    %% Engines
    subgraph "Engines"
        BytecodeEngine["Bytecode Engine"]:::engine
        ResourceEngine["Resource Engine"]:::engine
        FilePatcher["File Patcher"]:::engine
    end

    %% Utility Modules
    Utilities["Utility Modules"]:::util

    %% Output Writer
    OutputWriter["Output Writer\n(PatcherResult)"]:::facade

    %% Data Flows
    Consumer -->|"invoke with APK & Config"| Patcher
    Patcher -->|"load metadata"| InternalApi
    InternalApi -->|"compute fingerprint"| Fingerprint
    InternalApi -->|"read metadata"| PackageMetadata
    Patcher -->|"enumerate patches"| PatchManager
    PatchManager -->|"uses Patch Interface & Options"| PatchInterface
    PatchManager -->|"uses Option Model"| OptionModel

    PatchManager -->|"dispatch patch"| BytecodeEngine
    PatchManager -->|"dispatch patch"| ResourceEngine
    PatchManager -->|"dispatch patch"| FilePatcher

    BytecodeEngine -->|"use utilities"| Utilities
    ResourceEngine -->|"use utilities"| Utilities
    FilePatcher -->|"use utilities"| Utilities

    BytecodeEngine -->|"emit artifacts"| Context
    ResourceEngine -->|"emit artifacts"| Context
    FilePatcher -->|"emit artifacts"| Context

    Context -->|"rebuild APK"| OutputWriter
    OutputWriter -->|"produce"| APK

    %% Click Events
    click Patcher "https://github.com/revanced/revanced-patcher/blob/main/src/main/kotlin/app/revanced/patcher/Patcher.kt"
    click Config "https://github.com/revanced/revanced-patcher/blob/main/src/main/kotlin/app/revanced/patcher/PatcherConfig.kt"
    click Context "https://github.com/revanced/revanced-patcher/blob/main/src/main/kotlin/app/revanced/patcher/PatcherContext.kt"
    click Fingerprint "https://github.com/revanced/revanced-patcher/blob/main/src/main/kotlin/app/revanced/patcher/Fingerprint.kt"
    click InternalApi "https://github.com/revanced/revanced-patcher/blob/main/src/main/kotlin/app/revanced/patcher/InternalApi.kt"
    click PackageMetadata "https://github.com/revanced/revanced-patcher/blob/main/src/main/kotlin/app/revanced/patcher/PackageMetadata.kt"
    click PatchManager "https://github.com/revanced/revanced-patcher/tree/main/src/main/kotlin/app/revanced/patcher/patch/"
    click PatchInterface "https://github.com/revanced/revanced-patcher/blob/main/src/main/kotlin/app/revanced/patcher/patch/Patch.kt"
    click OptionModel "https://github.com/revanced/revanced-patcher/blob/main/src/main/kotlin/app/revanced/patcher/patch/Option.kt"
    click BytecodeEngine "https://github.com/revanced/revanced-patcher/blob/main/src/main/kotlin/app/revanced/patcher/patch/BytecodePatchContext.kt"
    click ResourceEngine "https://github.com/revanced/revanced-patcher/blob/main/src/main/kotlin/app/revanced/patcher/patch/ResourcePatchContext.kt"
    click FilePatcher "https://github.com/revanced/revanced-patcher/blob/main/src/main/kotlin/app/revanced/patcher/patch/PatchContext.kt"
    click Utilities "https://github.com/revanced/revanced-patcher/tree/main/src/main/kotlin/app/revanced/patcher/util/"
    classDef facade fill:#D0E6FF,stroke:#3399FF,color:#000
    classDef engine fill:#DFF2D8,stroke:#33AA33,color:#000
    classDef util fill:#FFF9C4,stroke:#FFCC00,color:#000
    classDef external fill:#EEEEEE,stroke:#999999,color:#000
```
