python.libgpac.libgpac.FilterPacket Class Reference

filter packet object More...

Public Member Functions
	enum_props (self, callback_obj)
	enumerate an packet properties
	get_prop (self, prop_name)
	get a packet property - see gf_filter_pck_get_property and gf_filter_pck_get_property_str
	ref (self)
	increase packet reference count - see gf_filter_pck_ref_ex
	unref (self)
	decrease packet reference count - see gf_filter_pck_unref
	discard (self)
	discard an output packet instead of sending it - see gf_filter_pck_discard
	clone (self, cached_pck=None)
	creates a new packet cloning a source packet - see gf_filter_pck_dangling_copy.
	readonly (self)
	mark an output packet as readonly - see gf_filter_pck_set_readonly
	send (self)
	send the packet - see gf_filter_pck_send
	copy_props (self, ipck)
	copy properties of source packet in this packet - see gf_filter_pck_merge_properties
	set_prop (self, pcode, prop, custom_type=0)
	set property in this packet - see gf_filter_pck_set_property and gf_filter_pck_set_property_str
	truncate (self, size)
	truncates an output packet to the given size - see gf_filter_pck_truncate
	get_gl_texture (self, idx)
	return OpenGL texture info for a given color plane of a frame interface packet

Static Public Attributes
	dts
	Decode Timestamp - see gf_filter_pck_get_dts and gf_filter_pck_set_dts.
	cts
	Compose Timestamp - see gf_filter_pck_get_cts and gf_filter_pck_set_cts.
	sap
	SAP type - see gf_filter_pck_get_sap and gf_filter_pck_set_sap.
	dur
	Duration - see gf_filter_pck_get_duration and gf_filter_pck_set_duration.
	size
	Size of packet data, readonly.
	data
	Packet data - see gf_filter_pck_get_data If NumPy is available, the data is returned as a np Array, otherwise it is a POINTER(c_ubyte) object The property is readonly (cannot be set) but content can be modified for non-refs output packets.
	start
	frame start - see gf_filter_pck_get_framing and gf_filter_pck_set_framing
	end
	frame end - see gf_filter_pck_get_framing and gf_filter_pck_set_framing
	timescale
	associated timescale, readonly - see gf_filter_pck_get_timescale
	interlaced
	Interlaced flags - see gf_filter_pck_get_interlaced and gf_filter_pck_set_interlaced.
	corrupted
	Corrupted flag - see gf_filter_pck_get_corrupted and gf_filter_pck_set_corrupted.
	seek
	Seek flag - see gf_filter_pck_get_seek_flag and gf_filter_pck_set_seek_flag.
	byte_offset
	Byte offset - see gf_filter_pck_get_byte_offset and gf_filter_pck_set_byte_offset.
	roll
	Roll info - see gf_filter_pck_get_roll_info and gf_filter_pck_set_roll_info.
	crypt
	Encryption flags - see gf_filter_pck_get_crypt_flags and gf_filter_pck_set_crypt_flags.
	clock
	Clock reference flag - see gf_filter_pck_get_clock_type and gf_filter_pck_set_clock_type.
	carousel
	Carousel version - see gf_filter_pck_get_carousel_version and gf_filter_pck_set_carousel_version.
	seqnum
	Sequence number - see gf_filter_pck_get_seq_num and gf_filter_pck_set_seq_num.
	deps
	Dependency flags - see gf_filter_pck_get_dependency_flags and gf_filter_pck_set_dependency_flags.
	frame_ifce
	true if packet holds a GF_FrameInterface object and not a data packet, readonly
	frame_ifce_gl
	true if packet holds a GF_FrameInterface object providing OpenGL only access and not a data packet, readonly
	has_properties
	Custom properties present, readonly - see gf_filter_pck_has_properties.
	blocking_ref
	true if packet is a blocking reference, readonly - see gf_filter_pck_is_blocking_ref

Protected Attributes
	_pck
	_is_src

Detailed Description

filter packet object

Member Function Documentation

enum_props()

python.libgpac.libgpac.FilterPacket.enum_props	(		self,
			callback_obj )

enumerate an packet properties

Parameters

callback_obj

callback object to use, must have a 'on_prop_enum' method defined taking two parameters, prop_name(string) and propval

Returns

get_prop()

python.libgpac.libgpac.FilterPacket.get_prop	(		self,
			prop_name )

get a packet property - see gf_filter_pck_get_property and gf_filter_pck_get_property_str

Parameters

prop_name

name of property to get

Returns

property value, or None if not found

ref()

python.libgpac.libgpac.FilterPacket.ref

(

self

)

increase packet reference count - see gf_filter_pck_ref_ex

Returns

unref()

python.libgpac.libgpac.FilterPacket.unref

(

self

)

decrease packet reference count - see gf_filter_pck_unref

Returns

discard()

python.libgpac.libgpac.FilterPacket.discard

(

self

)

discard an output packet instead of sending it - see gf_filter_pck_discard

Returns

clone()

python.libgpac.libgpac.FilterPacket.clone	(		self,
			cached_pck = None )

creates a new packet cloning a source packet - see gf_filter_pck_dangling_copy.

The resulting packet is read/write mode and may have its own memory allocated. This is typically used by sink filters wishing to access underling GPU data of a packet using frame interface. the resulting packet can be explicitly discarded using discard(), otherwise will be garbage collected.

Parameters

cached_pck

if set, will be reuse for creation of new packet. This can greatly reduce memory allocations

Returns

the new FilterPacket or None if failure or None if failure ( if grabbing the frame into a local copy failed)

readonly()

python.libgpac.libgpac.FilterPacket.readonly

(

self

)

mark an output packet as readonly - see gf_filter_pck_set_readonly

Returns

send()

python.libgpac.libgpac.FilterPacket.send

(

self

)

send the packet - see gf_filter_pck_send

Returns

copy_props()

python.libgpac.libgpac.FilterPacket.copy_props	(		self,
			ipck )

copy properties of source packet in this packet - see gf_filter_pck_merge_properties

Parameters

ipck	source packet

Returns

Here is the call graph for this function:

set_prop()

python.libgpac.libgpac.FilterPacket.set_prop	(		self,
			pcode,
			prop,
			custom_type = 0 )

set property in this packet - see gf_filter_pck_set_property and gf_filter_pck_set_property_str

Parameters

pcode	name of property
prop	property value
custom_type	type of property if user-defined property. If not set and user-defined, property is a string

Returns

truncate()

python.libgpac.libgpac.FilterPacket.truncate	(		self,
			size )

truncates an output packet to the given size - see gf_filter_pck_truncate

Parameters

size	new size of packet

Returns

get_gl_texture()

python.libgpac.libgpac.FilterPacket.get_gl_texture	(		self,
			idx )

return OpenGL texture info for a given color plane of a frame interface packet

Parameters

idx	index of texture to fetch. The number of texture depends on the underlying pixel format

Returns

GLTextureInfo object or None if error

Field Documentation

dts

python.libgpac.libgpac.FilterPacket.dts

static

Decode Timestamp - see gf_filter_pck_get_dts and gf_filter_pck_set_dts.

cts

python.libgpac.libgpac.FilterPacket.cts

static

Compose Timestamp - see gf_filter_pck_get_cts and gf_filter_pck_set_cts.

sap

python.libgpac.libgpac.FilterPacket.sap

static

SAP type - see gf_filter_pck_get_sap and gf_filter_pck_set_sap.

dur

python.libgpac.libgpac.FilterPacket.dur

static

Duration - see gf_filter_pck_get_duration and gf_filter_pck_set_duration.

size

python.libgpac.libgpac.FilterPacket.size

static

Size of packet data, readonly.

data

python.libgpac.libgpac.FilterPacket.data

static

Packet data - see gf_filter_pck_get_data If NumPy is available, the data is returned as a np Array, otherwise it is a POINTER(c_ubyte) object The property is readonly (cannot be set) but content can be modified for non-refs output packets.

start

python.libgpac.libgpac.FilterPacket.start

static

frame start - see gf_filter_pck_get_framing and gf_filter_pck_set_framing

end

python.libgpac.libgpac.FilterPacket.end

static

frame end - see gf_filter_pck_get_framing and gf_filter_pck_set_framing

timescale

python.libgpac.libgpac.FilterPacket.timescale

static

associated timescale, readonly - see gf_filter_pck_get_timescale

interlaced

python.libgpac.libgpac.FilterPacket.interlaced

static

Interlaced flags - see gf_filter_pck_get_interlaced and gf_filter_pck_set_interlaced.

corrupted

python.libgpac.libgpac.FilterPacket.corrupted

static

Corrupted flag - see gf_filter_pck_get_corrupted and gf_filter_pck_set_corrupted.

seek

python.libgpac.libgpac.FilterPacket.seek

static

Seek flag - see gf_filter_pck_get_seek_flag and gf_filter_pck_set_seek_flag.

byte_offset

python.libgpac.libgpac.FilterPacket.byte_offset

static

Byte offset - see gf_filter_pck_get_byte_offset and gf_filter_pck_set_byte_offset.

roll

python.libgpac.libgpac.FilterPacket.roll

static

Roll info - see gf_filter_pck_get_roll_info and gf_filter_pck_set_roll_info.

crypt

python.libgpac.libgpac.FilterPacket.crypt

static

Encryption flags - see gf_filter_pck_get_crypt_flags and gf_filter_pck_set_crypt_flags.

clock

python.libgpac.libgpac.FilterPacket.clock

static

Clock reference flag - see gf_filter_pck_get_clock_type and gf_filter_pck_set_clock_type.

carousel

python.libgpac.libgpac.FilterPacket.carousel

static

Carousel version - see gf_filter_pck_get_carousel_version and gf_filter_pck_set_carousel_version.

seqnum

python.libgpac.libgpac.FilterPacket.seqnum

static

Sequence number - see gf_filter_pck_get_seq_num and gf_filter_pck_set_seq_num.

deps

python.libgpac.libgpac.FilterPacket.deps

static

Dependency flags - see gf_filter_pck_get_dependency_flags and gf_filter_pck_set_dependency_flags.

frame_ifce

python.libgpac.libgpac.FilterPacket.frame_ifce

static

true if packet holds a GF_FrameInterface object and not a data packet, readonly

frame_ifce_gl

python.libgpac.libgpac.FilterPacket.frame_ifce_gl

static

true if packet holds a GF_FrameInterface object providing OpenGL only access and not a data packet, readonly

has_properties

python.libgpac.libgpac.FilterPacket.has_properties

static

Custom properties present, readonly - see gf_filter_pck_has_properties.

blocking_ref

python.libgpac.libgpac.FilterPacket.blocking_ref

static

true if packet is a blocking reference, readonly - see gf_filter_pck_is_blocking_ref

_pck

python.libgpac.libgpac.FilterPacket._pck

protected

_is_src

python.libgpac.libgpac.FilterPacket._is_src

protected