os_divers.c File Reference

#include <gpac/tools.h>
#include <gpac/network.h>
#include <gpac/config_file.h>
#include <time.h>
#include <sys/stat.h>
#include <sys/time.h>
#include <dirent.h>
#include <unistd.h>
#include <sys/times.h>
#include <sys/resource.h>
#include <errno.h>
#include <locale.h>
#include <gpac/revision.h>
#include <termios.h>
#include <sys/ioctl.h>
#include <gpac/thread.h>
#include <gpac/list.h>
#include <gpac/token.h>

Macros
#define	SLEEP_ABS_SELECT   1
#define	GPAC_FULL_VERSION   GPAC_VERSION "-rev" GPAC_GIT_REVISION
#define	GPAC_COPYRIGHT   "(c) 2000-2024 Telecom Paris distributed under LGPL v2.1+ - https://gpac.io"
#define	RMT_LOG_SIZE   5000

Functions
GF_EXPORT const char *	gf_gpac_version ()
GF_EXPORT const char *	gf_gpac_copyright ()
GF_EXPORT const char *	gf_gpac_copyright_cite ()
GF_EXPORT u32	gf_gpac_abi_major ()
GF_EXPORT u32	gf_gpac_abi_minor ()
GF_EXPORT u32	gf_gpac_abi_micro ()
GF_EXPORT u32	gf_sys_clock ()
	System clock query.
GF_EXPORT u64	gf_sys_clock_high_res ()
	High precision system clock query.
Bool	gf_sys_enable_remotery (Bool start, Bool is_shutdown)
GF_EXPORT void	gf_sleep (u32 ms)
	Sleeps thread/process.
GF_EXPORT void	gf_rand_init (Bool Reset)
	PseudoRandom Integer Generation Initialization.
GF_EXPORT u32	gf_rand ()
GF_EXPORT void	gf_utc_time_since_1970 (u32 *sec, u32 *msec)
	gets UTC time
GF_EXPORT void	gf_get_user_name (char buf[1024])
GF_EXPORT char *	my_str_upr (char *str)
GF_EXPORT char *	my_str_lwr (char *str)
static void	init_keyboard ()
static void	close_keyboard (Bool new_line)
GF_EXPORT void	gf_prompt_set_echo_off (Bool echo_off)
	turns prompt echo on/off
GF_EXPORT Bool	gf_prompt_has_input ()
	Prompt checking.
GF_EXPORT char	gf_prompt_get_char ()
	Prompt character flush.
GF_EXPORT GF_Err	gf_prompt_get_size (u32 *width, u32 *height)
	Get prompt TTY size.
GF_EXPORT struct tm *	gf_gmtime (const time_t *time)
	gets time from UTC timestamp
GF_EXPORT Bool	gf_log_use_file ()
	Checks if logs are stored to file.
static void	progress_quiet (const void *cbck, const char *title, u64 done, u64 total)
void	gpac_disable_progress ()
GF_EXPORT Bool	gf_sys_is_test_mode ()
	checks if test mode is enabled
GF_EXPORT Bool	gf_sys_old_arch_compat ()
	checks if compatibility with old arch is enabled
GF_EXPORT void	gf_log_reset_file ()
	Resets log file Resets log file if any log file name was specified, by closing and reopening a new file.
Bool	gf_sys_has_filter_global_args ()
Bool	gf_sys_has_filter_global_meta_args ()
GF_EXPORT GF_Err	gf_sys_set_args (s32 argc, const char **argv)
	System arguments.
GF_EXPORT void	gf_sys_mark_arg_used (s32 arg_idx, Bool used)
	Mark arg as used.
GF_EXPORT Bool	gf_sys_is_arg_used (s32 arg_idx)
	Check if arg is marked as used.
GF_EXPORT u32	gf_sys_is_quiet ()
	checks if running in quiet mode
GF_EXPORT u32	gf_sys_get_argc ()
	Get number of args.
GF_EXPORT const char **	gf_sys_get_argv ()
	Get program arguments.
GF_EXPORT const char *	gf_sys_get_arg (u32 arg)
	Get number of args.
GF_EXPORT const char *	gf_sys_find_global_arg (const char *arg)
	Locate a global filter arg.
const char *	gf_log_tool_name (GF_LOG_Tool log_tool)
	Log tool name.
const char *	gf_log_level_name (GF_LOG_Level log_level)
void	gpac_rmt_log_callback (void *cbck, GF_LOG_Level level, GF_LOG_Tool tool, const char *fmt, va_list vlist)
static void	gpac_rmt_input_handler (const char *text, void *context)
GF_EXPORT GF_Err	gf_sys_profiler_set_callback (void *udta, gf_rmt_user_callback usr_cbk)
GF_EXPORT GF_Err	gf_sys_profiler_log (const char *msg)
GF_EXPORT GF_Err	gf_sys_profiler_send (const char *msg)
GF_EXPORT void	gf_sys_profiler_enable_sampling (Bool enable)
GF_EXPORT Bool	gf_sys_profiler_sampling_enabled ()
GF_EXPORT GF_Err	gf_blob_get (const char *blob_url, u8 **out_data, u32 *out_size, u32 *out_flags)
GF_EXPORT GF_Err	gf_blob_release (const char *blob_url)
GF_EXPORT char *	gf_blob_register (GF_Blob *blob)
GF_EXPORT void	gf_blob_unregister (GF_Blob *blob)
void	gf_init_global_config (const char *profile)
void	gf_uninit_global_config (Bool discard_config)
GF_Config *	gf_sys_get_lang_file ()
GF_EXPORT const char *	gf_sys_localized (const char *sec_name, const char *key_name, const char *def_val)
static void	gf_sys_refresh_cache ()
GF_EXPORT GF_Err	gf_sys_init (GF_MemTrackerType mem_tracker_type, const char *profile)
	System setup.
void	gf_net_close_capture ()
GF_EXPORT void	gf_sys_close ()
	System closing.
Bool	gf_sys_get_rti_os (u32 refresh_time_ms, GF_SystemRTInfo *rti, u32 flags)
GF_EXPORT Bool	gf_sys_get_rti (u32 refresh_time_ms, GF_SystemRTInfo *rti, u32 flags)
	Gets Run-Time info.
const char *	gf_get_default_cache_directory_ex (Bool do_create)
GF_EXPORT const char *	gf_get_default_cache_directory ()
GF_EXPORT Bool	gf_sys_get_battery_state (Bool *onBattery, u32 *onCharge, u32 *level, u32 *batteryLifeTime, u32 *batteryFullLifeTime)
GF_EXPORT void	gf_net_set_ntp_shift (s32 shift)
	offsets NTP time by a given amount of seconds
GF_EXPORT void	gf_net_get_ntp (u32 *sec, u32 *frac)
	gets NTP time
GF_EXPORT u64	gf_net_get_ntp_ts ()
	gets NTP time
GF_EXPORT s32	gf_net_ntp_diff_ms (u64 ntp_a, u64 ntp_b)
GF_EXPORT s32	gf_net_get_ntp_diff_ms (u64 ntp)
GF_EXPORT u64	gf_net_get_ntp_ms ()
	gets NTP time in milliseconds
GF_EXPORT s32	gf_net_get_timezone ()
	gets timezone adjustment in seconds
GF_EXPORT Bool	gf_net_time_is_dst ()
	gets timezone daylight saving time status
static time_t	gf_mktime_utc (struct tm *tm)
GF_EXPORT u64	gf_net_parse_date (const char *val)
	parses date
GF_EXPORT u64	gf_net_get_utc_ts (u32 year, u32 month, u32 day, u32 hour, u32 min, u32 sec)
	returns 64-bit UTC timestamp from year, month, day, hour, min and sec
GF_EXPORT u64	gf_net_ntp_to_utc (u64 ntp)
	converts an ntp timestamp into UTC time in milliseconds
GF_EXPORT u64	gf_net_get_utc ()
	gets UTC time in milliseconds
GF_EXPORT GF_Err	gf_bin128_parse (const char *string, bin128 value)
	parses 128 bit from string
GF_EXPORT GF_Err	gf_file_load_data_filep (FILE *file, u8 **out_data, u32 *out_size)
	reads a file into memory
GF_EXPORT GF_Err	gf_file_load_data (const char *file_name, u8 **out_data, u32 *out_size)
	reads a file into memory
GF_EXPORT u32	gf_sys_get_process_id ()
	Gets process ID.
GF_EXPORT int	gf_getch ()
	Portable getch()
GF_EXPORT Bool	gf_read_line_input (char *line, int maxSize, Bool showContent)
	Reads a line of input from stdin.
GF_EXPORT GF_Err	gf_creds_check_password (const char *user, char *password)
GF_EXPORT Bool	gf_creds_check_membership (const char *username, const char *users, const char *groups)

Variables
static u32	sys_start_time = 0
static u64	sys_start_time_hr = 0
static Bool	gpac_disable_rti = GF_FALSE
static struct termios t_orig	t_new
static s32	ch_peek = -1
static u32	sys_init = 0
static u32	last_update_time = 0
static u64	last_process_k_u_time = 0
GF_SystemRTInfo	the_rti
static u64	last_cpu_u_k_time = 0
static u64	last_cpu_idle_time = 0
static u64	mem_at_startup = 0
static u64	memory_at_gpac_startup = 0
static u32	gpac_argc = 0
const char **	gpac_argv = NULL
Bool *	gpac_argv_state = NULL
static Bool	gpac_test_mode = GF_FALSE
static Bool	gpac_old_arch = GF_FALSE
static Bool	gpac_discard_config = GF_FALSE
FILE *	gpac_log_file
Bool	gpac_log_time_start
Bool	gpac_log_utc_time
const char *	gpac_log_file_name =NULL
Bool	gpac_log_dual
static Bool	gpac_has_global_filter_args =GF_FALSE
static Bool	gpac_has_global_filter_meta_args =GF_FALSE
GF_Mutex *	logs_mx = NULL
static u32	gpac_quiet = 0
char	gf_prog_lf = '\r'
Bool	gpac_use_poll
Remotery *	remotery_handle =NULL
gf_log_cbk	gpac_prev_default_logs = NULL
static void *	rmt_udta = NULL
gf_rmt_user_callback	rmt_usr_cbk = NULL
GF_List *	all_blobs = NULL
static GF_Config *	gpac_lang_file = NULL
static const char *	gpac_lang_code = NULL
static char	szCacheDir [GF_MAX_PATH]
static u32	ntp_shift = GF_NTP_SEC_1900_TO_1970

Macro Definition Documentation

SLEEP_ABS_SELECT

#define SLEEP_ABS_SELECT   1

GPAC_FULL_VERSION

#define GPAC_FULL_VERSION   GPAC_VERSION "-rev" GPAC_GIT_REVISION

GPAC_COPYRIGHT

#define GPAC_COPYRIGHT   "(c) 2000-2024 Telecom Paris distributed under LGPL v2.1+ - https://gpac.io"

RMT_LOG_SIZE

#define RMT_LOG_SIZE   5000

Function Documentation

gf_sys_enable_remotery()

Bool gf_sys_enable_remotery	(	Bool	start,
		Bool	is_shutdown
	)

init_keyboard()

static void init_keyboard ( )

static

close_keyboard()

static void close_keyboard ( Bool  new_line )

static

progress_quiet()

static void progress_quiet ( const void *  cbck, const char *  title, u64  done, u64  total  )

static

gpac_disable_progress()

void gpac_disable_progress

(

)

gf_sys_has_filter_global_args()

Bool gf_sys_has_filter_global_args

(

)

gf_sys_has_filter_global_meta_args()

Bool gf_sys_has_filter_global_meta_args

(

)

gf_log_level_name()

const char * gf_log_level_name

(

GF_LOG_Level

log_level

)

gpac_rmt_log_callback()

void gpac_rmt_log_callback	(	void *	cbck,
		GF_LOG_Level	level,
		GF_LOG_Tool	tool,
		const char *	fmt,
		va_list	vlist
	)

gpac_rmt_input_handler()

static void gpac_rmt_input_handler ( const char *  text, void *  context  )

static

gf_blob_get()

GF_EXPORT GF_Err gf_blob_get	(	const char *	blob_url,
		u8 **	out_data,
		u32 *	out_size,
		u32 *	blob_flags
	)

Retrieves data associated with a blob url. If success, gf_blob_release must be called after this

Parameters

blob_url	URL of blob object (ie gmem://p)
out_data	if success, set to blob data pointer
out_size	if success, set to blob data size
blob_flags	if success, set to blob flags - may be NULL

Returns

error code

gf_blob_release()

GF_EXPORT GF_Err gf_blob_release

(

const char *

blob_url

)

Releases blob data

Parameters

blob_url

URL of blob object (ie gmem://p)

Returns

error code

gf_blob_register()

GF_EXPORT char * gf_blob_register

(

GF_Blob *

blob

)

Registers a new blob

Parameters

blob	blob object

Returns

URL of blob object (ie gmem://p), must be freed by user

gf_blob_unregister()

GF_EXPORT void gf_blob_unregister

(

GF_Blob *

blob

)

Unegisters a blob. This must be called before destroying a registered blob

Parameters

blob	blob object

gf_init_global_config()

void gf_init_global_config

(

const char *

profile

)

gf_uninit_global_config()

void gf_uninit_global_config

(

Bool

discard_config

)

gf_sys_get_lang_file()

GF_Config * gf_sys_get_lang_file

(

)

gf_sys_refresh_cache()

static void gf_sys_refresh_cache ( )

static

gf_net_close_capture()

void gf_net_close_capture

(

)

gf_sys_get_rti_os()

Bool gf_sys_get_rti_os	(	u32	refresh_time_ms,
		GF_SystemRTInfo *	rti,
		u32	flags
	)

gf_get_default_cache_directory_ex()

const char * gf_get_default_cache_directory_ex

(

Bool

do_create

)

gf_sys_get_battery_state()

GF_EXPORT Bool gf_sys_get_battery_state	(	Bool *	onBattery,
		u32 *	onCharge,
		u32 *	level,
		u32 *	batteryLifeTime,
		u32 *	batteryFullLifeTime
	)

gets battery state

Parameters

onBattery	set to GF_TRUE if running on battery
onCharge	set to GF_TRUE if battery is charging
level	set to battery charge percent
batteryLifeTime	set to battery lifetime
batteryFullLifeTime	set to battery full lifetime

Returns

GF_TRUE if success

gf_mktime_utc()

static time_t gf_mktime_utc ( struct tm *  tm )

static

gf_bin128_parse()

GF_EXPORT GF_Err gf_bin128_parse	(	const char *	string,
		bin128	value
	)

parses 128 bit from string

Parses 128 bit from string

Parameters

string	the string containing the value in hexa. Non alphanum characters are skipped
value	the value parsed

Returns

error code if any

gf_getch()

GF_EXPORT int gf_getch

(

)

Portable getch()

Returns immediately a typed char from stdin

Returns

the typed char

gf_read_line_input()

GF_EXPORT Bool gf_read_line_input	(	char *	line,
		int	maxSize,
		Bool	showContent
	)

Reads a line of input from stdin.

Parameters

line	the buffer to fill
maxSize	the maximum size of the line to read
showContent	boolean indicating if the line read should be printed on stderr or not

Returns

GF_TRUE if some content was read, GF_FALSE otherwise

Variable Documentation

sys_start_time

u32 sys_start_time = 0

static

sys_start_time_hr

u64 sys_start_time_hr = 0

static

gpac_disable_rti

Bool gpac_disable_rti = GF_FALSE

static

t_new

struct termios t_orig t_new

static

ch_peek

s32 ch_peek = -1

static

sys_init

u32 sys_init = 0

static

last_update_time

u32 last_update_time = 0

static

last_process_k_u_time

u64 last_process_k_u_time = 0

static

the_rti

GF_SystemRTInfo the_rti

last_cpu_u_k_time

u64 last_cpu_u_k_time = 0

static

last_cpu_idle_time

u64 last_cpu_idle_time = 0

static

mem_at_startup

u64 mem_at_startup = 0

static

memory_at_gpac_startup

u64 memory_at_gpac_startup = 0

static

gpac_argc

u32 gpac_argc = 0

static

gpac_argv

const char** gpac_argv = NULL

gpac_argv_state

Bool* gpac_argv_state = NULL

gpac_test_mode

Bool gpac_test_mode = GF_FALSE

static

gpac_old_arch

Bool gpac_old_arch = GF_FALSE

static

gpac_discard_config

Bool gpac_discard_config = GF_FALSE

static

gpac_log_file

FILE* gpac_log_file

extern

gpac_log_time_start

Bool gpac_log_time_start

extern

gpac_log_utc_time

Bool gpac_log_utc_time

extern

gpac_log_file_name

const char* gpac_log_file_name =NULL

gpac_log_dual

Bool gpac_log_dual

extern

gpac_has_global_filter_args

Bool gpac_has_global_filter_args =GF_FALSE

static

gpac_has_global_filter_meta_args

Bool gpac_has_global_filter_meta_args =GF_FALSE

static

logs_mx

GF_Mutex* logs_mx = NULL

gpac_quiet

u32 gpac_quiet = 0

static

gf_prog_lf

char gf_prog_lf = '\r'

gpac_use_poll

Bool gpac_use_poll

extern

remotery_handle

Remotery* remotery_handle =NULL

gpac_prev_default_logs

gf_log_cbk gpac_prev_default_logs = NULL

rmt_udta

void* rmt_udta = NULL

static

rmt_usr_cbk

gf_rmt_user_callback rmt_usr_cbk = NULL

all_blobs

GF_List* all_blobs = NULL

gpac_lang_file

GF_Config* gpac_lang_file = NULL

static

gpac_lang_code

const char* gpac_lang_code = NULL

static

szCacheDir

char szCacheDir[GF_MAX_PATH]

static

ntp_shift

u32 ntp_shift = GF_NTP_SEC_1900_TO_1970

static