Skip to content

Commit 2619d30

Browse files
committed
Update README.md
1 parent 3c242cb commit 2619d30

File tree

1 file changed

+81
-111
lines changed

1 file changed

+81
-111
lines changed

README.md

Lines changed: 81 additions & 111 deletions
Original file line numberDiff line numberDiff line change
@@ -1,150 +1,120 @@
11
# Drone HUD Editor
22

3-
A professional heads-up display (HUD) overlay editor for DJI drone videos, integrating telemetry data from SRT files. Create stunning, data-rich video overlays with real-time flight information.
4-
5-
![Drone HUD Editor Screenshot](screenshots/demo.png) *Drone HUD Editor*
6-
7-
## Features
8-
9-
### Video Playback
10-
- Automatic window sizing to fit video content
11-
- Maintains aspect ratio while maximizing screen usage
12-
- Smooth playback with frame buffering
13-
- Interactive timeline slider with markers
14-
- Audio playback support
15-
16-
### HUD Elements
17-
- **Compass**: Dynamic heading indicator with cardinal directions
18-
- **Speedometer**: Digital and analog speed display
19-
- **Camera Settings**: ISO and shutter speed overlay
20-
- **GPS Coordinates**: 6-decimal precision location display
21-
- **Altitude**: Height and vertical speed indicators
22-
- **Center Crosshair**: Precision aiming guide
23-
- **Interactive Map**: Real-time position tracking with flight path
24-
- **Horizontal Compass**: Intuitive navigation bar
25-
- All elements can be toggled individually
26-
27-
### Themes
28-
- Multiple built-in themes:
3+
Transform your DJI drone footage with professional heads-up display (HUD) overlays using original flight telemetry data. Create cinematic drone videos with real-time speed, altitude, GPS coordinates, and dynamic mapping.
4+
5+
![Drone HUD Editor Screenshot](screenshots/demo.png)
6+
7+
## ✨ Key Features
8+
9+
### 🎥 Video Processing
10+
- Smart preview generation for smooth playback
11+
- Hardware-accelerated video processing
12+
- Custom start/end markers for export
13+
- Background music integration with YouTube support
14+
15+
### 🎮 HUD Elements
16+
- Dynamic speedometer with adjustable scale
17+
- 3D compass with cardinal directions
18+
- Real-time GPS coordinates and altitude
19+
- Interactive mini-map with flight path
20+
- Camera settings display (ISO, shutter)
21+
- Customizable crosshair
22+
- Horizontal compass bar
23+
- All elements individually toggleable
24+
25+
### 🎨 Themes & Customization
26+
- 4 Professional themes:
2927
- Default Green
3028
- Military
3129
- Modern Blue
3230
- Night Vision
33-
- Customizable colors and opacity
34-
- High-contrast text with shadows for better visibility
35-
36-
### Telemetry Processing
37-
- Automatic SRT file detection and parsing
38-
- Real-time speed calculation from GPS data
39-
- Vertical speed from altitude changes
40-
- Heading calculation from coordinate changes
41-
- Smoothed data using weighted moving averages
42-
43-
### Export Capabilities
44-
- Export video with permanent HUD overlay
45-
- Optional background music integration
46-
- Maintains original video quality
47-
- Progress tracking during export
48-
- Cancellable export process
49-
50-
## Installation
51-
52-
1. Clone the repository:
31+
- Adjustable opacity
32+
- High-contrast text with shadows
33+
34+
### 🎵 Audio Features
35+
- Local audio file support (MP3, WAV, M4A)
36+
- Direct YouTube audio import
37+
- Volume control with crossfading
38+
- Audio preview during editing
39+
40+
## 🚀 Quick Start
41+
42+
### Prerequisites
43+
- Python 3.8 or higher
44+
- Git (for cloning)
45+
46+
### Installation
47+
48+
1. Clone and enter directory:
5349
```bash
5450
git clone https://github.com/airobinnet/DroneHUDEditor.git
5551
cd DroneHUDEditor
5652
```
5753

58-
1a. (Optional) Create a new virtual environment:
54+
2. Create virtual environment (recommended):
5955
```bash
6056
python -m venv venv
61-
source venv/bin/activate
57+
source venv/bin/activate # On Windows: venv\Scripts\activate
6258
```
6359

64-
2. Install required dependencies:
65-
60+
3. Install dependencies:
6661
```bash
6762
pip install -r requirements.txt
6863
```
6964

65+
### Running the App
7066

71-
## Usage
72-
73-
1. **Launch the Application**:
7467
```bash
7568
python main.py
7669
```
7770

71+
## 📖 Basic Usage
7872

73+
1. **Load Content**
74+
- Click "Load Video" or drag & drop
75+
- SRT files are auto-detected
76+
- Add background music (optional)
7977

80-
2. **Load Video**:
81-
- Click "Load Video" or drag and drop
82-
- The app automatically detects matching SRT files
83-
- Window resizes to optimal viewing size
78+
2. **Customize HUD**
79+
- Toggle elements with checkboxes
80+
- Choose theme from dropdown
81+
- Adjust speedometer range
82+
- Real-time preview updates
8483

85-
3. **Customize HUD**:
86-
- Toggle elements using checkboxes
87-
- Select theme from dropdown
88-
- Adjust speedometer scale
89-
- Changes appear in real-time
84+
3. **Export**
85+
- Set start/end markers (optional)
86+
- Click "Export"
87+
- Choose quality settings
88+
- Add background music
89+
- Monitor progress
9090

91-
4. **Playback Controls**:
92-
- Play/Pause button
93-
- Timeline scrubbing
94-
- Set start/end markers for export
95-
- Volume control
91+
## 🛠 Technical Details
9692

97-
5. **Export**:
98-
- Click "Export" to save with HUD
99-
- Optional: Add background music
100-
- Choose output location
101-
- Monitor export progress
93+
- Built with PyQt6 and OpenCV
94+
- Multi-threaded frame processing
95+
- Efficient frame buffering
96+
- OpenStreetMap integration
97+
- Hardware acceleration support
10298

103-
## Requirements
99+
## 🤝 Contributing
104100

105-
- Python 3.8+
106-
- OpenCV
107-
- PyQt6
108-
- NumPy
109-
- Pygame (for audio)
110-
- Folium (for maps)
111-
- MoviePy (for export)
112-
113-
See `requirements.txt` for complete list.
114-
115-
## Technical Details
116-
117-
- Built with PyQt6 for the user interface
118-
- Uses OpenCV for video processing
119-
- Multithreaded frame reading and processing
120-
- Efficient frame buffering system
121-
- Smooth data interpolation for telemetry
122-
- OpenStreetMap integration for mapping
123-
124-
## Contributing
125-
126-
Contributions are welcome! Please feel free to submit a Pull Request.
101+
Contributions welcome! Please:
127102

128103
1. Fork the repository
129-
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
130-
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
131-
4. Push to the branch (`git push origin feature/AmazingFeature`)
132-
5. Open a Pull Request
133-
134-
## License
135-
136-
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
104+
2. Create feature branch (`git checkout -b feature/Amazing`)
105+
3. Commit changes (`git commit -m 'Add Amazing Feature'`)
106+
4. Push to branch (`git push origin feature/Amazing`)
107+
5. Open Pull Request
137108

138-
## Acknowledgments
109+
## 📄 License
139110

140-
- OpenStreetMap for map data
141-
- DJI for SRT telemetry format
142-
- PyQt team for the GUI framework
143-
- OpenCV team for video processing capabilities
111+
MIT License - see [LICENSE](LICENSE) file
144112

145-
## Support
113+
## 💡 Support
146114

147-
If you encounter any issues or have questions, please file an issue on the GitHub repository.
115+
- Issues: Use GitHub issue tracker
116+
- Questions: Open a discussion
117+
- Updates: Watch repository for releases
148118

149119
---
150-
Made with ❤️ for drone pilots and video editors
120+
Made with ❤️ by drone enthusiasts, for drone enthusiasts

0 commit comments

Comments
 (0)