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.
int	get(int property)
int	get(int property, int propertyVal) \brief Returns the specified VideoReader property
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)
boolean	set(int property, double propertyVal) \brief Sets a property in the VideoReader.

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, 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.

If no frames has been grabbed (there are no more frames in video file), the methods return false . The method throws 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.

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. If there is no new data since the last call to grab() the image will be empty.

idx - Determins 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 has 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 property,
                                       double propertyVal)

\brief Sets a property in the VideoReader.

Parameters:

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

propertyVal - Value of the property.

Returns:

true if the property has been set.

get

public int get(@Cast(value="const cv::cudacodec::VideoReaderProps")
               int property,
               int propertyVal)

\brief Returns the specified VideoReader property

Parameters:

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

propertyVal - Optional value for the property.

Returns:

Value for the specified property. Value -1 is returned when querying a property that is not supported.

get

public int get(@Cast(value="const cv::cudacodec::VideoReaderProps")
               int property)