Skip to content
Modular Media Player for Raspberry Pi and more...
Python C++ C JavaScript HTML Shell Other
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin/prebuilds install procedure Jan 22, 2020
core teleco Feb 10, 2020
extra http2 cleanup Oct 7, 2019
profiles teleco Feb 10, 2020
scripts Refactoring almost there Jan 30, 2020
.gitignore http2 simple May 21, 2019
LICENSE refactor project + arch binary Dec 6, 2016
README.md Update README.md Oct 7, 2019
TODO zero service naming Nov 18, 2019
hplayer2 install procedure Jan 22, 2020
hplayer2@.service move to /opt Nov 26, 2019
install.sh install procedure Jan 22, 2020
launcher.py install procedure Jan 22, 2020

README.md

HPlayer2

HPlayer2 is a modular media player designed to allow multiple ways of control, over multiple platform.

It is build in a modular way: you can choose the player engine (mpv, vlc, omxplayer, ...),
i/o interfaces (osc, http, rfid, ble, gpio, ...) and patch everything up.

HPlayer2 is focused on Raspberry Pi, but is based on python code wrapping 3rd parties engines and libraries, so as long as those 3rd parties components are supported on other platform, HPlayer2 should run on it !

HPlayer2 is under development, some features might not be fully available or sometimes broken, feel free to ask for help and open issues, i'll do my best to cover it. Pull requests are also welcomed !

Media engine

Hplayer2 abstracts the concept of player (media list, play, pause, stop, volume, position, ...), and then bind to an existing player engine.

On Raspberry Pi, i only managed to use 3 engines with Hardware acceleration on H.264 decoding:

  • omxplayer: the 1st HPlayer was based on via ofxOMXPlayer, but using OF on Pi was a bit tricky at the time
  • vlc: works great, but was tricky to compile on RPi when i tried it couple years ago
  • mpv: has a great build script, works very well and offers ipc interface to communicate with

The goal of HPlayer2 is to offer the choice between those 3 engines, but for now only mpv is supported.

Install

HPlayer2 is a python program, with several "modular" dependencies, depending on which component you will be using.
The core component you need to install is of course the media engine. For now, only mpv is supported, so you should install it, but the mpv package in your distro repository might not be compiled with HW video decoding, so it might be necessary to build it yourself with this specific options enabled.

There is a generic build script provided in scripts/build.sh that should cover most of the dependencies installation, including mpv. It is a bit long since mpv is re-compiled. The script might miss some recent dependencies (i sometime forget to update this script for brand new features).

This script supports arch and xbian (raspbian/debian/ubuntu)
On Raspberry Pi, i recommand using arch since boot up is faster, but it's up to you !

On your freshly configured Raspberry Pi:

cd ~
git clone https://github.com/Hemisphere-Project/HPlayer2.git
cd HPlayer2/scripts
sudo ./build.sh
cd ..

You should examine this build script to understand what it does.

You could run each part on your own instead of running the whole script blindly,
it will help in case it is broken (it can be !).

Run

Since HPlayer2 is modular, you must specify a "patch" or profile that link i/o interfaces to the engine.
There is a default profile provided, and several example based on projects where i use HPlayer2.

To start, go to HPlayer2 directory, and run ./hplayer2 profile
where profile is the name of a file in the profiles subdirectory (without the .py)

for exemple you can run ./hplayer2 chrd
which will start HPlayer with the profile located in profiles/chrd.py

if you omit the profile and simply run ./hplayer2
it will use the default profile located in profiles/default.py

Patch a profile

The idea here is for you to program you own profile !
(or to use an existing one if it feats your needs..)

Start reading the files in profiles/ to see examples on how profiles are made.
It's very simplified and patching oriented: an interface event can be plugged to a player action and vice-versa.

The idea in a profile is:

  • create a player
  • attach interfaces modules (OSC, HTTP, RFID, GPIO, ...)
  • patch events from interfaces to action on the player (NB: some events are already patched inside the modules)
  • run

You can check those profiles:

  • hpod: OSC player with video fade support (on RPi)
  • gadagne: HTTP and GPIO basic player
  • chrd: a simple Museum player, with HTTP2 webinterface
  • audioscope: RFID/NFC player (using PN532-like shield)
  • looper: read every files from basedir in a loop
  • ciconia: HTTP and LCD-Keypad interfaces
  • 1watt / chalon / kxkm: more advanced profiles, leveraging time sync via Zyre

Interfaces

A more complete documentation regarding the capabilities and the use of the different interface modules will be provided in the future (PR and help are welcome!).
Interfaces are available without the need of explicit inclusion, from directory core/interfaces/

Please check the profiles examples to see how to use those interfaces.

Available interfaces:

  • GPIO: allows patching RPi gpio event to player action
  • OSC: patching OSC message to player actions to control it from TouchOSC / MaxMSP / etc...
  • HTTP: bootstrap a basic HTTP server to enable network basic API
  • HTTP2: a nice web interface (responsive & websocket enabled) to setup an control HPlayer2
  • Keyboard: usb keyboard, numpad or infrared remotes like this one
  • Keypad: interface LCD+Keypad RPi shield like this one
  • NFC: interface RFID/NFC tag reader based on PN532 like this one

CREDITS

HPlayer2 is developed by Thomas BOHL for Hemisphere

HPlayer2 is build on top of MPV player, liblo, Adafruit libs and more.. thanks to all those open developers !

You can’t perform that action at this time.