# li-vien/ccclip architecture

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

- Interactive diagram: https://gitdiagram.com/li-vien/ccclip
- Repository: https://github.com/li-vien/ccclip

## Overview

##### Project Type and Purpose
- The project is a frontend media editor that performs client-side audio/video editing.
- Its core purpose is to allow timeline-based editing, including multi-track sequencing, trimming, and applying various effects, while handling media processing (such as frame extraction, cropping, and audio mixing) via FFmpeg integrated in the browser.

##### Analyzing the File Structure
- Top-level directories/files indicate key parts:
- “public/”: Holds static assets including audio, video, images, and the FFmpeg WASM binaries along with its JavaScript glue files. This shows the tight integration of FFmpeg processing.
- “vite.config.ts”, “pnpm-lock.yaml”, and various TypeScript configuration files indicating a modern frontend build system.
- Configuration files (.eslintrc, tailwind.config.js) suggest robust code quality and design styling.
- Directory patterns such as “components/container”, “components/item”, and various “src/data/options” files indicate a modular, component-based UI design, likely following one or more common design patterns (such as MVVM/MVC) to separate UI presentation from data and logic.

##### Main Components
- UI/Presentation Layer:
- Views: Editor and Preview pages (src/pages/views/Editor.vue and Preview.vue).
- UI Containers: HeaderContainer, CanvasPlayer, TrackContainer, and ResourcesContainer that define the editor’s layout.
- Application Logic Layer:
- Pinia Stores: Manage global state for page, track, and player (in src/stores).
- Routing and Plugin System: Auto-import and route registration (src/plugins/installRouter.ts and installIcon.ts) streamline component integration.
- API Modules: The “src/api” folder (even though it includes a “mock.ts”) that simulates data or media retrieval.
- Media Processing Integration:
- FFmpeg Integration: Components and utilities (such as src/plugins/installFFmpeg.ts, src/utils/ffmpegCommand.ts, and ffmpegManager.ts) encapsulate calls to FFmpeg, likely using the bundled WASM binaries (public/ffmpeg).
- Media Processing Utilities: Additional scripts for initializing audio (initAudio.ts) and drawing/canvas utilities (canvasUtil.ts).

##### Relationships and Interactions
- The UI components (editor/preview views) interact with the Pinia state management to keep track of media timelines and edits.
- User actions (such as trimming or track reordering) trigger updates in the stores, which in turn call utility functions to adjust the media processing commands.
- The FFmpeg integration module takes directive inputs (commands built using track parameters) and interacts with FFmpeg’s WASM core (stored in “public/ffmpeg”) to execute processing tasks.

##### Architectural Patterns & Design Principles
- Modularization: A clear separation of concerns is visible between UI components, state management, plugins, and media processing utilities.
- Declarative/Reactive Data Binding: Vue 3 and Pinia ensure reactive updates between the views (e.g., timeline adjustments) and underlying data.
- Client-Side FFmpeg processing: Integrating a WASM version of FFmpeg allows processing to be done without a dedicated backend, though the README also suggests that for heavy media information extraction there could be a server-backed flow.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% UI/Presentation Layer
    subgraph "UI/Presentation Layer"
        EditorView["Editor View"]:::ui
        PreviewView["Preview View"]:::ui
        subgraph "Container Components"
            HeaderContainer["HeaderContainer"]:::ui
            CanvasPlayer["CanvasPlayer"]:::ui
            TrackContainer["TrackContainer"]:::ui
            ResourcesContainer["ResourcesContainer"]:::ui
        end
        TrackItems["Track Items"]:::ui
        IconComponents["Icons Components"]:::ui
    end

    %% Application Logic Layer
    subgraph "Application Logic Layer"
        PiniaStores["Pinia State Management"]:::logic
        APIMock["API (Mock Server)"]:::logic
        subgraph "Routing & Plugin System"
            Router["Auto-register Router"]:::logic
            IconPlugin["Auto-import Icons"]:::logic
            AxiosPlugin["Axios Plugin"]:::logic
            PiniaPlugin["Pinia Plugin"]:::logic
        end
    end

    %% Media Processing Module
    subgraph "Media Processing Module"
        FFmpegPlugin["FFmpeg Plugin"]:::media
        FFmpegCommand["FFmpeg Command Utilities"]:::media
        FFmpegManager["FFmpeg Manager"]:::media
        AudioInit["Audio Initialization Utility"]:::media
        CanvasUtility["Canvas Drawing Utility"]:::media
    end

    %% Build & Asset Management Layer
    subgraph "Build & Asset Management"
        FFmpegWASM["FFmpeg WASM & Binaries"]:::build
        subgraph "Media Assets"
            AudioAssets["Audio Assets"]:::build
            VideoAssets["Video Assets"]:::build
            ImageAssets["Image Assets"]:::build
        end
        subgraph "Build Configurations"
            ViteConfig["Vite Config"]:::build
            TailwindConfig["Tailwind Config"]:::build
        end
    end

    %% Interactions and Data Flow
    EditorView -->|"Triggers"| PiniaStores
    PreviewView -->|"Triggers"| PiniaStores
    PiniaStores -->|"Updates"| FFmpegCommand
    FFmpegCommand -->|"Calls"| FFmpegManager
    FFmpegManager -->|"Executes"| FFmpegWASM
    Router -->|"Registers"| EditorView
    Router -->|"Registers"| PreviewView
    IconPlugin -->|"Loads"| IconComponents
    HeaderContainer -->|"PartOf"| EditorView
    CanvasPlayer -->|"PartOf"| EditorView
    TrackContainer -->|"PartOf"| EditorView
    ResourcesContainer -->|"PartOf"| EditorView
    TrackItems -->|"UsedIn"| TrackContainer
    AxiosPlugin -->|"Supports"| APIMock

    %% Click Events for UI/Presentation Layer
    click EditorView "https://github.com/li-vien/ccclip/blob/master/src/pages/views/Editor.vue"
    click PreviewView "https://github.com/li-vien/ccclip/blob/master/src/pages/views/Preview.vue"
    click HeaderContainer "https://github.com/li-vien/ccclip/blob/master/src/components/container/HeaderContainer.vue"
    click CanvasPlayer "https://github.com/li-vien/ccclip/blob/master/src/components/container/CanvasPlayer.vue"
    click TrackContainer "https://github.com/li-vien/ccclip/blob/master/src/components/container/TrackContainer.vue"
    click ResourcesContainer "https://github.com/li-vien/ccclip/blob/master/src/components/container/ResourcesContainer.vue"
    click TrackItems "https://github.com/li-vien/ccclip/tree/master/src/components/item/trackItem"
    click IconComponents "https://github.com/li-vien/ccclip/tree/master/src/components/icons"

    %% Click Events for Application Logic Layer
    click PiniaStores "https://github.com/li-vien/ccclip/tree/master/src/stores"
    click APIMock "https://github.com/li-vien/ccclip/blob/master/src/api/mock.ts"
    click Router "https://github.com/li-vien/ccclip/blob/master/src/plugins/installRouter.ts"
    click IconPlugin "https://github.com/li-vien/ccclip/blob/master/src/plugins/installIcon.ts"
    click AxiosPlugin "https://github.com/li-vien/ccclip/blob/master/src/plugins/installAxios.ts"
    click PiniaPlugin "https://github.com/li-vien/ccclip/blob/master/src/plugins/installPiniaPlugin.ts"

    %% Click Events for Media Processing Module
    click FFmpegPlugin "https://github.com/li-vien/ccclip/blob/master/src/plugins/installFFmpeg.ts"
    click FFmpegCommand "https://github.com/li-vien/ccclip/blob/master/src/utils/ffmpegCommand.ts"
    click FFmpegManager "https://github.com/li-vien/ccclip/blob/master/src/utils/ffmpegManager.ts"
    click AudioInit "https://github.com/li-vien/ccclip/blob/master/src/components/item/player/initAudio.ts"
    click CanvasUtility "https://github.com/li-vien/ccclip/blob/master/src/components/item/player/canvasDraw.ts"

    %% Click Events for Build & Asset Management Layer
    click FFmpegWASM "https://github.com/li-vien/ccclip/tree/master/public/ffmpeg"
    click AudioAssets "https://github.com/li-vien/ccclip/tree/master/public/audio"
    click VideoAssets "https://github.com/li-vien/ccclip/tree/master/public/video"
    click ImageAssets "https://github.com/li-vien/ccclip/tree/master/public/image"
    click ViteConfig "https://github.com/li-vien/ccclip/blob/master/vite.config.ts"
    click TailwindConfig "https://github.com/li-vien/ccclip/blob/master/tailwind.config.js"

    %% Styles
    classDef ui fill:#FAD7A0,stroke:#333,stroke-width:2px;
    classDef logic fill:#AED6F1,stroke:#333,stroke-width:2px;
    classDef media fill:#A9DFBF,stroke:#333,stroke-width:2px;
    classDef build fill:#F5B7B1,stroke:#333,stroke-width:2px;
```
