.\" Automatically generated by Pandoc 3.1.3 .\" .\" Define V font for inline verbatim, using C font in formats .\" that render this, and otherwise B font. .ie "\f[CB]x\f[]"x" \{\ . ftr V B . ftr VI BI . ftr VB B . ftr VBI BI .\} .el \{\ . ftr V CR . ftr VI CI . ftr VB CB . ftr VBI CBI .\} .TH "Bino" "1" "February 1, 2023" "" "Version 2.1" .hy .SH Overview .PP Bino is a video player with a focus on 3D and Virtual Reality: .IP \[bu] 2 Support for stereoscopic 3D videos in various formats .IP \[bu] 2 Support for 360° and 180° videos, with and without stereoscopic 3D .IP \[bu] 2 Support for Virtual Reality environments, including SteamVR, CAVEs, powerwalls, and other multi-display / multi-GPU / multi-host systems .SH Invocation .PP \f[V]bino\f[R] [\f[I]options\f[R]] \f[I]URL\f[R]\&... .IP \[bu] 2 \f[V]-h\f[R], \f[V]--help\f[R] .RS 2 .PP Displays help on commandline options. .RE .IP \[bu] 2 \f[V]--help-all\f[R] .RS 2 .PP Displays help including Qt specific options. .RE .IP \[bu] 2 \f[V]-v\f[R], \f[V]--version\f[R] .RS 2 .PP Displays version information. .RE .IP \[bu] 2 \f[V]--log-level\f[R] \f[I]level\f[R] .RS 2 .PP Set log level (fatal, warning, info, debug, firehose). .RE .IP \[bu] 2 \f[V]--log-file\f[R] \f[I]file\f[R] .RS 2 .PP Set log file. .RE .IP \[bu] 2 \f[V]--read-commands\f[R] \f[I]script\f[R] .RS 2 .PP Read commands from a script file. See Scripting. .RE .IP \[bu] 2 \f[V]--opengles\f[R] .RS 2 .PP Use OpenGL ES instead of Desktop OpenGL. .RE .IP \[bu] 2 \f[V]--stereo\f[R] .RS 2 .PP Use OpenGL quad-buffered stereo in GUI mode. .RE .IP \[bu] 2 \f[V]--vr\f[R] .RS 2 .PP Start in Vitrual Reality mode instead of GUI mode. See Virtual Reality. .RE .IP \[bu] 2 \f[V]--vr-screen\f[R] \f[I]screen\f[R] .RS 2 .PP Set VR screen geometry, either as a comma-separated list of nine values representing three 3D coordinates that define a planar screen (bottom left, bottom right, top left) or as a name of an OBJ file that contains the screen geometry with texture coordinates. .RE .IP \[bu] 2 \f[V]--capture\f[R] .RS 2 .PP Capture video/audio input from camera and microphone. .RE .IP \[bu] 2 \f[V]--list-audio-outputs\f[R] .RS 2 .PP List audio outputs. .RE .IP \[bu] 2 \f[V]--list-audio-inputs\f[R] .RS 2 .PP List audio inputs. .RE .IP \[bu] 2 \f[V]--list-video-inputs\f[R] .RS 2 .PP List video inputs. .RE .IP \[bu] 2 \f[V]--audio-output\f[R] \f[I]ao\f[R] .RS 2 .PP Choose audio output via its index. .RE .IP \[bu] 2 \f[V]--audio-input\f[R] \f[I]ai\f[R] .RS 2 .PP Choose audio input via its index. Can be empty. .RE .IP \[bu] 2 \f[V]--video-input\f[R] \f[I]vi\f[R] .RS 2 .PP Choose video input via its index. .RE .IP \[bu] 2 \f[V]--list-tracks\f[R] .RS 2 .PP List all video, audio and subtitle tracks in the media. .RE .IP \[bu] 2 \f[V]--preferred-audio\f[R] \f[I]lang\f[R] .RS 2 .PP Set preferred audio track language (en, de, fr, \&...). .RE .IP \[bu] 2 \f[V]--preferred-subtitle\f[R] \f[I]lang\f[R] .RS 2 .PP Set preferred subtitle track language (en, de, fr, \&...). Can be empty. .RE .IP \[bu] 2 \f[V]--video-track\f[R] \f[I]track\f[R] .RS 2 .PP Choose video track via its index. .RE .IP \[bu] 2 \f[V]--audio-track\f[R] \f[I]track\f[R] .RS 2 .PP Choose audio track via its index. .RE .IP \[bu] 2 \f[V]--subtitle-track\f[R] \f[I]track\f[R] .RS 2 .PP Choose subtitle track via its index. Can be empty. .RE .IP \[bu] 2 \f[V]-i\f[R], \f[V]--input\f[R] \f[I]mode\f[R] .RS 2 .PP Set input mode (mono, top-bottom, top-bottom-half, bottom-top, bottom-top-half, left-right, left-right-half, right-left, right-left-half, alternating-left-right, alternating-right-left). .RE .IP \[bu] 2 \f[V]-o\f[R], \f[V]--output\f[R] \f[I]mode\f[R] .RS 2 .PP Set output mode (left, right, stereo, alternating, red-cyan-dubois, red-cyan-full-color, red-cyan-half-color, red-cyan-monochrome, green-magenta-dubois, green-magenta-full-color, green-magenta-half-color, green-magenta-monochrome, amber-blue-dubois, amber-blue-full-color, amber-blue-half-color, amber-blue-monochrome, red-green-monochrome, red-blue-monochrome, even-odd-rows, even-odd-columns, checkerboard). .RE .IP \[bu] 2 \f[V]--surround\f[R] \f[I]mode\f[R] .RS 2 .PP Set surround mode (360, 180, off). .RE .IP \[bu] 2 \f[V]-S\f[R], \f[V]--swap-eyes\f[R] .RS 2 .PP Swap left/right eye. .RE .IP \[bu] 2 \f[V]-f\f[R], \f[V]--fullscreen\f[R] .RS 2 .PP Start in fullscreen mode. .RE .SH Scripting .PP Bino can read commands from a script file and execute them via the option \f[V]--read-commands\f[R] \f[I]scriptfile\f[R]. This works both in GUI mode and in Virtual Reality mode. .PP The script file can also be a named pipe so that you can have arbitraty remote control interfaces write commands into it as they come in. .PP Empty lines and comment lines (which begin with \f[V]#\f[R]) are ignored. The following commands are supported: .IP \[bu] 2 \f[V]open\f[R] \f[V][--input\f[R] \f[I]mode\f[R]\f[V]]\f[R] \f[V][--surround\f[R] \f[I]mode\f[R]\f[V]]\f[R] \f[V][--video-track\f[R] \f[I]vt\f[R]\f[V]]\f[R] \f[V][--audio-track\f[R] \f[I]at\f[R]\f[V]]\f[R] \f[V][--subtitle-track\f[R] \f[I]st\f[R]\f[V]]\f[R] \f[I]URL\f[R] .RS 2 .PP Open the URL and start playing. The options have the same meaning as the corresponding command line options. .RE .IP \[bu] 2 \f[V]capture\f[R] \f[V][--audio-input\f[R] \f[I]ai\f[R]\f[V]]\f[R] \f[V][--video-input\f[R] \f[I]vi\f[R]\f[V]]\f[R] .RS 2 .PP Start capturing camera and microphone. The options have the same meaning as the corresponding command line options. .RE .IP \[bu] 2 \f[V]play\f[R] .RS 2 .PP Start playing. .RE .IP \[bu] 2 \f[V]pause\f[R] .RS 2 .PP Pause. .RE .IP \[bu] 2 \f[V]toggle-pause\f[R] .RS 2 .PP Switch between pause and play. .RE .IP \[bu] 2 \f[V]stop\f[R] .RS 2 .PP Stop playing. .RE .IP \[bu] 2 \f[V]playlist-next\f[R] .RS 2 .PP Switch to next playlist entry. .RE .IP \[bu] 2 \f[V]playlist-prev\f[R] .RS 2 .PP Switch to previous playlist entry. .RE .IP \[bu] 2 \f[V]playlist-loop\f[R] \f[I]mode\f[R] .RS 2 .PP Set loop mode (off, one, all). .RE .IP \[bu] 2 \f[V]quit\f[R] .RS 2 .PP Quit Bino. .RE .IP \[bu] 2 \f[V]set-position\f[R] \f[I]p\f[R] .RS 2 .PP Set the video position to \f[I]p\f[R], where \f[I]p\f[R]=0 is the beginning and \f[I]p\f[R]=1 is the end. .RE .IP \[bu] 2 \f[V]seek\f[R] \f[I]seconds\f[R] .RS 2 .PP Seek the given amounts of seconds forward or, if the number of seconds is negative, backwards. .RE .IP \[bu] 2 \f[V]wait\f[R] \f[V]stop\f[R]|\f[I]seconds\f[R] .RS 2 .PP Wait until the video stops, or wait for the given number of seconds, before executing the next command. .RE .IP \[bu] 2 \f[V]set-mute\f[R] \f[V]on\f[R]|\f[V]off\f[R] .RS 2 .PP Set the volume mute status. .RE .IP \[bu] 2 \f[V]toggle-mute\f[R] .RS 2 .PP Switch between mute and unmute. .RE .IP \[bu] 2 \f[V]set-volume\f[R] \f[I]vol\f[R] .RS 2 .PP Set the volume level to \f[I]vol\f[R] (between 0 and 1). .RE .IP \[bu] 2 \f[V]adjust-volume\f[R] \f[I]offset\f[R] .RS 2 .PP Adjust the volume by the given amount (the final volume is clamped between 0 and 1). .RE .IP \[bu] 2 \f[V]set-output-mode\f[R] \f[I]mode\f[R] .RS 2 .PP Set the given output mode. See the command line option \f[V]--output\f[R] for a list of modes. .RE .IP \[bu] 2 \f[V]set-swap-eyes\f[R] \f[V]on\f[R]|\f[V]off\f[R] .RS 2 .PP Set left/right eye swap. .RE .IP \[bu] 2 \f[V]toggle-swap-eyes\f[R] .RS 2 .PP Toggle left/right eye swap. .RE .IP \[bu] 2 \f[V]set-fullscreen\f[R] \f[V]on\f[R]|\f[V]off\f[R] .RS 2 .PP Set fullscreen mode. .RE .IP \[bu] 2 \f[V]toggle-fullscreen\f[R] .RS 2 .PP Toggle fullscreen mode. .RE .SH File Name Conventions .PP Bino currently cannot detect the stereoscopic layout or the surround video mode from metadata because Qt does not provide that information. It therefore has to guess. .PP Bino recognizes the following hints at the last part of the file name, just before the file name extension (.ext): .IP \[bu] 2 \f[V]*-tb.ext\f[R], \f[V]*-ab.ext\f[R]: Input mode \f[V]top-bottom\f[R] .IP \[bu] 2 \f[V]*-tbh.ext\f[R], \f[V]*-abq.ext\f[R]: Input mode \f[V]top-bottom-half\f[R] .IP \[bu] 2 \f[V]*-bt.ext\f[R], \f[V]*-ba.ext\f[R]: Input mode \f[V]bottom-top\f[R] .IP \[bu] 2 \f[V]*-bth.ext\f[R], \f[V]*-baq.ext\f[R]: Input mode \f[V]bottom-top-half\f[R] .IP \[bu] 2 \f[V]*-lr.ext\f[R]: Input mode \f[V]left-right\f[R] .IP \[bu] 2 \f[V]*-lrh.ext\f[R], \f[V]*-lrq.ext\f[R]: Input mode \f[V]left-right-half\f[R] .IP \[bu] 2 \f[V]*-rl.ext\f[R]: Input mode \f[V]right-left\f[R] .IP \[bu] 2 \f[V]*-rlh.ext\f[R], \f[V]*-rlq.ext\f[R]: Input mode \f[V]right-left-half\f[R] .IP \[bu] 2 \f[V]*-2d.ext\f[R]: Input mode \f[V]mono\f[R] .PP Additionally, if the number \f[V]180\f[R] or \f[V]360\f[R] is part of the file name and separated by neighboring digits or letters by other characters, then the corresponding surround mode is assumed. .SH Virtual Reality .PP Bino supports all sorts of Virtual Reality environments via QVR (https://marlam.de/qvr): .IP \[bu] 2 When QVR is compiled with just with Qt6, CAVEs and powerwalls and similar multi-display setups are supported, including multi-GPU and multi-host rendering. .IP \[bu] 2 When QVR is additionally compiled with VRPN (https://github.com/vrpn/vrpn), all sorts of tracking and interaction hardware for such systems are supported. .IP \[bu] 2 When QVR is additionally compiled with OpenVR (https://github.com/ValveSoftware/openvr), SteamVR is supported and automatically detected (e.g.\ HTC Vive). .PP To start Bino in VR mode, use the option \f[V]--vr\f[R]. Bino will then display a screen in the virtual world, and the video will be displayed on that screen, unless the input is a surround video (360° or 180°), which will of course be displayed all around the viewer. .PP The default is a 16:9 screen in a few meters distance from the viewer, but you can use the \f[V]--vr-screen\f[R] option to either define arbitrary planar screens via their bottom left, bottom right and top left corners, or to load arbitrary screen geometry from an OBJ file. The latter case is useful e.g.\ if you want Bino\[cq]s virtual screen to coincide with a curved physical screen. .PP Bino uses QVRs default navigation, which may be based on autodetected controllers such as the HTC Vive controllers, or on tracking and interaction hardware configured via QVR for your VR system, or on the mouse and WASDQE keys if nothing else is available. .PP Additional interaction in VR mode is currently limited to the same keyboard shortcuts that also work in GUI mode. That means you currently must specify the video to play on the command line, and have no way to pause, skip or seek \[en] this will be added in a future version.