Package org.opencastproject.crop.impl

Class CropServiceImpl

java.lang.Object

org.opencastproject.job.api.AbstractJobProducer

org.opencastproject.crop.impl.CropServiceImpl

All Implemented Interfaces:

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

public class CropServiceImpl
extends AbstractJobProducer
implements CropService, org.osgi.service.cm.ManagedService

Media analysis plugin that takes a video stream and removes black bars on each side

This plugin runs

     ffmpeg -i input.file -vf cropdetect=24:16:0 -max_muxing_qurue_size 2000 -f null -

     ffmpeg -i input.file -vf startCropping=wi-2*x:hi:x:0 -max_muxing_queue_size 2000 -y output.file
 

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	CROP_FFMPEG_GREYSCALE_LIMIT	The threshold of greyscale to use for cropping
static final String	CROP_FFMPEG_MAX_CROPPING_RATIO	Regular expression to grep the detected crop parameters from the ffmpeg output.
static final String	CROP_FFMPEG_PARAM	Additional parameters that will be added to the ffmpeg command line
static final String	CROP_FFMPEG_REGEX	Regular expression to grep the detected crop parameters from the ffmpeg output.
static final String	CROP_FFMPEG_RESET	The counter that determines after how many frames cropdetect will be executed again
static final String	CROP_FFMPEG_ROUND	The value which the width/height should be divisible by
static final String	CROP_FFMPEG_TARGET_EXTENSION	File extension for the resulting cropped video
static final String	CROP_JOB_LOAD_KEY	The key to look for in the service configuration file to override the DEFAULT_CROP_JOB_LOAD
static final Integer	DEFAULT_CROP_FFMPEG_MAX_CROPPING_RATIO
static final String	DEFAULT_CROP_FFMPEG_PARAM
static final String	DEFAULT_CROP_FFMPEG_REGEX
static final String	DEFAULT_CROP_FFMPEG_RESET
static final String	DEFAULT_CROP_FFMPEG_ROUND
static final String	DEFAULT_CROP_FFMPEG_TARGET_EXTENSION
static final String	DEFAULT_CROP_GREYSCALE_LIMIT
static final float	DEFAULT_CROP_JOB_LOAD	The load introduced on the system by creating a caption job
static final String	FFMPEG_BINARY_CONFIG
static final String	FFMPEG_BINARY_DEFAULT

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.crop.api.CropService

JOB_TYPE

Constructor Summary

Constructors

Constructor	Description
CropServiceImpl()	Creates a new instance of the startCropping service.

Method Summary

Modifier and Type	Method	Description
void	activate(org.osgi.service.component.ComponentContext cc)	OSGI activate method.
Job	crop(Track track)	Takes the given track and returns the job that can be used to get the resulting mpeg7 catalog
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,?> dictionary)

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

COLLECTION_ID

public static final String COLLECTION_ID

Resulting collection in the working file repository

See Also:

• Constant Field Values

binary

protected String binary

Path to the executable

FFMPEG_BINARY_CONFIG

public static final String FFMPEG_BINARY_CONFIG

See Also:

• Constant Field Values

FFMPEG_BINARY_DEFAULT

public static final String FFMPEG_BINARY_DEFAULT

See Also:

• Constant Field Values

DEFAULT_CROP_JOB_LOAD

public static final float DEFAULT_CROP_JOB_LOAD

The load introduced on the system by creating a caption job

See Also:

• Constant Field Values

CROP_JOB_LOAD_KEY

public static final String CROP_JOB_LOAD_KEY

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

See Also:

• Constant Field Values

CROP_FFMPEG_GREYSCALE_LIMIT

public static final String CROP_FFMPEG_GREYSCALE_LIMIT

The threshold of greyscale to use for cropping

See Also:

• Constant Field Values

DEFAULT_CROP_GREYSCALE_LIMIT

public static final String DEFAULT_CROP_GREYSCALE_LIMIT

See Also:

• Constant Field Values

CROP_FFMPEG_ROUND

public static final String CROP_FFMPEG_ROUND

The value which the width/height should be divisible by

See Also:

• Constant Field Values

DEFAULT_CROP_FFMPEG_ROUND

public static final String DEFAULT_CROP_FFMPEG_ROUND

See Also:

• Constant Field Values

CROP_FFMPEG_RESET

public static final String CROP_FFMPEG_RESET

The counter that determines after how many frames cropdetect will be executed again

See Also:

• Constant Field Values

DEFAULT_CROP_FFMPEG_RESET

public static final String DEFAULT_CROP_FFMPEG_RESET

See Also:

• Constant Field Values

CROP_FFMPEG_PARAM

public static final String CROP_FFMPEG_PARAM

Additional parameters that will be added to the ffmpeg command line

See Also:

• Constant Field Values

DEFAULT_CROP_FFMPEG_PARAM

public static final String DEFAULT_CROP_FFMPEG_PARAM

See Also:

• Constant Field Values

CROP_FFMPEG_TARGET_EXTENSION

public static final String CROP_FFMPEG_TARGET_EXTENSION

File extension for the resulting cropped video

See Also:

• Constant Field Values

DEFAULT_CROP_FFMPEG_TARGET_EXTENSION

public static final String DEFAULT_CROP_FFMPEG_TARGET_EXTENSION

See Also:

• Constant Field Values

CROP_FFMPEG_REGEX

public static final String CROP_FFMPEG_REGEX

Regular expression to grep the detected crop parameters from the ffmpeg output. Be aware that the names for the named groups must be present.

See Also:

• Constant Field Values

DEFAULT_CROP_FFMPEG_REGEX

public static final String DEFAULT_CROP_FFMPEG_REGEX

See Also:

• Constant Field Values

CROP_FFMPEG_MAX_CROPPING_RATIO

public static final String CROP_FFMPEG_MAX_CROPPING_RATIO

Regular expression to grep the detected crop parameters from the ffmpeg output. Be aware that the names for the named groups must be present.

See Also:

• Constant Field Values

DEFAULT_CROP_FFMPEG_MAX_CROPPING_RATIO

public static final Integer DEFAULT_CROP_FFMPEG_MAX_CROPPING_RATIO

Constructor Details

CropServiceImpl

public CropServiceImpl()

Creates a new instance of the startCropping service.

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

process

protected String process(Job job)
                  throws Exception

Description copied from class: AbstractJobProducer

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

crop

public Job crop(Track track)
         throws CropException,
MediaPackageException

Takes the given track and returns the job that can be used to get the resulting mpeg7 catalog

Specified by:

crop in interface CropService

Parameters:

track - track to crop

Returns:

the job with which we can obtain the extracted metadata

Throws:

CropException - if the track could not be cropped

MediaPackageException - if the track is invalid

See Also:

• CropService.crop(org.opencastproject.mediapackage.Track)

updated

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

Specified by:

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

Throws:

org.osgi.service.cm.ConfigurationException

See Also:

• ManagedService.updated(java.util.Dictionary)

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)

setWorkspace

public void setWorkspace(Workspace workspace)

setUserDirectoryService

public void setUserDirectoryService(UserDirectoryService userDirectoryService)

setOrganizationDirectoryService

public void setOrganizationDirectoryService(OrganizationDirectoryService organizationDirectoryService)

setSecurityService

public void setSecurityService(SecurityService securityService)