diff --git a/README.md b/README.md index 93c9f91..0661798 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # clivrt -CLI app to do video calls but from the terminal. Just fun little project that let's you chat with friends in a retro kidna way - while staying in your CLI. +CLI app to do video calls but from the terminal. Just fun little project that let's you chat with friends in a retro kinda way - while staying in your CLI. ![Screenshot](docs/clivrtsmilethumbsup.png?raw=true) @@ -9,8 +9,8 @@ TBD ## CLI reference TBD -### Config File -If file is is located in the same folder as the cli executable and named `.clivrt`, it will be used for default config. Here's an example: +### Configuration +The file is is located in the same folder as the cli executable and named `.clivrt`, it will be used for default config. Here's an example: ``` [DEFAULT] signalinghosturl = wss://signaling-s-dudash-dev.apps.sandbox.x8i5.p1.openshiftapps.com @@ -23,7 +23,7 @@ video_size = 800x600 ``` * signalinghosturl = Which server to connect to for finding/connecting/chatting with peers (note once a peer connection is established this is no longer required for video chat). Must begin with ws:// or wss:// * loglevel = [INFO, DEBUG, WARN, ERROR, CRITICAL] how much log data to display -* videostyle = [just-ascii, ascii-color, filled-ascii] +* videostyle = [just-ascii, ascii-color, filled-ascii] pick your sytle for visualizing the video as ASCII * webcam = Path to your webcam. Some examples: [linux: /dev/video0, windows: video=Integrated Camera, mac: default:none] * framerate = outgoing video framerate * video_size = outgoing video resolution @@ -54,4 +54,4 @@ This project uses the awesome open source work from many other folks. There are ## Some other interesting things - The architecture design [lives here in Miro](https://miro.com/app/board/uXjVOZLd2gQ=/) -- Concurrency in Python [a good reference here](https://realpython.com/python-concurrency/#what-is-concurrency) \ No newline at end of file +- Concurrency in Python [a good reference here](https://realpython.com/python-concurrency/#what-is-concurrency) diff --git a/docs/README-buildnotes.md b/docs/README-buildnotes.md index 4a3b991..94c4dab 100644 --- a/docs/README-buildnotes.md +++ b/docs/README-buildnotes.md @@ -41,7 +41,12 @@ There seems to be an issue on the jetson with a mismatch in dependencies with NV sudo apt-get install libopus-dev libvpx-dev ``` -* Build container +* Build container - this is TBD but using these links might help + * https://github.com/dusty-nv/jetson-containers#pre-built-container-images + * https://github.com/NVIDIA/nvidia-docker/wiki/NVIDIA-Container-Runtime-on-Jetson -This is TBD but using these links might help: https://github.com/dusty-nv/jetson-containers#pre-built-container-images -https://github.com/NVIDIA/nvidia-docker/wiki/NVIDIA-Container-Runtime-on-Jetson + +* Hardware support +The Jetson is a edge device with low computing capabilities - so using the dedicated hardware efficiently is important. If everything just uses CPU then we are doing it wrong. Using software libraries that can leverage the HW is important (encoding and decoding video). Initial research shows ffmpeg available for the Jetson might not support HW enc/dec - also H.264 might be required vs. other formats. See here for discussion/alternatives: + * https://forums.developer.nvidia.com/t/webrtc-low-performances-with-nvidia-encoder/115324 + * https://docs.nvidia.com/jetson/l4t/index.html#page/Tegra%20Linux%20Driver%20Package%20Development%20Guide/hardware_acceleration_in_webrtc.html#wwpID0E0OB0HA