# blairbai/fijkplayer architecture

> Architecture diagram of the GitHub repository blairbai/fijkplayer, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-18). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/blairbai/fijkplayer
- Repository: https://github.com/blairbai/fijkplayer

## Overview

##### Project Type and Purpose
- This is a cross‑platform Flutter plugin (“fijkplayer”) that exposes a video/media player API to Dart apps.
- It bundles native implementations on Android (Java), iOS (Objective‑C), and desktop (Go via Hover), all under a single Dart API.
- The “example” and “test” folders demonstrate integration and validate functionality; “docs” is a Jekyll‐powered documentation website.

##### High‑Level Architecture Overview
- A layered architecture with four main layers:
1. Flutter App Layer (e.g. example/)
2. Dart Plugin Layer (lib/)
3. Platform Channel / Plugin Registration Layer
4. Native Engine Layer (Android, iOS, Go)

##### Main Components
A. Flutter Application
- Example Flutter app using fijkplayer API (example/lib, example/android, example/ios, example/macos)
B. Dart Plugin API
- lib/fijkplayer.dart: High‑level FijkPlayer class
- lib/core/*: core Dart classes (FijkOption, FijkValue, FijkView, etc.)
- lib/ui/*: built‑in UI components (slider, panel, volume)
C. Platform Channel / Plugin Registry
- Generated by Flutter tooling at build time.
- On Android: FijkPlugin.java registers channels and routes Dart method calls.
- On iOS: FijkPlugin.{h,m} registers with Flutter engine and handles channels.
- On Desktop via Go: import.go.tmpl and plugin.go create a similar channel bridge.
D. Native Engine Wrappers
- Android (android/src/main/java/com/befovy/fijkplayer)
- FijkEngine.java: JNI interface to native ijkplayer
- FileMediaDataSource, RawMediaDataSource: data source handlers
- QueuingEventSink: event streaming into Dart
- iOS (ios/Classes)
- FijkPlugin, FijkPlayer, FijkHostOption, FijkQueuingEventSink: Objective‑C wrappers around ijkmediaframework
- Go (go/*.go + go/native-ijk.go)
- go-player.go, plugin.go, queue-sink.go: Go wrappers binding to ijkplayer via cgo
E. Third‑Party Engine
- ijkplayer (C/FFmpeg‑based) – compiled separately and linked into each native target.

##### Relationships and Data Flows
1. Dart UI code invokes methods on FijkPlayer (lib/core/fijkplayer.dart).
2. FijkPlayer uses MethodChannel to send “setDataSource”, “play”, “pause”, etc., to platform.
3. Platform registry (FijkPlugin) receives calls, delegates to native wrapper (FijkEngine on Android, Obj‑C class on iOS, Go code on desktop).
4. Native wrapper calls into ijkplayer C library to control playback.
5. Playback events (onPrepared, onProgress, onError) are dispatched back through QueuingEventSink to Dart via EventChannel.
6. Dart side emits events that update UI (FijkView) or notify the application.

##### Architectural Patterns and Principles
- Layered Separation: UI → Dart API → Platform Bridge → Native Engine
- Adapter/Facade: FijkEngine, FijkPlayer, and Go wrappers present a uniform API over C library.
- Event‑driven: EventChannel/QueuingEventSink decouple native callbacks from Dart listeners.
- Cross‑platform plugin pattern: platform channels and plugin registrars enable code reuse across mobile/desktop.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Flutter App Layer
    subgraph "Flutter App Layer"
        FlutterApp["Example App"]:::frontend
    end

    %% Dart Plugin Layer
    subgraph "Dart Plugin Layer"
        DartAPI["fijkplayer.dart"]:::frontend
        CoreLib["lib/core/"]:::frontend
        UILib["lib/ui/"]:::frontend
    end

    %% Platform Channel / Plugin Registration Layer
    subgraph "Platform Channel Layer"
        AndroidRegistrar["FijkPlugin.java"]:::channel
        iOSRegistrar["FijkPlugin.h/.m"]:::channel
        GoRegistrar["plugin.go / import.go.tmpl"]:::channel
    end

    %% Native Engine Wrapper Layer
    subgraph "Native Engine Layer"
        subgraph Android
            AE1["FijkEngine.java"]:::native
            AE2["FijkPlayer.java"]:::native
            AE3["FileMediaDataSource.java"]:::native
            AE4["RawMediaDataSource.java"]:::native
            AE5["QueuingEventSink.java"]:::native
            AE6["HostOption.java"]:::native
            AE7["FijkVolume.java"]:::native
        end
        subgraph iOS
            IE1["FijkPlayer.h/.m"]:::native
            IE2["FijkHostOption.h/.m"]:::native
            IE3["FijkQueuingEventSink.h/.m"]:::native
        end
        subgraph Go
            GE1["go-player.go"]:::native
            GE2["native-ijk.go"]:::native
            GE3["queue-sink.go"]:::native
            GE4["options.go"]:::native
            GE5["go-pointer.go"]:::native
            GE6["plugin.go"]:::native
            GE7["import.go.tmpl"]:::native
        end
    end

    %% Third-Party Engine
    ijk["ijkplayer (C Library)"]:::engine

    %% Connections
    FlutterApp -->|"uses API"| DartAPI
    DartAPI -->|"imports core/ui"| CoreLib
    DartAPI --> CoreLib
    DartAPI --> UILib

    DartAPI -->|"MethodChannel calls"| AndroidRegistrar
    DartAPI -->|"MethodChannel calls"| iOSRegistrar
    DartAPI -->|"MethodChannel calls"| GoRegistrar

    AndroidRegistrar -->|"delegates to"| AE1
    AndroidRegistrar --> AE2
    AndroidRegistrar --> AE3
    AndroidRegistrar --> AE4
    AndroidRegistrar --> AE5

    iOSRegistrar -->|"delegates to"| IE1
    iOSRegistrar --> IE2
    iOSRegistrar --> IE3

    GoRegistrar -->|"delegates to"| GE1
    GoRegistrar --> GE2
    GoRegistrar --> GE3

    AE1 -->|"JNI calls"| ijk
    AE2 --> ijk
    AE3 --> ijk
    AE4 --> ijk
    AE5 --> ijk

    IE1 -->|"ObjC calls"| ijk
    IE2 --> ijk
    IE3 --> ijk

    GE1 -->|"cgo calls"| ijk
    GE2 --> ijk
    GE3 --> ijk

    %% Event flow back
    AE5 -.->|"events"| DartAPI
    IE3 -.->|"events"| DartAPI
    GE3 -.->|"events"| DartAPI

    %% Click Events
    click FlutterApp "https://github.com/blairbai/fijkplayer/tree/main/example/"
    click DartAPI "https://github.com/blairbai/fijkplayer/blob/main/lib/fijkplayer.dart"
    click CoreLib "https://github.com/blairbai/fijkplayer/tree/main/lib/core/"
    click UILib "https://github.com/blairbai/fijkplayer/tree/main/lib/ui/"
    click AndroidRegistrar "https://github.com/blairbai/fijkplayer/blob/main/android/src/main/java/com/befovy/fijkplayer/FijkPlugin.java"
    click iOSRegistrar "https://github.com/blairbai/fijkplayer/blob/main/ios/Classes/FijkPlugin.h"
    click iOSRegistrar "https://github.com/blairbai/fijkplayer/blob/main/ios/Classes/FijkPlugin.m"
    click GoRegistrar "https://github.com/blairbai/fijkplayer/blob/main/go/plugin.go"
    click GoRegistrar "https://github.com/blairbai/fijkplayer/blob/main/go/import.go.tmpl"

    click AE1 "https://github.com/blairbai/fijkplayer/blob/main/android/src/main/java/com/befovy/fijkplayer/FijkEngine.java"
    click AE2 "https://github.com/blairbai/fijkplayer/blob/main/android/src/main/java/com/befovy/fijkplayer/FijkPlayer.java"
    click AE3 "https://github.com/blairbai/fijkplayer/blob/main/android/src/main/java/com/befovy/fijkplayer/FileMediaDataSource.java"
    click AE4 "https://github.com/blairbai/fijkplayer/blob/main/android/src/main/java/com/befovy/fijkplayer/RawMediaDataSource.java"
    click AE5 "https://github.com/blairbai/fijkplayer/blob/main/android/src/main/java/com/befovy/fijkplayer/QueuingEventSink.java"
    click AE6 "https://github.com/blairbai/fijkplayer/blob/main/android/src/main/java/com/befovy/fijkplayer/HostOption.java"
    click AE7 "https://github.com/blairbai/fijkplayer/blob/main/android/src/main/java/com/befovy/fijkplayer/FijkVolume.java"

    click IE1 "https://github.com/blairbai/fijkplayer/blob/main/ios/Classes/FijkPlayer.h"
    click IE1 "https://github.com/blairbai/fijkplayer/blob/main/ios/Classes/FijkPlayer.m"
    click IE2 "https://github.com/blairbai/fijkplayer/blob/main/ios/Classes/FijkHostOption.h"
    click IE2 "https://github.com/blairbai/fijkplayer/blob/main/ios/Classes/FijkHostOption.m"
    click IE3 "https://github.com/blairbai/fijkplayer/blob/main/ios/Classes/FijkQueuingEventSink.h"
    click IE3 "https://github.com/blairbai/fijkplayer/blob/main/ios/Classes/FijkQueuingEventSink.m"

    click GE1 "https://github.com/blairbai/fijkplayer/blob/main/go/go-player.go"
    click GE2 "https://github.com/blairbai/fijkplayer/blob/main/go/native-ijk.go"
    click GE3 "https://github.com/blairbai/fijkplayer/blob/main/go/queue-sink.go"
    click GE4 "https://github.com/blairbai/fijkplayer/blob/main/go/options.go"
    click GE5 "https://github.com/blairbai/fijkplayer/blob/main/go/go-pointer.go"
    click GE6 "https://github.com/blairbai/fijkplayer/blob/main/go/plugin.go"
    click GE7 "https://github.com/blairbai/fijkplayer/blob/main/go/import.go.tmpl"

    %% Styles
    classDef frontend fill:#a6cee3,stroke:#1f77b4,color:#000
    classDef channel fill:#b2df8a,stroke:#33a02c,color:#000
    classDef native fill:#fdbf6f,stroke:#ff7f00,color:#000
    classDef engine fill:#fb9a99,stroke:#e31a1c,color:#000
```
