mlbserver 2021.10.0-1.2

package/README.md

@@ -0,0 +1,62 @@
+# mlbserver
+
+Current version 2021.10.01.2
+
+Credit to https://github.com/tonycpsu/streamglob and https://github.com/mafintosh/hls-decryptor
+
+```
+npm install -g mlbserver
+```
+
+## Usage
+
+Launch the server
+
+```
+mlbserver
+```
+
+and follow the prompts. Load the resulting web URL in a browser to start using the server and to see more documentation.
+
+Basic command line options:
+
+```
+--port or -p (primary port to run on; defaults to 9999 if not specified)
+--debug or -d (false if not specified)
+--version or -v (returns package version number)
+--logout or -l (logs out and clears session)
+--session or -s (clears session)
+--cache or -c (clears cache)
+```
+
+Advanced command line options:
+
+```
+--account_username (email address, default will use stored credentials or prompt user to enter them)
+--account_password (default will use stored credentials or prompt user to enter them)
+--multiview_port (port for multiview streaming; defaults to 1 more than primary port, or 10000)
+--multiview_path (where to create the folder for multiview encoded files; defaults to app directory)
+--ffmpeg_path (path to ffmpeg binary to use for multiview encoding; default downloads a binary using ffmpeg-static)
+--ffmpeg_encoder (ffmpeg video encoder to use for multiview; default is the software encoder libx264)
+--ffmpeg_logging (if present, logs all ffmpeg output -- useful for experimenting or troubleshooting)
+--page_username (username to protect pages; default is no protection)
+--page_password (password to protect pages; default is no protection)
+```
+
+You may want to experiment with different ffmpeg hardware encoders depending on your system as described at https://stackoverflow.com/a/50703794
+
+```
+h264_amf to access AMD gpu, (windows only)
+h264_nvenc use nvidia gpu cards (work with windows and linux)
+h264_omx raspberry pi encoder
+h264_qsv use Intel Quick Sync Video (hardware embedded in modern Intel CPU)
+h264_v4l2m2m use V4L2 Linux kernel api to access hardware codecs
+h264_vaapi use VAAPI which is another abstraction API to access video acceleration hardware (Linux only)
+h264_videotoolbox use videotoolbox an API to access hardware on OS X
+```
+
+Note that use of h264_v4l2m2m here requires ffmpeg to be compiled with this patch: https://www.raspberrypi.org/forums/viewtopic.php?p=1780625#p1780625
+
+## License
+
+MIT