bino - Man Page
Overview
Bino is a video player with a focus on 3D and Virtual Reality:
- Support for stereoscopic 3D images and videos in various formats
- Support for 180° and 360° surround images and videos, with and without stereoscopic 3D
- Support for Virtual Reality environments, including SteamVR, CAVEs, powerwalls, and other multi-display / multi-GPU / multi-host systems
Invocation
bino [options] URL...
-h,--helpDisplays help on command line options.
--help-allDisplays help including Qt specific options.
-v,--versionDisplays version information.
--log-levellevelSet log level (fatal, warning, info, debug, firehose).
--log-filefileSet log file.
--control-filefileGet control commands from a file. See Scripting and Remote Control.
--control-fifonameGet control commands from a named pipe (fifo). See Scripting and Remote Control.
--control-udsnameGet control commands from a Unix Domain Socket. See Scripting and Remote Control.
--control-tcp[ip|name]:portGet control commands by listening on a TCP port. See Scripting and Remote Control.
--stereoEnable OpenGL quad-buffered stereo support. This typically only works with legacy proprietary GPU drivers, and autodetection breaks with these drivers, so this feature has to be enabled manually.
--openglesUse OpenGL ES instead of Desktop OpenGL.
--vrStart in Virtual Reality mode instead of GUI mode. See Virtual Reality.
--vr-screenscreenSet VR screen geometry, either as the special values `united' or `intersected', or 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 an aspect ratio followed by the name of an OBJ file that contains the screen geometry with texture coordinates (example: `16:9,myscreen.obj').
--captureCapture audio/video input from microphone and camera/screen/window.
--list-audio-outputsList audio outputs.
--list-audio-inputsList audio inputs.
--list-video-inputsList video inputs.
--list-screen-inputsList screen inputs.
--list-window-inputsList window inputs.
--audio-outputindexChoose audio output via its index.
--audio-inputindexChoose audio input via its index. Can be empty.
--video-inputindexChoose video input via its index.
--screen-inputindexChoose screen input via its index.
--window-inputindexChoose window input via its index.
--list-tracksList all video, audio and subtitle tracks in the media.
--preferred-audiolangSet preferred audio track language (en, de, fr, ...).
--preferred-subtitlelangSet preferred subtitle track language (en, de, fr, ...). Can be empty.
--video-tracktrackChoose video track via its index.
--audio-tracktrackChoose audio track via its index.
--subtitle-tracktrackChoose subtitle track via its index. Can be empty.
-p,--playlistfileLoad playlist.
-l,--loopmodeSet loop mode (off, one, all).
-w,--waitmodeSet wait mode (off, on).
-i,--inputmodeSet 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).
-o,--outputmodeSet output mode (left, right, stereo, alternating, hdmi-frame-pack, left-right, left-right-half, right-left, right-left-half, top-bottom, top-bottom-half, bottom-top, bottom-top-half, even-odd-rows, even-odd-columns, checkerboard, 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).
-s,--surroundmodeSet surround mode (360, 180, off).
--surround-vfovdegreesSet surround vertical field of view (default 50, range 5-115).
-S,--swap-eyesSwap left/right eye.
-f,--fullscreenStart in fullscreen mode.
Output Modes
Single-Screen Output
Most output modes should be self explanatory, but there are some exceptions:
stereorequires OpenGL quad-buffered stereo support, typically limited to high-end graphics cards. You must use the--stereooption on the command line to enable this mode.alternatingtries to mimic stereo mode by displaying the left and right frames alternating, ideally at display speed. This is unreliable since Bino has no way of making sure that its output frames actually correspond to display output frames, but it might work, depending on your hardware and system setup.hdmi-frame-packis a special mode supported by some 3D TVs via HDMI 1.4a, where the left view is placed in the top part of a frame and the right view in the bottom part, and both parts are separated by a blank area that takes 1/49 of the vertical space. To use this mode, force your display output resolution into either 1280x1470 (720p 3D: 720+30+720=1470; 1470/49=30) or 1920x2205 (1080p 3D: 1080+45+1080=2205; 2205/49=45).even-odd-rows,even-odd-columnsandcheckerboardare for (older) 3D TVs.
Multi-Screen Output
Common stereoscopic display setups have one display for the left view and one display for the right view.
The easiest way to use such setups is to configure your desktop environment to allow Bino to use two screens in fullscreen mode, and then pick output mode left/right or top/bottom.
For example, on KDE Plasma, look for “KWin Scripts” in the System Settings, enable the “Video Wall” script, and configure it so that it applies to “org.bino3d.bino”.
An alternative is to use Virtual Reality mode, which can support much more complex multi-screen setups without the need for any VR hardware (you can still use keyboard and mouse).
File Name Conventions
Bino tries to autodetect the stereoscopic layout and the surround video mode from image and video metadata, but that data is often incomplete or unknown. In such cases, Bino has to guess.
To help with this, the hints listed below can be used as the last part of the file name, just before the file name extension (.ext).
If you use both stereoscopic and surround mode hints, but the surround hint first, followed by the stereoscopic hint, e.g. example-180-tb.mp4.
Stereoscopic Layout Hints
*-tb.ext,*-ab.ext: Input modetop-bottom*-tbh.ext,*-abq.ext: Input modetop-bottom-half*-bt.ext,*-ba.ext: Input modebottom-top*-bth.ext,*-baq.ext: Input modebottom-top-half*-lr.ext: Input modeleft-right*-lrh.ext,*-lrq.ext: Input modeleft-right-half*-rl.ext: Input moderight-left*-rlh.ext,*-rlq.ext: Input moderight-left-half*-2d.ext: Input modemono
Surround Mode Hints
*-180-*.extor*-180.ext: Surround mode 180°*-360-*.extor*-360.ext: Surround mode 360°
Virtual Reality
Overview
Bino supports all sorts of Virtual Reality environments via QVR\c :
- When QVR is compiled just with Qt6, CAVEs and powerwalls and similar multi-display setups are supported, including multi-GPU and multi-host rendering.
- When QVR is compiled with VRPN\c , all sorts of tracking and interaction hardware for such systems are additionally supported.
- When QVR is compiled with OpenVR\c , SteamVR is additionally supported and automatically detected (e.g. HTC Vive).
VR mode does not require any VR hardware, it can also be used for multi-screen output in normal desktop environments, with keyboard/mouse interaction.
Use the option --vr to start Bino in VR mode.
Interaction
You can quit VR mode by pressing the Menu button on your controller, or the Q key on your keyboard.
Activate the on-screen user interface by pressing a trigger on your controller. When you release the trigger, the selected action will be performed, and the on-screen user interface will vanish again. Keyboard shortcuts also still work, in case you have access to your keyboard in VR mode.
Bino uses QVRs default navigation to move around in the virtual world: * With autodetected controllers such as the HTC Vive controllers, one controller is for left/right/forward/backward movement, the other is for up/down and for left/right rotations. * When keyboard/mouse input is available, the WASD keys will move forward/left/backward/right, QE will move up/down, and the mouse will change the viewing direction.
Virtual Screen
Bino will display a video screen in the virtual world for conventional video. If the input is a surround image or video instead (360° or 180°), it will be displayed all around the viewer.
The default screen is a 16:9 screen in front of the viewer, but you can use the --vr-screen option to define your own screen via its bottom left, bottom right and top left corners, or to load screen geometry from an OBJ file. The latter case is useful e.g. if you want Bino’s virtual screen to coincide with a curved physical screen.
The --vr-screen option also accepts the special values united and intersected. This will unite (or intersect) the 2D geometries of all VR windows at runtime, which is useful for multi-screen output configurations. For example, use --vr-screen=united --qvr-config=two-screen-stereo.qvr for a two-screen stereo setup, where the left view goes on the first screen and the right view goes on the second screen.
Scripting and Remote Control
Bino can read commands and execute them. This works both in GUI mode and in Virtual Reality mode.
The source of the commands can be a text file, a named pipe (fifo), a Unix Domain Socket (UDS), or a TCP port that Bino listens on. See the various --control options. Examples:
### File: $ bino --control-file script.bino ### FIFO: $ mkfifo fifo.bino $ bino --control-fifo fifo.bino & $ echo "open myvideo.mp4" > fifo.bino ### Unix Domain Socket: $ bino --control-uds /tmp/socket.bino & $ echo "open myvideo.mp4" | nc -q0 -U /tmp/socket.bino ### TCP Socket: $ bino --control-tcp localhost:63000 & $ echo "open myvideo.mp4" | nc -q0 localhost 63000
This allows pre-scripted media presentations as well as the implementation of custom remote controls for Bino.
The command interface is line-based. Empty lines and comment lines (which begin with #) are ignored. The following commands are supported:
open [--inputmode] [--surroundmode] [--video-trackvt] [--audio-trackat] [--subtitle-trackst]URLOpen the URL and start playing. The options have the same meaning as the corresponding command line options.
capture [--audio-inputai] [--video-inputvi] [--screen-inputsi] [--window-inputwi]Start capturing camera and microphone. The options have the same meaning as the corresponding command line options.
playStart playing.
pausePause.
toggle-pauseSwitch between pause and play.
stopStop playing.
playlist-loadplaylist.m3uLoad the playlist.
playlist-nextSwitch to next playlist entry.
playlist-prevSwitch to previous playlist entry.
playlist-waitmodeSet wait mode (off, on).
playlist-loopmodeSet loop mode (off, one, all).
quitQuit Bino.
set-positionpSet the video position to p, where p=0 is the beginning and p=1 is the end.
seeksecondsSeek the given amounts of seconds forward or, if the number of seconds is negative, backwards.
wait stop|secondsWait until the video stops, or wait for the given number of seconds, before executing the next command.
set-mute on|offSet the volume mute status.
toggle-muteSwitch between mute and unmute.
set-volumevolSet the volume level to vol (between 0 and 1).
adjust-volumeoffsetAdjust the volume by the given amount (the final volume is clamped between 0 and 1).
set-output-modemodeSet the given output mode. See the command line option
--outputfor a list of modes.set-surround-vfovdegreesSet surround vertical field of view (default 50, range 5-115).
set-swap-eyes on|offSet left/right eye swap.
toggle-swap-eyesToggle left/right eye swap.
set-fullscreen on|offSet fullscreen mode.
toggle-fullscreenToggle fullscreen mode.
Slideshows
You can play slideshows of images (or videos) simply by making a playlist. In the GUI, use the Playlist menu, and on the command line, just list multiple files to play.
By default, the next image/video in the playlist will only be displayed after you press the N key, or choose Playlist/Next from the menu or the on-screen user interface.
When the wait status of the playlist is switched off instead, the next media will play as soon as the previous is finished.
For a scripted slideshow with predefined presentation times for each image or video, use the scripting mode as in the following example:
set-fullscreen on playlist-load my-slideshow.m3u playlist-loop on playlist-wait on playlist-next wait 4 playlist-next wait 7 playlist-next wait 5 quit