GPAC Configuration documentation

GPAC Configuration file documentation
GPAC Version 1.0.0

Overview

Applications in the GPAC framework use a configuration file common to libgpac and modules (video and audio output, compositor modules). This configuration file is called GPAC.cfg. It is located:

on Windows plateforms, in C:\\Users\\FOO\\AppData\\Roaming\\GPAC, or in C:\\Program Files\\GPAC.
on iOS plateforms, in a .gpac folder in the app storage directory.
on Android plateforms, in /sdcard/osmo/ or, if not found there, created in /data/data/com.gpac.Osmo4.
on other plateforms, in a .gpac folder in the user home directory (for ex, /home/foo/.gpac/ or /Users/foo/.gpac/).

GPAC can use different configuration profiles other than the default, check GPAC wiki.
The config file is structured in sections, each made of one or more keys. A section is declared as [SectionName], and key is declared as keyName=value. The key value is not interpreted and always handled as ASCII text.

This document describes player-specific options defined in section General and old DirectFB options described in section DirectFB.
Check GPAC wiki for the documentation of libgpac core options and filter options configuration.

Note on module names
Module names as given in the config file are names exported by each interface and not name of the physical library file (.dll, .so, ...). The physical file name can however be used to identify a module - it will then be replaced by the module name.

Section "General" Back to top

The General section of the config file holds player-specific options.

StartupFile [value: filename]

Specifies file to load upon startup of most clients (Osmo4/MP4Client). If not specified, no file is loaded.

LogFile [value: filename, Android only]

Specifies where to output GPAC's log. By default, the logs are written to stdout. Note that GPAC may be compiled without log support. This is not used by MP4Client.

Logs [value: tool[:tool]@level:tool[:tool]@level, Android only]

Specifies log level for each tool. For more information on available tools and levels, check GPAC wiki.

NoMIMETypeFetch [value: "yes" "no"]

Specifies whether mime type should be fetched when checking a link to a new file (currently deprecated).

LastWorkingDir [value: string]

Indicates the last directory from which a file was opened.

iOSDocumentsDir [value: string, iOS only]

Path to the iOS document directory for the client (automatically set upon first launch of the player).

Section "DirectFB" Back to top

The "DirectFB" section of the config file holds the configuration options for the DirectFB output module. You may also want to check the official documentation.

DisableAcceleration [value: "yes" "no"]

Forces to disable hardware acceleration.

DisableDisplay [value: "yes" "no"]

Specifies the DisableDisplay parameter value.

FlipSyncMode [value: "waitsync" "wait" "sync" "swap"]

Specifies the flip sync mode.

DisableBlit [value: "yes" "no"]

Forces to disable hardware blitting.

WindowMode [value: "X11" "SDL"]

Specifies the underlying windowing library.