diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..f66fce3 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +install.sh diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..7e5c69c --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,14 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +## [1.0.0] 2021-02-26 + +Initial release of `pi-player-lite` based on Raspberry Pi OS 2021-01-11 updated to Linux kernel 5.10.11 with added VLC 3.0.12 + +[Unreleased]: https://github.com/IMAGINARY/pi-player-lite/compare/v1.0.0...HEAD +[1.0.0]: https://github.com/IMAGINARY/pi-player-lite/compare/v0.0.0...v1.0.0 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..9bb49c5 --- /dev/null +++ b/LICENSE @@ -0,0 +1,191 @@ + + Apache License + Version 2.0, January 2004 + https://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + Copyright 2021 IMAGINARY gGmbH + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + https://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/Makefile b/Makefile new file mode 100755 index 0000000..9b7d61e --- /dev/null +++ b/Makefile @@ -0,0 +1,2 @@ +installer.run: package/* + makeself ./package install.sh "pi-player-lite installer" ./install \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..1ebfa09 --- /dev/null +++ b/README.md @@ -0,0 +1,128 @@ +# Pi Player Lite + +# Player setup + +## On your desktop system + + - Download [Raspberry Pi OS Lite](https://downloads.raspberrypi.org/raspios_lite_armhf/images/raspios_lite_armhf-2021-01-12/2021-01-11-raspios-buster-armhf-lite.zip) ([Torrent](https://downloads.raspberrypi.org/raspios_lite_armhf/images/raspios_lite_armhf-2021-01-12/2021-01-11-raspios-buster-armhf-lite.zip.torrent)). SHA256: `d49d6fab1b8e533f7efc40416e98ec16019b9c034bc89c59b83d0921c2aefeef` + - Flash the disk image to a SD card large enough to fit the OS (~2GiB) and your media files. + - Enlarge the root partition (ext4) to ~2GiB + - Create a *third* partition on the SD card: + - File system: FAT32 (files < 4GiB) or ExFAT (large files) + - Label: `MEDIA` + - Modify files on the `boot` partition: + - Remove `init=/usr/lib/raspi-config/init_resize.sh` from `cmdline.txt` + - (Optional) Enable `ssh` by creating an empty file called `ssh` + +## On the Raspberry Pi + +With the Raspberry Pi connected to the internet: + + - Execute the install script: + ``` + wget https://github.com/IMAGINARY/pi-player-lite/releases/download/v1.0.0/install.sh + chmod +x install.sh + sudo ./install.sh + ``` + - Activate overlay file system: + ``` + sudo raspi-config + ``` + Select `Performance Options` → `Overlay File System` and answer the questions with `Yes`. + - Reboot + +## Configuration +The player supports basic configuration by adding the file `/MEDIA/config.txt`. +Each line of the file holds one configuration option and its value separated by `=`. +Supported options include: +``` +randomize={0,1} +transform={90,180,270,hflip,vflip,transpose,antitranspose} +wait= +``` +The `wait` option can be used to delay the start of the media player by the given number of +seconds which is helpful if you need to log into the machine via a local terminal since the login and command prompt would otherwise be overlaid by the media player. + +### Screen rotation +It is recommended to enable rotation by adding either +``` +transform=90 +``` +or +``` +transform=270 +``` +to `/MEDIA/config.txt`. This will enable hardware accelerated rotation via VLC, +leaving OS-level screen rotation untouched. + +Raspberry Pi also supports the following options in `/boot/config.txt`: +``` +lcd_rotate=1 +display_lcd_rotate=1 +display_hdmi_rotate=1 +``` +However, our tests led to mixed results. In some cases, the rotation did not work at all. +In other cases, the rotation has been applied, but the video playback suffered +from stuttering, dropouts and especially video tearing. + +Therefore, you should prefer the method described above. + +### Miscellaneous +- If you power the display and the Raspberry Pi from the same power source, you might need to add `bootcode_delay=` to `/boot/config.txt` in order to delay access of the display until it is fully powered on. + +## Media files + - Add your media files to the `MEDIA` of the SD card + - By default, all media files are played in a loop. + - The playlist file `autoplay.m3u` can be added to restrict to a subset of the media files or enforce a specific order. + - Encode your videos in h.264. + - The container format does not matter much. VLC supports `.mp4`, `.mkv`, `.mov` and many others. + +## Remote control +The player exposed the [VLC telnet interface](https://wiki.videolan.org/Talk:Console/) on port 4212. This can be used for controlling the player remotely, e.g. for triggering actions based through hardware buttons. + +Netcat (`nc`) makes it easy to utilise this interface. + +Interactive: +``` +(echo "pi-player-lite" && cat) | nc [host] 4212 +``` + +Send single command: +``` +(echo -e "pi-player-lite\n[cmd]") | nc [host] 4212 -w0 +``` +Most important commands: +``` +add XYZ . . . . . . . . . . . . . . . . . . . . add XYZ to playlist +enqueue XYZ . . . . . . . . . . . . . . . . . queue XYZ to playlist +playlist . . . . . . . . . . . . . show items currently in playlist +play . . . . . . . . . . . . . . . . . . . . . . . . . . play stream +stop . . . . . . . . . . . . . . . . . . . . . . . . . . stop stream +next . . . . . . . . . . . . . . . . . . . . . . next playlist item +prev . . . . . . . . . . . . . . . . . . . . previous playlist item +goto [X], gotoitem [X] . . . . . . . . . . . . . goto item at index +pause . . . . . . . . . . . . . . . . . . . . . . . . toggle pause +volume [X] . . . . . . . . . . . . . . . . . . set/get audio volume +volup [X] . . . . . . . . . . . . . . . raise audio volume X steps +voldown [X] . . . . . . . . . . . . . . lower audio volume X steps +help, ? [pattern] . . . . . . . . . . . . . . . . . a help message +longhelp [pattern] . . . . . . . . . . . . . . a longer help message +logout . . . . . . . . . . . . . . exit (if in a socket connection) +``` + +## Building the installer script + +You need `make` and [`makeself`](https://makeself.io/). Once installed, run +``` +make +``` + +## Credits + +Developed by Christian Stussak for IMAGINARY gGmbH. + +## License + +Copyright 2021 IMAGINARY gGmbH + +Licensed under the Apache License, Version 2.0. \ No newline at end of file diff --git a/package/MEDIA.mount b/package/MEDIA.mount new file mode 100644 index 0000000..bf1d915 --- /dev/null +++ b/package/MEDIA.mount @@ -0,0 +1,10 @@ +[Unit] +Before=local-fs.target + +[Mount] +Where=/MEDIA +What=/dev/disk/by-label/MEDIA +Options=defaults,user,umask=0000,ro + +[Install] +RequiredBy=local-fs.target diff --git a/package/bg.png b/package/bg.png new file mode 100644 index 0000000..307a0d9 Binary files /dev/null and b/package/bg.png differ diff --git a/package/install b/package/install new file mode 100755 index 0000000..57467a8 --- /dev/null +++ b/package/install @@ -0,0 +1,45 @@ +#!/bin/bash + +# +set -e + +# cd into script directory +cd "${0%/*}" + +# Update system +apt update +apt upgrade -y + +# Install media players +apt install --no-install-recommends -y \ + pulseaudio \ + pulseaudio-utils \ + vlc \ + '' # dummy entry to terminate the list + +# Disable overscan and raise GPU memory +cat >> /boot/config.txt << EOF +[all] +disable_overscan=1 +gpu_mem=128 +hdmi_drive=2 +EOF + +# Create destination folder and copy script and resource file(s) +DESTINATION="/opt/pi-player-lite" +install -d "${DESTINATION}" +install run "${DESTINATION}" +install -m 644 bg.png "${DESTINATION}" + +# Setup systemd services +PI_USER_NAME=`logname` +PI_USER_ID=`id -u "$PI_USER_NAME"` +install -m 644 -t /etc/systemd/system MEDIA.mount +install -m 644 -t /etc/systemd/user *.service +systemctl daemon-reload +systemctl reenable MEDIA.mount +sudo -u "$PI_USER_NAME" XDG_RUNTIME_DIR=/run/user/`id -u "$PI_USER_ID"` systemctl --user reenable pi-player-lite +loginctl enable-linger "$PI_USER_NAME" + +echo +echo "Please reboot to complete the installation" diff --git a/package/pi-player-lite.service b/package/pi-player-lite.service new file mode 100644 index 0000000..1c226ae --- /dev/null +++ b/package/pi-player-lite.service @@ -0,0 +1,12 @@ +[Unit] +Description=VLC media player +After=MEDIA.mount +After=sound.target + +[Service] +Type=simple +ExecStart=/opt/pi-player-lite/run +Restart=always + +[Install] +WantedBy=default.target diff --git a/package/pulseaudio.service b/package/pulseaudio.service new file mode 100644 index 0000000..3dcddbc --- /dev/null +++ b/package/pulseaudio.service @@ -0,0 +1,14 @@ +[Unit] +Description=Pulseaudio Sound Service +Requires=pulseaudio.socket +Before=sound.target + +[Service] +Type=notify +ExecStart=/usr/bin/pulseaudio --verbose --daemonize=no +ExecStartPost=/usr/bin/pactl load-module module-alsa-sink +Restart=on-failure + +[Install] +Also=pulseaudio.socket +WantedBy=default.target diff --git a/package/pulseaudio.socket b/package/pulseaudio.socket new file mode 100644 index 0000000..7dadba0 --- /dev/null +++ b/package/pulseaudio.socket @@ -0,0 +1,10 @@ +[Unit] +Description=Pulseaudio Sound System + +[Socket] +Priority=6 +Backlog=5 +ListenStream=%t/pulse/native + +[Install] +WantedBy=sockets.target diff --git a/package/run b/package/run new file mode 100755 index 0000000..eba1326 --- /dev/null +++ b/package/run @@ -0,0 +1,100 @@ +#!/usr/bin/env bash + +PIDS="" +function finish { + EXIT_CODE=$? + kill $PIDS >/dev/null 2>&1 + exit $EXIT_CODE +} +trap finish SIGINT SIGTERM EXIT + +# Read the config file +typeset -A CONFIG # init array +CONFIG=( # set default values in config array + [randomize]="0" + [transform]="0" + [wait]="0" +) + +CONFIG_FILE="/MEDIA/config.txt" +if [ -f "$CONFIG_FILE" ]; then + echo "Reading config file $CONFIG_FILE" + while read LINE + do + echo "Config line: $line" + if echo $LINE | grep -F = &>/dev/null + then + CONFIG_KEY=$(echo "$LINE" | cut -d '=' -f 1) + CONFIG_VALUE=$(echo "$LINE" | cut -d '=' -f 2-) + CONFIG[$CONFIG_KEY]="$CONFIG_VALUE" + echo "K:$CONFIG_KEY -> V:$CONFIG_VALUE V2:${CONFIG[$CONFIG_KEY]}" + fi + done < "$CONFIG_FILE" +else + echo "Config file ${config[randomize]} not found." +fi + +if [ ! -z "$INVOCATION_ID" ]; then + # Running as systemd service + if [ -n "${CONFIG[wait]}" ] && [ "${CONFIG[wait]}" -eq "${CONFIG[wait]}" ] && [ "${CONFIG[wait]}" -ge 0 ] 2>/dev/null; then + sleep "${CONFIG[wait]}" + fi +fi + +VLC_OPTS=( + "--quiet" + "--intf=telnet" + "--telnet-password=pi-player-lite" + "--logfile=/MEDIA/log.txt" + "--playlist-tree" + "--no-osd" + "--mmal-layer=1" + "--fullscreen" + "--loop" +) +VLC_PATH="/MEDIA" +if [ -f "${VLC_PATH}/autoplay.m3u" ] +then + VLC_PATH="${VLC_PATH}/autoplay.m3u" +else + VLC_PATH="/MEDIA" +fi + +# Randomize playlist? +if [ ${CONFIG[randomize]} -eq 1 ] +then + VLC_OPTS+=("--random") +fi + +if [ ${CONFIG[transform]} = "90" ] \ + || [ ${CONFIG[transform]} = "180" ] \ + || [ ${CONFIG[transform]} = "270" ] \ + || [ ${CONFIG[transform]} = "hflip" ] \ + || [ ${CONFIG[transform]} = "vflip" ] \ + || [ ${CONFIG[transform]} = "transpose" ] \ + || [ ${CONFIG[transform]} = "antitranspose" ] +then + VLC_OPTS+=("--mmal-vout-transform=${CONFIG[transform]}") +fi + +echo "Configuration:" +for i in "${!CONFIG[@]}"; do printf "%s=%s\n" "$i" "${CONFIG[$i]}"; done + +# Let VLC display a background on MMAL layer 0; the video player will use layer 1 +SCRIPT=$(readlink -f "$0") +SCRIPT_DIR="$( cd "${SCRIPT%/*}" >/dev/null 2>&1 && pwd )" +BG_IMAGE="$SCRIPT_DIR/bg.png" +cvlc --mmal-layer=0 --no-osd --fullscreen --loop "$BG_IMAGE" >/dev/null 2>&1 & +PID_BGLVC="$!" +PIDS="$PIDS $PID_BGVLC" + +echo +echo "Starting the media player:" +VLC="cvlc" +echo "$VLC" "${VLC_OPTS[@]}" "${VLC_PATH}" + +"$VLC" "${VLC_OPTS[@]}" "${VLC_PATH}" >/dev/null 2>&1 & +PID_VLC="$!" +PIDS="$PIDS $PID_VLC" + +wait $PID_VLC