mirror of
https://github.com/amitbet/vnc2video.git
synced 2025-04-27 18:25:10 +00:00
40 lines
2.8 KiB
Markdown
40 lines
2.8 KiB
Markdown
# Vnc2Video [](https://circleci.com/gh/amitbet/vnc2video) [](https://raw.githubusercontent.com/CircleCI-Public/circleci-demo-go/master/LICENSE.md)
|
|
## A **real wold** implementation of vnc client for go
|
|
After searching the web for an vnc client in golang which is not a toy & support more than handshake + RAW encoding, I came up blank, so, I set out to write one myself.
|
|
|
|
The video encoding part means that something can be viewed, and since I don't really feel like writing GTK UIs in 2018 (plus VNC viewers are a dime a dozen), a video file will do.
|
|
In actuality the images produced are go images and can easily be saved as JPEG, or displayed in any UI you want to create.
|
|
|
|
## Encoding support:
|
|
* Tight VNC
|
|
* Hextile
|
|
* ZLIB
|
|
* CopyRect
|
|
* Raw
|
|
* RRE
|
|
* ZRLE
|
|
* Rich-cursor pseudo
|
|
* Desktop Size Pseudo
|
|
* Cursor pos Pseudo
|
|
|
|
## Video codec support:
|
|
* x264 (ffmpeg) - the market standard
|
|
* dv8 (ffmpeg) - google encoding current standard for webm
|
|
* dv9 (ffmpeg) - a stronger codec supported by webm format on most browsers
|
|
* qtrle (ffmpeg) - the best losless encoding I could find. (10 - 20 MB/min)
|
|
* huffyuv (ffmpeg) - a lossless encoding which is low-Cpu but less compressed (50-100 MB/min)
|
|
* MJpeg (native golang implementation) - lossy intra frame only (every frame encoded separately)
|
|
|
|
## Frame Buffer Stream file support (fbs)
|
|
* Supports reading & rendering fbs files that can be created by [vncProxy](https://github.com/amitbet/vncproxy)
|
|
* This allows recording vnc without the cost of video encoding while retaining the ability to transcode it into video later if the vnc session is found to be important.
|
|
|
|
## About
|
|
It may seem strange that I didn't use my previous vncproxy code in order to create this client, but since that code is highly optimized to be a proxy (never hold a full message in buffer & introduce no lags), it is not best suited to be a client, so instead of spending the time reverting all the proxy-specific code, I just started from the most advanced go vnc-client code I found.
|
|
|
|
Most of what I added is the rfb-encoder & video encoding implementations, there are naturally some additional changes in order to get a global canvas (draw.Image) to render on by all encodings.
|
|
|
|
The code for the encodings was gathered by peeking at several RFB source codes in cpp & some in java, reading the excellent documentation in [rfbproto](https://github.com/rfbproto/rfbproto/blob/master/rfbproto.rst), and **a lot** of gritty bit-plucking, pixel jogging & code cajoling until everything fell into place on screen.
|
|
|
|
I did not include tightPng in the supported encoding list since I didn't find a server to test it with, so I can't vouch for the previous implementation, If you have such a server handy, please check and tell me if it works.
|