libgpac
Documentation of the core library of GPAC
Error codes

Error Types. More...

+ Collaboration diagram for Error codes:

Enumerations

enum  GF_Err {
  GF_SCRIPT_INFO = 3, GF_PENDING_PACKET = 2, GF_EOS = 1, GF_OK = 0,
  GF_BAD_PARAM = -1, GF_OUT_OF_MEM = -2, GF_IO_ERR = -3, GF_NOT_SUPPORTED = -4,
  GF_CORRUPTED_DATA = -5, GF_SG_UNKNOWN_NODE = -6, GF_SG_INVALID_PROTO = -7, GF_SCRIPT_ERROR = -8,
  GF_BUFFER_TOO_SMALL = -9, GF_NON_COMPLIANT_BITSTREAM = -10, GF_FILTER_NOT_FOUND = -11, GF_URL_ERROR = -12,
  GF_SERVICE_ERROR = -13, GF_REMOTE_SERVICE_ERROR = -14, GF_STREAM_NOT_FOUND = -15, GF_URL_REMOVED = -16,
  GF_ISOM_INVALID_FILE = -20, GF_ISOM_INCOMPLETE_FILE = -21, GF_ISOM_INVALID_MEDIA = -22, GF_ISOM_INVALID_MODE = -23,
  GF_ISOM_UNKNOWN_DATA_REF = -24, GF_ODF_INVALID_DESCRIPTOR = -30, GF_ODF_FORBIDDEN_DESCRIPTOR = -31, GF_ODF_INVALID_COMMAND = -32,
  GF_BIFS_UNKNOWN_VERSION = -33, GF_IP_ADDRESS_NOT_FOUND = -40, GF_IP_CONNECTION_FAILURE = -41, GF_IP_NETWORK_FAILURE = -42,
  GF_IP_CONNECTION_CLOSED = -43, GF_IP_NETWORK_EMPTY = -44, GF_IP_SOCK_WOULD_BLOCK = -45, GF_IP_UDP_TIMEOUT = -46,
  GF_AUTHENTICATION_FAILURE = -50, GF_SCRIPT_NOT_READY = -51, GF_INVALID_CONFIGURATION = -52, GF_NOT_FOUND = -53,
  GF_PROFILE_NOT_SUPPORTED = -54, GF_REQUIRES_NEW_INSTANCE = -56, GF_FILTER_NOT_SUPPORTED = -57
}
 

Functions

const char * gf_error_to_string (GF_Err e)
 Error Printing. More...
 

Detailed Description

This section documents all error codes used in the GPAC framework. Most of the GPAC's functions will use these as return values, and some of these errors are also used for state communication with the different modules of the framework.

Enumeration Type Documentation

◆ GF_Err

enum GF_Err

GPAC Error

Positive values are warning and info, 0 means no error and negative values are errors

Enumerator
GF_SCRIPT_INFO 

Message from any scripting engine used in the presentation (ECMAScript, MPEG-J, ...) (Info).

GF_PENDING_PACKET 

Indicates a send packet is not dispatched due to pending connections.

GF_EOS 

Indicates the end of a stream or of a file (Info).

GF_OK 



Operation success (no error).

GF_BAD_PARAM 


One of the input parameter is not correct or cannot be used in the current operating mode of the framework.

GF_OUT_OF_MEM 

Memory allocation failure.

GF_IO_ERR 

Input/Output failure (disk access, system call failures)

GF_NOT_SUPPORTED 

The desired feature or operation is not supported by the framework

GF_CORRUPTED_DATA 

Input data has been corrupted

GF_SG_UNKNOWN_NODE 

A modification was attempted on a scene node which could not be found

GF_SG_INVALID_PROTO 

The PROTO node interface does not match the nodes using it

GF_SCRIPT_ERROR 

An error occured in the scripting engine

GF_BUFFER_TOO_SMALL 

Buffer is too small to contain decoded data. Decoders shall use this error whenever they need to resize their output memory buffers

GF_NON_COMPLIANT_BITSTREAM 

The bitstream is not compliant to the specfication it refers to

GF_FILTER_NOT_FOUND 

No filter could be found to handle the desired media type

GF_URL_ERROR 

The URL is not properly formatted or cannot be found

GF_SERVICE_ERROR 

An service error has occured at the local side

GF_REMOTE_SERVICE_ERROR 

A service error has occured at the remote (server) side

GF_STREAM_NOT_FOUND 

The desired stream could not be found in the service

GF_URL_REMOVED 

The URL no longer exists

GF_ISOM_INVALID_FILE 

The IsoMedia file is not a valid one

GF_ISOM_INCOMPLETE_FILE 

The IsoMedia file is not complete. Either the file is being downloaded, or it has been truncated

GF_ISOM_INVALID_MEDIA 

The media in this IsoMedia track is not valid (usually due to a broken stream description)

GF_ISOM_INVALID_MODE 

The requested operation cannot happen in the current opening mode of the IsoMedia file

GF_ISOM_UNKNOWN_DATA_REF 

This IsoMedia track refers to media outside the file in an unknown way

GF_ODF_INVALID_DESCRIPTOR 

An invalid MPEG-4 Object Descriptor was found

GF_ODF_FORBIDDEN_DESCRIPTOR 

An MPEG-4 Object Descriptor was found or added to a forbidden descriptor

GF_ODF_INVALID_COMMAND 

An invalid MPEG-4 BIFS command was detected

GF_BIFS_UNKNOWN_VERSION 

The scene has been encoded using an unknown BIFS version

GF_IP_ADDRESS_NOT_FOUND 

The remote IP address could not be solved

GF_IP_CONNECTION_FAILURE 

The connection to the remote peer has failed

GF_IP_NETWORK_FAILURE 

The network operation has failed

GF_IP_CONNECTION_CLOSED 

The network connection has been closed

GF_IP_NETWORK_EMPTY 

The network operation has failed because no data is available

GF_IP_SOCK_WOULD_BLOCK 

The network operation has been discarded because it would be a blocking one

GF_IP_UDP_TIMEOUT 

UDP connection did not receive any data at all. Signaled by client services to reconfigure network if possible

GF_AUTHENTICATION_FAILURE 

Authentication with the remote host has failed

GF_SCRIPT_NOT_READY 

Script not ready for playback

GF_INVALID_CONFIGURATION 

Bad configuration for the current context

GF_NOT_FOUND 

The element has not been found

GF_PROFILE_NOT_SUPPORTED 

Unexpected format of data

GF_REQUIRES_NEW_INSTANCE 

filter PID config requires new instance of filter

GF_FILTER_NOT_SUPPORTED 

filter PID config cannot be supported by this filter, no use trying to find an alternate input filter chain

Function Documentation

◆ gf_error_to_string()

const char* gf_error_to_string ( GF_Err  e)

Returns a printable version of a given error

Parameters
eError code requested
Returns
String representing the error