libgpac
Documentation of the core library of GPAC
python.libgpac.libgpac Namespace Reference

Data Structures

class  Fraction
 fraction object, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_Fraction More...
 
class  Fraction64
 large fraction object, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_Fraction64 More...
 
class  FilterStats
 filter statistics object, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_FilterStats More...
 
class  FilterPidStatistics
 filter pid statistics object, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_FilterPidStatistics More...
 
class  FilterArg
 filter argument object, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_FilterArgs More...
 
class  PropVec2i
 filter prop type, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_PropVec2i More...
 
class  PropVec2
 filter prop type, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_PropVec2 More...
 
class  PropVec3i
 filter prop type, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_PropVec3i More...
 
class  PropVec4i
 filter prop type, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_PropVec4i More...
 
class  PropData
 filter prop type, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_PropData More...
 
class  PropStringList
 filter prop type, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_PropStringList More...
 
class  FEVT_Base
 event value, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_FEVT_Base More...
 
class  FEVT_Play
 event value, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_FEVT_Play More...
 
class  FEVT_SourceSeek
 event value, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_FEVT_SourceSeek More...
 
class  FEVT_SegmentSize
 event value, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_FEVT_SegmentSize More...
 
class  FEVT_FragmentSize
 event value, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_FEVT_FragmentSize More...
 
class  FEVT_AttachScene
 event value, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_FEVT_AttachScene More...
 
class  FEVT_QualitySwitch
 event value, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_FEVT_QualitySwitch More...
 
class  FEVT_FileDelete
 event value, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_FEVT_FileDelete More...
 
class  FEVT_VisibilityHint
 event value, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_FEVT_VisibilityHint More...
 
class  FEVT_BufferRequirement
 event value, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_FEVT_BufferRequirement More...
 
class  FEVT_EncodeHints
 event value, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_FEVT_EncodeHints More...
 
class  FEVT_NTPRef
 event value, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_FEVT_NTPRef More...
 
class  EVT_mouse
 event value, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_EventMouse More...
 
class  EVT_mtouch
 event value, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_EventMultiTouch More...
 
class  EVT_keys
 event value, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_EventKey More...
 
class  EVT_char
 event value, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_EventChar More...
 
class  EVT_size
 event value, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_EventSize More...
 
class  EVT_show
 event value, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_EventShow More...
 
class  EVT_base
 event value, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_Event only common events from GPAC video ouput are mapped More...
 
class  FEVT_UserEvent
 event value, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_FEVT_Event More...
 
class  FilterEvent
 event value, as defined in libgpac and usable as a Python object Fields have the same types, names and semantics as GF_FilterEvent More...
 
class  BufferOccupancy
 Buffer occupancy object. More...
 
class  FilterTask
 Task object for user callbacks from libgpac scheduler. More...
 
class  FilterSession
 filter session object - see GF_FilterSession More...
 
class  HTTPOutRequest
 HTTP request handler object. More...
 
class  DASHQualityInfo
 DASH media quality information (Representation info) More...
 
class  DASHSRD
 DASH Spatial Relation Descriptor object, used for tiling. More...
 
class  DASHGroup
 DASH group object. More...
 
class  DASHGroupStatistics
 DASH groups statistics object. More...
 
class  DASHGroupDownloadStatistics
 DASH group current segment download statistics object. More...
 
class  DASHCustomAlgorithm
 DASH custom algo Upon successful binding to the dashin filter, the object will be assigned a list member called groups, containing the declared group for the active period. More...
 
class  Filter
 filter object More...
 
class  FilterCustom
 Base class used to create custom filters in python. More...
 
class  FilterPid
 Object representing a PID of a custom filter. More...
 
class  GLTextureInfo
 OpenGL texture info. More...
 
class  FilterPacket
 filter packet object More...
 
class  FileIO
 FileIO object for file IO callbacks from libgpac. More...
 

Functions

def e2s (err)
 convert error value to string message More...
 
def init (mem_track=0, profile=None)
 initialize libgpac - see gf_sys_init More...
 
def close ()
 close libgpac - see gf_sys_close More...
 
def set_logs (logs, reset=False)
 set log tools and levels - see gf_log_set_tools_levels More...
 
def sys_clock ()
 get clock - see gf_sys_clock More...
 
def sys_clock_high_res ()
 get high res clock - see gf_sys_clock_high_res More...
 
def set_args (args)
 set libgpac arguments - see gf_sys_set_args More...
 
def set_rmt_fun (callback_obj)
 set profiler (Remotery) callback - see gf_sys_profiler_set_callback More...
 
def rmt_log (text)
 send message to profiler (Remotery) - see gf_sys_profiler_log More...
 
def rmt_send (text)
 send message to profiler (Remotery) - see gf_sys_profiler_send More...
 
def rmt_on ()
 check if profiler (Remotery) sampling is enabled - see gf_sys_profiler_sampling_enabled More...
 
def rmt_enable (value)
 enable or disable sampling in profiler (Remotery) - see gf_sys_profiler_enable_sampling More...
 
def sleep (value)
 sleep for given time in milliseconds More...
 

Variables

bool numpy_support
 set to True if numpy was successfully loaded More...
 
 _libgpac
 ctypes instance of libgpac More...
 
bool _libgpac_abi_mismatch = False
 Set to true if mismatch was detected between the ABI version the Python wrapper was designed and the libgpac shared library ABI version A warning is thrown if mismatched, but it is left up to the pythin script to decide whether it still wants to use libgpac wrapper. More...
 
 version
 libgpac version (string) More...
 
 copyright
 libgpac copyright notice (string) More...
 
 copyright_cite
 libgpac full copyright notice (string) More...
 
int GF_FS_SCHEDULER_LOCK_FREE
 see GF_FS_SCHEDULER_LOCK_FREE More...
 
int GF_FS_SCHEDULER_LOCK
 see GF_FS_SCHEDULER_LOCK More...
 
int GF_FS_SCHEDULER_LOCK_FREE_X
 see GF_FS_SCHEDULER_LOCK_FREE_X More...
 
int GF_FS_SCHEDULER_LOCK_FORCE
 see GF_FS_SCHEDULER_LOCK_FORCE More...
 
int GF_FS_SCHEDULER_DIRECT
 see GF_FS_SCHEDULER_DIRECT More...
 
int GF_FS_FLAG_LOAD_META
 see GF_FS_FLAG_LOAD_META More...
 
int GF_FS_FLAG_NON_BLOCKING
 see GF_FS_FLAG_NON_BLOCKING More...
 
int GF_FS_FLAG_NO_GRAPH_CACHE
 see GF_FS_FLAG_NO_GRAPH_CACHE More...
 
int GF_FS_FLAG_NO_REGULATION
 see GF_FS_FLAG_NO_REGULATION More...
 
int GF_FS_FLAG_NO_PROBE
 see GF_FS_FLAG_NO_PROBE More...
 
int GF_FS_FLAG_NO_REASSIGN
 see GF_FS_FLAG_NO_REASSIGN More...
 
int GF_FS_FLAG_PRINT_CONNECTIONS
 see GF_FS_FLAG_PRINT_CONNECTIONS More...
 
int GF_FS_FLAG_NO_ARG_CHECK
 see GF_FS_FLAG_NO_ARG_CHECK More...
 
int GF_FS_FLAG_NO_RESERVOIR
 see GF_FS_FLAG_NO_RESERVOIR More...
 
int GF_FS_FLAG_FULL_LINK
 see GF_FS_FLAG_FULL_LINK More...
 
int GF_FS_FLAG_NO_IMPLICIT
 see GF_FS_FLAG_NO_IMPLICIT More...
 
int GF_FS_FLAG_REQUIRE_SOURCE_ID
 see GF_FS_FLAG_REQUIRE_SOURCE_ID More...
 
int GF_FS_FLAG_FORCE_DEFER_LINK
 see GF_FS_FLAG_FORCE_DEFER_LINK More...
 
int GF_FS_FLAG_PREVENT_PLAY
 see GF_FS_FLAG_PREVENT_PLAY More...
 
int GF_PROP_FORBIDDEN
 see GF_PROP_FORBIDDEN More...
 
int GF_PROP_SINT
 see GF_PROP_SINT More...
 
int GF_PROP_UINT
 see GF_PROP_UINT More...
 
int GF_PROP_LSINT
 see GF_PROP_LSINT More...
 
int GF_PROP_LUINT
 see GF_PROP_LUINT More...
 
int GF_PROP_BOOL
 see GF_PROP_BOOL More...
 
int GF_PROP_FRACTION
 see GF_PROP_FRACTION More...
 
int GF_PROP_FRACTION64
 see GF_PROP_FRACTION64 More...
 
int GF_PROP_FLOAT
 see GF_PROP_FLOAT More...
 
int GF_PROP_DOUBLE
 see GF_PROP_DOUBLE More...
 
int GF_PROP_VEC2I
 see GF_PROP_VEC2I More...
 
int GF_PROP_VEC2
 see GF_PROP_VEC2 More...
 
int GF_PROP_VEC3I
 see GF_PROP_VEC3I More...
 
int GF_PROP_VEC4I
 see GF_PROP_VEC4I More...
 
int GF_PROP_STRING
 see GF_PROP_STRING More...
 
int GF_PROP_STRING_NO_COPY
 see GF_PROP_STRING_NO_COPY More...
 
int GF_PROP_DATA
 see GF_PROP_DATA More...
 
int GF_PROP_NAME
 see GF_PROP_NAME More...
 
int GF_PROP_DATA_NO_COPY
 see GF_PROP_DATA_NO_COPY More...
 
int GF_PROP_CONST_DATA
 see GF_PROP_CONST_DATA More...
 
int GF_PROP_POINTER
 see GF_PROP_POINTER More...
 
int GF_PROP_STRING_LIST
 see GF_PROP_STRING_LIST More...
 
int GF_PROP_UINT_LIST
 see GF_PROP_UINT_LIST More...
 
int GF_PROP_SINT_LIST
 see GF_PROP_SINT_LIST More...
 
int GF_PROP_VEC2I_LIST
 see GF_PROP_VEC2I_LIST More...
 
int GF_PROP_4CC
 see GF_PROP_4CC More...
 
int GF_PROP_4CC_LIST
 see GF_PROP_4CC_LIST More...
 
int GF_PROP_FIRST_ENUM
 see GF_PROP_FIRST_ENUM More...
 
int GF_PROP_PIXFMT
 see GF_PROP_PIXFMT More...
 
int GF_PROP_PCMFMT
 see GF_PROP_PCMFMT More...
 
int GF_PROP_CICP_COL_PRIM
 see GF_PROP_CICP_COL_PRIM More...
 
int GF_PROP_CICP_COL_TFC
 see GF_PROP_CICP_COL_TFC More...
 
int GF_PROP_CICP_COL_MX
 see GF_PROP_CICP_COL_MX More...
 
int GF_PROP_CICP_LAYOUT
 see GF_PROP_CICP_LAYOUT More...
 
int GF_FEVT_PLAY
 see GF_FEVT_PLAY More...
 
int GF_FEVT_SET_SPEED
 see GF_FEVT_SET_SPEED More...
 
int GF_FEVT_STOP
 see GF_FEVT_STOP More...
 
int GF_FEVT_PAUSE
 see GF_FEVT_PAUSE More...
 
int GF_FEVT_RESUME
 see GF_FEVT_RESUME More...
 
int GF_FEVT_SOURCE_SEEK
 see GF_FEVT_SOURCE_SEEK More...
 
int GF_FEVT_SOURCE_SWITCH
 see GF_FEVT_SOURCE_SWITCH More...
 
int GF_FEVT_SEGMENT_SIZE
 see GF_FEVT_SEGMENT_SIZE More...
 
int GF_FEVT_ATTACH_SCENE
 see GF_FEVT_ATTACH_SCENE More...
 
int GF_FEVT_RESET_SCENE
 see GF_FEVT_RESET_SCENE More...
 
int GF_FEVT_QUALITY_SWITCH
 see GF_FEVT_QUALITY_SWITCH More...
 
int GF_FEVT_VISIBILITY_HINT
 see GF_FEVT_VISIBILITY_HINT More...
 
int GF_FEVT_INFO_UPDATE
 see GF_FEVT_INFO_UPDATE More...
 
int GF_FEVT_BUFFER_REQ
 see GF_FEVT_BUFFER_REQ More...
 
int GF_FEVT_CAPS_CHANGE
 see GF_FEVT_CAPS_CHANGE More...
 
int GF_FEVT_CONNECT_FAIL
 see GF_FEVT_CONNECT_FAIL More...
 
int GF_FEVT_USER
 see GF_FEVT_USER More...
 
int GF_FEVT_PLAY_HINT
 see GF_FEVT_PLAY_HINT More...
 
int GF_FEVT_FILE_DELETE
 see GF_FEVT_FILE_DELETE More...
 
int GF_FS_ARG_HINT_NORMAL
 see GF_FS_ARG_HINT_NORMAL More...
 
int GF_FS_ARG_HINT_ADVANCED
 see GF_FS_ARG_HINT_ADVANCED More...
 
int GF_FS_ARG_HINT_EXPERT
 see GF_FS_ARG_HINT_EXPERT More...
 
int GF_FS_ARG_HINT_HIDE
 see GF_FS_ARG_HINT_HIDE More...
 
int GF_FS_ARG_UPDATE
 see GF_FS_ARG_UPDATE More...
 
int GF_FS_ARG_META
 see GF_FS_ARG_META More...
 
int GF_FS_ARG_META_ALLOC
 see GF_FS_ARG_META_ALLOC More...
 
int GF_FS_ARG_SINK_ALIAS
 see GF_FS_ARG_SINK_ALIAS More...
 
int GF_CAPFLAG_IN_BUNDLE
 see GF_CAPFLAG_IN_BUNDLE More...
 
int GF_CAPFLAG_INPUT
 see GF_CAPFLAG_INPUT More...
 
int GF_CAPFLAG_OUTPUT
 see GF_CAPFLAG_OUTPUT More...
 
int GF_CAPFLAG_EXCLUDED
 see GF_CAPFLAG_EXCLUDED More...
 
int GF_CAPFLAG_LOADED_FILTER
 see GF_CAPFLAG_LOADED_FILTER More...
 
int GF_CAPFLAG_STATIC
 see GF_CAPFLAG_STATIC More...
 
int GF_CAPFLAG_OPTIONAL
 see GF_CAPFLAG_OPTIONAL More...
 
tuple GF_CAPS_INPUT
 see GF_CAPS_INPUT More...
 
tuple GF_CAPS_INPUT_OPT
 see GF_CAPS_INPUT_OPT More...
 
tuple GF_CAPS_INPUT_STATIC
 see GF_CAPS_INPUT_STATIC More...
 
tuple GF_CAPS_INPUT_STATIC_OPT
 see GF_CAPS_INPUT_STATIC_OPT More...
 
tuple GF_CAPS_INPUT_EXCLUDED
 see GF_CAPS_INPUT_EXCLUDED More...
 
tuple GF_CAPS_INPUT_LOADED_FILTER
 see GF_CAPS_INPUT_LOADED_FILTER More...
 
tuple GF_CAPS_OUTPUT
 see GF_CAPS_OUTPUT More...
 
tuple GF_CAPS_OUTPUT_LOADED_FILTER
 see GF_CAPS_OUTPUT_LOADED_FILTER More...
 
tuple GF_CAPS_OUTPUT_EXCLUDED
 see GF_CAPS_OUTPUT_EXCLUDED More...
 
tuple GF_CAPS_OUTPUT_STATIC
 see GF_CAPS_OUTPUT_STATIC More...
 
tuple GF_CAPS_OUTPUT_STATIC_EXCLUDED
 see GF_CAPS_OUTPUT_STATIC_EXCLUDED More...
 
tuple GF_CAPS_INPUT_OUTPUT
 see GF_CAPS_INPUT_OUTPUT More...
 
tuple GF_CAPS_INPUT_OUTPUT_OPT
 see GF_CAPS_INPUT_OUTPUT_OPT More...
 
int GF_STATS_LOCAL
 see GF_STATS_LOCAL More...
 
int GF_STATS_LOCAL_INPUTS
 see GF_STATS_LOCAL_INPUTS More...
 
int GF_STATS_DECODER_SINK
 see GF_STATS_DECODER_SINK More...
 
int GF_STATS_DECODER_SOURCE
 see GF_STATS_DECODER_SOURCE More...
 
int GF_STATS_ENCODER_SINK
 see GF_STATS_ENCODER_SINK More...
 
int GF_STATS_ENCODER_SOURCE
 see GF_STATS_ENCODER_SOURCE More...
 
int GF_STATS_SINK
 see GF_STATS_SINK More...
 
int GF_SCRIPT_INFO
 see GF_SCRIPT_INFO More...
 
int GF_PENDING_PACKET
 see GF_PENDING_PACKET More...
 
int GF_EOS
 see GF_EOS More...
 
int GF_OK
 see GF_OK More...
 
int GF_BAD_PARAM
 see GF_BAD_PARAM More...
 
int GF_OUT_OF_MEM
 see GF_OUT_OF_MEM More...
 
int GF_IO_ERR
 see GF_IO_ERR More...
 
int GF_NOT_SUPPORTED
 see GF_NOT_SUPPORTED More...
 
int GF_CORRUPTED_DATA
 see GF_CORRUPTED_DATA More...
 
int GF_SCRIPT_ERROR
 see GF_SCRIPT_ERROR More...
 
int GF_BUFFER_TOO_SMALL
 see GF_BUFFER_TOO_SMALL More...
 
int GF_NON_COMPLIANT_BITSTREAM
 see GF_NON_COMPLIANT_BITSTREAM More...
 
int GF_FILTER_NOT_FOUND
 see GF_FILTER_NOT_FOUND More...
 
int GF_URL_ERROR
 see GF_URL_ERROR More...
 
int GF_SERVICE_ERROR
 see GF_SERVICE_ERROR More...
 
int GF_REMOTE_SERVICE_ERROR
 see GF_REMOTE_SERVICE_ERROR More...
 
int GF_STREAM_NOT_FOUND
 see GF_STREAM_NOT_FOUND More...
 
int GF_URL_REMOVED
 see GF_URL_REMOVED More...
 
int GF_IP_ADDRESS_NOT_FOUND
 see GF_IP_ADDRESS_NOT_FOUND More...
 
int GF_IP_CONNECTION_FAILURE
 see GF_IP_CONNECTION_FAILURE More...
 
int GF_IP_NETWORK_FAILURE
 see GF_IP_NETWORK_FAILURE More...
 
int GF_IP_CONNECTION_CLOSED
 see GF_IP_CONNECTION_CLOSED More...
 
int GF_IP_NETWORK_EMPTY
 see GF_IP_NETWORK_EMPTY More...
 
int GF_IP_UDP_TIMEOUT
 see GF_IP_UDP_TIMEOUT More...
 
int GF_AUTHENTICATION_FAILURE
 see GF_AUTHENTICATION_FAILURE More...
 
int GF_NOT_READY
 see GF_NOT_READY More...
 
int GF_INVALID_CONFIGURATION
 see GF_INVALID_CONFIGURATION More...
 
int GF_NOT_FOUND
 see GF_NOT_FOUND More...
 
int GF_PROFILE_NOT_SUPPORTED
 see GF_PROFILE_NOT_SUPPORTED More...
 
int GF_REQUIRES_NEW_INSTANCE
 see GF_REQUIRES_NEW_INSTANCE More...
 
int GF_FILTER_NOT_SUPPORTED
 see GF_FILTER_NOT_SUPPORTED More...
 
int GF_SETUP_ERROR = 0
 notification is a setup error, the filter chain was never connected More...
 
int GF_NOTIF_ERROR = 1
 notification is an error but keep the filter chain connected More...
 
int GF_NOTIF_ERROR_AND_DISCONNECT = 2
 notification is an error and disconnect the filter chain More...
 
int GF_FS_FLUSH_NONE = 0,
 Do not flush session: everything is discarded, potentially breaking output files. More...
 
int GF_FS_FLUSH_ALL = 1
 Flush all pending data before closing sessions: sources will be forced into end of stream and all emitted packets will be processed. More...
 
int GF_FS_FLUSH_FAST = 2
 Stop session (resetting buffers) and flush pipeline. More...