# jart/gosip architecture

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

- Interactive diagram: https://gitdiagram.com/jart/gosip
- Repository: https://github.com/jart/gosip

## Overview

##### Component Relationships

- SIP signaling path (control plane)
- RTP media path (data plane)
- Dialog management interactions
- SDP negotiation flow

##### External Interfaces

Interfaces for:
- PSTN connectivity
- SIP service providers (e.g., Flowroute)
- DNS for SRV/NAPTR lookups
- Network layer interactions

##### Key Technical Elements to Highlight

a. Parser Implementation:
- Ragel-generated state machines
- Message parsing flow

b. Audio Processing:
- ΜLaw codec implementation
- SSE optimized mixing
- Comfort noise generation

##### Specific technical details
- Support for RFC3261 (SIP)
- Support for RFC4566 (SDP)
- Support for RFC3550 (RTP)
- Support for RFC4733 (DTMF)
- Failover mechanisms
- Mid-call audio/signaling path changes

## Diagram (Mermaid)

```mermaid
graph TB
    %% Define styles
    classDef core fill:#2196F3,stroke:#1565C0,color:white
    classDef media fill:#4CAF50,stroke:#2E7D32,color:white
    classDef session fill:#FFC107,stroke:#FFA000,color:black
    classDef dialog fill:#FF9800,stroke:#F57C00,color:white
    classDef dsp fill:#9E9E9E,stroke:#616161,color:white
    classDef transport fill:#795548,stroke:#5D4037,color:white

    %% Application Layer
    subgraph AppLayer["Application Layer"]
        App[Application Examples]
    end

    %% Dialog Management Layer
    subgraph DialogLayer["Dialog Management"]
        DM["Dialog Manager"]:::dialog
        DState["State Management"]:::dialog
        DRoute["Routing"]:::dialog
        DPrefs["Preferences"]:::dialog
        DTrans["Transport"]:::dialog
        DMsgs["Message Handler"]:::dialog

        DM --> DState
        DM --> DRoute
        DM --> DPrefs
        DM --> DTrans
        DM --> DMsgs
    end

    %% Signaling Layer
    subgraph SignalingLayer["Signaling Layer (SIP)"]
        SIPStack["SIP Stack"]:::core
        MsgParser["Message Parser<br/>(Ragel-based)"]:::core
        URIHandler["URI Handler"]:::core
        AddrMgmt["Address Management"]:::core
        TransInt["Transport Interface"]:::core

        SIPStack --> MsgParser
        SIPStack --> URIHandler
        SIPStack --> AddrMgmt
        SIPStack --> TransInt
    end

    %% Media Layer
    subgraph MediaLayer["Media Layer (RTP)"]
        RTPStack["RTP Stack"]:::media
        DTMF["DTMF Handler"]:::media
        MediaSession["Session Manager"]:::media
        RTPCore["Core RTP"]:::media

        RTPStack --> DTMF
        RTPStack --> MediaSession
        RTPStack --> RTPCore
    end

    %% Session Description Layer
    subgraph SDPLayer["Session Description (SDP)"]
        SDPCore["SDP Core"]:::session
        CodecNeg["Codec Negotiation"]:::session
        MediaDesc["Media Description"]:::session
        SessDesc["Session Description"]:::session
        Origin["Origin Handler"]:::session

        SDPCore --> CodecNeg
        SDPCore --> MediaDesc
        SDPCore --> SessDesc
        SDPCore --> Origin
    end

    %% DSP Layer
    subgraph DSPLayer["DSP Processing"]
        DSPCore["DSP Core"]:::dsp
        AssemblyOpt["Assembly Optimizations<br/>(SSE)"]:::dsp
        AWGN["AWGN Component"]:::dsp

        DSPCore --> AssemblyOpt
        DSPCore --> AWGN
    end

    %% Layer Connections
    App --> DM
    DM --> SIPStack
    DM --> RTPStack
    SIPStack --> SDPCore
    RTPStack --> DSPCore

    %% Click Events
    click SIPStack "https://github.com/jart/gosip/tree/master//sip"
    click MsgParser "https://github.com/jart/gosip/blob/master//sip/msg_parse.go"
    click URIHandler "https://github.com/jart/gosip/blob/master//sip/uri.go"
    click AddrMgmt "https://github.com/jart/gosip/blob/master//sip/addr.go"
    click TransInt "https://github.com/jart/gosip/blob/master//sip/via.go"
    click RTPStack "https://github.com/jart/gosip/tree/master//rtp"
    click DTMF "https://github.com/jart/gosip/blob/master//rtp/dtmf.go"
    click MediaSession "https://github.com/jart/gosip/blob/master//rtp/session.go"
    click RTPCore "https://github.com/jart/gosip/blob/master//rtp/rtp.go"
    click SDPCore "https://github.com/jart/gosip/tree/master//sdp"
    click CodecNeg "https://github.com/jart/gosip/blob/master//sdp/codec.go"
    click MediaDesc "https://github.com/jart/gosip/blob/master//sdp/media.go"
    click SessDesc "https://github.com/jart/gosip/blob/master//sdp/sdp.go"
    click Origin "https://github.com/jart/gosip/blob/master//sdp/origin.go"
    click DM "https://github.com/jart/gosip/tree/master//dialog"
    click DState "https://github.com/jart/gosip/blob/master//dialog/dialog.go"
    click DRoute "https://github.com/jart/gosip/blob/master//dialog/route.go"
    click DPrefs "https://github.com/jart/gosip/blob/master//dialog/prefs.go"
    click DTrans "https://github.com/jart/gosip/blob/master//dialog/transport.go"
    click DMsgs "https://github.com/jart/gosip/blob/master//dialog/messages.go"
    click DSPCore "https://github.com/jart/gosip/tree/master//dsp"
    click AssemblyOpt "https://github.com/jart/gosip/blob/master//dsp/dsp_amd64.s"
    click AWGN "https://github.com/jart/gosip/blob/master//dsp/awgn.go"
```
