# F1 Race Replay 🏎️ 🏁

A Python application for visualizing Formula 1 race telemetry and replaying race events with interactive controls and a graphical interface.

![Race Replay Preview](./resources/preview.png)

> **HUGE NEWS:** The telemetry stream feature is now in a usable state. See the [telemetry demo documentation](./telemetry.md) for access instructions, data format details, and usage ideas.

## Features

- **Race Replay Visualization:** Watch the race unfold with real-time driver positions on a rendered track.
- **Safety Car Visualization:** See the Safety Car deploy from pit lane, lead the field, and return to pits — with animated transitions and pulsing glow effects.
- **Insights Menu:** Floating menu for quick access to telemetry analysis tools (launches automatically with replay).
- **Leaderboard:** See live driver positions and current tyre compounds.
- **Lap & Time Display:** Track the current lap and total race time.
- **Driver Status:** Drivers who retire or go out are marked as "OUT" on the leaderboard.
- **Interactive Controls:** Pause, rewind, fast forward, and adjust playback speed using on-screen buttons or keyboard shortcuts.
- **Legend:** On-screen legend explains all controls.
- **Driver Telemetry Insights:** View speed, gear, DRS status, and current lap for selected drivers when selected on the leaderboard.

## Controls

- **Pause/Resume:** SPACE or Pause button
- **Rewind/Fast Forward:** ← / → or Rewind/Fast Forward buttons
- **Playback Speed:** ↑ / ↓ or Speed button (steps between 0.1x and 256x)
- **Set Speed Directly:** Keys 1–4 (0.5x, 1x, 2x, 4x)
- **Restart**: **R** to restart replay
- **Toggle DRS Zone**: **D** to hide/show DRS Zone
- **Toggle Progress Bar**: **B** to hide/show progress bar
- **Toggle Driver Names**: **L** to hide/show driver names on track
- **Toggle Session Info**: **I** to hide/show the session info banner
- **Drivers' Championship**: **C** to show/hide the live drivers' standings
- **Constructors' Championship**: **A** to show/hide the live constructors' standings
- **Controls Help**: **H** to show/hide the controls popup
- **Close Window**: **ESC**
- **Select driver/drivers**: Click to select driver or shift click to select multiple drivers


## Safety Car

The replay includes a **simulated Safety Car** that appears on track whenever the F1 data indicates a Safety Car deployment (track status code `4`). Since the F1 API does not provide GPS telemetry for the actual Safety Car, its position is simulated based on the race leader's position.

### How it works

- **Data source:** The Safety Car deployment timing comes from the real F1 track status data via FastF1 (`session.track_status`).
- **Position simulation:** The SC is placed ~500 meters ahead of the race leader on the track reference polyline. This approximates where the real SC would be relative to the field.
- **Three animation phases:**
  - **Deploying** — The SC animates from the pit lane onto the track over ~3 seconds, with a pulsing glow and "SC DEPLOYING" label.
  - **On Track** — The SC drives ahead of the leader with a steady amber glow and "SC" label.
  - **Returning** — The SC animates back to the pit lane over ~3 seconds, with a fading pulsing glow and "SC IN" label.
- **Visual appearance:** The SC is drawn as a larger orange/amber circle (8px radius vs 6px for regular cars) with an orange outline ring and always-visible "SC" label.

### Technical details

The SC position computation happens in `_compute_safety_car_positions()` in `src/f1_data.py`. Each frame gets a `safety_car` field:

```json
{
  "safety_car": {
    "x": 1234.56,
    "y": 7890.12,
    "phase": "on_track",
    "alpha": 1.0
  }
}
```

| Field | Description |
|-------|-------------|
| `x`, `y` | World coordinates of the SC |
| `phase` | `"deploying"`, `"on_track"`, or `"returning"` |
| `alpha` | Opacity value from `0.0` (invisible) to `1.0` (fully visible), used for fade in/out animation |

> **Note:** If you have existing cached `.pkl` files from previous runs, you must re-run with `--refresh-data` to generate SC position data. Older cached files will simply show no Safety Car.

## Qualifying Session Support (in development)

Recently added support for Qualifying session replays with telemetry visualization including speed, gear, throttle, and brake over the lap distance. This feature is still being refined.

## Requirements

- Python 3.11+
- [FastF1](https://github.com/theOehrly/Fast-F1)
- [Arcade](https://api.arcade.academy/en/latest/)
- numpy

Install dependencies:
```bash
pip install -r requirements.txt
```

FastF1 cache folder will be created automatically on first run. If it is not created, you can manually create a folder named `.fastf1-cache` in the project root
> **First Run Notice:** Loading a session for the first time may take noticeably longer because telemetry data must be downloaded, processed, and cached locally. Subsequent launches of the same session are significantly faster..

## Environment Setup

To get started with this project locally, you can follow these steps:

1. **Clone the Repository:**
   ```bash
   git clone https://github.com/IAmTomShaw/f1-race-replay
    cd f1-race-replay
    ```
2. **Create a Virtual Environment:**
    This process differs based on your operating system.
    - On macOS/Linux:
      ```bash
      python3 -m venv venv
      source venv/bin/activate
      ```
    - On Windows:
      ```bash
      python -m venv venv
      .\venv\Scripts\activate
      ```
3. **Install Dependencies:**
    ```bash
    pip install -r requirements.txt
    ```

4. **Run the Application:**
    You can now run the application using the instructions in the Usage section below.
## Troubleshooting
If the pull data proccess fails, run:
```bash
pip install --upgrade fastf1
```

## Usage

**DEFAULT GUI MENU:** To use the new GUI menu system, you can simply run:
```bash
python main.py
```

![GUI Menu Preview](./resources/gui-menu.png)

This will open a graphical interface where you can select the year and round of the race weekend you want to replay. This is still a new feature, so please report any issues you encounter.

**OPTIONAL CLI MENU:** To use the CLI menu system, you can simply run:
```bash
python main.py --cli
```

![CLI Menu Preview](./resources/cli-menu.gif)

This will prompt you with series of questions and a list of options to make your choice from using the arrow keys and enter key.

If you would already know the year and round number of the session you would like to watch, you run the commands directly as follows:

Run the main script and specify the year and round:
```bash
python main.py --viewer --year 2025 --round 12
```

To run without HUD:
```bash
python main.py --viewer --year 2025 --round 12 --no-hud
```

To run a Sprint session (if the event has one), add `--sprint`:
```bash
python main.py --viewer --year 2025 --round 12 --sprint
```

The application will load a pre-computed telemetry dataset if you have run it before for the same event. To force re-computation of telemetry data, use the `--refresh-data` flag:
```bash
python main.py --viewer --year 2025 --round 12 --refresh-data
```

To start the replay at a different speed, use the `--playback-speed` flag:
```bash
python main.py --viewer --year 2025 --round 12 --playback-speed 2
```

### Practice Session Replay

To run a Practice session replay, use the `--fp1`, `--fp2` or `--fp3` flag:
```bash
python main.py --viewer --year 2025 --round 12 --fp1
```

### Qualifying Session Replay

To run a Qualifying session replay, use the `--qualifying` flag:
```bash
python main.py --viewer --year 2025 --round 12 --qualifying
```

To run a Sprint Qualifying session (if the event has one), add `--sprint`:
```bash
python main.py --viewer --year 2025 --round 12 --qualifying --sprint
```

`--sprint-qualifying` does the same thing:
```bash
python main.py --viewer --year 2025 --round 12 --sprint-qualifying
```

## File Structure

```
f1-race-replay/
├── main.py                       # Entry point: parses CLI flags, loads the session and starts the replay
├── requirements.txt              # Python dependencies
├── requirements-dev.txt          # Runtime dependencies + pytest
├── README.md                     # Project documentation
├── roadmap.md                    # Planned features and project vision
├── telemetry.md                  # Telemetry stream usage and data format
├── docs/                         # Developer guides (Insights Menu, PitWallWindow, Testing)
├── resources/                    # Screenshots and preview images used in the docs
├── src/
│   ├── f1_data.py                # Telemetry loading, processing, frame generation & SC position simulation
│   ├── run_session.py            # Starts the Arcade replay window, insights menu and telemetry viewer
│   ├── ui_components.py          # Arcade UI components like buttons, leaderboard and HUD
│   ├── bayesian_tyre_model.py    # Bayesian tyre degradation model
│   ├── tyre_degradation_integration.py  # Connects the tyre model to the replay
│   ├── interfaces/               # Arcade replay windows
│   │   ├── race_replay.py        # Race replay interface, SC rendering & telemetry visualization
│   │   ├── qualifying.py         # Qualifying session interface and telemetry visualization
│   │   └── practice.py           # Practice session interface
│   ├── gui/                      # PySide6 windows
│   │   ├── race_selection.py     # GUI menu for choosing a season, round and session
│   │   ├── settings_dialog.py    # Cache and data location settings
│   │   ├── insights_menu.py      # Floating menu for launching insight windows
│   │   ├── pit_wall_window.py    # Base class for custom telemetry windows
│   │   └── pit_wall_window_template.py  # Starting template for a new insight window
│   ├── insights/                 # Insight windows fed by the telemetry stream
│   │   ├── driver_telemetry_window.py
│   │   ├── lap_time_chart_window.py
│   │   ├── race_control_feed_window.py
│   │   ├── sector_times_window.py
│   │   ├── track_position_window.py
│   │   ├── tyre_strategy_window.py
│   │   ├── telemetry_stream_viewer.py  # Raw telemetry stream viewer
│   │   └── example_pit_wall_window.py  # Example PitWallWindow implementation
│   ├── services/
│   │   └── stream.py             # TCP telemetry stream server and client
│   ├── cli/
│   │   └── race_selection.py     # CLI menu (python main.py --cli)
│   └── lib/                      # Small helpers
│       ├── season.py             # Current season detection
│       ├── sectors.py            # Sector time analysis helpers
│       ├── settings.py           # Persistent application settings
│       ├── time.py               # Time formatting utilities
│       └── tyres.py              # Tyre compound mapping
├── tests/                        # pytest suite (see docs/Testing.md)
├── .fastf1-cache/                # FastF1 cache folder (created automatically upon first run)
└── computed_data/                # Computed telemetry data (created automatically upon first run)
```

## Building Custom Telemetry Windows

When you start a race replay, an **Insights Menu** automatically appears, providing quick access to various telemetry analysis tools. You can easily create custom insight windows that receive live telemetry data using the `PitWallWindow` base class:

```python
from src.gui.pit_wall_window import PitWallWindow

class MyInsightWindow(PitWallWindow):
    def setup_ui(self):
        # Create your custom UI
        pass
    
    def on_telemetry_data(self, data):
        # Process telemetry data
        pass
```

The `PitWallWindow` base class handles all telemetry stream connection logic automatically, allowing you to focus solely on your window's functionality.

**Key Features:**
- Automatic connection to telemetry stream
- Built-in status bar with connection state
- Proper cleanup on window close
- Simple API - just implement `setup_ui()` and `on_telemetry_data()`

**Documentation & Examples:**
- See [docs/PitWallWindow.md](./docs/PitWallWindow.md) for complete guide
- See [docs/InsightsMenu.md](./docs/InsightsMenu.md) for adding insights to the menu
- Run the example: `python -m src.insights.example_pit_wall_window`
- Test the menu: `python -m src.gui.insights_menu`

## Customization

- Change track width, colors, and UI layout in `src/interfaces/race_replay.py` and `src/ui_components.py`.
- Adjust telemetry processing in `src/f1_data.py`.
- Create custom telemetry windows using `PitWallWindow` base class (see above).

## Contributing

There have been several contributions from the community that have helped enhance this project. I have added a [contributors.md](./contributors.md) file to acknowledge those who have contributed features and improvements.

If you would like to contribute, feel free to:

- Open pull requests for UI improvements or new features.
- Report issues on GitHub.

Please see [roadmap.md](./roadmap.md) for planned features and project vision.

# Known Issues

- If you are using a `conda` environment, you might need to install a few extra packages if you get this error:
```
arcade.application.NoOpenGLException: Unable to create an OpenGL 3.3+ context. Check to make sure your system supports OpenGL 3.3 or higher
```
You can easily fix this by running this command:
```bash
$ conda install -c conda-forge libstdcxx-ng
```
Thanks to @el-mandaloriano for showing how to resolve this issue: #12
- The leaderboard appears to be inaccurate for the first few corners of the race. The leaderboard is also temporarily affected by a driver going in the pits. At the end of the race, the leaderboard is sometimes affected by the drivers' final x,y positions being further ahead than other drivers. These are known issues caused by inaccuracies in the telemetry and are being worked on for future releases. It's likely that these issues will be fixed in stages as improving the leaderboard accuracy is a complex task.

## 📝 License

This project is licensed under the MIT License.

## ⚠️ Disclaimer

No copyright infringement intended. Formula 1 and related trademarks are the property of their respective owners. All data used is sourced from publicly available APIs and is used for educational and non-commercial purposes only.

---

Built with ❤️ by [Tom Shaw](https://tomshaw.dev)