Package org.opencastproject.waveform.ffmpeg

Class WaveformServiceImpl

java.lang.Object

org.opencastproject.job.api.AbstractJobProducer

org.opencastproject.waveform.ffmpeg.WaveformServiceImpl

All Implemented Interfaces:

JobProducer, WaveformService, org.osgi.service.cm.ManagedService

public class WaveformServiceImpl
extends AbstractJobProducer
implements WaveformService, org.osgi.service.cm.ManagedService

This service creates a waveform image from a media file with at least one audio channel. This will be done using ffmpeg.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	binary	Path to the executable
static final String	COLLECTION_ID	Resulting collection in the working file repository
static final String	DEFAULT_FFMPEG_BINARY	The default path to the ffmpeg binary
static final String[]	DEFAULT_WAVEFORM_COLOR	The default waveform colors per audio channel
static final String	DEFAULT_WAVEFORM_FILTER_MODE
static final String	DEFAULT_WAVEFORM_FILTER_POST	The default filter to be optionally appended to the showwavespic filter
static final String	DEFAULT_WAVEFORM_FILTER_PRE	The default filter to be optionally prepended to the showwavespic filter
static final float	DEFAULT_WAVEFORM_JOB_LOAD	The default job load of a waveform job
static final String	DEFAULT_WAVEFORM_SCALE	The default waveform image scale algorithm
static final boolean	DEFAULT_WAVEFORM_SPLIT_CHANNELS	The default value if the waveforms (per audio channel) should be renderen next to each other (if true) or on top of each other (if false)
static final String	FFMPEG_BINARY_CONFIG_KEY	The key to look for in the service configuration file to override the DEFAULT_FFMPEG_BINARY
protected static final org.slf4j.Logger	logger	The logging facility
static final String	WAVEFORM_COLOR_CONFIG_KEY	The key to look for in the service configuration file to override the DEFAULT_WAVEFORM_COLOR
static final String	WAVEFORM_FILTER_MODE_CONFIG_KEY
static final String	WAVEFORM_FILTER_POST_CONFIG_KEY	The key to look for in the service configuration file to override the DEFAULT_WAVEFORM_FILTER_POST
static final String	WAVEFORM_FILTER_PRE_CONFIG_KEY	The key to look for in the service configuration file to override the DEFAULT_WAVEFORM_FILTER_PRE
static final String	WAVEFORM_JOB_LOAD_CONFIG_KEY	The key to look for in the service configuration file to override the DEFAULT_WAVEFORM_JOB_LOAD
static final String	WAVEFORM_SCALE_CONFIG_KEY	The key to look for in the service configuration file to override the DEFAULT_WAVEFORM_SCALE
static final String	WAVEFORM_SPLIT_CHANNELS_CONFIG_KEY	The key to look for in the service configuration file to override the DEFAULT_WAVEFORM_SPLIT_CHANNELS

Fields inherited from class org.opencastproject.job.api.AbstractJobProducer

ACCEPT_JOB_LOADS_EXCEEDING_PROPERTY, acceptJobLoadsExeedingMaxLoad, DEFAULT_ACCEPT_JOB_LOADS_EXCEEDING, executor, jobType

Fields inherited from interface org.opencastproject.waveform.api.WaveformService

JOB_TYPE

Constructor Summary

Constructors

Constructor	Description
WaveformServiceImpl()

Method Summary

Modifier and Type	Method	Description
void	activate(org.osgi.service.component.ComponentContext cc)	OSGI activate method.
Job	createWaveformImage(Track sourceTrack, int pixelsPerMinute, int minWidth, int maxWidth, int height, String color)	Takes the given track and returns the job that will create a waveform image.
protected OrganizationDirectoryService	getOrganizationDirectoryService()	Returns a reference to the organization directory service.
protected SecurityService	getSecurityService()	Returns a reference to the security service
protected ServiceRegistry	getServiceRegistry()	Returns a reference to the service registry.
protected UserDirectoryService	getUserDirectoryService()	Returns a reference to the user directory service
protected String	process(Job job)	Asks the overriding class to process the arguments using the given operation.
void	setOrganizationDirectoryService(OrganizationDirectoryService organizationDirectoryService)
void	setSecurityService(SecurityService securityService)
void	setServiceRegistry(ServiceRegistry serviceRegistry)
void	setUserDirectoryService(UserDirectoryService userDirectoryService)
void	setWorkspace(Workspace workspace)
void	updated(Dictionary<String,?> properties)

Methods inherited from class org.opencastproject.job.api.AbstractJobProducer

acceptJob, countJobs, finallyUpdateJob, getJobType, incident, isReadyToAccept, isReadyToAcceptJobs

Methods inherited from class java.lang.Object

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

Field Details

logger

protected static final org.slf4j.Logger logger

The logging facility

binary

protected String binary

Path to the executable

WAVEFORM_JOB_LOAD_CONFIG_KEY

public static final String WAVEFORM_JOB_LOAD_CONFIG_KEY

The key to look for in the service configuration file to override the DEFAULT_WAVEFORM_JOB_LOAD

See Also:

• Constant Field Values

DEFAULT_WAVEFORM_JOB_LOAD

public static final float DEFAULT_WAVEFORM_JOB_LOAD

The default job load of a waveform job

See Also:

• Constant Field Values

FFMPEG_BINARY_CONFIG_KEY

public static final String FFMPEG_BINARY_CONFIG_KEY

The key to look for in the service configuration file to override the DEFAULT_FFMPEG_BINARY

See Also:

• Constant Field Values

DEFAULT_FFMPEG_BINARY

public static final String DEFAULT_FFMPEG_BINARY

The default path to the ffmpeg binary

See Also:

• Constant Field Values

DEFAULT_WAVEFORM_SCALE

public static final String DEFAULT_WAVEFORM_SCALE

The default waveform image scale algorithm

See Also:

• Constant Field Values

WAVEFORM_SCALE_CONFIG_KEY

public static final String WAVEFORM_SCALE_CONFIG_KEY

The key to look for in the service configuration file to override the DEFAULT_WAVEFORM_SCALE

See Also:

• Constant Field Values

DEFAULT_WAVEFORM_SPLIT_CHANNELS

public static final boolean DEFAULT_WAVEFORM_SPLIT_CHANNELS

The default value if the waveforms (per audio channel) should be renderen next to each other (if true) or on top of each other (if false)

See Also:

• Constant Field Values

WAVEFORM_SPLIT_CHANNELS_CONFIG_KEY

public static final String WAVEFORM_SPLIT_CHANNELS_CONFIG_KEY

The key to look for in the service configuration file to override the DEFAULT_WAVEFORM_SPLIT_CHANNELS

See Also:

• Constant Field Values

DEFAULT_WAVEFORM_COLOR

public static final String[] DEFAULT_WAVEFORM_COLOR

The default waveform colors per audio channel

WAVEFORM_COLOR_CONFIG_KEY

public static final String WAVEFORM_COLOR_CONFIG_KEY

The key to look for in the service configuration file to override the DEFAULT_WAVEFORM_COLOR

See Also:

• Constant Field Values

DEFAULT_WAVEFORM_FILTER_MODE

public static final String DEFAULT_WAVEFORM_FILTER_MODE

See Also:

• Constant Field Values

WAVEFORM_FILTER_MODE_CONFIG_KEY

public static final String WAVEFORM_FILTER_MODE_CONFIG_KEY

See Also:

• Constant Field Values

DEFAULT_WAVEFORM_FILTER_PRE

public static final String DEFAULT_WAVEFORM_FILTER_PRE

The default filter to be optionally prepended to the showwavespic filter

WAVEFORM_FILTER_PRE_CONFIG_KEY

public static final String WAVEFORM_FILTER_PRE_CONFIG_KEY

The key to look for in the service configuration file to override the DEFAULT_WAVEFORM_FILTER_PRE

See Also:

• Constant Field Values

DEFAULT_WAVEFORM_FILTER_POST

public static final String DEFAULT_WAVEFORM_FILTER_POST

The default filter to be optionally appended to the showwavespic filter

WAVEFORM_FILTER_POST_CONFIG_KEY

public static final String WAVEFORM_FILTER_POST_CONFIG_KEY

The key to look for in the service configuration file to override the DEFAULT_WAVEFORM_FILTER_POST

See Also:

• Constant Field Values

COLLECTION_ID

public static final String COLLECTION_ID

Resulting collection in the working file repository

See Also:

• Constant Field Values

Constructor Details

WaveformServiceImpl

public WaveformServiceImpl()

Method Details

activate

public void activate(org.osgi.service.component.ComponentContext cc)

Description copied from class: AbstractJobProducer

OSGI activate method.

Overrides:

activate in class AbstractJobProducer

Parameters:

cc - OSGI component context

updated

public void updated(Dictionary<String,?> properties)
             throws org.osgi.service.cm.ConfigurationException

Specified by:

updated in interface org.osgi.service.cm.ManagedService

Throws:

org.osgi.service.cm.ConfigurationException

createWaveformImage

public Job createWaveformImage(Track sourceTrack,
 int pixelsPerMinute,
 int minWidth,
 int maxWidth,
 int height,
 String color)
                        throws MediaPackageException,
WaveformServiceException

Takes the given track and returns the job that will create a waveform image.

Specified by:

createWaveformImage in interface WaveformService

Parameters:

sourceTrack - the track to create waveform image from

pixelsPerMinute - the width of the waveform image in pixels per minute

minWidth - the minimum width of the waveform image

maxWidth - the maximum width of the waveform image

height - the height of the waveform image

color - the color of the waveform image

Returns:

a job that will create a waveform image

Throws:

MediaPackageException - if the serialization of the given track fails

WaveformServiceException - if the job can't be created for any reason

See Also:

• WaveformService.createWaveformImage(org.opencastproject.mediapackage.Track, int, int, int, int, String)

process

protected String process(Job job)
                  throws Exception

Asks the overriding class to process the arguments using the given operation. The result will be added to the associated job as the payload.

Specified by:

process in class AbstractJobProducer

Parameters:

job - the job to process

Returns:

the operation result

Throws:

Exception

See Also:

• AbstractJobProducer.process(org.opencastproject.job.api.Job)

getServiceRegistry

protected ServiceRegistry getServiceRegistry()

Description copied from class: AbstractJobProducer

Returns a reference to the service registry.

Specified by:

getServiceRegistry in class AbstractJobProducer

Returns:

the service registry

getSecurityService

protected SecurityService getSecurityService()

Description copied from class: AbstractJobProducer

Returns a reference to the security service

Specified by:

getSecurityService in class AbstractJobProducer

Returns:

the security service

getUserDirectoryService

protected UserDirectoryService getUserDirectoryService()

Description copied from class: AbstractJobProducer

Returns a reference to the user directory service

Specified by:

getUserDirectoryService in class AbstractJobProducer

Returns:

the user directory service

getOrganizationDirectoryService

protected OrganizationDirectoryService getOrganizationDirectoryService()

Description copied from class: AbstractJobProducer

Returns a reference to the organization directory service.

Specified by:

getOrganizationDirectoryService in class AbstractJobProducer

Returns:

the organization directory service

setServiceRegistry

public void setServiceRegistry(ServiceRegistry serviceRegistry)

setSecurityService

public void setSecurityService(SecurityService securityService)

setUserDirectoryService

public void setUserDirectoryService(UserDirectoryService userDirectoryService)

setOrganizationDirectoryService

public void setOrganizationDirectoryService(OrganizationDirectoryService organizationDirectoryService)

setWorkspace

public void setWorkspace(Workspace workspace)