Collaboration diagram for File System:

Data Structures
struct	GF_FileEnumInfo
	FileEnum info object. More...

Typedefs
typedef Bool(*	gf_enum_dir_item) (void cbck, char item_name, char item_path, GF_FileEnumInfo file_info)
	Directory Enumeration Callback. More...

typedef GF_FileIO (	gfio_open_proc) (GF_FileIO fileio_ref, const char url, const char mode, GF_Err out_error)

typedef GF_Err(*	gfio_seek_proc) (GF_FileIO *fileio, u64 offset, s32 whence)

typedef u32(*	gfio_read_proc) (GF_FileIO fileio, u8 buffer, u32 bytes)

typedef u32(*	gfio_write_proc) (GF_FileIO fileio, u8 buffer, u32 bytes)

typedef s64(*	gfio_tell_proc) (GF_FileIO *fileio)

typedef Bool(*	gfio_eof_proc) (GF_FileIO *fileio)

typedef int(*	gfio_printf_proc) (GF_FileIO fileio, const char format, va_list args)

Enumerations
enum	GF_FileIOWriteState { GF_FIO_WRITE_READY =0 , GF_FIO_WRITE_WAIT , GF_FIO_WRITE_CANCELED }

enum	GF_FileIOCacheState { GF_FILEIO_CACHE_IN_PROGRESS =0 , GF_FILEIO_CACHE_DONE , GF_FILEIO_NO_CACHE }

Functions
GF_Err	gf_file_load_data (const char file_name, u8 out_data, u32 out_size)
	reads a file into memory More...

GF_Err	gf_file_load_data_filep (FILE file, u8 out_data, u32 out_size)
	reads a file into memory More...

GF_Err	gf_rmdir (const char *DirPathName)
	Delete Directory. More...

GF_Err	gf_mkdir (const char *DirPathName)
	Create Directory. More...

Bool	gf_dir_exists (const char *DirPathName)
	Check Directory Exists. More...

GF_Err	gf_dir_cleanup (const char *DirPathName)
	Create Directory. More...

const char *	gf_get_default_cache_directory ()

u32	gf_file_handles_count ()

size_t	gf_fwrite (const void ptr, size_t nb_bytes, FILE stream)
	file writing helper More...

size_t	gf_fread (void ptr, size_t nbytes, FILE stream)
	file reading helper More...

char *	gf_fgets (char buf, size_t size, FILE stream)
	file reading helper More...

int	gf_fgetc (FILE *stream)
	file reading helper More...

int	gf_fputc (int val, FILE *stream)
	file writing helper More...

int	gf_fputs (const char buf, FILE stream)
	file writing helper More...

int	gf_fprintf (FILE stream, const char format,...)
	file writing helper More...

int	gf_vfprintf (FILE stream, const char format, va_list args)
	file writing helper More...

int	gf_fflush (FILE *stream)
	file flush helper More...

int	gf_feof (FILE *stream)
	end of file helper More...

int	gf_ferror (FILE *stream)
	file error helper More...

u64	gf_fsize (FILE *fp)
	file size helper More...

Bool	gf_fileio_check (FILE *fp)
	file IO checker More...

GF_FileIOWriteState	gf_fileio_write_ready (FILE *fp)
	file IO write checker More...

FILE *	gf_fopen (const char file_name, const char mode)
	file opening More...

FILE *	gf_fopen_ex (const char file_name, const char parent_url, const char *mode, Bool no_warn)
	file opening More...

s32	gf_fclose (FILE *file)
	file closing More...

u64	gf_ftell (FILE *f)
	large file position query More...

s32	gf_fseek (FILE *f, s64 pos, s32 whence)
	large file seeking More...

char *	gf_file_basename (const char *filename)

char *	gf_file_ext_start (const char *filename)

GF_Err	gf_enum_directory (const char dir, Bool enum_directory, gf_enum_dir_item enum_dir, void cbck, const char *filter)
	Directory enumeration. More...

GF_Err	gf_file_delete (const char *fileName)
	File Deletion. More...

GF_Err	gf_file_move (const char fileName, const char newFileName)
	File Move. More...

FILE *	gf_file_temp (char **const fileName)
	Temporary File Creation. More...

u64	gf_file_modification_time (const char *filename)
	File Modification Time. More...

Bool	gf_file_exists (const char *fileName)
	File existence check. More...

Bool	gf_file_exists_ex (const char file_name, const char par_name)
	File existence check. More...

s32	gf_fd_open (const char *file_name, u32 oflags, u32 pflags)
	Open file descriptor. More...

GF_FileIO *	gf_fileio_new (char url, void udta, gfio_open_proc open, gfio_seek_proc seek, gfio_read_proc read, gfio_write_proc write, gfio_tell_proc tell, gfio_eof_proc eof, gfio_printf_proc printf)

void	gf_fileio_del (GF_FileIO *fileio)

void *	gf_fileio_get_udta (GF_FileIO *fileio)

const char *	gf_fileio_url (GF_FileIO *fileio)

GF_FileIO *	gf_fileio_from_mem (const char URL, const u8 data, u32 size)

void	gf_fileio_set_stats (GF_FileIO *fileio, u64 bytes_done, u64 file_size, GF_FileIOCacheState cache_state, u32 bytes_per_sec)

Bool	gf_fileio_get_stats (GF_FileIO fileio, u64 bytes_done, u64 file_size, GF_FileIOCacheState cache_state, u32 *bytes_per_sec)

void	gf_fileio_set_write_state (GF_FileIO *fileio, GF_FileIOWriteState write_state)

GF_FileIO *	gf_fileio_open_url (GF_FileIO fileio, const char url, const char mode, GF_Err out_err)

GF_Err	gf_fileio_tag_main_thread (GF_FileIO *fileio)

Bool	gf_fileio_is_main_thread (const char *url)

GF_FileIO *	gf_fileio_from_url (const char *url)

const char *	gf_fileio_factory (GF_FileIO fileio, const char new_res_url)

const char *	gf_fileio_translate_url (const char *url)

const char *	gf_fileio_resource_url (GF_FileIO *fileio)

Bool	gf_fileio_read_mode (GF_FileIO *fileio)

Bool	gf_fileio_write_mode (GF_FileIO *fileio)

Detailed Description

This section documents file system tools used in GPAC.

FILE objects are wrapped in GPAC for direct memory or callback operations. All file functions not using stderr/stdout must use the gf_ prefixed versions, eg:

//bad design, will fail when using wrapped memory IOs
FILE *t = fopen(url, "rb");
fputs(t, mystring);
fclose(t);
 
//good design, will work fine when using wrapped memory IOs
FILE *t = gf_fopen(url, "rb");
gf_fputs(t, mystring);
gf_fclose(t);

Data Structure Documentation

◆ GF_FileEnumInfo

struct GF_FileEnumInfo

The FileEnumInfo object is used to get file attributes upon enumeration of a directory.

Data Fields
Bool	hidden	File is marked as hidden
Bool	directory	File is a directory
Bool	drive	File is a drive mountpoint
Bool	system	File is a system file
u64	size	File size in bytes
u64	last_modified	File last modif time in UTC seconds

Typedef Documentation

◆ gf_enum_dir_item

typedef Bool(* gf_enum_dir_item) (void *cbck, char *item_name, char *item_path, GF_FileEnumInfo *file_info)

The gf_enum_dir_item type is the type for the callback of the gf_enum_directory function

Parameters

cbck	Opaque user data.
item_name	File or directory name.
item_path	File or directory full path and name from filesystem root.
file_info	information for the file or directory.

Returns: 1 to abort enumeration, 0 to continue enumeration.

◆ gfio_open_proc

typedef GF_FileIO*(* gfio_open_proc) (GF_FileIO *fileio_ref, const char *url, const char *mode, GF_Err *out_error)

open proc for memory file IO

Parameters

fileio_ref	reference file_io. A file can be opened multiple times for the same reference, your code must handle this
url	target file name.
mode	opening mode of file, same as fopen mode. The following additional modes are defined: "ref": indicates this FileIO object is used by some part of the code and must not be destroyed upon closing of the file. Associated URL is null "unref": indicates this FileIO object is not used by some part of the code and may be destroyed if no more references to this object are set. Associated URL is null "url": indicates to create a new FileIO object for the given URL without opening the output file. The resulting FileIO object must be garbage collected by the app in case its is never used by the callers "probe": checks if the file exists, but no need to open the file. The function should return NULL in this case. If file does not exist, set out_error to GF_URL_ERROR "close": indicates the fileIO object is being closed (fclose)
out_error	must be set to error code if any (never NULL)

Returns: the opened GF_FileIO if success, or NULL otherwise

◆ gfio_seek_proc

typedef GF_Err(* gfio_seek_proc) (GF_FileIO *fileio, u64 offset, s32 whence)

seek proc for memory file IO

Parameters

fileio	target file IO object
offset	offset in file
whence	position from offset, same as fseek

Returns: error if any

◆ gfio_read_proc

typedef u32(* gfio_read_proc) (GF_FileIO *fileio, u8 *buffer, u32 bytes)

read proc for memory file IO

Parameters

fileio	target file IO object
buffer	buffer to read.
bytes	number of bytes to read.

Returns: number of bytes read, 0 if error.

◆ gfio_write_proc

typedef u32(* gfio_write_proc) (GF_FileIO *fileio, u8 *buffer, u32 bytes)

write proc for memory file IO

Parameters

fileio	target file IO object
buffer	buffer to write.
bytes	number of bytes to write. If 0, acts as fflush

Returns: number of bytes write, 0 if error

◆ gfio_tell_proc

typedef s64(* gfio_tell_proc) (GF_FileIO *fileio)

positon tell proc for memory file IO

Parameters

fileio target file IO object

Returns: position in bytes from file start

◆ gfio_eof_proc

typedef Bool(* gfio_eof_proc) (GF_FileIO *fileio)

end of file proc for memory file IO

Parameters

fileio target file IO object

Returns: GF_TRUE if end of file, GF_FALSE otherwise

◆ gfio_printf_proc

typedef int(* gfio_printf_proc) (GF_FileIO *fileio, const char *format, va_list args)

printf proc for memory file IO

Parameters

fileio	target file IO object
format	format string to use
args	variable argument list for printf, already initialized (va_start called)

Returns: same as vfprint

Enumeration Type Documentation

◆ GF_FileIOWriteState

enum GF_FileIOWriteState

FileIO write state

Enumerator
GF_FIO_WRITE_READY	FileIO object is ready for write operations
GF_FIO_WRITE_WAIT	FileIO object is not yet ready for write operations
GF_FIO_WRITE_CANCELED	FileIO object has been canceled

◆ GF_FileIOCacheState

enum GF_FileIOCacheState

Cache state for file IO object

Enumerator
GF_FILEIO_CACHE_IN_PROGRESS	File caching is in progress
GF_FILEIO_CACHE_DONE	File caching is done
GF_FILEIO_NO_CACHE	No file caching (file is not stored to disk))

Function Documentation

◆ gf_file_load_data()

GF_Err gf_file_load_data	(	const char *	file_name,
		u8 **	out_data,
		u32 *	out_size
	)

Reads a local file into memory, in binary open mode.

Parameters

file_name	path on disk of the file to read
out_data	pointer to allocted address, to be freed by caller
out_size	pointer to allocted size

Returns: error code if any

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gf_file_load_data_filep()

GF_Err gf_file_load_data_filep	(	FILE *	file,
		u8 **	out_data,
		u32 *	out_size
	)

Reads a local file into memory, in binary open mode.

Parameters

file	stream object to read (no seek is performed)
out_data	pointer to allocted address, to be freed by caller
out_size	pointer to allocted size

Returns: error code if any

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gf_rmdir()

GF_Err gf_rmdir ( const char * DirPathName )

Delete a dir within the full path.

Parameters

DirPathName the file path name.

Returns: error if any

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gf_mkdir()

GF_Err gf_mkdir ( const char * DirPathName )

Create a directory within the full path.

Parameters

DirPathName the dir path name.

Returns: error if any

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gf_dir_exists()

Bool gf_dir_exists ( const char * DirPathName )

Create a directory within the full path.

Parameters

DirPathName the dir path name.

Returns: GF_TRUE if directory exists

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gf_dir_cleanup()

GF_Err gf_dir_cleanup ( const char * DirPathName )

Cleanup a directory within the full path, removing all the files and the directories.

Parameters

DirPathName the dir path name.

Returns: error if any

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gf_get_default_cache_directory()

const char* gf_get_default_cache_directory ( )

Gets a newly allocated string containing the default cache directory. It is the responsibility of the caller to free the string.

Returns: a fully qualified path to the default cache directory

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gf_file_handles_count()

u32 gf_file_handles_count ( )

Gets the number of open file handles (gf_fopen/gf_fclose only).

Returns: number of open file handles

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gf_fwrite()

size_t gf_fwrite	(	const void *	ptr,
		size_t	nb_bytes,
		FILE *	stream
	)

Wrapper to properly handle calls to fwrite(), ensuring proper error handling is invoked when it fails.

Parameters

ptr	data buffer to write
nb_bytes	number of bytes to write
stream	stream object

Returns: number of bytes to written

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gf_fread()

size_t gf_fread	(	void *	ptr,
		size_t	nbytes,
		FILE *	stream
	)

Wrapper to properly handle calls to fread()

Parameters

ptr	data buffer to read
nbytes	number of bytes to read
stream	stream object

Returns: number of bytes read

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gf_fgets()

char* gf_fgets	(	char *	buf,
		size_t	size,
		FILE *	stream
	)

Wrapper to properly handle calls to fgets()

Parameters

buf	same as fgets
size	same as fgets
stream	same as fgets

Returns: same as fgets

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gf_fgetc()

int gf_fgetc ( FILE * stream )

Wrapper to properly handle calls to fgetc()

Parameters

stream same as fgetc

Returns: same as fgetc

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gf_fputc()

int gf_fputc	(	int	val,
		FILE *	stream
	)

Wrapper to properly handle calls to fputc()

Parameters

val	same as fputc
stream	same as fputc

Returns: same as fputc

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gf_fputs()

int gf_fputs	(	const char *	buf,
		FILE *	stream
	)

Wrapper to properly handle calls to fputs()

Parameters

buf	same as fputs
stream	same as fputs

Returns: same as fputs

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gf_fprintf()

int gf_fprintf	(	FILE *	stream,
		const char *	format,
			...
	)

Wrapper to properly handle calls to fprintf()

Parameters

stream	same as fprintf
format	same as fprintf

Returns: same as fprintf

Here is the call graph for this function:

◆ gf_vfprintf()

int gf_vfprintf	(	FILE *	stream,
		const char *	format,
		va_list	args
	)

Wrapper to properly handle calls to vfprintf()

Parameters

stream	same as vfprintf
format	same as vfprintf
args	same as vfprintf

Returns: same as fprintf

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gf_fflush()

int gf_fflush ( FILE * stream )

Wrapper to properly handle calls to fflush()

Parameters

stream same as fflush

Returns: same as fflush

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gf_feof()

int gf_feof ( FILE * stream )

Wrapper to properly handle calls to feof()

Parameters

stream same as feof

Returns: same as feof

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gf_ferror()

int gf_ferror ( FILE * stream )

Wrapper to properly handle calls to ferror()

Parameters

stream same as ferror

Returns: same as ferror

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gf_fsize()

u64 gf_fsize ( FILE * fp )

Gets the file size given a FILE object. The FILE object position will be reset to 0 after this call

Parameters

fp	FILE object to check

Returns: file size in bytes

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gf_fileio_check()

Bool gf_fileio_check ( FILE * fp )

Checks if the given FILE object is a native FILE or a GF_FileIO wrapper.

Parameters

fp	FILE object to check

Returns: GF_TRUE if the FILE object is a wrapper to GF_FileIO

Here is the caller graph for this function:

◆ gf_fileio_write_ready()

GF_FileIOWriteState gf_fileio_write_ready ( FILE * fp )

Checks if the given FILE object is ready for write.

Parameters

fp	FILE object to check

Returns: write state of GF_FileIO object, GF_FIO_WRITE_READY if not a GF_FileIO object

Here is the caller graph for this function:

◆ gf_fopen()

FILE* gf_fopen	(	const char *	file_name,
		const char *	mode
	)

Opens a file, potentially bigger than 4GB. if filename identifies a blob (gmem://), the blob will be opened

Parameters

file_name	same as fopen
mode	same as fopen

Returns: stream handle of the file object

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gf_fopen_ex()

FILE* gf_fopen_ex	(	const char *	file_name,
		const char *	parent_url,
		const char *	mode,
		Bool	no_warn
	)

Opens a file, potentially using file IO if the parent URL is a File IO wrapper

Parameters

file_name	same as fopen
parent_url	URL of parent file. If not a file io wrapper (gfio://), the function is equivalent to gf_fopen
mode	same as fopen - value "mkdir" checks if parent dir(s) need to be created, create them if needed and returns NULL (no file open)
no_warn	if GF_TRUE, do not throw log message if failure

Returns: stream handle of the file object

Note: You only need to call this function if you're suspecting the file to be a large one (usually only media files), otherwise use regular stdio.

Returns: stream habdle of the file or file IO object

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gf_fclose()

s32 gf_fclose ( FILE * file )

Closes a file

Note: You only need to call this function if you're suspecting the file to be a large one (usually only media files), otherwise use regular stdio.

Parameters

file	file to close

Returns: same as flcose

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gf_ftell()

u64 gf_ftell ( FILE * f )

Queries the current read/write position in a large file

Parameters

f	Same semantics as gf_ftell

Returns: position in the file

Note: You only need to call this function if you're suspecting the file to be a large one (usually only media files), otherwise use regular stdio.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gf_fseek()

s32 gf_fseek	(	FILE *	f,
		s64	pos,
		s32	whence
	)

Seeks the current read/write position in a large file

Parameters

f	Same semantics as fseek
pos	Same semantics as fseek
whence	Same semantics as fseek

Returns: 0 if success, -1 if error

Note: You only need to call this function if you're suspecting the file to be a large one (usually only media files), otherwise use regular stdio.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gf_file_basename()

char* gf_file_basename ( const char * filename )

gets basename from filename/path

Parameters

filename Path of the file, can be an absolute path

Returns: a pointer to the start of a filepath basename or null

Returns a pointer to the start of a filepath basename

Here is the caller graph for this function:

◆ gf_file_ext_start()

char* gf_file_ext_start ( const char * filename )

gets extension from filename

Parameters

filename Path of the file, can be an absolute path

Returns: a pointer to the start of a filepath extension or null

Returns a pointer to the start of a filepath extension or null

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gf_enum_directory()

GF_Err gf_enum_directory	(	const char *	dir,
		Bool	enum_directory,
		gf_enum_dir_item	enum_dir,
		void *	cbck,
		const char *	filter
	)

Enumerates a directory content. Feedback is provided by the enum_dir_item function

Parameters

dir	Directory to enumerate
enum_directory	If set, only directories will be enumerated, otherwise only files are.
enum_dir	gf_enum_dir_item callback function for enumeration.
cbck	Opaque user data passed to callback function.
filter	optional filter for file extensions. If a file extension without the dot '.' character is not found in the filter the file will be skipped.

Returns: error if any

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gf_file_delete()

GF_Err gf_file_delete ( const char * fileName )

Deletes a file from the disk.

Parameters

fileName absolute name of the file or name relative to the current working directory.

Returns: error if any

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gf_file_move()

GF_Err gf_file_move	(	const char *	fileName,
		const char *	newFileName
	)

Moves or renames a file or directory.

Parameters

fileName	absolute path of the file / directory to move or rename
newFileName	absolute new path/name of the file / directory

Returns: error if any

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gf_file_temp()

FILE* gf_file_temp ( char **const fileName )

Creates a new temporary file in binary mode

Parameters

fileName if not NULL, strdup() of the temporary filename when created by GPAC (NULL otherwise as the system automatically removes its own tmp files)

Returns: stream handle to the new file ressoucre

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gf_file_modification_time()

u64 gf_file_modification_time ( const char * filename )

Gets the UTC modification time of the given file in microseconds

Parameters

filename file to check

Returns: modification time of the file

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gf_file_exists()

Bool gf_file_exists ( const char * fileName )

Checks if file with given name exists

Parameters

fileName path of the file to check

Returns: GF_TRUE if file exists

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gf_file_exists_ex()

Bool gf_file_exists_ex	(	const char *	file_name,
		const char *	par_name
	)

Checks if file with given name exists, for regular files or File IO wrapper

Parameters

file_name	path of the file to check
par_name	name of the parent file

Returns: GF_TRUE if file exists

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gf_fd_open()

s32 gf_fd_open	(	const char *	file_name,
		u32	oflags,
		u32	pflags
	)

Opens a file descriptor - this is simply a wrapper aroun open taking care of UTF8 for windows

Parameters

file_name	path of the file to check
oflags	same parameters as open flags for open
pflags	same parameters as permission flags for open

Returns: file descriptor, -1 if error

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gf_fileio_new()

GF_FileIO* gf_fileio_new	(	char *	url,
		void *	udta,
		gfio_open_proc	open,
		gfio_seek_proc	seek,
		gfio_read_proc	read,
		gfio_write_proc	write,
		gfio_tell_proc	tell,
		gfio_eof_proc	eof,
		gfio_printf_proc	printf
	)

Creates a new file IO object

There is no guarantee that the corresponding resource will be opened by the framework, it is therefore the caller responsibility to track objects created by gf_fileio_new or as a response to open with mode "url".

Parameters

url	the original URL this file IO object wraps
udta	opaque data for caller
open	open proc for IO, must not be NULL
seek	seek proc for IO, must not be NULL
read	read proc for IO - if NULL the file is considered write only
write	write proc for IO - if NULL the file is considered read only
tell	tell proc for IO, must not be NULL
eof	eof proc for IO, must not be NULL
printf	printf proc for IO, may be NULL

Returns: the newly created file IO wrapper

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gf_fileio_del()

void gf_fileio_del ( GF_FileIO * fileio )

Deletes a new fileIO object

Parameters

fileio the File IO object to delete

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gf_fileio_get_udta()

void* gf_fileio_get_udta ( GF_FileIO * fileio )

Gets associated user data of a fileIO object

Parameters

fileio target file IO object

Returns: the associated user data

Here is the caller graph for this function:

◆ gf_fileio_url()

const char* gf_fileio_url ( GF_FileIO * fileio )

Gets URL of a fileIO object. The url uses the protocol scheme "gfio://"

Parameters

fileio target file IO object

Returns: the file IO url to use

Here is the caller graph for this function:

◆ gf_fileio_from_mem()

GF_FileIO* gf_fileio_from_mem	(	const char *	URL,
		const u8 *	data,
		u32	size
	)

Gets a fileIO object from memory - the resulting fileIO can only be opened once at any time but can be closed/reopen.

Parameters

URL	of source data, may be null
data	memory, must be valid until next close
size	memory size

Returns: new file IO - use gf_fclose() on this object to close it

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gf_fileio_set_stats()

void gf_fileio_set_stats	(	GF_FileIO *	fileio,
		u64	bytes_done,
		u64	file_size,
		GF_FileIOCacheState	cache_state,
		u32	bytes_per_sec
	)

Sets statistics on a fileIO object.

Parameters

fileio	target file IO object
bytes_done	number of bytes fetched for this file
file_size	total size of this file, 0 if unknown
cache_state	if GF_TRUE, means the file is completely available
bytes_per_sec	reception bytes per second, 0 if unknown

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gf_fileio_get_stats()

Bool gf_fileio_get_stats	(	GF_FileIO *	fileio,
		u64 *	bytes_done,
		u64 *	file_size,
		GF_FileIOCacheState *	cache_state,
		u32 *	bytes_per_sec
	)

Gets statistics on a fileIO object.

Parameters

fileio	target file IO object
bytes_done	number of bytes fetched for this file (may be NULL)
file_size	total size of this file, 0 if unknown (may be NULL)
cache_state	set to caching state for this object (may be NULL)
bytes_per_sec	reception bytes per second, 0 if unknown (may be NULL)

Returns: GF_TRUE if success, GF_FALSE otherwise

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gf_fileio_set_write_state()

void gf_fileio_set_write_state	(	GF_FileIO *	fileio,
		GF_FileIOWriteState	write_state
	)

Sets write state of a fileIO object.

Parameters

fileio	target file IO object
write_state	the state to set

◆ gf_fileio_open_url()

GF_FileIO* gf_fileio_open_url	(	GF_FileIO *	fileio,
		const char *	url,
		const char *	mode,
		GF_Err *	out_err
	)

Checks if a FileIO object can write

Parameters

fileio	target file IO object
url	the original resource URL to open
mode	the desired open mode
out_err	set to error code if any, must not be NULL

Returns: file IO object for this resource

Here is the caller graph for this function:

◆ gf_fileio_tag_main_thread()

GF_Err gf_fileio_tag_main_thread ( GF_FileIO * fileio )

Tags a FileIO object to be accessed from main thread only

Parameters

fileio target file IO object

Returns: error if any

◆ gf_fileio_is_main_thread()

Bool gf_fileio_is_main_thread ( const char * url )

Check if a FileIO object is to be accessed from main thread only

Note: Filters accessing FileIO objects by other means that a filter option must manually tag themselves as main thread, potentially rescheduling a configure call to next process. Not doing so can result in binding crashes in multi-threaded mode.

Parameters

url	target url

Returns: GF_TRUE if object is tagged for main thread, GF_FALSE otherwise

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gf_fileio_from_url()

GF_FileIO* gf_fileio_from_url ( const char * url )

Gets GF_FileIO object from its URL The url uses the protocol scheme "gfio://"

Parameters

url	the URL of the File IO object

Returns: the file IO object

Here is the caller graph for this function:

◆ gf_fileio_factory()

const char* gf_fileio_factory	(	GF_FileIO *	fileio,
		const char *	new_res_url
	)

Constructs a new GF_FileIO object from a URL The url can be absolute or relative to the parent GF_FileIO. This is typcically needed by filters (dash input, dasher, NHML/NHNT writers...) generating or consuming additional files associated with the main file IO object but being written or read by other filters. The function will not open the associated resource, only create the file IO wrapper for later usage If you need to create a new fileIO to be opened immediately, use gf_fopen_ex.

Parameters

fileio	parent file IO object
new_res_url	the original URL of the new object to create

Returns: the url (gfio://) of the created file IO object, NULL otherwise

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gf_fileio_translate_url()

const char* gf_fileio_translate_url ( const char * url )

Translates a FileIO object URL into the original resource URL

Parameters

url	the URL of the File IO object

Returns: the original resource URL associated with the file IO object

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gf_fileio_resource_url()

const char* gf_fileio_resource_url ( GF_FileIO * fileio )

Gets a FileIO original resource URL

Parameters

fileio target file IO object

Returns: the original resource URL associated with the file IO object

Here is the caller graph for this function:

◆ gf_fileio_read_mode()

Bool gf_fileio_read_mode ( GF_FileIO * fileio )

Checks if a FileIO object can read

Parameters

fileio target file IO object

Returns: GF_TRUE if read is enabled on this object

Here is the caller graph for this function:

◆ gf_fileio_write_mode()

Bool gf_fileio_write_mode ( GF_FileIO * fileio )

Checks if a FileIO object can write

Parameters

fileio target file IO object

Returns: GF_TRUE if write is enabled on this object

Here is the caller graph for this function:

Data Structures

Typedefs

Enumerations

Functions

Detailed Description

Data Structure Documentation

◆ GF_FileEnumInfo

Typedef Documentation

◆ gf_enum_dir_item

◆ gfio_open_proc

◆ gfio_seek_proc

◆ gfio_read_proc

◆ gfio_write_proc

◆ gfio_tell_proc

◆ gfio_eof_proc

◆ gfio_printf_proc

Enumeration Type Documentation

◆ GF_FileIOWriteState

◆ GF_FileIOCacheState

Function Documentation

◆ gf_file_load_data()

◆ gf_file_load_data_filep()

◆ gf_rmdir()

◆ gf_mkdir()

◆ gf_dir_exists()

◆ gf_dir_cleanup()

◆ gf_get_default_cache_directory()

◆ gf_file_handles_count()

◆ gf_fwrite()

◆ gf_fread()

◆ gf_fgets()

◆ gf_fgetc()

◆ gf_fputc()

◆ gf_fputs()

◆ gf_fprintf()

◆ gf_vfprintf()

◆ gf_fflush()

◆ gf_feof()

◆ gf_ferror()

◆ gf_fsize()

◆ gf_fileio_check()

◆ gf_fileio_write_ready()

◆ gf_fopen()

◆ gf_fopen_ex()

◆ gf_fclose()

◆ gf_ftell()

◆ gf_fseek()

◆ gf_file_basename()

◆ gf_file_ext_start()

◆ gf_enum_directory()

◆ gf_file_delete()

◆ gf_file_move()

◆ gf_file_temp()

◆ gf_file_modification_time()

◆ gf_file_exists()

◆ gf_file_exists_ex()

◆ gf_fd_open()

◆ gf_fileio_new()

◆ gf_fileio_del()

◆ gf_fileio_get_udta()

◆ gf_fileio_url()

◆ gf_fileio_from_mem()

◆ gf_fileio_set_stats()

◆ gf_fileio_get_stats()

◆ gf_fileio_set_write_state()

◆ gf_fileio_open_url()

◆ gf_fileio_tag_main_thread()

◆ gf_fileio_is_main_thread()

◆ gf_fileio_from_url()

◆ gf_fileio_factory()

◆ gf_fileio_translate_url()

◆ gf_fileio_resource_url()

◆ gf_fileio_read_mode()

◆ gf_fileio_write_mode()