# arakne/arakneswf architecture

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

- Interactive diagram: https://gitdiagram.com/arakne/arakneswf
- Repository: https://github.com/arakne/arakneswf

## Overview

##### Project type & purpose
- This is a PHP library (plus CLI tool) for parsing and extracting resources from SWF (Flash) files.
- It provides:
- A SwfFile façade to open/validate SWF streams
- A Parser module (raw tag reader -> structured tag/record objects)
- An AVM interpreter for ActionScript 2 variables
- Drawer back-ends: an SVG canvas implementation and a raster‐converter (via Imagick/InkScape/Rsvg)
- A small Console layer (bin/swf-extract) that invokes the core library

##### File‐structure → architectural layers
- bin/ (CLI entrypoint)
- src/Console → Symfony-style Command + options → orchestration layer
- src/SwfFile.php → façade that wires Parser, Extractor, AVM Processor
- src/Parser → low-level reader (SwfReader) + domain structures (Tag/Record classes)
- src/Avm → AVM interpreter (Processor + State + API)
- src/Extractor/Drawer/Svg → vector rendering
- src/Extractor/Drawer/Converter → raster conversion engine
- src/Error, src/Util → shared utilities & error flags
- tests/ → per-module unit/integration tests

##### Key interactions
- CLI → SwfFile façade → optionally variables()/execute() on AVM Processor or calls SwfExtractor
- SwfFile invokes Parser to produce Tag objects
- Parser → structured tags/records → returned to SwfFile/Extractor
- SwfExtractor builds in-memory models: ShapeDefinition, SpriteDefinition, Timeline
- DrawerInterface implementations render those models → SVGCanvas or Converter
- Converter uses external renderer back-ends (Imagick, Inkscape, Rsvg) for PNG/JPEG/GIF/WebP
- All layers respect Errors flags to handle corrupted data

- CLI Layer (bin/swf-extract + ExtractCommand)
- Facade Layer (SwfFile)
- Parser Layer
- AVM Interpreter
- Extractor Layer
- Drawer Layer
– SVG Canvas
– Raster Converter (Imagick / Inkscape / Rsvg back-ends)
- External Dependencies (gd, xml, json, Imagick, rsvg-convert, inkscape)
- Output & Storage (filesystem for SVG/PNG/JPEG)
- CLI → SwfFile façade (method calls)
- SwfFile → Parser (parse tags)
- SwfFile → AVM Processor (execute)
- Extractor → DrawerInterface → specific SVGCanvas or Converter
- Converter → external renderer executables/extensions
- Drawer → outputs SVG, PNG, JPEG files on disk
c. Architectural patterns & principles
- Facade (SwfFile) simplifies complex subsystem
- Strategy / Provider (DrawerInterface + multiple implementations)
- Layered separation: parsing, processing, rendering
- Dependency Injection: pass Processor, State, Drawer to methods
- Error-flag bitmask for configurable error handling
d. Technologies & libraries
- Pure PHP (≥8.4)
- Composer autoload (PSR-4)
- PHP extensions: gd, xml, json, Imagick
- External commands: librsvg2-bin (rsvg-convert), inkscape

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% CLI Layer
    subgraph "CLI Layer" 
        direction TB
        CLIExe["bin/swf-extract"]:::cli
        ExtractCommand["ExtractCommand.php"]:::cli
        ExtractOptions["ExtractOptions.php"]:::cli
    end

    %% Facade Layer
    SwfFile["SwfFile"]:::facade

    %% Core Modules
    subgraph "Core Library" 
        direction TB
        subgraph "Parser Layer"
            SwfReader["SwfReader"]:::core
            SwfParser["Swf.php"]:::core
            Structure["Structure/*"]:::core
            ParserError["Parser/Error/*"]:::core
        end
        subgraph "AVM Interpreter"
            Processor["Processor"]:::core
            State["State"]:::core
            ScriptArray["ScriptArray"]:::core
            ScriptObject["ScriptObject"]:::core
        end
        subgraph "Extractor Layer"
            SwfExtractor["SwfExtractor"]:::core
            ShapeDef["Shape/*"]:::core
            SpriteDef["SpriteDefinition.php"]:::core
            Timeline["Timeline/*"]:::core
            ImageDef["Image/*"]:::core
            GDUtil["Util/GD.php"]:::core
            MissingChar["MissingCharacter.php"]:::core
            ExtractorError["Extractor/Error/*"]:::core
        end
    end

    %% Drawer Interfaces
    Drawable["DrawableInterface"]:::interface
    DrawerIntf["DrawerInterface"]:::interface

    %% SVG Canvas Drawer
    subgraph "SVG Drawer" 
        direction TB
        AbstractSvg["AbstractSvgCanvas"]:::svg
        SvgCanvas["SvgCanvas"]:::svg
        SvgBuilder["SvgBuilder"]:::svg
        SvgPath["SvgPathDrawer"]:::svg
        SvgFilter["Filter/*"]:::svg
    end

    %% Raster Converter Drawer
    subgraph "Raster Converter" 
        direction TB
        ConverterCore["Converter"]:::converter
        ImageFormat["ImageFormat"]:::converter
        FitResizer["FitSizeResizer"]:::converter
        ImageResizerIntf["ImageResizerInterface"]:::converter
        subgraph "Renderer Resolvers"
            ImagickResolver["ImagickSvgRendererResolver"]:::converter
            InkscapeRenderer["InkscapeImagickSvgRenderer"]:::converter
            NativeRenderer["NativeImagickSvgRenderer"]:::converter
            RsvgRenderer["RsvgImagickSvgRenderer"]:::converter
            AbstractCmd["AbstractCommandImagickSvgRenderer"]:::converter
        end
    end

    %% External & Filesystem
    subgraph "External Dependencies / Filesystem"
        direction TB
        Errors["Errors"]:::external
        Externals["gd, xml, json, Imagick, rsvg-convert, inkscape"]:::external
        Filesys["Filesystem (SVG/PNG/JPEG)"]:::external
    end

    %% Connections
    CLIExe -->|"invokes"| SwfFile
    ExtractCommand -->|"invokes"| SwfFile
    ExtractOptions -->|"options"| ExtractCommand

    SwfFile -->|"parse(): Tag[] "| SwfReader
    SwfFile -->|"execute() "| Processor
    SwfFile -->|"extract() "| SwfExtractor

    Errors --> SwfReader
    Errors --> ParserError
    Errors --> Processor

    SwfReader --> Structure
    SwfReader --> ParserError
    Structure --> SwfParser

    SwfExtractor -->|builds models| ShapeDef
    SwfExtractor -->|builds models| SpriteDef
    SwfExtractor -->|builds models| Timeline
    SwfExtractor -->|builds image models| ImageDef
    SwfExtractor -->|uses| GDUtil
    SwfExtractor -->|uses| MissingChar
    SwfExtractor -->|errors| ExtractorError

    ShapeDef --> Drawable
    SpriteDef --> Drawable
    Timeline --> Drawable
    ImageDef --> Drawable

    Drawable --> DrawerIntf

    DrawerIntf --> SvgCanvas
    DrawerIntf --> ConverterCore

    SvgCanvas --> AbstractSvg
    SvgCanvas --> SvgBuilder
    SvgCanvas --> SvgPath
    SvgCanvas --> SvgFilter

    ConverterCore --> ImageFormat
    ConverterCore --> FitResizer
    ConverterCore --> ImageResizerIntf
    ConverterCore --> ImagickResolver
    ConverterCore --> InkscapeRenderer
    ConverterCore --> NativeRenderer
    ConverterCore --> RsvgRenderer
    ConverterCore --> AbstractCmd

    ImagickRenderer --> Externals
    RsvgRenderer --> Externals
    InkscapeRenderer --> Externals

    SvgCanvas --> Filesys
    ConverterCore --> Filesys

    %% Click Events
    click CLIExe "https://github.com/arakne/arakneswf/tree/master/bin/swf-extract"
    click ExtractCommand "https://github.com/arakne/arakneswf/blob/master/src/Console/ExtractCommand.php"
    click ExtractOptions "https://github.com/arakne/arakneswf/blob/master/src/Console/ExtractOptions.php"
    click SwfFile "https://github.com/arakne/arakneswf/blob/master/src/SwfFile.php"
    click SwfReader "https://github.com/arakne/arakneswf/blob/master/src/Parser/SwfReader.php"
    click SwfParser "https://github.com/arakne/arakneswf/blob/master/src/Parser/Swf.php"
    click Structure "https://github.com/arakne/arakneswf/tree/master/src/Parser/Structure/"
    click ParserError "https://github.com/arakne/arakneswf/tree/master/src/Parser/Error/"
    click Processor "https://github.com/arakne/arakneswf/blob/master/src/Avm/Processor.php"
    click State "https://github.com/arakne/arakneswf/blob/master/src/Avm/State.php"
    click ScriptArray "https://github.com/arakne/arakneswf/blob/master/src/Avm/Api/ScriptArray.php"
    click ScriptObject "https://github.com/arakne/arakneswf/blob/master/src/Avm/Api/ScriptObject.php"
    click SwfExtractor "https://github.com/arakne/arakneswf/blob/master/src/Extractor/SwfExtractor.php"
    click ShapeDef "https://github.com/arakne/arakneswf/tree/master/src/Extractor/Shape/"
    click SpriteDef "https://github.com/arakne/arakneswf/blob/master/src/Extractor/Sprite/SpriteDefinition.php"
    click Timeline "https://github.com/arakne/arakneswf/tree/master/src/Extractor/Timeline/"
    click ImageDef "https://github.com/arakne/arakneswf/tree/master/src/Extractor/Image/"
    click GDUtil "https://github.com/arakne/arakneswf/blob/master/src/Extractor/Image/Util/GD.php"
    click MissingChar "https://github.com/arakne/arakneswf/blob/master/src/Extractor/MissingCharacter.php"
    click ExtractorError "https://github.com/arakne/arakneswf/tree/master/src/Extractor/Error/"
    click Drawable "https://github.com/arakne/arakneswf/blob/master/src/Extractor/DrawableInterface.php"
    click DrawerIntf "https://github.com/arakne/arakneswf/blob/master/src/Extractor/Drawer/DrawerInterface.php"
    click AbstractSvg "https://github.com/arakne/arakneswf/blob/master/src/Extractor/Drawer/Svg/AbstractSvgCanvas.php"
    click SvgCanvas "https://github.com/arakne/arakneswf/blob/master/src/Extractor/Drawer/Svg/SvgCanvas.php"
    click SvgBuilder "https://github.com/arakne/arakneswf/blob/master/src/Extractor/Drawer/Svg/SvgBuilder.php"
    click SvgPath "https://github.com/arakne/arakneswf/blob/master/src/Extractor/Drawer/Svg/SvgPathDrawer.php"
    click SvgFilter "https://github.com/arakne/arakneswf/tree/master/src/Extractor/Drawer/Svg/Filter/"
    click ConverterCore "https://github.com/arakne/arakneswf/blob/master/src/Extractor/Drawer/Converter/Converter.php"
    click ImageFormat "https://github.com/arakne/arakneswf/blob/master/src/Extractor/Drawer/Converter/ImageFormat.php"
    click FitResizer "https://github.com/arakne/arakneswf/blob/master/src/Extractor/Drawer/Converter/FitSizeResizer.php"
    click ImageResizerIntf "https://github.com/arakne/arakneswf/blob/master/src/Extractor/Drawer/Converter/ImageResizerInterface.php"
    click ImagickResolver "https://github.com/arakne/arakneswf/blob/master/src/Extractor/Drawer/Converter/Renderer/ImagickSvgRendererResolver.php"
    click InkscapeRenderer "https://github.com/arakne/arakneswf/blob/master/src/Extractor/Drawer/Converter/Renderer/InkscapeImagickSvgRenderer.php"
    click NativeRenderer "https://github.com/arakne/arakneswf/blob/master/src/Extractor/Drawer/Converter/Renderer/NativeImagickSvgRenderer.php"
    click RsvgRenderer "https://github.com/arakne/arakneswf/blob/master/src/Extractor/Drawer/Converter/Renderer/RsvgImagickSvgRenderer.php"
    click AbstractCmd "https://github.com/arakne/arakneswf/blob/master/src/Extractor/Drawer/Converter/Renderer/AbstractCommandImagickSvgRenderer.php"

    %% Styles
    classDef cli fill:#b2f5b4,stroke:#2f855a,color:#22543d
    classDef facade fill:#bee3f8,stroke:#2b6cb0,color:#2a4365
    classDef core fill:#ebf8ff,stroke:#3182ce,color:#2a4365
    classDef interface fill:#c6f6d5,stroke:#38a169,color:#22543d
    classDef svg fill:#fff5f5,stroke:#dd6b20,color:#7b341e
    classDef converter fill:#fffaf0,stroke:#ed8936,color:#7b341e
    classDef external fill:#e2e8f0,stroke:#4a5568,color:#2d3748
```
