org.bytedeco.opencv.opencv_cudacodec

Class VideoReader

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.opencv.opencv_cudacodec.VideoReader

All Implemented Interfaces:

AutoCloseable

@Name(value="cv::cudacodec::VideoReader")
 @Properties(inherit=opencv_cudacodec.class)
public class VideoReader
extends Pointer

\brief Video reader interface.

\note - An example on how to use the videoReader class can be found at opencv_source_code/samples/gpu/video_reader.cpp

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
VideoReader(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
FormatInfo	format() \brief Returns information about video file format.
boolean	get(int propertyId, double[] propertyVal)
boolean	get(int propertyId, DoubleBuffer propertyVal)
boolean	get(int propertyId, DoublePointer propertyVal) \brief Returns the specified VideoReader property
boolean	getVideoReaderProps(int propertyId, double[] propertyValOut)
boolean	getVideoReaderProps(int propertyId, double[] propertyValOut, double propertyValIn)
boolean	getVideoReaderProps(int propertyId, DoubleBuffer propertyValOut)
boolean	getVideoReaderProps(int propertyId, DoubleBuffer propertyValOut, double propertyValIn)
boolean	getVideoReaderProps(int propertyId, DoublePointer propertyValOut)
boolean	getVideoReaderProps(int propertyId, DoublePointer propertyValOut, double propertyValIn)
boolean	grab()
boolean	grab(Stream stream) \brief Grabs the next frame from the video source.
boolean	nextFrame(GpuMat frame)
boolean	nextFrame(GpuMat frame, Stream stream) \brief Grabs, decodes and returns the next video frame.
boolean	retrieve(GpuMat frame)
boolean	retrieve(GpuMat frame, long idx)
boolean	retrieve(Mat frame)
boolean	retrieve(Mat frame, long idx) \brief Returns previously grabbed video data.
boolean	retrieve(UMat frame)
boolean	retrieve(UMat frame, long idx)
void	set(int colorFormat) \brief Set the desired ColorFormat for the frame returned by nextFrame()/retrieve().
boolean	set(int propertyId, double propertyVal) \brief Sets a property in the VideoReader.
boolean	setVideoReaderProps(int propertyId, double propertyVal)

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getDirectBufferAddress, getPointer, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, position, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

VideoReader

public VideoReader(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

nextFrame

@Cast(value="bool")
public boolean nextFrame(@ByRef
                                              GpuMat frame,
                                              @ByRef(nullValue="cv::cuda::Stream::Null()")
                                              Stream stream)

\brief Grabs, decodes and returns the next video frame.

Parameters:

frame - [out] The video frame.

stream - Stream for the asynchronous version.

Returns:

false if no frames have been grabbed.

If no frames have been grabbed (there are no more frames in video file), the methods return false. The method throws an Exception if error occurs.

nextFrame

@Cast(value="bool")
public boolean nextFrame(@ByRef
                                              GpuMat frame)

format

@ByVal
public FormatInfo format()

\brief Returns information about video file format.

grab

@Cast(value="bool")
public boolean grab(@ByRef(nullValue="cv::cuda::Stream::Null()")
                                         Stream stream)

\brief Grabs the next frame from the video source.

Parameters:

stream - Stream for the asynchronous version.

Returns:

true (non-zero) in the case of success.

The method/function grabs the next frame from video file or camera and returns true (non-zero) in the case of success.

The primary use of the function is for reading both the encoded and decoded video data when rawMode is enabled. With rawMode enabled retrieve() can be called following grab() to retrieve all the data associated with the current video source since the last call to grab() or the creation of the VideoReader.

grab

@Cast(value="bool")
public boolean grab()

retrieve

@Cast(value="bool")
public boolean retrieve(@ByVal
                                             Mat frame,
                                             @Cast(value="const size_t")
                                             long idx)

\brief Returns previously grabbed video data.

Parameters:

frame - [out] The returned data which depends on the provided idx.

idx - Determines the returned data inside image. The returned data can be the: - Decoded frame, idx = get(PROP_DECODED_FRAME_IDX). - Extra data if available, idx = get(PROP_EXTRA_DATA_INDEX). - Raw encoded data package. To retrieve package i, idx = get(PROP_RAW_PACKAGES_BASE_INDEX) + i with i < get(PROP_NUMBER_OF_RAW_PACKAGES_SINCE_LAST_GRAB)

Returns:

false if no frames have been grabbed

The method returns data associated with the current video source since the last call to grab() or the creation of the VideoReader. If no data is present the method returns false and the function returns an empty image.

retrieve

@Cast(value="bool")
public boolean retrieve(@ByVal
                                             Mat frame)

retrieve

@Cast(value="bool")
public boolean retrieve(@ByVal
                                             UMat frame,
                                             @Cast(value="const size_t")
                                             long idx)

retrieve

@Cast(value="bool")
public boolean retrieve(@ByVal
                                             UMat frame)

retrieve

@Cast(value="bool")
public boolean retrieve(@ByVal
                                             GpuMat frame,
                                             @Cast(value="const size_t")
                                             long idx)

retrieve

@Cast(value="bool")
public boolean retrieve(@ByVal
                                             GpuMat frame)

set

@Cast(value="bool")
public boolean set(@Cast(value="const cv::cudacodec::VideoReaderProps")
                                        int propertyId,
                                        double propertyVal)

\brief Sets a property in the VideoReader.

Parameters:

propertyId - Property identifier from cv::cudacodec::VideoReaderProps (eg. cv::cudacodec::VideoReaderProps::PROP_DECODED_FRAME_IDX, cv::cudacodec::VideoReaderProps::PROP_EXTRA_DATA_INDEX, ...).

propertyVal - Value of the property.

Returns:

true if the property has been set.

setVideoReaderProps

@Cast(value="bool")
public boolean setVideoReaderProps(@Cast(value="const cv::cudacodec::VideoReaderProps")
                                                        int propertyId,
                                                        double propertyVal)

set

public void set(@Cast(value="const cv::cudacodec::ColorFormat")
                int colorFormat)

\brief Set the desired ColorFormat for the frame returned by nextFrame()/retrieve().

Parameters:

colorFormat - Value of the ColorFormat.

get

@Cast(value="bool")
public boolean get(@Cast(value="const cv::cudacodec::VideoReaderProps")
                                        int propertyId,
                                        @ByRef
                                        DoublePointer propertyVal)

\brief Returns the specified VideoReader property

Parameters:

propertyId - Property identifier from cv::cudacodec::VideoReaderProps (eg. cv::cudacodec::VideoReaderProps::PROP_DECODED_FRAME_IDX, cv::cudacodec::VideoReaderProps::PROP_EXTRA_DATA_INDEX, ...).

propertyVal - - In: Optional value required for querying specific propertyId's, e.g. the index of the raw package to be checked for a key frame (cv::cudacodec::VideoReaderProps::PROP_LRF_HAS_KEY_FRAME). - Out: Value of the property.

Returns:

true unless the property is not supported.

get

@Cast(value="bool")
public boolean get(@Cast(value="const cv::cudacodec::VideoReaderProps")
                                        int propertyId,
                                        @ByRef
                                        DoubleBuffer propertyVal)

get

@Cast(value="bool")
public boolean get(@Cast(value="const cv::cudacodec::VideoReaderProps")
                                        int propertyId,
                                        @ByRef
                                        double[] propertyVal)

getVideoReaderProps

@Cast(value="bool")
public boolean getVideoReaderProps(@Cast(value="const cv::cudacodec::VideoReaderProps")
                                                        int propertyId,
                                                        @ByRef
                                                        DoublePointer propertyValOut,
                                                        double propertyValIn)

getVideoReaderProps

@Cast(value="bool")
public boolean getVideoReaderProps(@Cast(value="const cv::cudacodec::VideoReaderProps")
                                                        int propertyId,
                                                        @ByRef
                                                        DoublePointer propertyValOut)

getVideoReaderProps

@Cast(value="bool")
public boolean getVideoReaderProps(@Cast(value="const cv::cudacodec::VideoReaderProps")
                                                        int propertyId,
                                                        @ByRef
                                                        DoubleBuffer propertyValOut,
                                                        double propertyValIn)

getVideoReaderProps

@Cast(value="bool")
public boolean getVideoReaderProps(@Cast(value="const cv::cudacodec::VideoReaderProps")
                                                        int propertyId,
                                                        @ByRef
                                                        DoubleBuffer propertyValOut)

getVideoReaderProps

@Cast(value="bool")
public boolean getVideoReaderProps(@Cast(value="const cv::cudacodec::VideoReaderProps")
                                                        int propertyId,
                                                        @ByRef
                                                        double[] propertyValOut,
                                                        double propertyValIn)

getVideoReaderProps

@Cast(value="bool")
public boolean getVideoReaderProps(@Cast(value="const cv::cudacodec::VideoReaderProps")
                                                        int propertyId,
                                                        @ByRef
                                                        double[] propertyValOut)