![]() |
||
---|---|---|
.idea | ||
images | ||
lib | ||
models | ||
src | ||
test | ||
.gitignore | ||
LICENSE | ||
README.md |
README.md
osci-render
Program for drawing lines on an oscilloscope using audio output.
This allows for 3D rendering of any generic object (.obj
file)
Lots of this code was built as part of a 24hr hackathon: IC Hack 20. The original repository can be found here: https://github.com/wdhg/ICHack20 It won 'Best Newcomers Prize' at the event.
Video Demonstration
Current Features
- Render
.obj
files on an oscilloscope - Rotation of objects
- Scaling image
- Translating image
- Sorting of rendered lines for clean output
- Rendering polygrams in realtime
- Rendering simple shapes in realtime
Proposed Features
- Performance improvements to Shapes.sortLines()
- With goal of high-framerate realtime rendering
- Tune and transpose audio output
- Support rendering of multiple objects
- Saving pre-rendered frames to file for later loading
- Saving audio output to file
- (long term) Keyframing/animating objects and camera
Usage
Using osci-render is very easy; specify the object file you would like to render, and optionally the rotation speed, and camera focal length and position and it will output the 3D model as audio to visualise on your oscilloscope.
To render the cube example in /models
, you would use the following args:
osci-render models/cube.obj 3 1
This will render a cube with a rotation speed of 3 and a focal length of 1. Detailed argument usage below:
Program Arguments
osci-render objFilePath [rotateSpeed] [focalLength] [cameraX] [cameraY] [cameraZ]
If no camera position arguments are given, the program will automatically move the camera to a position that renders the whole object on the screen with minimal display clipping.
Required
- objFilePath
- Specifies the file path to retrieve the
.obj
file
- Specifies the file path to retrieve the
Optional
- rotateSpeed
- Sets the speed of rotation of the object
- focalLength
- Sets the camera's focal length
- cameraX/Y/Z
- Sets X/Y/Z position of camera
Building
Library setup
Libraries
Open the folder in your IDE of choice (I would recommend using IntelliJ) and build/run AudioClient
after setting up libraries as provided in /lib
. You will additionally require a platform-specific dll
/so
file for XT-Audio depending if you're on a windows/linux x86/x64 OS, which you'll find in the java-xt folder in the XT-Audio binaries.
Make sure your default playback devices are setup correctly, as XT-Audio will try and find your default device for audio output.
osci-render is currently using JDK 15, though anything past Java 10 will probably be fine.
Contact
James Ball, james@ball.sh
Special Thanks
Team Members: James Ball, William Grant, Jessica Lally, Noor Sawhney, and Andy Wang