Skip to content

Commit

Permalink
Added timeout to render process
Browse files Browse the repository at this point in the history
  • Loading branch information
@net-cscience-raphael
net-cscience-raphael committed Mar 6, 2024
1 parent 850f4f0 commit 3713e92
Show file tree
Hide file tree
Showing 4 changed files with 167 additions and 155 deletions.
2 changes: 1 addition & 1 deletion cineast-core/src/main/java/org/vitrivr/cineast/core/render/Renderer.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ default void positionCameraPolar(float r, float theta, float phi, float cx, floa
*
* @return BufferedImage containing a snapshot of the current render-buffer.
*/
BufferedImage obtain();
BufferedImage obtain() throws InterruptedException;

/**
* Clears buffers to preset-values and applies a user-defined background colour.
Expand Down
7 changes: 6 additions & 1 deletion .../src/main/java/org/vitrivr/cineast/core/render/lwjgl/renderer/LWJGLOffscreenRenderer.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,12 @@ public void assemble(IModel model) {
*/
@Override
public BufferedImage obtain() {
return this.imageQueue.poll();
try {
return this.imageQueue.poll(60, java.util.concurrent.TimeUnit.SECONDS);
} catch (InterruptedException e) {
LOGGER.error("Timeout on rendering", e);
throw new RuntimeException("Timeout on rendering", e);
}
}

/**
Expand Down
307 changes: 157 additions & 150 deletions cineast-core/src/main/java/org/vitrivr/cineast/core/render/lwjgl/renderer/RenderWorker.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import java.util.Hashtable;
import java.util.LinkedList;
import java.util.concurrent.BlockingDeque;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.joml.Vector3f;
Expand Down Expand Up @@ -45,57 +46,58 @@
@StateProvider
public class RenderWorker extends Worker<RenderJob> {

private static final Logger LOGGER = LogManager.getLogger();
private static final Logger LOGGER = LogManager.getLogger();

/**
* The Lightweight Java Game Library (LWJGL) Offscreen Renderer instance.
*/
private LWJGLOffscreenRenderer renderer;
/**
* The Lightweight Java Game Library (LWJGL) Offscreen Renderer instance.
*/
private LWJGLOffscreenRenderer renderer;

/**
* Since only one OpenGl renderer can be instanced
* use Static queue
* The queue can be accessed by the caller wit {@link RenderWorker#getRenderJobQueue()}
* On this queue the caller will provide new render jobs.
*/
private static BlockingDeque<RenderJob> renderJobQueue;
/**
* Since only one OpenGl renderer can be instanced
* use Static queue
* The queue can be accessed by the caller wit {@link RenderWorker#getRenderJobQueue()}
* On this queue the caller will provide new render jobs.
*/
private static BlockingDeque<RenderJob> renderJobQueue;

/**
* Instantiates a new RenderWorker.
* <p>
* The queue is stores in a static variable.
*/
public RenderWorker(BlockingDeque<RenderJob> jobs) {
super(jobs);
RenderWorker.renderJobQueue = jobs;
LOGGER.trace("Initialized RenderWorker");
}
/**
* Instantiates a new RenderWorker.
* <p>
* The queue is stores in a static variable.
*/
public RenderWorker(BlockingDeque<RenderJob> jobs) {
super(jobs);
RenderWorker.renderJobQueue = jobs;
LOGGER.trace("Initialized RenderWorker");
}

/**
* static getter for the renderJobQueue
* A caller can use get the queue submit new jobs to the render worker.
* @return the render job queue
*/
public static BlockingDeque<RenderJob> getRenderJobQueue() {
return renderJobQueue;
}
/**
* static getter for the renderJobQueue
* A caller can use get the queue submit new jobs to the render worker.
*
* @return the render job queue
*/
public static BlockingDeque<RenderJob> getRenderJobQueue() {
return renderJobQueue;
}


/**
* The render worker main thread.
*/
public void run() {
Configuration.STACK_SIZE.set((int) java.lang.Math.pow(2, 19));
this.renderer = new LWJGLOffscreenRenderer();
var defaultOptions = new WindowOptions();
renderer.setWindowOptions(defaultOptions);
renderer.startEngine();
super.run();
LOGGER.trace("Running RenderWorker");
}
/**
* The render worker main thread.
*/
public void run() {
Configuration.STACK_SIZE.set((int) java.lang.Math.pow(2, 19));
this.renderer = new LWJGLOffscreenRenderer();
var defaultOptions = new WindowOptions();
renderer.setWindowOptions(defaultOptions);
renderer.startEngine();
super.run();
LOGGER.trace("Running RenderWorker");
}


// @formatter:off
// @formatter:off

/**
* Creates the graph for the RenderWorker.
Expand Down Expand Up @@ -131,122 +133,127 @@ protected Graph createGraph() {
}
// @formatter:on

/**
* Handler for render exceptions.
* Unloads the model and sends a JobControlCommand. ERROR to the caller.
* @param ex The exception that was thrown.
* @return The handler message.
*/
@Override
protected String onJobException(Exception ex) {
this.unload();
this.currentJob.putResultQueue(new RenderJob(JobControlCommand.JOB_FAILURE));
return "Job failed";
}
/**
* Handler for render exceptions.
* Unloads the model and sends a JobControlCommand. ERROR to the caller.
*
* @param ex The exception that was thrown.
* @return The handler message.
*/
@Override
protected String onJobException(Exception ex) {
this.unload();
this.currentJob.putResultQueue(new RenderJob(JobControlCommand.JOB_FAILURE));
return "Job failed";
}

/**
* Initializes the renderer. Sets the window options and starts the engine.
*/
@StateEnter(state = RenderStates.INIT_WINDOW, data = RenderData.WINDOWS_OPTIONS)
public void setWindowOptions(WindowOptions opt) {
LOGGER.trace("INIT_WINDOW RenderWorker");
this.renderer = new LWJGLOffscreenRenderer();
/**
* Initializes the renderer. Sets the window options and starts the engine.
*/
@StateEnter(state = RenderStates.INIT_WINDOW, data = RenderData.WINDOWS_OPTIONS)
public void setWindowOptions(WindowOptions opt) {
LOGGER.trace("INIT_WINDOW RenderWorker");
this.renderer = new LWJGLOffscreenRenderer();

renderer.setWindowOptions(opt);
renderer.startEngine();
}
renderer.setWindowOptions(opt);
renderer.startEngine();
}

/**
* Sets specific render options.
*/
@StateEnter(state = RenderStates.INIT_RENDERER, data = RenderData.RENDER_OPTIONS)
public void setRendererOptions(RenderOptions opt) {
LOGGER.trace("INIT_RENDERER RenderWorker");
this.renderer.setRenderOptions(opt);
if (opt.lightingOptions != null) {
this.renderer.setLighting(opt.lightingOptions);
/**
* Sets specific render options.
*/
@StateEnter(state = RenderStates.INIT_RENDERER, data = RenderData.RENDER_OPTIONS)
public void setRendererOptions(RenderOptions opt) {
LOGGER.trace("INIT_RENDERER RenderWorker");
this.renderer.setRenderOptions(opt);
if (opt.lightingOptions != null) {
this.renderer.setLighting(opt.lightingOptions);
}
}
}

/**
* State to wait for new jobs.
*/
@StateEnter(state = RenderStates.IDLE)
public void idle() {
LOGGER.trace("IDLE RenderWorker");
}
/**
* State to wait for new jobs.
*/
@StateEnter(state = RenderStates.IDLE)
public void idle() {
LOGGER.trace("IDLE RenderWorker");
}

/**
* Register a model to the renderer.
*
* @param model The model to register and to be rendered.
*/
@StateEnter(state = RenderStates.LOAD_MODEL, data = RenderData.MODEL)
public void registerModel(IModel model) {
LOGGER.trace("LOAD_MODEL RenderWorker");
this.renderer.assemble(model);
}
/**
* Register a model to the renderer.
*
* @param model The model to register and to be rendered.
*/
@StateEnter(state = RenderStates.LOAD_MODEL, data = RenderData.MODEL)
public void registerModel(IModel model) {
LOGGER.trace("LOAD_MODEL RenderWorker");
this.renderer.assemble(model);
}

/**
* Renders the model. Sends the rendered image to the caller.
*/
@StateEnter(state = RenderStates.RENDER)
public void renderModel() {
LOGGER.trace("RENDER RenderWorker");
this.renderer.render();
var pic = this.renderer.obtain();
var data = new Variant().set(RenderData.IMAGE, pic);
var responseJob = new RenderJob(data);
this.currentJob.putResultQueue(responseJob);
}
/**
* Renders the model. Sends the rendered image to the caller.
*/
@StateEnter(state = RenderStates.RENDER)
public void renderModel() {
try {
LOGGER.trace("RENDER RenderWorker");
this.renderer.render();
var pic = this.renderer.obtain();
var data = new Variant().set(RenderData.IMAGE, pic);
var responseJob = new RenderJob(data);
this.currentJob.putResultQueue(responseJob);
} catch (Exception e) {
this.onJobException(e);
}
}

/**
* Rotates the camera.
*
* @param rotation The rotation vector (x,y,z)
*/
@StateEnter(state = RenderStates.ROTATE, data = RenderData.VECTOR)
public void rotate(Vector3f rotation) {
LOGGER.trace("ROTATE RenderWorker");
this.renderer.moveCameraOrbit(rotation.x, rotation.y, rotation.z);
}
/**
* Rotates the camera.
*
* @param rotation The rotation vector (x,y,z)
*/
@StateEnter(state = RenderStates.ROTATE, data = RenderData.VECTOR)
public void rotate(Vector3f rotation) {
LOGGER.trace("ROTATE RenderWorker");
this.renderer.moveCameraOrbit(rotation.x, rotation.y, rotation.z);
}

/**
* Looks at the origin from a specific position. The rotation is not affected. Removes the processed position vector
* from the list.
*
* @param vectors The list of position vectors
*/
@StateEnter(state = RenderStates.LOOKAT, data = RenderData.VECTORS)
public void lookAt(LinkedList<Vector3f> vectors) {
LOGGER.trace("Look at RenderWorker");
var vec = vectors.poll();
assert vec != null;
this.renderer.setCameraOrbit(vec.x, vec.y, vec.z);
}
/**
* Looks at the origin from a specific position. The rotation is not affected. Removes the processed position vector
* from the list.
*
* @param vectors The list of position vectors
*/
@StateEnter(state = RenderStates.LOOKAT, data = RenderData.VECTORS)
public void lookAt(LinkedList<Vector3f> vectors) {
LOGGER.trace("Look at RenderWorker");
var vec = vectors.poll();
assert vec != null;
this.renderer.setCameraOrbit(vec.x, vec.y, vec.z);
}

/**
* Looks from a specific position at the origin. Removes the processed position vector from the list.
*
* @param vectors The list of position vectors
*/
@StateEnter(state = RenderStates.LOOK_FROM_AT_O, data = RenderData.VECTORS)
public void lookFromAtO(LinkedList<Vector3f> vectors) {
LOGGER.trace("LOOK_FROM_AT_O RenderWorker");
var vec = vectors.poll();
assert vec != null;
this.renderer.lookFromAtO(vec.x, vec.y, vec.z);
}
/**
* Looks from a specific position at the origin. Removes the processed position vector from the list.
*
* @param vectors The list of position vectors
*/
@StateEnter(state = RenderStates.LOOK_FROM_AT_O, data = RenderData.VECTORS)
public void lookFromAtO(LinkedList<Vector3f> vectors) {
LOGGER.trace("LOOK_FROM_AT_O RenderWorker");
var vec = vectors.poll();
assert vec != null;
this.renderer.lookFromAtO(vec.x, vec.y, vec.z);
}

/**
* Unloads the model and sends a JobControlCommand.JOB_DONE to the caller.
*/
@StateEnter(state = RenderStates.UNLOAD_MODEL)
public void unload() {
LOGGER.trace("UNLOAD_MODEL RenderWorker");
this.renderer.clear();
this.renderer = null;
var responseJob = new RenderJob(JobControlCommand.JOB_DONE);
this.currentJob.putResultQueue(responseJob);
}
/**
* Unloads the model and sends a JobControlCommand.JOB_DONE to the caller.
*/
@StateEnter(state = RenderStates.UNLOAD_MODEL)
public void unload() {
LOGGER.trace("UNLOAD_MODEL RenderWorker");
this.renderer.clear();
this.renderer = null;
var responseJob = new RenderJob(JobControlCommand.JOB_DONE);
this.currentJob.putResultQueue(responseJob);
}
}
6 changes: 3 additions & 3 deletions cineast-runtime/src/main/resources/log4j2.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,14 @@
</Appenders>
<Loggers>
<!-- Here one can set up, for each package individually, which level will be logged -->
<logger name="io" level="ERROR">
<logger name="io" level="TRACE">
</logger>
<logger name="org" level="INFO" additivity="true">
<logger name="org" level="TRACE" additivity="true">
</logger>
<logger name="org.vitrivr.cineast" level="TRACE" additivity="true">
</logger>
<!-- Root is fall back config if no matching logger is found -->
<Root level="info">
<Root level="TRACE">
<AppenderRef ref="Console"/>
<AppenderRef ref="File"/>
</Root>
Expand Down

0 comments on commit 3713e92

Please sign in to comment.