gpac/tools.h File Reference

Base definitions and functions of GPAC. More...

#include <gpac/setup.h>

Classes

struct  GF_SystemRTInfo
 run-time system info object More...

Defines

#define GPAC_VERSION
 GPAC Version.
#define GPAC_BUILD_NUMBER   "18"
#define GPAC_FULL_VERSION   GPAC_VERSION" (build "GPAC_BUILD_NUMBER")"
#define GPAC_VERSION_INT
 GPAC Version.
#define GF_SAFEALLOC(__ptr, __struct)
 Memory allocation.
#define GF_4CC(a, b, c, d)
 4CC Formatting
#define GF_LOG(_log_level, _log_tools, __args)
 Message logging.

Typedefs

typedef void(* gf_log_cbk )(void *cbck, u32 log_level, u32 log_tool, const char *fmt, va_list vlist)
 Log Message Callback.
typedef Bool(* gf_enum_dir_item )(void *cbck, char *item_name, char *item_path)
 Directory Enumeration Callback.
typedef void(* gf_on_progress_cbk )(void *cbck, char *title, u32 done, u32 total)
 Progress Callback.

Enumerations

enum  GF_Err {
  GF_SCRIPT_INFO = 3, GF_PACKED_FRAMES = 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_CODEC_NOT_FOUND = -11, GF_URL_ERROR = -12,
  GF_SERVICE_ERROR = -13, GF_REMOTE_SERVICE_ERROR = -14, GF_STREAM_NOT_FOUND = -15, 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
}
enum  { GF_LOG_ERROR = 1, GF_LOG_WARNING, GF_LOG_INFO, GF_LOG_DEBUG }
enum  {
  GF_LOG_CORE = 1, GF_LOG_CODING = 1<<1, GF_LOG_CONTAINER = 1<<2, GF_LOG_NETWORK = 1<<3,
  GF_LOG_RTP = 1<<4, GF_LOG_AUTHOR = 1<<5, GF_LOG_SYNC = 1<<6, GF_LOG_CODEC = 1<<7,
  GF_LOG_PARSER = 1<<8, GF_LOG_MEDIA = 1<<9, GF_LOG_SCENE = 1<<10, GF_LOG_SCRIPT = 1<<11,
  GF_LOG_INTERACT = 1<<12, GF_LOG_COMPOSE = 1<<13, GF_LOG_SERVICE = 1<<14, GF_LOG_MMIO = 1<<15,
  GF_LOG_RTI = 1<<16
}
enum  { GF_RTI_ALL_PROCESSES_TIMES = 1, GF_RTI_PROCESS_MEMORY = 1<<1, GF_RTI_SYSTEM_MEMORY_ONLY = 1<<2 }

Functions

const char * gf_4cc_to_str (u32 type)
 4CC Printing
FILE * gf_f64_open (const char *file_name, const char *mode)
 large file opening
u64 gf_f64_tell (FILE *f)
 large file position query
u64 gf_f64_seek (FILE *f, s64 pos, s32 whence)
 large file seeking
const char * gf_error_to_string (GF_Err e)
 Error Printing.
void gf_log_set_level (u32 level)
 Log level assignment.
void gf_log_set_tools (u32 tools)
 Log modules assignment.
gf_log_cbk gf_log_set_callback (void *usr_cbk, gf_log_cbk cbk)
 Log overwrite.
void gf_log (const char *fmt,...)
void gf_log_lt (u32 ll, u32 lt)
u32 gf_log_get_level ()
u32 gf_log_get_tools ()
void gf_rand_init (Bool Reset)
 PseudoRandom Integer Generation Initialization.
u32 gf_rand ()
 PseudoRandom Integer Generation.
void gf_get_user_name (char *buf, u32 buf_size)
 user name
GF_Err gf_enum_directory (const char *dir, Bool enum_directory, gf_enum_dir_item enum_dir, void *cbck, const char *filter)
 Directory enumeration.
void gf_delete_file (char *fileName)
 File Deletion.
FILE * gf_temp_file_new ()
 File Deletion.
void gf_set_progress (char *title, u32 done, u32 total)
 Progress formatting.
void gf_set_progress_callback (void *user_cbk, gf_on_progress_cbk prog_cbk)
 Progress overwriting.
Bool gf_prompt_has_input ()
 Prompt checking.
char gf_prompt_get_char ()
 Prompt character flush.
void gf_prompt_set_echo_off (Bool echo_off)
 turns prompt echo on/off
void gf_sys_init ()
 System setup.
void gf_sys_close ()
 System closing.
u32 gf_sys_clock ()
 System clock query.
void gf_sleep (u32 ms)
 Sleeps thread/process.
Bool gf_sys_get_rti (u32 refresh_time_ms, GF_SystemRTInfo *rti, u32 flags)
 Gets Run-Time info.
Bool gf_sys_get_battery_state (Bool *onBattery, u32 *state, u32 *level)


Detailed Description

This file contains basic functions and core definitions of the GPAC framework. This file is usually included by all GPAC header files since it contains the error definitions.

Generated on Mon Sep 8 16:42:13 2008 for libgpac by  doxygen 1.5.6