org.bytedeco.ffmpeg.avcodec

Class AVPacket

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.ffmpeg.avcodec.AVPacket

All Implemented Interfaces:

AutoCloseable

@Properties(inherit=avcodec.class)
public class AVPacket
extends Pointer

This structure stores compressed data. It is typically exported by demuxers and then passed as input to decoders, or received as output from encoders and then passed to muxers. For video, it should typically contain one compressed frame. For audio it may contain several compressed frames. Encoders are allowed to output empty packets, with no compressed data, containing only side data (e.g. to update some stream parameters at the end of encoding). AVPacket is one of the few structs in FFmpeg, whose size is a part of public ABI. Thus it may be allocated on stack and no new fields can be added to it without libavcodec and libavformat major bump. The semantics of data ownership depends on the buf field. If it is set, the packet data is dynamically allocated and is valid indefinitely until a call to av_packet_unref() reduces the reference count to 0. If the buf field is not set av_packet_ref() would make a copy instead of increasing the reference count. The side data is always allocated with av_malloc(), copied by av_packet_ref() and freed by av_packet_unref().

See Also:

av_packet_ref, av_packet_unref

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
AVPacket() Default native constructor.
AVPacket(long size) Native array allocator.
AVPacket(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
AVBufferRef	buf() A reference to the reference-counted buffer where the packet data is stored.
AVPacket	buf(AVBufferRef setter)
long	convergence_duration() Deprecated. Same as the duration field, but as int64_t. This was required for Matroska subtitles, whose duration values could overflow when the duration field was still an int.
AVPacket	convergence_duration(long setter)
BytePointer	data()
AVPacket	data(BytePointer setter)
long	dts() Decompression timestamp in AVStream->time_base units; the time at which the packet is decompressed.
AVPacket	dts(long setter)
long	duration() Duration of this packet in AVStream->time_base units, 0 if unknown.
AVPacket	duration(long setter)
int	flags() A combination of AV_PKT_FLAG values
AVPacket	flags(int setter)
long	pos() byte position in stream, -1 if unknown
AVPacket	pos(long setter)
AVPacket	position(long position)
long	pts() Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will be presented to the user.
AVPacket	pts(long setter)
int	side_data_elems()
AVPacket	side_data_elems(int setter)
AVPacketSideData	side_data() Additional packet data that can be provided by the container.
AVPacket	side_data(AVPacketSideData setter)
int	size()
AVPacket	size(int setter)
int	stream_index()
AVPacket	stream_index(int setter)

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, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, parseBytes, physicalBytes, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, toString, totalBytes, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

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

Constructor Detail

AVPacket

public AVPacket()

Default native constructor.

AVPacket

public AVPacket(long size)

Native array allocator. Access with Pointer.position(long).

AVPacket

public AVPacket(Pointer p)

Pointer cast constructor. Invokes Pointer.Pointer(Pointer).

Method Detail

position

public AVPacket position(long position)

Overrides:

position in class Pointer

buf

public AVBufferRef buf()

A reference to the reference-counted buffer where the packet data is stored. May be NULL, then the packet data is not reference-counted.

buf

public AVPacket buf(AVBufferRef setter)

pts

@Cast(value="int64_t")
public long pts()

Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will be presented to the user. Can be AV_NOPTS_VALUE if it is not stored in the file. pts MUST be larger or equal to dts as presentation cannot happen before decompression, unless one wants to view hex dumps. Some formats misuse the terms dts and pts/cts to mean something different. Such timestamps must be converted to true pts/dts before they are stored in AVPacket.

pts

public AVPacket pts(long setter)

dts

@Cast(value="int64_t")
public long dts()

Decompression timestamp in AVStream->time_base units; the time at which the packet is decompressed. Can be AV_NOPTS_VALUE if it is not stored in the file.

dts

public AVPacket dts(long setter)

data

@Cast(value="uint8_t*")
public BytePointer data()

data

public AVPacket data(BytePointer setter)

size

public int size()

size

public AVPacket size(int setter)

stream_index

public int stream_index()

stream_index

public AVPacket stream_index(int setter)

flags

public int flags()

A combination of AV_PKT_FLAG values

flags

public AVPacket flags(int setter)

side_data

public AVPacketSideData side_data()

Additional packet data that can be provided by the container. Packet can contain several types of side information.

side_data

public AVPacket side_data(AVPacketSideData setter)

side_data_elems

public int side_data_elems()

side_data_elems

public AVPacket side_data_elems(int setter)

duration

@Cast(value="int64_t")
public long duration()

Duration of this packet in AVStream->time_base units, 0 if unknown. Equals next_pts - this_pts in presentation order.

duration

public AVPacket duration(long setter)

pos

@Cast(value="int64_t")
public long pos()

byte position in stream, -1 if unknown

pos

public AVPacket pos(long setter)

convergence_duration

@Cast(value="int64_t")
 @Deprecated
public long convergence_duration()

Deprecated. Same as the duration field, but as int64_t. This was required for Matroska subtitles, whose duration values could overflow when the duration field was still an int.

convergence_duration

public AVPacket convergence_duration(long setter)