diff --git a/README.md b/README.md index 96d2679..a8380d5 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,95 @@ ---- -layout: default -title: index ---- +# OpenBroadcaster Player -* TOC -{:toc} +## Project Overview +OpenBroadcaster Player (OBPlayer) is an open-source media playback and broadcasting tool for radio stations and media professionals. It works with OBServer to play scheduled media but can also function as a standalone or network-controlled player. Designed for continuous broadcasting, OBPlayer syncs with OBServer to update schedules, media, and priority broadcasts. If the schedule has gaps, it plays a default playlist. If that fails, it switches to Fallback Media Mode, then to analog input bypass, and finally to a test signal as a last resort. OBPlayer always prioritizes valid Common Alerting Protocol (CAP) messages. -## About the Player -{:toc} +## Key Features +- Multi-format media playback (audio, video, images) +- Live assist web interface +- Support for multiple streaming protocols +- Configurable outputs +- Remote override capabilities +- Integrated logging and monitoring +- Automatic fallback mechanisms +- Emergency alert (CAP) prioritization -OBPlayer is a stable and secure UNIX-based media streaming playout application that can operate as a standalone player or controlled over a network by a managing OBServer instance. It can be installed remotely at a transmitter site, in the studio or as a virtual headless process on a server. +## Supported Configurations +- Headless OBPlayer (CLI process) +- GTK Desktop application -OBPlayer is built with rules based intelligence to continue broadcasting no matter what happens. It functions by continually syncing with OBServer, looking for updated schedules, media, and priority broadcasts. If there is a blank spot in the schedule, it falls back to a Default Playlist. If that fails, it goes into Fallback Media Mode. If that fails, it plays from the analog input bypass. Finally, it will play a test signal as a last resort. +## Dependencies -OBPlayer will always play valid CAP (Common Alerting Protocol) Alerts at the highest priority. +### Core Dependencies +- Python 3.7+ +- GStreamer 1.0+ +- GTK 3.x +- inotify +- requests +- gi (GObject Introspection) +- FFmpeg -OBPlayer can be run in a variety of configurations: -+ Headless OBPlayer (Virtual Process) -+ LIVE Assist with Mobile HTML5 Touch Screen interface -+ GTK desktop application for a Digital Video Screen. -+ Standalone Emergency Alerting CAP Player supporting audio, image and video -+ Coming Soon Support For IPAWS CAP Profile Version 1.0 +## Installation +OBPlayer is designed to run on Linux Ubuntu 24.04. Installation scripts and containerized versions are available: +- [Reference Installer](https://github.com/pikaspace/openbroadcaster-reference-installer/blob/main/ubuntu-noble-obplayer.sh) +- [Containerized Version](https://github.com/btelliot/openbroadcaster-containers) -OpenBroadcaster Player -https://openbroadcaster.com/ +## Core Modules -Copyright 2012-2024 OpenBroadcaster, Inc. +### `Scheduler/` +- Manages media scheduling and playlists +- Handles show timing, transitions, and priority content +- Fallback content management -Licensed under GNU AGPLv3. See COPYING. +### `Player/` +- GStreamer-based media playback engine +- Supports audio/video pipelines, transitions, and multiple outputs +- Includes playback logging and error recovery + +### `HTTPAdmin/` +- Web dashboard for managing and monitoring the player +- Provides secure configuration, alert management, and playback control + +### `LiveAssist/` +- Web-based control interface for real-time playback and microphone input +- Playlist management and playback control + +### `Streamer/` +- Handles output streaming with protocols like Icecast and RTMP +- Manages stream encoding and network connectivity + + +## Priority System + +1. **Highest Priority** + - Emergency alerts (CAP) + - Station override signals + - Live assist input + +2. **Normal Priority** + - Scheduled content + - Regular playlists + - Advertisements + +3. **Fallback Priority** + - Default playlist + - Fallback media + - Test signal + +## Contributing + +1. Fork the repository +2. Create a feature branch +3. Commit your changes +4. Push to the branch +5. Create a Pull Request + +## License + +OpenBroadcaster Player is released under the GNU Affero General Public License v3.0. + +## Support + +- GitHub Issues: https://github.com/openbroadcaster/obplayer/issues +- Support Website: https://support.openbroadcaster.com/ \ No newline at end of file diff --git a/VERSION b/VERSION index b005977..da46513 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -5.3.0-20240601 +5.3.0-20250104 diff --git a/obplayer/data.py b/obplayer/data.py index e617e77..d18a9ec 100644 --- a/obplayer/data.py +++ b/obplayer/data.py @@ -425,6 +425,16 @@ def validate_setting(self, setting_name, setting_value, settings=None): ): return "station_override_passwords_invalid" + if setting_name == "fade_duration": + try: + fade_value = float(setting_value) + if fade_value < 0: + return "fade_duration_invalid" + if fade_value > 20: + return "fade_duration_too_long" + except ValueError: + return "fade_duration_not_numeric" + return None """ @@ -440,6 +450,7 @@ def check_defaults(self): "audio_caps", "audio/x-raw,channels=2,rate=44100,format=S16LE,layout=interleaved", ) + self.add_setting("fade_duration", "5.0", "float") self.add_setting("audio_out_mode", "auto", "text") self.add_setting("audio_out_alsa_device", "default", "text") self.add_setting("audio_out_jack_name", "", "text") diff --git a/obplayer/httpadmin/http/index.html b/obplayer/httpadmin/http/index.html index 8bd4a31..1f92d23 100644 --- a/obplayer/httpadmin/http/index.html +++ b/obplayer/httpadmin/http/index.html @@ -1,12844 +1,12854 @@ - - - - <%= obplayer.HTTPAdmin.title %> - - - - - - - - - - <% if obplayer.Config.setting('http_show_location'): %> - - - - - <% end %> - - <% if obplayer.Config.setting('http_admin_reload'): %> - - <% end %> - - - -

<%= obplayer.HTTPAdmin.title %>

- <% if obplayer.SUPPORTED == False: %> -
This system isn't a ML350/Raspberry Pi. This is a unsupported system, so your results may very.
- <% end %> - - <% if obplayer.Config.setting('http_admin_password',True) == 'admin': %> -
The admin password is set to the default. Please go to the HTTP(S) Admin tab and change it.
- <% end %> - - <% if sys.version_info.major == 2: %> -
This version of obplayer 5.0 is running on python2. Please upgrade your system dependencies and restart.
- <% end %> + + + + <%= obplayer.HTTPAdmin.title %> + + + + + + + + + + <% if obplayer.Config.setting('http_show_location'): %> + + + + + <% end %> + + <% if obplayer.Config.setting('http_admin_reload'): %> + + <% end %> + + + +

<%= obplayer.HTTPAdmin.title %>

+ <% if obplayer.SUPPORTED == False: %> +
This system isn't a ML350/Raspberry Pi. This is a unsupported system, so your results may very.
+ <% end %> + + <% if obplayer.Config.setting('http_admin_password',True) == 'admin': %> +
The admin password is set to the default. Please go to the HTTP(S) Admin tab and change it.
+ <% end %> + + <% if sys.version_info.major == 2: %> +
This version of obplayer 5.0 is running on python2. Please upgrade your system dependencies and restart.
+ <% end %> + +
+
Status
+
Summary
+
Admin
+ <% if obplayer.Config.setting('http_show_sync'): %>
Sync/Media
<% end %> +
Sources
+
Outputs
+ <% if obplayer.Config.setting('http_show_streaming'): %>
Streaming
<% end %> + <% if obplayer.Config.setting('http_show_alerts'): %>
Emergency Alerts
<% end %> + <% if obplayer.Config.setting('http_show_location'): %>
Location Map
<% end %> +
HTTP(S) Admin
+ <% if obplayer.Config.setting('http_show_liveassist'): %>
Live Assist
<% end %> + +
+ + +
-
-
Status
-
Summary
-
Admin
- <% if obplayer.Config.setting('http_show_sync'): %>
Sync/Media
<% end %> -
Sources
-
Outputs
- <% if obplayer.Config.setting('http_show_streaming'): %>
Streaming
<% end %> - <% if obplayer.Config.setting('http_show_alerts'): %>
Emergency Alerts
<% end %> - <% if obplayer.Config.setting('http_show_location'): %>
Location Map
<% end %> -
HTTP(S) Admin
- <% if obplayer.Config.setting('http_show_liveassist'): %>
Live Assist
<% end %> - -
- - -
+
+
+ -