ws.schild.jave.encode.VideoAttributes Maven / Gradle / Ivy
Show all versions of jave-core Show documentation
/*
* JAVE - A Java Audio/Video Encoder (based on FFMPEG)
*
* Copyright (C) 2008-2009 Carlo Pelliccia (www.sauronsoftware.it)
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see videoFilters = new ArrayList<>();
/**
* Encode the video with faststart mode, default OFF
*
* The mov/mp4/ismv muxer supports fragmentation. Normally, a MOV/MP4 file has all the metadata
* about all packets stored in one location (written at the end of the file, it can be moved to
* the start for better playback by adding faststart to the movflags, or using the qt-faststart
* tool). A fragmented file consists of a number of fragments, where packets and metadata about
* these packets are stored together. Writing a fragmented file has the advantage that the file is
* decodable even if the writing is interrupted (while a normal MOV/MP4 is undecodable if it is
* not properly finished), and it requires less memory when writing very long files (since writing
* normal MOV/MP4 files stores info about every single packet in memory until the file is closed).
* The downside is that it is less compatible with other applications.
*/
private boolean faststart = false;
private X264_PROFILE x264Profile = null;
/**
* Returns the codec name for the encoding process.
*
* @return The codec name for the encoding process.
*/
public Optional getCodec() {
return Optional.ofNullable(codec);
}
/**
* Sets the codec name for the encoding process. If null or not specified the encoder will perform
* a direct stream copy.
*
* Be sure the supplied codec name is in the list returned by {@link
* Encoder#getVideoEncoders()}.
*
*
A special value can be picked from {@link VideoAttributes#DIRECT_STREAM_COPY}.
*
* @param codec The codec name for the encoding process.
* @return this instance
*/
public VideoAttributes setCodec(String codec) {
this.codec = codec;
return this;
}
/**
* Returns the the forced tag/fourcc value for the video stream.
*
* @return The the forced tag/fourcc value for the video stream.
*/
public Optional getTag() {
return Optional.ofNullable(tag);
}
/**
* Sets the forced tag/fourcc value for the video stream.
*
* @param tag The the forced tag/fourcc value for the video stream.
* @return this instance
*/
public VideoAttributes setTag(String tag) {
this.tag = tag;
return this;
}
/**
* Returns the bitrate value for the encoding process.
*
* @return The bitrate value for the encoding process.
*/
public Optional getBitRate() {
return Optional.ofNullable(bitRate);
}
/**
* Sets the bitrate value for the encoding process. If null or not specified a default value will
* be picked.
*
* @param bitRate The bitrate value for the encoding process.
* @return this instance
*/
public VideoAttributes setBitRate(Integer bitRate) {
this.bitRate = bitRate;
return this;
}
/**
* Returns the frame rate value for the encoding process.
*
* @return The frame rate value for the encoding process.
*/
public Optional getFrameRate() {
return Optional.ofNullable(frameRate);
}
/**
* Sets the frame rate value for the encoding process. If null or not specified a default value
* will be picked.
*
* @param frameRate The frame rate value for the encoding process.
* @return this instance
*/
public VideoAttributes setFrameRate(Integer frameRate) {
this.frameRate = frameRate;
return this;
}
/**
* Returns the video size for the encoding process.
*
* @return The video size for the encoding process.
*/
public Optional getSize() {
return Optional.ofNullable(size);
}
/**
* Sets the video size for the encoding process. If null or not specified the source video size
* will not be modified.
*
* @param size he video size for the encoding process.
* @return this instance
*/
public VideoAttributes setSize(VideoSize size) {
this.size = size;
return this;
}
/** @return the faststart */
public boolean isFaststart() {
return faststart;
}
public Optional getComplexFiltergraph() {
return Optional.ofNullable(complexFiltergraph);
}
public VideoAttributes setComplexFiltergraph(FilterGraph complexFiltergraph) {
this.complexFiltergraph = complexFiltergraph;
return this;
}
public void addFilter(VideoFilter videoFilter) {
this.videoFilters.add(videoFilter);
}
public ArrayList getVideoFilters() {
return this.videoFilters;
}
/**
* @param faststart the faststart to set
* @return this instance
*/
public VideoAttributes setFaststart(boolean faststart) {
this.faststart = faststart;
return this;
}
/** @return the quality */
public Optional getQuality() {
return Optional.ofNullable(quality);
}
/**
* The video quality value for the encoding process. If null or not specified the ffmpeg default
* will be used
*
* @param quality the quality to set
* @return this instance
*/
public VideoAttributes setQuality(Integer quality) {
this.quality = quality;
return this;
}
public Optional getPixelFormat() {
return Optional.ofNullable(pixelFormat);
}
public VideoAttributes setPixelFormat(String pixelFormat) {
this.pixelFormat = pixelFormat;
return this;
}
public Optional getVsync() {
return Optional.ofNullable(vsync);
}
public VideoAttributes setVsync(VsyncMethod vsync) {
this.vsync = vsync;
return this;
}
@Override
public String toString() {
return getClass().getName()
+ "(codec="
+ codec
+ ", bitRate="
+ bitRate
+ ", frameRate="
+ frameRate
+ ", size="
+ size
+ ", faststart="
+ faststart
+ ", quality="
+ quality
+ ")";
}
/** @return the x264Profile */
public Optional getX264Profile() {
return Optional.ofNullable(x264Profile);
}
/**
* @param x264Profile the x264Profile to set
* @return this instance
*/
public VideoAttributes setX264Profile(X264_PROFILE x264Profile) {
this.x264Profile = x264Profile;
return this;
}
}