org.bytedeco.javacpp

Class avcodec.AVPacket

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.javacpp.avcodec.AVPacket

All Implemented Interfaces:

AutoCloseable

Enclosing class:

avcodec

public static class avcodec.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

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
avcodec.AVPacket() Default native constructor.
avcodec.AVPacket(long size) Native array allocator.
avcodec.AVPacket(Pointer p) Pointer cast constructor.

Method Summary

Methods

Modifier and Type	Method and Description
avutil.AVBufferRef	buf() A reference to the reference-counted buffer where the packet data is stored.
avcodec.AVPacket	buf(avutil.AVBufferRef buf)
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.
avcodec.AVPacket	convergence_duration(long convergence_duration)
BytePointer	data()
avcodec.AVPacket	data(BytePointer data)
long	dts() Decompression timestamp in AVStream->time_base units; the time at which the packet is decompressed.
avcodec.AVPacket	dts(long dts)
long	duration() Duration of this packet in AVStream->time_base units, 0 if unknown.
avcodec.AVPacket	duration(long duration)
int	flags() A combination of AV_PKT_FLAG values
avcodec.AVPacket	flags(int flags)
long	pos() byte position in stream, -1 if unknown
avcodec.AVPacket	pos(long pos)
avcodec.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.
avcodec.AVPacket	pts(long pts)
int	side_data_elems()
avcodec.AVPacket	side_data_elems(int side_data_elems)
avcodec.AVPacketSideData	side_data() Additional packet data that can be provided by the container.
avcodec.AVPacket	side_data(avcodec.AVPacketSideData side_data)
int	size()
avcodec.AVPacket	size(int size)
int	stream_index()
avcodec.AVPacket	stream_index(int stream_index)

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, free, hashCode, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, physicalBytes, position, put, realloc, setNull, sizeof, toString, totalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

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

Constructor Detail

avcodec.AVPacket

public avcodec.AVPacket()

Default native constructor.

avcodec.AVPacket

public avcodec.AVPacket(long size)

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

avcodec.AVPacket

public avcodec.AVPacket(Pointer p)

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

Method Detail

position

public avcodec.AVPacket position(long position)

Overrides:

position in class Pointer

buf

public avutil.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 avcodec.AVPacket buf(avutil.AVBufferRef buf)

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 avcodec.AVPacket pts(long pts)

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 avcodec.AVPacket dts(long dts)

data

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

data

public avcodec.AVPacket data(BytePointer data)

size

public int size()

size

public avcodec.AVPacket size(int size)

stream_index

public int stream_index()

stream_index

public avcodec.AVPacket stream_index(int stream_index)

flags

public int flags()

A combination of AV_PKT_FLAG values

flags

public avcodec.AVPacket flags(int flags)

side_data

public avcodec.AVPacketSideData side_data()

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

side_data

public avcodec.AVPacket side_data(avcodec.AVPacketSideData side_data)

side_data_elems

public int side_data_elems()

side_data_elems

public avcodec.AVPacket side_data_elems(int side_data_elems)

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 avcodec.AVPacket duration(long duration)

pos

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

byte position in stream, -1 if unknown

pos

public avcodec.AVPacket pos(long pos)

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 avcodec.AVPacket convergence_duration(long convergence_duration)