Package org.opencastproject.sox.impl

Class SoxServiceImpl

java.lang.Object

org.opencastproject.job.api.AbstractJobProducer

org.opencastproject.sox.impl.SoxServiceImpl

All Implemented Interfaces:

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

public class SoxServiceImpl
extends AbstractJobProducer
implements SoxService, org.osgi.service.cm.ManagedService

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ANALYZE_JOB_LOAD_KEY	The key to look for in the service configuration file to override the DEFAULT_ANALYZE_JOB_LOAD
static final String	COLLECTION	The collection name
static final String	CONFIG_SOX_PATH
static final float	DEFAULT_ANALYZE_JOB_LOAD	The load introduced on the system by creating a analyze job
static final float	DEFAULT_NORMALIZE_JOB_LOAD	The load introduced on the system by creating a normalize job
static final String	NORMALIZE_JOB_LOAD_KEY	The key to look for in the service configuration file to override the DEFAULT_NORMALIZE_JOB_LOAD
protected OrganizationDirectoryService	organizationDirectoryService	The organization directory service
protected SecurityService	securityService	The security service
static final String	SOX_BINARY_DEFAULT	Default location of the SoX binary (resembling the installer)
protected UserDirectoryService	userDirectoryService	The user directory service

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.sox.api.SoxService

JOB_TYPE

Constructor Summary

Constructors

Constructor	Description
SoxServiceImpl()	Creates a new composer service instance.

Method Summary

Modifier and Type	Method	Description
void	activate(org.osgi.service.component.ComponentContext cc)	OSGi callback on component activation.
protected Option<Track>	analyze(Job job, Track audioTrack)
Job	analyze(Track sourceAudioTrack)	Get audio statistics, using that track's audio streams.
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
Job	normalize(Track sourceAudioTrack, Float targetRmsLevDb)	Normalize the audio stream of that track.
protected String	process(Job job)	Asks the overriding class to process the arguments using the given operation.
void	setOrganizationDirectoryService(OrganizationDirectoryService organizationDirectory)	Sets a reference to the organization directory service.
void	setSecurityService(SecurityService securityService)	Callback for setting the security service.
protected void	setServiceRegistry(ServiceRegistry serviceRegistry)	Sets the service registry
void	setUserDirectoryService(UserDirectoryService userDirectoryService)	Callback for setting the user directory service.
protected void	setWorkspace(Workspace workspace)	Sets the workspace
void	updated(Dictionary 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

SOX_BINARY_DEFAULT

public static final String SOX_BINARY_DEFAULT

Default location of the SoX binary (resembling the installer)

See Also:

• Constant Field Values

CONFIG_SOX_PATH

public static final String CONFIG_SOX_PATH

See Also:

• Constant Field Values

DEFAULT_ANALYZE_JOB_LOAD

public static final float DEFAULT_ANALYZE_JOB_LOAD

The load introduced on the system by creating a analyze job

See Also:

• Constant Field Values

ANALYZE_JOB_LOAD_KEY

public static final String ANALYZE_JOB_LOAD_KEY

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

See Also:

• Constant Field Values

DEFAULT_NORMALIZE_JOB_LOAD

public static final float DEFAULT_NORMALIZE_JOB_LOAD

The load introduced on the system by creating a normalize job

See Also:

• Constant Field Values

NORMALIZE_JOB_LOAD_KEY

public static final String NORMALIZE_JOB_LOAD_KEY

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

See Also:

• Constant Field Values

COLLECTION

public static final String COLLECTION

The collection name

See Also:

• Constant Field Values

securityService

protected SecurityService securityService

The security service

userDirectoryService

protected UserDirectoryService userDirectoryService

The user directory service

organizationDirectoryService

protected OrganizationDirectoryService organizationDirectoryService

The organization directory service

Constructor Details

SoxServiceImpl

public SoxServiceImpl()

Creates a new composer service instance.

Method Details

activate

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

OSGi callback on component activation.

Overrides:

activate in class AbstractJobProducer

Parameters:

cc - the component context

analyze

public Job analyze(Track sourceAudioTrack)
            throws MediaPackageException,
SoxException

Get audio statistics, using that track's audio streams.

Specified by:

analyze in interface SoxService

Parameters:

sourceAudioTrack - The source audio track

Returns:

The receipt for this audio processing job.

Throws:

MediaPackageException - if the mediapackage is invalid

SoxException - if audio processing fails

See Also:

• SoxService.analyze(Track)

normalize

public Job normalize(Track sourceAudioTrack,
 Float targetRmsLevDb)
              throws MediaPackageException,
SoxException

Normalize the audio stream of that track.

Specified by:

normalize in interface SoxService

Parameters:

sourceAudioTrack - The source audio track

targetRmsLevDb - The target RMS Lev dB

Returns:

The receipt for this audio processing job

Throws:

MediaPackageException - if the mediapackage is invalid

SoxException - if audio processing fails

See Also:

• SoxService.normalize(Track, Float)

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)

analyze

protected Option<Track> analyze(Job job,
 Track audioTrack)
                         throws SoxException

Throws:

SoxException

setWorkspace

protected void setWorkspace(Workspace workspace)

Sets the workspace

Parameters:

workspace - an instance of the workspace

setServiceRegistry

protected void setServiceRegistry(ServiceRegistry serviceRegistry)

Sets the service registry

Parameters:

serviceRegistry - the service registry

getServiceRegistry

protected ServiceRegistry getServiceRegistry()

Returns a reference to the service registry.

Specified by:

getServiceRegistry in class AbstractJobProducer

Returns:

the service registry

See Also:

• AbstractJobProducer.getServiceRegistry()

setSecurityService

public void setSecurityService(SecurityService securityService)

Callback for setting the security service.

Parameters:

securityService - the securityService to set

setUserDirectoryService

public void setUserDirectoryService(UserDirectoryService userDirectoryService)

Callback for setting the user directory service.

Parameters:

userDirectoryService - the userDirectoryService to set

setOrganizationDirectoryService

public void setOrganizationDirectoryService(OrganizationDirectoryService organizationDirectory)

Sets a reference to the organization directory service.

Parameters:

organizationDirectory - the organization directory

getSecurityService

protected SecurityService getSecurityService()

Returns a reference to the security service

Specified by:

getSecurityService in class AbstractJobProducer

Returns:

the security service

See Also:

• AbstractJobProducer.getSecurityService()

getUserDirectoryService

protected UserDirectoryService getUserDirectoryService()

Returns a reference to the user directory service

Specified by:

getUserDirectoryService in class AbstractJobProducer

Returns:

the user directory service

See Also:

• AbstractJobProducer.getUserDirectoryService()

getOrganizationDirectoryService

protected OrganizationDirectoryService getOrganizationDirectoryService()

Returns a reference to the organization directory service.

Specified by:

getOrganizationDirectoryService in class AbstractJobProducer

Returns:

the organization directory service

See Also:

• AbstractJobProducer.getOrganizationDirectoryService()

updated

public void updated(Dictionary properties)
             throws org.osgi.service.cm.ConfigurationException

Specified by:

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

Throws:

org.osgi.service.cm.ConfigurationException