Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oatpp/example-hls-media-stream
Example project how-to build HLS-streaming server using oat++ Async-API.
https://github.com/oatpp/example-hls-media-stream
async cpp hls-live-streaming hls-server oatpp
Last synced: 3 days ago
JSON representation
Example project how-to build HLS-streaming server using oat++ Async-API.
- Host: GitHub
- URL: https://github.com/oatpp/example-hls-media-stream
- Owner: oatpp
- License: unlicense
- Created: 2019-01-29T02:01:07.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-04-22T21:27:12.000Z (7 months ago)
- Last Synced: 2024-10-29T23:45:31.777Z (15 days ago)
- Topics: async, cpp, hls-live-streaming, hls-server, oatpp
- Language: C++
- Homepage: https://oatpp.io/
- Size: 75 MB
- Stars: 70
- Watchers: 4
- Forks: 21
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Example-HLS-Media-Stream [](https://dev.azure.com/lganzzzo/lganzzzo/_build?definitionId=12&branchName=master)
Example project how-to build HLS-streaming server using oat++ (AKA oatpp) Async API.
Live stream is tested with Safari-Browser and VLC-player
See more:
- [Oat++ Website](https://oatpp.io/)
- [Oat++ Github Repository](https://github.com/oatpp/oatpp)
- [Get Started](https://oatpp.io/docs/start)
## Overview
Server generates infinite .m3u8 playlist from the pre-generated
```playlist_live.m3u8``` file in the ```video``` folder.
File ```video/playlist_live.m3u8``` together with video chunks is generated using ```ffmpeg```.
Server is built using oat++ Async-Api and has following endpoints:
- ```("GET", "/", Root)``` - Starting html-page aka index.html
- ```("GET", "video/*", Video)``` - Embedded video html-page
- ```("GET", "media/live", Live)``` - Infinite HLS playlist for live-stream describing video chunks
- ```("GET", "media/*", Static)``` - Endpoint serving media files with range requests support
### Project layout
```
|- CMakeLists.txt // projects CMakeLists.txt
|- src/ // source folder
|- test/ // test folder
|- utility/install-oatpp-modules.sh // utility script to install required oatpp-modules.
|
|- video/ // media files and playlists here
|- generate_pls.sh // example how to use ```ffmpeg``` to generate initial playlist and video chunks
|- playlist_live.m3u8 // playlist used to generate infinite playlist for http-live-streaming
```
```
- src/
|
|- controller/ // Folder containing UserController where all endpoints are declared
|- hls/ // Playlist generator is here
|- Utils.hpp // Utils
|- AppComponent.hpp // Service config
|- App.cpp // main() is here
```
---
### Build and Run
#### Using CMake
**Requires**
- `oatpp` module installed. You may run `utility/install-oatpp-modules.sh`
script to install required oatpp modules.
```
$ mkdir build && cd build
$ cmake ..
$ make
$ ./hls-example-exe # - run application.
```
#### In Docker
```
$ docker build -t example-hls .
$ docker run -p 8000:8000 -t example-hls
```
---
### Screenshots
---
## Notes
### Urls
- localhost:8000 - Index page
- localhost:8000/media/live - Live stream made from {repo}/video/video1.mp4 and {repo}/video/video2.mp4 played in the loop
### Files
- {repo}/video/playlist_live.m3u8 - playlist used for live HLS streaming
- {repo}/video/generate_pls.sh - example script used to generate sub-playlists and video fragmets using ffmpeg tool. #EXTINF sections of sub-playlists then have to be manualy moved to playlist_live.m3u8.
### Note
If app can't find playlist of video files then specify full-file-paths for {repo}/video/playlist_live.m3u8 file and {repo}/video folder in AppComponent.hpp