MIRAGE_CallbackFunction ()

gboolean            (*MIRAGE_CallbackFunction)          (const gpointer data,
                                                         gpointer user_data);

Callback function type used in libMirage's iteration functions. A pointer to data buffer is stored in data; the buffer usually belongs to the object and therefore should not be modified. user_data is user data passed to iteration function.

MIRAGE_PasswordFunction ()

gchar *             (*MIRAGE_PasswordFunction)          (gpointer user_data);

Password function type used in libMirage's to obtain password for encrypted images. A password function needs to be set to libMirage via libmirage_set_password_function(), along with user_data that the password function should be called with.

MIRAGE_DebugMask

typedef struct {
    gchar *name;
    gint value;
} MIRAGE_DebugMask;

Structure containing debug mask information.

libmirage_init ()

gboolean            libmirage_init                      (GError **error);

Initializes libMirage library. It should be called before any other of libMirage functions.

libmirage_shutdown ()

gboolean            libmirage_shutdown                  (GError **error);

Shuts down libMirage library. It should be called when libMirage is no longer needed.

libmirage_set_password_function ()

gboolean            libmirage_set_password_function     (MIRAGE_PasswordFunction func,
                                                         gpointer user_data,
                                                         GError **error);

Sets the password function to libMirage. The function is used by parsers that support encrypted images to obtain password for unlocking such images.

Both func and user_data can be NULL; in that case the appropriate setting will be reset.

libmirage_obtain_password ()

gchar *             libmirage_obtain_password           (GError **error);

Obtains password string, using the MIRAGE_PasswordFunction callback that was provided via libmirage_set_password_function().

libmirage_create_disc ()

GObject *           libmirage_create_disc               (gchar **filenames,
                                                         GObject *debug_context,
                                                         GHashTable *params,
                                                         GError **error);

Creates a MIRAGE_Disc object representing image stored in filenames. filenames is a NULL-terminated list of filenames containing image data. The function tries to find a parser that can handle give filename(s), creates disc implementation, attaches debug_context to it (if provided) and attempts to load the data into disc object.

params, if not NULL, is a GHashTable containing parser parameters (such as password, encoding, etc.) - it must have strings for its keys and values of GValue type. The hash table is passed to the parser; whether parameters are actually used (or supported) by the parser, however, depends on the parser implementation. If parser does not support a parameter, it will be ignored.

If multiple filenames are provided and parser supports only single-file images, only the first filename is used.

libmirage_create_fragment ()

GObject *           libmirage_create_fragment           (GType fragment_interface,
                                                         const gchar *filename,
                                                         GError **error);

Creates a MIRAGE_Fragment implementation that implements interface specified by fragment_interface and can handle data file with file name filename.

libmirage_for_each_parser ()

gboolean            libmirage_for_each_parser           (MIRAGE_CallbackFunction func,
                                                         gpointer user_data,
                                                         GError **error);

Iterates over list of supported parsers, calling func for each parser.

If func returns FALSE, the function immediately returns FALSE and error is set to MIRAGE_E_ITERCANCELLED.

libmirage_for_each_fragment ()

gboolean            libmirage_for_each_fragment         (MIRAGE_CallbackFunction func,
                                                         gpointer user_data,
                                                         GError **error);

Iterates over list of supported fragments, calling func for each fragment.

If func returns FALSE, the function immediately returns FALSE and error is set to MIRAGE_E_ITERCANCELLED.

libmirage_get_supported_debug_masks ()

gboolean            libmirage_get_supported_debug_masks (const MIRAGE_DebugMask **masks,
                                                         gint *num_masks,
                                                         GError **error);

Retrieves the pointer to array of supported debug masks and stores it in masks. The array consists of one or more structures of type MIRAGE_DebugMask. The number of elements in the array is stored in num_masks. The array belongs to libMirage and should not be altered or freed.