org.openimaj.vis.video

Class VideoBarVisualisation

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.openimaj.vis.VisualisationImpl<T>

org.openimaj.vis.timeline.TimelineObjectAdapter<Video<MBFImage>>

org.openimaj.vis.video.VideoBarVisualisation

All Implemented Interfaces:

ComponentListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, AnimatedVisualisationListener, AnimatedVisualisationProvider, TimelineObject, Visualisation<Video<MBFImage>>, VisualisationImageProvider

Direct Known Subclasses:

ShotBoundaryVideoBarVisualisation, VideoObjectVisualisation

public abstract class VideoBarVisualisation
extends TimelineObjectAdapter<Video<MBFImage>>
implements AnimatedVisualisationProvider

Displays a block, or bar, which represents the data. The block will be scaled to fit the JPanel in which its drawn. The block will contain a visImage of the data content. The visImage of the content is determined by one of the subclasses of this class.

This class will process the data in a separate thread. Obviously, it's not sensible to call this class with a "live" data stream, such as from a VideoCapture object.

Version:

$Author$, $Revision$, $Date$

Author:

David Dupplaw (dpd@ecs.soton.ac.uk)

See Also:

Serialized Form

Created:

3 Jul 2012

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	VideoBarVisualisation.VideoTimelineMarker A marker for marking data frames within the data bar

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected int	audioHeight The height to plot the audio
protected Float[]	barColour The background colour of the bar
protected int	nFrame The frame being processed
protected long	nFrames Number of frames in the data in total
protected VideoBarVisualisation.VideoTimelineMarker	processingMarker The marker that's used for processing progress

Fields inherited from class org.openimaj.vis.timeline.TimelineObjectAdapter

endTime, pixelTransformer, startTime

Fields inherited from class org.openimaj.vis.VisualisationImpl

clearBeforeDraw, data, visImage

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	VideoBarVisualisation(Video<MBFImage> video)

Method Summary

Modifier and Type	Method and Description
void	addAnimatedVisualisationListener(AnimatedVisualisationListener avl) Add a visualisation listener to be informed of animation events.
protected void	fireAnimationEvent() Fire an event to say a new vis update is available
Float[]	getBarColour()
long	getEndTimeMilliseconds() Returns the end time of the timeline object in the timeline.
protected double	getTimePosition(int nFrame) Returns the position of the given frame at the scale of the current display.
protected double	getTimePosition(Timecode t) Returns the position of the given timecode at the scale of the current display.
Video<MBFImage>	getVideo() Return the data being shown by this bar.
abstract void	processFrame(MBFImage frame, Timecode t) Process a particular frame of the data.
void	processVideo() Begin processing the data in a separate thread.
void	removeAnimatedVisualisationListener(AnimatedVisualisationListener avl) Remove a given listener from being informed of animation events.
void	setBarColour(Float[] barColour)
void	update() If you override this method, you should call it at the end of your own implementation.

Methods inherited from class org.openimaj.vis.timeline.TimelineObjectAdapter

getStartTimeMilliseconds, setDataPixelTransformer, setStartTimeMilliseconds

Methods inherited from class org.openimaj.vis.VisualisationImpl

addOverlay, componentHidden, componentMoved, componentResized, componentShown, getRequiredSize, getVisualisationImage, isAllowResize, newVisualisationAvailable, paint, removeOverlay, setAllowResize, setClearBeforeDraw, setData, setRequiredSize, showWindow, update, updateVis, updateVis

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.openimaj.vis.VisualisationImageProvider

getVisualisationImage, setRequiredSize, updateVis

Methods inherited from interface org.openimaj.vis.timeline.TimelineObject

getPreferredSize, getRequiredSize

Field Detail

barColour

protected Float[] barColour

The background colour of the bar

audioHeight

protected final int audioHeight

The height to plot the audio

See Also:

Constant Field Values

nFrames

protected long nFrames

Number of frames in the data in total

processingMarker

protected VideoBarVisualisation.VideoTimelineMarker processingMarker

The marker that's used for processing progress

nFrame

protected int nFrame

The frame being processed

Constructor Detail

VideoBarVisualisation

protected VideoBarVisualisation(Video<MBFImage> video)

Parameters:

data -

Method Detail

processFrame

public abstract void processFrame(MBFImage frame,
                                  Timecode t)

Process a particular frame of the data. The frame and timecode of the frame are provided.

Parameters:

frame - The frame to process

t - The timecode.

processVideo

public void processVideo()

Begin processing the data in a separate thread. The data will be reset after processing is complete.

fireAnimationEvent

protected void fireAnimationEvent()

Fire an event to say a new vis update is available

getBarColour

public Float[] getBarColour()

Returns:

the barColour

setBarColour

public void setBarColour(Float[] barColour)

Parameters:

barColour - the barColour to set

getVideo

public Video<MBFImage> getVideo()

Return the data being shown by this bar.

Returns:

The data.

getTimePosition

protected double getTimePosition(Timecode t)

Returns the position of the given timecode at the scale of the current display. The position is given in pixels from the start of the bar.

Parameters:

t - the timecode for which to give the position.

Returns:

The position in pixels of the timecode.

getTimePosition

protected double getTimePosition(int nFrame)

Returns the position of the given frame at the scale of the current display. The position is given in pixel from the start of the bar.

Parameters:

nFrame - The frame index

Returns:

The position in pixels of the frame.

getEndTimeMilliseconds

public long getEndTimeMilliseconds()

Returns the end time of the timeline object in the timeline.

Specified by:

getEndTimeMilliseconds in interface TimelineObject

Overrides:

getEndTimeMilliseconds in class TimelineObjectAdapter<Video<MBFImage>>

Returns:

The end time.

See Also:

TimelineObjectAdapter.getEndTimeMilliseconds()

addAnimatedVisualisationListener

public void addAnimatedVisualisationListener(AnimatedVisualisationListener avl)

Add a visualisation listener to be informed of animation events.

Specified by:

addAnimatedVisualisationListener in interface AnimatedVisualisationProvider

Parameters:

avl - The listener to add

See Also:

AnimatedVisualisationProvider.addAnimatedVisualisationListener(org.openimaj.vis.AnimatedVisualisationListener)

removeAnimatedVisualisationListener

public void removeAnimatedVisualisationListener(AnimatedVisualisationListener avl)

Remove a given listener from being informed of animation events.

Specified by:

removeAnimatedVisualisationListener in interface AnimatedVisualisationProvider

Parameters:

avl - The listener to remove

See Also:

AnimatedVisualisationProvider.removeAnimatedVisualisationListener(org.openimaj.vis.AnimatedVisualisationListener)

update

public void update()

If you override this method, you should call it at the end of your own implementation. Called to update the visualisation. This method can expect the visImage member to be available and of the correct size. The method simply needs to draw the visualisation to this MBFImage. You should wrap any drawing code in a synchronized block, synchronized on the visImage - this stops the image being repainted to the screen half way through drawing.

Update is called from the paint() method so should ideally not force a repaint() as this will call a continuous repaint loop.

Specified by:

update in class VisualisationImpl<Video<MBFImage>>

See Also:

VisualisationImpl.update()