Package org.opencastproject.composer.remote

Class ComposerServiceRemoteImpl

java.lang.Object

org.opencastproject.serviceregistry.api.RemoteBase

org.opencastproject.composer.remote.ComposerServiceRemoteImpl

All Implemented Interfaces:

ComposerService

public class ComposerServiceRemoteImpl
extends RemoteBase
implements ComposerService

Proxies a set of remote composer services for use as a JVM-local service. Remote services are selected at random.

Nested Class Summary

Nested classes/interfaces inherited from class org.opencastproject.serviceregistry.api.RemoteBase

RemoteBase.HttpClientClosingInputStream

Field Summary

Fields inherited from class org.opencastproject.serviceregistry.api.RemoteBase

client, remoteServiceManager, serviceType

Fields inherited from interface org.opencastproject.composer.api.ComposerService

AUDIO_ONLY, BOTH, JOB_TYPE, LOWER, UPPER, VIDEO_ONLY

Constructor Summary

Constructors

Constructor	Description
ComposerServiceRemoteImpl()

Method Summary

Modifier and Type	Method	Description
protected String	buildTimeArray(double[] times)	Builds string containing times in seconds separated by comma.
Job	composite(Dimension compositeTrackSize, Optional<LaidOutElement<Track>> upperTrack, LaidOutElement<Track> lowerTrack, Optional<LaidOutElement<Attachment>> watermark, String profileId, String background, String sourceAudioName)	Compose two videos into one with an optional watermark.
Job	concat(String profileId, Dimension outputDimension, boolean sameCodec, Track... tracks)	Concat multiple tracks to a single track.
Job	concat(String profileId, Dimension outputDimension, float outputFrameRate, boolean sameCodec, Track... tracks)	Concat multiple tracks to a single track.
Job	convertImage(Attachment image, String... profileIds)	Converts the given image to a different image format using the specified image profiles.
List<Attachment>	convertImageSync(Attachment image, String... profileIds)	Synchronously converts the given image to different image formats using the specified encoding profiles.
Job	demux(Track sourceTrack, String profileId)	Demux a multi-track source into 2 media as defined by the encoding profile, the results are flavored and tagged positionally. eg: One ffmpeg operation to produce presenter/work and presentation/work
Job	encode(Track sourceTrack, String profileId)	Encode one track, using that track's audio and video streams.
EncodingProfile	getProfile(String profileId)	Gets a profile by its ID
Job	image(Track sourceTrack, String profileId, double... times)	Extracts an image from the media package element identified by sourceVideoTrackId.
Job	image(Track sourceTrack, String profileId, Map<String,String> properties)	Extracts an image from the media package element identified by sourceTrack.
List<Attachment>	imageSync(Track sourceTrack, String profileId, double... times)	Synchronously extracts images from the source track.
Job	imageToVideo(Attachment sourceImageAttachment, String profileId, double time)	Transforms an image attachment to a video track
EncodingProfile[]	listProfiles()
Job	multiEncode(Track sourceTrack, List<String> profileIds)	Encodes a track to set of media targets as defined by a list of encoding profiles
Job	mux(Map<String,Track> sourceTracks, String profileId)	Mux multiple tracks into a new Track.
Job	mux(Track sourceVideoTrack, Track sourceAudioTrack, String profileId)	Encode the video stream from one track and the audio stream from another, into a new Track.
Job	parallelEncode(Track sourceTrack, String profileId)	Encode one track to multiple other tracks in one encoding operation, using that track's audio and video streams.
Job	processSmil(Smil smil, String trackParamGroupId, String mediaType, List<String> profileIds)	Reads a smil definition and create one media track in multiple delivery formats.
void	setRemoteServiceManager(ServiceRegistry remoteServiceManager)	Sets the remote service manager.
void	setTrustedHttpClient(TrustedHttpClient client)	Sets the trusted http client
Job	trim(Track sourceTrack, String profileId, long start, long duration)	Trims the given track to the given start time and duration.

Methods inherited from class org.opencastproject.serviceregistry.api.RemoteBase

closeConnection, elementsFromHttpResponse, getResponse, getResponse, runRequest

Methods inherited from class java.lang.Object

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

Constructor Details

ComposerServiceRemoteImpl

public ComposerServiceRemoteImpl()

Method Details

setTrustedHttpClient

public void setTrustedHttpClient(TrustedHttpClient client)

Sets the trusted http client

Overrides:

setTrustedHttpClient in class RemoteBase

Parameters:

client -

setRemoteServiceManager

public void setRemoteServiceManager(ServiceRegistry remoteServiceManager)

Sets the remote service manager.

Overrides:

setRemoteServiceManager in class RemoteBase

Parameters:

remoteServiceManager -

encode

public Job encode(Track sourceTrack,
 String profileId)
           throws EncoderException

Encode one track, using that track's audio and video streams.

Specified by:

encode in interface ComposerService

Parameters:

sourceTrack - The source track

profileId - The profile to use for encoding

Returns:

The receipt for this encoding job. The receipt can be used with ComposerService#getJob to obtain the status of an encoding job.

Throws:

EncoderException

See Also:

• ComposerService.encode(org.opencastproject.mediapackage.Track, java.lang.String)

parallelEncode

public Job parallelEncode(Track sourceTrack,
 String profileId)
                   throws EncoderException

Encode one track to multiple other tracks in one encoding operation, using that track's audio and video streams.

Specified by:

parallelEncode in interface ComposerService

Parameters:

sourceTrack - The source track

profileId - The profile to use for encoding

Throws:

EncoderException

trim

public Job trim(Track sourceTrack,
 String profileId,
 long start,
 long duration)
         throws EncoderException

Trims the given track to the given start time and duration.

Specified by:

trim in interface ComposerService

Parameters:

sourceTrack - The source track

profileId - The profile to use for trimming

start - start time in miliseconds

duration - duration in miliseconds

Returns:

The receipt for this encoding job. The receipt can be used with ComposerService#getJob to obtain the status of an encoding job.

Throws:

EncoderException - if trimming fails

See Also:

• ComposerService.trim(Track, String, long, long)

mux

public Job mux(Track sourceVideoTrack,
 Track sourceAudioTrack,
 String profileId)
        throws EncoderException

Encode the video stream from one track and the audio stream from another, into a new Track.

Specified by:

mux in interface ComposerService

Parameters:

sourceVideoTrack - The source video track

sourceAudioTrack - The source audio track

profileId - The profile to use for encoding

Returns:

The receipt for this encoding job

Throws:

EncoderException - if encoding fails

See Also:

• ComposerService.mux(org.opencastproject.mediapackage.Track, org.opencastproject.mediapackage.Track, java.lang.String)

mux

public Job mux(Map<String,Track> sourceTracks,
 String profileId)
        throws EncoderException

Mux multiple tracks into a new Track.

Specified by:

mux in interface ComposerService

Parameters:

sourceTracks - The source tracks

profileId - The profile to use for encoding

Returns:

The receipt for this encoding job

Throws:

EncoderException - if encoding fails

See Also:

• ComposerService.mux(java.util.Map, java.lang.String)

getProfile

public EncodingProfile getProfile(String profileId)

Gets a profile by its ID

Specified by:

getProfile in interface ComposerService

Parameters:

profileId - The profile ID

Returns:

The encoding profile, or null if no profile is registered with that ID

See Also:

• ComposerService.getProfile(java.lang.String)

image

public Job image(Track sourceTrack,
 String profileId,
 double... times)
          throws EncoderException

Extracts an image from the media package element identified by sourceVideoTrackId. The image is taken at the timepoint time seconds into the movie.

Specified by:

image in interface ComposerService

Parameters:

sourceTrack - the source video track

profileId - identifier of the encoding profile

times - number of seconds into the video

Returns:

the extracted image as an attachment

Throws:

EncoderException - if image extraction fails

imageSync

public List<Attachment> imageSync(Track sourceTrack,
 String profileId,
 double... times)
                           throws EncoderException,
MediaPackageException

Description copied from interface: ComposerService

Synchronously extracts images from the source track. The images are taken at the given timepoints (seconds into the movie). Please note that synchronously doing this means, that the workload cannot be distributed amongst all nodes. This should be used rarely.

Specified by:

imageSync in interface ComposerService

Parameters:

sourceTrack - the source video track

profileId - identifier of the encoding profile

times - number of seconds into the video

Returns:

the extracted images as attachments

Throws:

EncoderException - if image extraction fails

MediaPackageException - if the mediapackage is invalid

image

public Job image(Track sourceTrack,
 String profileId,
 Map<String,String> properties)
          throws EncoderException,
MediaPackageException

Extracts an image from the media package element identified by sourceTrack. The image is taken by the given properties and the corresponding encoding profile.

Specified by:

image in interface ComposerService

Parameters:

sourceTrack - the source video track

profileId - identifier of the encoding profile

properties - the properties applied to the encoding profile

Returns:

the extracted image as an attachment

Throws:

EncoderException - if image extraction fails

MediaPackageException - if the mediapackage is invalid

See Also:

• ComposerService.image(Track, String, Map)

convertImage

public Job convertImage(Attachment image,
 String... profileIds)
                 throws EncoderException,
MediaPackageException

Converts the given image to a different image format using the specified image profiles.

Specified by:

convertImage in interface ComposerService

Parameters:

image - the image

profileIds - the profiles to use for conversion

Returns:

the job for the image conversion

Throws:

EncoderException - if image conversion fails

MediaPackageException - if the mediapackage is invalid

See Also:

• ComposerService.convertImage(org.opencastproject.mediapackage.Attachment, java.lang.String...)

convertImageSync

public List<Attachment> convertImageSync(Attachment image,
 String... profileIds)
                                  throws EncoderException,
MediaPackageException

Synchronously converts the given image to different image formats using the specified encoding profiles. Please note that synchronously doing this means that the workload cannot be distributed amongst all nodes.

Specified by:

convertImageSync in interface ComposerService

Parameters:

image - the image

profileIds - the profiles to use for conversion

Returns:

the converted images

Throws:

EncoderException - if image conversion fails

MediaPackageException - if the mediapackage is invalid

See Also:

• ComposerService.convertImageSync(org.opencastproject.mediapackage.Attachment, java.lang.String...)

listProfiles

public EncodingProfile[] listProfiles()

Specified by:

listProfiles in interface ComposerService

Returns:

All registered EncodingProfiles.

See Also:

• ComposerService.listProfiles()

buildTimeArray

protected String buildTimeArray(double[] times)

Builds string containing times in seconds separated by comma.

Parameters:

times - time array to be converted to string

Returns:

string represented specified time array

composite

public Job composite(Dimension compositeTrackSize,
 Optional<LaidOutElement<Track>> upperTrack,
 LaidOutElement<Track> lowerTrack,
 Optional<LaidOutElement<Attachment>> watermark,
 String profileId,
 String background,
 String sourceAudioName)
              throws EncoderException,
MediaPackageException

Description copied from interface: ComposerService

Compose two videos into one with an optional watermark.

Specified by:

composite in interface ComposerService

Parameters:

compositeTrackSize - The composite track dimension

upperTrack - upper track element from mediapackage (optional)

lowerTrack - lower track element from mediapackage

watermark - watermark element (optional)

profileId - Encoding profile name

background - The background color

sourceAudioName - Use audio from only lower or upper track or both, use both when available if omitted

Returns:

The receipt for this composite job

Throws:

EncoderException - if encoding fails

MediaPackageException - if the mediapackage is invalid

concat

public Job concat(String profileId,
 Dimension outputDimension,
 boolean sameCodec,
 Track... tracks)
           throws EncoderException,
MediaPackageException

Description copied from interface: ComposerService

Concat multiple tracks to a single track.

Specified by:

concat in interface ComposerService

Parameters:

profileId - The encoding profile to use

outputDimension - The output dimensions

sameCodec - Defines if lossless concat should be used

tracks - an array of track to concat in order of the array

Returns:

The receipt for this concat job

Throws:

EncoderException - if encoding fails

MediaPackageException - if the mediapackage is invalid

concat

public Job concat(String profileId,
 Dimension outputDimension,
 float outputFrameRate,
 boolean sameCodec,
 Track... tracks)
           throws EncoderException,
MediaPackageException

Description copied from interface: ComposerService

Concat multiple tracks to a single track. Required ffmpeg version 1.1

Specified by:

concat in interface ComposerService

Parameters:

profileId - The encoding profile to use

outputDimension - The output dimensions

outputFrameRate - The output frame rate

sameCodec - Defines if lossless concat should be used

tracks - an array of track to concat in order of the array

Returns:

The receipt for this concat job

Throws:

EncoderException - if encoding fails

MediaPackageException - if the mediapackage is invalid

imageToVideo

public Job imageToVideo(Attachment sourceImageAttachment,
 String profileId,
 double time)
                 throws EncoderException,
MediaPackageException

Description copied from interface: ComposerService

Transforms an image attachment to a video track

Specified by:

imageToVideo in interface ComposerService

Parameters:

sourceImageAttachment - The source image attachment

profileId - The profile to use for encoding

time - the length of the resulting video track in seconds

Returns:

The receipt for this image to video job

Throws:

EncoderException - if encoding fails

MediaPackageException - if the mediapackage is invalid

demux

public Job demux(Track sourceTrack,
 String profileId)
          throws EncoderException,
MediaPackageException

Description copied from interface: ComposerService

Demux a multi-track source into 2 media as defined by the encoding profile, the results are flavored and tagged positionally. eg: One ffmpeg operation to produce presenter/work and presentation/work

Specified by:

demux in interface ComposerService

Parameters:

sourceTrack -

profileId -

Returns:

Receipt for this demux based on the profile

Throws:

EncoderException

MediaPackageException

processSmil

public Job processSmil(Smil smil,
 String trackParamGroupId,
 String mediaType,
 List<String> profileIds)
                throws EncoderException,
MediaPackageException

Description copied from interface: ComposerService

Reads a smil definition and create one media track in multiple delivery formats. The track in the smil is selected by "trackParamGroupId" which is the paramGroup in the smil The multiple delivery formats are determined by a list of encoding profiles by name. The resultant tracks will be tagged by profile name. The smil file can contain more than one source track but they must have the same dimension. This is used mainly on smil.xml from the editor. There is a configurable fadein/fadeout between each clip (default is 2s).

Specified by:

processSmil in interface ComposerService

Parameters:

smil - - Describes one media (can contain multiple source in ws) and editing instructions (in out points of video clips) for concatenation into one video with transitions

trackParamGroupId - - track group id to process, if missing, will process first track found in smil

mediaType - - v for videoOnly, a for audioOnly, anything else is AudioVisual

profileIds - - Encoding profiles for each output from this media

Returns:

Receipt for this processing based on the smil file and the list of profiles

Throws:

EncoderException

MediaPackageException

multiEncode

public Job multiEncode(Track sourceTrack,
 List<String> profileIds)
                throws EncoderException,
MediaPackageException

Description copied from interface: ComposerService

Encodes a track to set of media targets as defined by a list of encoding profiles

Specified by:

multiEncode in interface ComposerService

Parameters:

sourceTrack - - video or audio track

profileIds - - a list of encoding profiles by name

Returns:

Receipt for this processing based on the inputs

Throws:

EncoderException - if it fails

MediaPackageException - if adding files to a mediapackage produces errors