FFmpegFrameGrabber (JavaCV 1.5.11 API)

java.lang.Object
- org.bytedeco.javacv.FrameGrabber
- - org.bytedeco.javacv.FFmpegFrameGrabber

All Implemented Interfaces:

Closeable, AutoCloseable
```
public class FFmpegFrameGrabber
extends FrameGrabber
```
Author:

Samuel Audet

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FFmpegFrameGrabber.Exception
- Nested classes/interfaces inherited from class org.bytedeco.javacv.FrameGrabber
  FrameGrabber.Array, FrameGrabber.ImageMode, FrameGrabber.PropertyEditor, FrameGrabber.SampleMode

Nested Classes
Modifier and Type	Class and Description
`static class`	`FFmpegFrameGrabber.Exception`

Field Summary
- Fields inherited from class org.bytedeco.javacv.FrameGrabber
  aspectRatio, audioBitrate, audioChannels, audioCodec, audioCodecName, audioDisposition, audioMetadata, audioOptions, audioSideData, audioStream, bpp, charset, deinterlace, format, frameNumber, frameRate, gamma, imageHeight, imageMode, imageScalingFlags, imageWidth, list, maxDelay, metadata, numBuffers, options, pixelFormat, sampleFormat, sampleMode, sampleRate, SENSOR_PATTERN_BGGR, SENSOR_PATTERN_GBRG, SENSOR_PATTERN_GRBG, SENSOR_PATTERN_RGGB, sensorPattern, startTime, timeout, timestamp, triggerMode, videoBitrate, videoCodec, videoCodecName, videoDisposition, videoMetadata, videoOptions, videoSideData, videoStream

Constructor Summary

Constructors
Constructor and Description
`FFmpegFrameGrabber(File file)`
`FFmpegFrameGrabber(InputStream inputStream)` Calls `FFmpegFrameGrabber(inputStream, Integer.MAX_VALUE - 8)` so that the whole input stream is seekable.
`FFmpegFrameGrabber(InputStream inputStream, int maximumSize)` Set maximumSize to 0 to disable seek and minimize startup time.
`FFmpegFrameGrabber(String filename)`
`FFmpegFrameGrabber(URL url)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static FFmpegFrameGrabber`	`createDefault(File deviceFile)`
`static FFmpegFrameGrabber`	`createDefault(int deviceNumber)`
`static FFmpegFrameGrabber`	`createDefault(String devicePath)`
`protected void`	`finalize()`
`double`	`getAspectRatio()`
`int`	`getAudioBitrate()`
`int`	`getAudioChannels()`
`int`	`getAudioCodec()`
`String`	`getAudioCodecName()`
`double`	`getAudioFrameRate()` Estimation of audio frames per second.
`Map<String,String>`	`getAudioMetadata()`
`String`	`getAudioMetadata(String key)`
`Map<String,Buffer>`	`getAudioSideData()`
`Buffer`	`getAudioSideData(String key)`
`static String[]`	`getDeviceDescriptions()`
`double`	`getDisplayRotation()` Returns the rotation in degrees from the side data of the video stream, or 0 if unknown.
`String`	`getFormat()`
`AVFormatContext`	`getFormatContext()`
`double`	`getFrameRate()` Returns `getVideoFrameRate()`
`double`	`getGamma()`
`int`	`getImageHeight()`
`int`	`getImageWidth()`
`int`	`getLengthInAudioFrames()`
`int`	`getLengthInFrames()` Returns `getLengthInVideoFrames()`
`long`	`getLengthInTime()`
`int`	`getLengthInVideoFrames()` Returns `(int) Math.round(getLengthInTime() * getFrameRate() / 1000000L)`, which is an approximation in general.
`Map<String,String>`	`getMetadata()`
`String`	`getMetadata(String key)`
`int`	`getPixelFormat()`
`int`	`getSampleFormat()`
`int`	`getSampleRate()`
`int`	`getVideoBitrate()`
`int`	`getVideoCodec()`
`String`	`getVideoCodecName()`
`double`	`getVideoFrameRate()`
`Map<String,String>`	`getVideoMetadata()`
`String`	`getVideoMetadata(String key)`
`Map<String,Buffer>`	`getVideoSideData()`
`Buffer`	`getVideoSideData(String key)`
`Frame`	`grab()` Each call to grab stores the new image in the memory address for the previously returned frame.
`Frame`	`grabFrame(boolean doAudio, boolean doVideo, boolean doProcessing, boolean keyFrames)`
`Frame`	`grabFrame(boolean doAudio, boolean doVideo, boolean doProcessing, boolean keyFrames, boolean doData)`
`Frame`	`grabImage()`
`Frame`	`grabKeyFrame()`
`AVPacket`	`grabPacket()`
`Frame`	`grabSamples()`
`boolean`	`hasAudio()` Is there an audio stream?
`boolean`	`hasVideo()` Is there a video stream?
`boolean`	`isCloseInputStream()`
`void`	`release()`
`void`	`releaseUnsafe()`
`void`	`setAudioFrameNumber(int frameNumber)` if there is audio stream tries to seek to audio frame with corresponding timestamp ignoring otherwise
`void`	`setAudioTimestamp(long timestamp)` setTimestamp with resulting audio frame type if there is an audio stream.
`void`	`setCloseInputStream(boolean closeInputStream)`
`void`	`setFrameNumber(int frameNumber)` default override of super.setFrameNumber implies setting of a frame close to a video frame having that number
`void`	`setTimestamp(long timestamp)` setTimestamp without checking frame content (using old code used in JavaCV versions prior to 1.4.1)
`void`	`setTimestamp(long timestamp, boolean checkFrame)` setTimestamp with possibility to select between old quick seek code or new code doing check of frame content.
`void`	`setVideoFrameNumber(int frameNumber)` if there is video stream tries to seek to video frame with corresponding timestamp otherwise sets super.frameNumber only because frameRate==0 if there is no video stream
`void`	`setVideoTimestamp(long timestamp)` setTimestamp with resulting video frame type if there is a video stream.
`void`	`start()` Calls `start(true)`.
`void`	`start(boolean findStreamInfo)` Set findStreamInfo to false to minimize startup time, at the expense of robustness.
`void`	`startUnsafe()`
`void`	`startUnsafe(boolean findStreamInfo)`
`void`	`stop()`
`void`	`trigger()`
`static void`	`tryLoad()`

Methods inherited from class org.bytedeco.javacv.FrameGrabber
close, create, create, create, create, createArray, delayedGrab, flush, get, getAudioDisposition, getAudioOption, getAudioOptions, getAudioStream, getBitsPerPixel, getCharset, getDefault, getDelayedFrame, getDelayedTime, getFrameNumber, getImageMode, getImageScalingFlags, getMaxDelay, getNumBuffers, getOption, getOptions, getSampleMode, getSensorPattern, getTimeout, getTimestamp, getVideoDisposition, getVideoOption, getVideoOptions, getVideoStream, grabAtFrameRate, grabFrame, init, isDeinterlace, isTriggerMode, resetStartTime, restart, setAspectRatio, setAudioBitrate, setAudioChannels, setAudioCodec, setAudioCodecName, setAudioDisposition, setAudioMetadata, setAudioMetadata, setAudioOption, setAudioOptions, setAudioSideData, setAudioSideData, setAudioStream, setBitsPerPixel, setCharset, setDeinterlace, setFormat, setFrameRate, setGamma, setImageHeight, setImageMode, setImageScalingFlags, setImageWidth, setMaxDelay, setMetadata, setMetadata, setNumBuffers, setOption, setOptions, setPixelFormat, setSampleFormat, setSampleMode, setSampleRate, setSensorPattern, setTimeout, setTriggerMode, setVideoBitrate, setVideoCodec, setVideoCodecName, setVideoDisposition, setVideoMetadata, setVideoMetadata, setVideoOption, setVideoOptions, setVideoSideData, setVideoSideData, setVideoStream, waitForTimestamp

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FFmpegFrameGrabber
```
public FFmpegFrameGrabber(URL url)
```
  - FFmpegFrameGrabber
```
public FFmpegFrameGrabber(File file)
```
  - FFmpegFrameGrabber
```
public FFmpegFrameGrabber(String filename)
```
  - FFmpegFrameGrabber
```
public FFmpegFrameGrabber(InputStream inputStream)
```
    Calls FFmpegFrameGrabber(inputStream, Integer.MAX_VALUE - 8) so that the whole input stream is seekable.
  - FFmpegFrameGrabber
```
public FFmpegFrameGrabber(InputStream inputStream,
                          int maximumSize)
```
    Set maximumSize to 0 to disable seek and minimize startup time.
- Method Detail
  - getDeviceDescriptions
```
public static String[] getDeviceDescriptions()
                                      throws FFmpegFrameGrabber.Exception
```
    Throws:
    
    FFmpegFrameGrabber.Exception
  - createDefault
```
public static FFmpegFrameGrabber createDefault(File deviceFile)
                                        throws FFmpegFrameGrabber.Exception
```
    Throws:
    
    FFmpegFrameGrabber.Exception
  - createDefault
```
public static FFmpegFrameGrabber createDefault(String devicePath)
                                        throws FFmpegFrameGrabber.Exception
```
    Throws:
    
    FFmpegFrameGrabber.Exception
  - createDefault
```
public static FFmpegFrameGrabber createDefault(int deviceNumber)
                                        throws FFmpegFrameGrabber.Exception
```
    Throws:
    
    FFmpegFrameGrabber.Exception
  - tryLoad
```
public static void tryLoad()
                    throws FFmpegFrameGrabber.Exception
```
    Throws:
    
    FFmpegFrameGrabber.Exception
  - release
```
public void release()
             throws FFmpegFrameGrabber.Exception
```
    Specified by:
    
    release in class FrameGrabber
    
    Throws:
    
    FFmpegFrameGrabber.Exception
  - releaseUnsafe
```
public void releaseUnsafe()
                   throws FFmpegFrameGrabber.Exception
```
    Throws:
    
    FFmpegFrameGrabber.Exception
  - finalize
```
protected void finalize()
                 throws Throwable
```
    Overrides:
    
    finalize in class Object
    
    Throws:
    
    Throwable
  - isCloseInputStream
```
public boolean isCloseInputStream()
```
  - setCloseInputStream
```
public void setCloseInputStream(boolean closeInputStream)
```
  - hasVideo
```
public boolean hasVideo()
```
    Is there a video stream?
    
    Returns:
    
    video_st!=null;
  - hasAudio
```
public boolean hasAudio()
```
    Is there an audio stream?
    
    Returns:
    
    audio_st!=null;
  - getGamma
```
public double getGamma()
```
    Overrides:
    
    getGamma in class FrameGrabber
  - getFormat
```
public String getFormat()
```
    Overrides:
    
    getFormat in class FrameGrabber
  - getImageWidth
```
public int getImageWidth()
```
    Overrides:
    
    getImageWidth in class FrameGrabber
  - getImageHeight
```
public int getImageHeight()
```
    Overrides:
    
    getImageHeight in class FrameGrabber
  - getAudioChannels
```
public int getAudioChannels()
```
    Overrides:
    
    getAudioChannels in class FrameGrabber
  - getPixelFormat
```
public int getPixelFormat()
```
    Overrides:
    
    getPixelFormat in class FrameGrabber
  - getVideoCodec
```
public int getVideoCodec()
```
    Overrides:
    
    getVideoCodec in class FrameGrabber
  - getVideoCodecName
```
public String getVideoCodecName()
```
    Overrides:
    
    getVideoCodecName in class FrameGrabber
  - getVideoBitrate
```
public int getVideoBitrate()
```
    Overrides:
    
    getVideoBitrate in class FrameGrabber
  - getAspectRatio
```
public double getAspectRatio()
```
    Overrides:
    
    getAspectRatio in class FrameGrabber
  - getFrameRate
```
public double getFrameRate()
```
    Returns getVideoFrameRate()
    
    Overrides:
    
    getFrameRate in class FrameGrabber
  - getAudioFrameRate
```
public double getAudioFrameRate()
```
    Estimation of audio frames per second. Care must be taken as this method may require unnecessary call of grabFrame(true, false, false, false, false) with frameGrabbed set to true.
    
    Returns:
    
    (double) getSampleRate()) / samples_frame.nb_samples() if samples_frame.nb_samples() is not zero, otherwise return 0
  - getVideoFrameRate
```
public double getVideoFrameRate()
```
  - getAudioCodec
```
public int getAudioCodec()
```
    Overrides:
    
    getAudioCodec in class FrameGrabber
  - getAudioCodecName
```
public String getAudioCodecName()
```
    Overrides:
    
    getAudioCodecName in class FrameGrabber
  - getAudioBitrate
```
public int getAudioBitrate()
```
    Overrides:
    
    getAudioBitrate in class FrameGrabber
  - getSampleFormat
```
public int getSampleFormat()
```
    Overrides:
    
    getSampleFormat in class FrameGrabber
  - getSampleRate
```
public int getSampleRate()
```
    Overrides:
    
    getSampleRate in class FrameGrabber
  - getMetadata
```
public Map<String,String> getMetadata()
```
    Overrides:
    
    getMetadata in class FrameGrabber
  - getVideoMetadata
```
public Map<String,String> getVideoMetadata()
```
    Overrides:
    
    getVideoMetadata in class FrameGrabber
  - getAudioMetadata
```
public Map<String,String> getAudioMetadata()
```
    Overrides:
    
    getAudioMetadata in class FrameGrabber
  - getMetadata
```
public String getMetadata(String key)
```
    Overrides:
    
    getMetadata in class FrameGrabber
  - getVideoMetadata
```
public String getVideoMetadata(String key)
```
    Overrides:
    
    getVideoMetadata in class FrameGrabber
  - getAudioMetadata
```
public String getAudioMetadata(String key)
```
    Overrides:
    
    getAudioMetadata in class FrameGrabber
  - getVideoSideData
```
public Map<String,Buffer> getVideoSideData()
```
    Overrides:
    
    getVideoSideData in class FrameGrabber
  - getVideoSideData
```
public Buffer getVideoSideData(String key)
```
    Overrides:
    
    getVideoSideData in class FrameGrabber
  - getDisplayRotation
```
public double getDisplayRotation()
```
    Returns the rotation in degrees from the side data of the video stream, or 0 if unknown.
  - getAudioSideData
```
public Map<String,Buffer> getAudioSideData()
```
    Overrides:
    
    getAudioSideData in class FrameGrabber
  - getAudioSideData
```
public Buffer getAudioSideData(String key)
```
    Overrides:
    
    getAudioSideData in class FrameGrabber
  - setFrameNumber
```
public void setFrameNumber(int frameNumber)
                    throws FFmpegFrameGrabber.Exception
```
    default override of super.setFrameNumber implies setting of a frame close to a video frame having that number
    
    Overrides:
    
    setFrameNumber in class FrameGrabber
    
    Throws:
    
    FFmpegFrameGrabber.Exception
  - setVideoFrameNumber
```
public void setVideoFrameNumber(int frameNumber)
                         throws FFmpegFrameGrabber.Exception
```
    if there is video stream tries to seek to video frame with corresponding timestamp otherwise sets super.frameNumber only because frameRate==0 if there is no video stream
    
    Throws:
    
    FFmpegFrameGrabber.Exception
  - setAudioFrameNumber
```
public void setAudioFrameNumber(int frameNumber)
                         throws FFmpegFrameGrabber.Exception
```
    if there is audio stream tries to seek to audio frame with corresponding timestamp ignoring otherwise
    
    Throws:
    
    FFmpegFrameGrabber.Exception
  - setTimestamp
```
public void setTimestamp(long timestamp)
                  throws FFmpegFrameGrabber.Exception
```
    setTimestamp without checking frame content (using old code used in JavaCV versions prior to 1.4.1)
    
    Overrides:
    
    setTimestamp in class FrameGrabber
    
    Throws:
    
    FFmpegFrameGrabber.Exception
  - setTimestamp
```
public void setTimestamp(long timestamp,
                         boolean checkFrame)
                  throws FFmpegFrameGrabber.Exception
```
    setTimestamp with possibility to select between old quick seek code or new code doing check of frame content. The frame check can be useful with corrupted files, when seeking may end up with an empty frame not containing video nor audio
    
    Throws:
    
    FFmpegFrameGrabber.Exception
  - setVideoTimestamp
```
public void setVideoTimestamp(long timestamp)
                       throws FFmpegFrameGrabber.Exception
```
    setTimestamp with resulting video frame type if there is a video stream. This should provide precise seek to a video frame containing the requested timestamp in most cases.
    
    Throws:
    
    FFmpegFrameGrabber.Exception
  - setAudioTimestamp
```
public void setAudioTimestamp(long timestamp)
                       throws FFmpegFrameGrabber.Exception
```
    setTimestamp with resulting audio frame type if there is an audio stream. This should provide precise seek to an audio frame containing the requested timestamp in most cases.
    
    Throws:
    
    FFmpegFrameGrabber.Exception
  - getLengthInFrames
```
public int getLengthInFrames()
```
    Returns getLengthInVideoFrames()
    
    Overrides:
    
    getLengthInFrames in class FrameGrabber
  - getLengthInTime
```
public long getLengthInTime()
```
    Overrides:
    
    getLengthInTime in class FrameGrabber
  - getLengthInVideoFrames
```
public int getLengthInVideoFrames()
```
    Returns (int) Math.round(getLengthInTime() * getFrameRate() / 1000000L), which is an approximation in general.
  - getLengthInAudioFrames
```
public int getLengthInAudioFrames()
```
  - getFormatContext
```
public AVFormatContext getFormatContext()
```
  - start
```
public void start()
           throws FFmpegFrameGrabber.Exception
```
    Calls start(true).
    
    Specified by:
    
    start in class FrameGrabber
    
    Throws:
    
    FFmpegFrameGrabber.Exception
  - start
```
public void start(boolean findStreamInfo)
           throws FFmpegFrameGrabber.Exception
```
    Set findStreamInfo to false to minimize startup time, at the expense of robustness.
    
    Throws:
    
    FFmpegFrameGrabber.Exception
  - startUnsafe
```
public void startUnsafe()
                 throws FFmpegFrameGrabber.Exception
```
    Throws:
    
    FFmpegFrameGrabber.Exception
  - startUnsafe
```
public void startUnsafe(boolean findStreamInfo)
                 throws FFmpegFrameGrabber.Exception
```
    Throws:
    
    FFmpegFrameGrabber.Exception
  - stop
```
public void stop()
          throws FFmpegFrameGrabber.Exception
```
    Specified by:
    
    stop in class FrameGrabber
    
    Throws:
    
    FFmpegFrameGrabber.Exception
  - trigger
```
public void trigger()
             throws FFmpegFrameGrabber.Exception
```
    Specified by:
    
    trigger in class FrameGrabber
    
    Throws:
    
    FFmpegFrameGrabber.Exception
  - grab
```
public Frame grab()
           throws FFmpegFrameGrabber.Exception
```
    Description copied from class: FrameGrabber
    
    Each call to grab stores the new image in the memory address for the previously returned frame.
    IE.
    grabber.grab() == grabber.grab()
    This means that if you need to cache images returned from grab you should Frame.clone() the returned frame as the next call to grab will overwrite your existing image's memory.
    Why?
    Using this method instead of allocating a new buffer every time a frame is grabbed improves performance by reducing the frequency of garbage collections. Almost no additional heap space is typically allocated per frame.
    
    Specified by:
    
    grab in class FrameGrabber
    
    Returns:
    
    The frame returned from the grabber
    
    Throws:
    
    FFmpegFrameGrabber.Exception
  - grabImage
```
public Frame grabImage()
                throws FFmpegFrameGrabber.Exception
```
    Throws:
    
    FFmpegFrameGrabber.Exception
  - grabSamples
```
public Frame grabSamples()
                  throws FFmpegFrameGrabber.Exception
```
    Throws:
    
    FFmpegFrameGrabber.Exception
  - grabKeyFrame
```
public Frame grabKeyFrame()
                   throws FFmpegFrameGrabber.Exception
```
    Throws:
    
    FFmpegFrameGrabber.Exception
  - grabFrame
```
public Frame grabFrame(boolean doAudio,
                       boolean doVideo,
                       boolean doProcessing,
                       boolean keyFrames)
                throws FFmpegFrameGrabber.Exception
```
    Throws:
    
    FFmpegFrameGrabber.Exception
  - grabFrame
```
public Frame grabFrame(boolean doAudio,
                       boolean doVideo,
                       boolean doProcessing,
                       boolean keyFrames,
                       boolean doData)
                throws FFmpegFrameGrabber.Exception
```
    Throws:
    
    FFmpegFrameGrabber.Exception
  - grabPacket
```
public AVPacket grabPacket()
                    throws FFmpegFrameGrabber.Exception
```
    Throws:
    
    FFmpegFrameGrabber.Exception

Class FFmpegFrameGrabber

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacv.FrameGrabber

Field Summary

Fields inherited from class org.bytedeco.javacv.FrameGrabber

Constructor Summary

Method Summary

Methods inherited from class org.bytedeco.javacv.FrameGrabber

Methods inherited from class java.lang.Object

Constructor Detail

FFmpegFrameGrabber

FFmpegFrameGrabber

FFmpegFrameGrabber

FFmpegFrameGrabber

FFmpegFrameGrabber

Method Detail

getDeviceDescriptions

createDefault

createDefault

createDefault

tryLoad

release

releaseUnsafe

finalize

isCloseInputStream

setCloseInputStream

hasVideo

hasAudio

getGamma

getFormat

getImageWidth

getImageHeight

getAudioChannels

getPixelFormat

getVideoCodec

getVideoCodecName

getVideoBitrate

getAspectRatio

getFrameRate

getAudioFrameRate

getVideoFrameRate

getAudioCodec

getAudioCodecName

getAudioBitrate

getSampleFormat

getSampleRate

getMetadata

getVideoMetadata

getAudioMetadata

getMetadata

getVideoMetadata

getAudioMetadata

getVideoSideData

getVideoSideData

getDisplayRotation

getAudioSideData

getAudioSideData

setFrameNumber

setVideoFrameNumber

setAudioFrameNumber

setTimestamp

setTimestamp

setVideoTimestamp

setAudioTimestamp

getLengthInFrames

getLengthInTime

getLengthInVideoFrames

getLengthInAudioFrames

getFormatContext

start

start

startUnsafe

startUnsafe

stop

trigger

grab

grabImage

grabSamples

grabKeyFrame

grabFrame