			libMirage Reference Manual
C \| D \| E \| F \| G \| H \| I \| L \| M \| O \| P \| S \| T \| V

libMirage API Reference

Main — Core libMirage functions
MirageCdTextCoder — General-purpose CD-TEXT encoder/decoder object.
MirageContext — Context object.
MirageContextual — Interface for attaching context to objects.
MirageDisc — Object representing an optical disc.
MirageFileFilter — File filter object.
MirageFragment — Fragment object.
MirageIndex — Object representing an index within track.
MirageLanguage — Object representing a language for session or track.
MirageObject — Base object class.
MirageParser — Base object for parsers implementation.
MiragePlugin — Plugin object.
MirageSector — Object representing a sector.
MirageSession — Object representing a session.
MirageTrack — Object representing a track.
Debug — Debugging facilities.
Error — Error reporting facilities.
Utilities — Various helper and utility functions.
Version — Version information variables.
Annotation Glossary

Annotation Glossary

T

transfer full

Free data after the code is done.

A

allow-none

NULL is ok, both for passing and for returning.

T

type

Override the parsed C type with given type.

S

scope call

The callback is valid only during the call to the method.

C

closure

This parameter is a 'user_data', for callbacks; many bindings can pass NULL here.

O

out callee-allocates

Out parameter, where caller must allocate storage.

out

Parameter for returning results. Default is transfer full.

I

in

Parameter for input. Default is transfer none.

T

transfer none

Don't free data after the code is done.

A

array

Parameter points to an array of items.

O

out caller-allocates

Out parameter, where caller must allocate storage.

C

MIRAGE_CAST_DATA, macro in Utilities

MIRAGE_CAST_PTR, macro in Utilities

MirageCdTextCoder, struct in MirageCdTextCoder

MirageCdTextCoderClass, struct in MirageCdTextCoder

MirageCdTextDataCallback, user_function in MirageCdTextCoder

mirage_cdtext_decoder_get_block_info, function in MirageCdTextCoder

mirage_cdtext_decoder_get_data, function in MirageCdTextCoder

mirage_cdtext_decoder_init, function in MirageCdTextCoder

mirage_cdtext_encoder_add_data, function in MirageCdTextCoder

mirage_cdtext_encoder_encode, function in MirageCdTextCoder

mirage_cdtext_encoder_init, function in MirageCdTextCoder

mirage_cdtext_encoder_set_block_info, function in MirageCdTextCoder

MirageContext, struct in MirageContext

MirageContextClass, struct in MirageContext

MirageContextual, struct in MirageContextual

MirageContextualInterface, struct in MirageContextual

mirage_contextual_create_file_stream, function in MirageContextual

mirage_contextual_debug_message, function in MirageContextual

mirage_contextual_debug_messagev, function in MirageContextual

mirage_contextual_get_context, function in MirageContextual

mirage_contextual_get_file_stream_filename, function in MirageContextual

mirage_contextual_get_option, function in MirageContextual

mirage_contextual_obtain_password, function in MirageContextual

mirage_contextual_set_context, function in MirageContextual

mirage_context_clear_options, function in MirageContext

mirage_context_create_file_stream, function in MirageContext

mirage_context_get_debug_domain, function in MirageContext

mirage_context_get_debug_mask, function in MirageContext

mirage_context_get_debug_name, function in MirageContext

mirage_context_get_file_stream_filename, function in MirageContext

mirage_context_get_option, function in MirageContext

mirage_context_load_image, function in MirageContext

mirage_context_obtain_password, function in MirageContext

mirage_context_set_debug_domain, function in MirageContext

mirage_context_set_debug_mask, function in MirageContext

mirage_context_set_debug_name, function in MirageContext

mirage_context_set_option, function in MirageContext

mirage_context_set_password_function, function in MirageContext

D

MIRAGE_DEBUG, macro in Debug

MirageDebugMask, struct in Main

MirageDebugMasks, enum in Debug

MirageDisc, struct in MirageDisc

MirageDisc::layout-changed, object signal in MirageDisc

MirageDiscClass, struct in MirageDisc

mirage_disc_add_session_by_index, function in MirageDisc

mirage_disc_add_session_by_number, function in MirageDisc

mirage_disc_add_track_by_index, function in MirageDisc

mirage_disc_add_track_by_number, function in MirageDisc

mirage_disc_enumerate_sessions, function in MirageDisc

mirage_disc_get_disc_structure, function in MirageDisc

mirage_disc_get_dpm_data, function in MirageDisc

mirage_disc_get_dpm_data_for_sector, function in MirageDisc

mirage_disc_get_filenames, function in MirageDisc

mirage_disc_get_mcn, function in MirageDisc

mirage_disc_get_medium_type, function in MirageDisc

mirage_disc_get_number_of_sessions, function in MirageDisc

mirage_disc_get_number_of_tracks, function in MirageDisc

mirage_disc_get_sector, function in MirageDisc

mirage_disc_get_session_after, function in MirageDisc

mirage_disc_get_session_before, function in MirageDisc

mirage_disc_get_session_by_address, function in MirageDisc

mirage_disc_get_session_by_index, function in MirageDisc

mirage_disc_get_session_by_number, function in MirageDisc

mirage_disc_get_session_by_track, function in MirageDisc

mirage_disc_get_track_by_address, function in MirageDisc

mirage_disc_get_track_by_index, function in MirageDisc

mirage_disc_get_track_by_number, function in MirageDisc

mirage_disc_layout_get_first_session, function in MirageDisc

mirage_disc_layout_get_first_track, function in MirageDisc

mirage_disc_layout_get_length, function in MirageDisc

mirage_disc_layout_get_start_sector, function in MirageDisc

mirage_disc_layout_set_first_session, function in MirageDisc

mirage_disc_layout_set_first_track, function in MirageDisc

mirage_disc_layout_set_start_sector, function in MirageDisc

mirage_disc_remove_session_by_index, function in MirageDisc

mirage_disc_remove_session_by_number, function in MirageDisc

mirage_disc_remove_session_by_object, function in MirageDisc

mirage_disc_remove_track_by_index, function in MirageDisc

mirage_disc_remove_track_by_number, function in MirageDisc

mirage_disc_set_disc_structure, function in MirageDisc

mirage_disc_set_dpm_data, function in MirageDisc

mirage_disc_set_filename, function in MirageDisc

mirage_disc_set_filenames, function in MirageDisc

mirage_disc_set_mcn, function in MirageDisc

mirage_disc_set_medium_type, function in MirageDisc

E

mirage_enumerate_file_filters, function in Main

mirage_enumerate_parsers, function in Main

MirageEnumFileFilterInfoCallback, user_function in Main

MirageEnumFragmentCallback, user_function in MirageTrack

MirageEnumIndexCallback, user_function in MirageTrack

MirageEnumLanguageCallback, user_function in MirageSession

MirageEnumParserInfoCallback, user_function in Main

MirageEnumSessionCallback, user_function in MirageDisc

MirageEnumTrackCallback, user_function in MirageSession

MirageErrorCodes, enum in Error

mirage_error_quark, function in Error

F

MirageFileFilter, struct in MirageFileFilter

MirageFileFilterClass, struct in MirageFileFilter

MirageFileFilterInfo, struct in MirageFileFilter

mirage_file_filter_can_handle_data_format, function in MirageFileFilter

mirage_file_filter_generate_info, function in MirageFileFilter

mirage_file_filter_get_info, function in MirageFileFilter

mirage_file_filter_get_position, function in MirageFileFilter

mirage_file_filter_info_copy, function in MirageFileFilter

mirage_file_filter_info_free, function in MirageFileFilter

mirage_file_filter_set_file_size, function in MirageFileFilter

MirageFragment, struct in MirageFragment

MirageFragment::layout-changed, object signal in MirageFragment

MirageFragmentClass, struct in MirageFragment

mirage_fragment_get_address, function in MirageFragment

mirage_fragment_get_length, function in MirageFragment

mirage_fragment_main_data_get_filename, function in MirageFragment

mirage_fragment_main_data_get_format, function in MirageFragment

mirage_fragment_main_data_get_offset, function in MirageFragment

mirage_fragment_main_data_get_size, function in MirageFragment

mirage_fragment_main_data_set_format, function in MirageFragment

mirage_fragment_main_data_set_offset, function in MirageFragment

mirage_fragment_main_data_set_size, function in MirageFragment

mirage_fragment_main_data_set_stream, function in MirageFragment

mirage_fragment_read_main_data, function in MirageFragment

mirage_fragment_read_subchannel_data, function in MirageFragment

mirage_fragment_set_address, function in MirageFragment

mirage_fragment_set_length, function in MirageFragment

mirage_fragment_subchannel_data_get_filename, function in MirageFragment

mirage_fragment_subchannel_data_get_format, function in MirageFragment

mirage_fragment_subchannel_data_get_offset, function in MirageFragment

mirage_fragment_subchannel_data_get_size, function in MirageFragment

mirage_fragment_subchannel_data_set_format, function in MirageFragment

mirage_fragment_subchannel_data_set_offset, function in MirageFragment

mirage_fragment_subchannel_data_set_size, function in MirageFragment

mirage_fragment_subchannel_data_set_stream, function in MirageFragment

mirage_fragment_use_the_rest_of_file, function in MirageFragment

G

mirage_get_file_filters_info, function in Main

mirage_get_file_filters_type, function in Main

mirage_get_parsers_info, function in Main

mirage_get_parsers_type, function in Main

mirage_get_supported_debug_masks, function in Main

H

mirage_helper_ascii2isrc, function in Utilities

mirage_helper_bcd2hex, function in Utilities

mirage_helper_calculate_crc16, function in Utilities

mirage_helper_calculate_crc32, macro in Utilities

mirage_helper_calculate_crc32f, function in Utilities

mirage_helper_calculate_crc32s, function in Utilities

mirage_helper_determine_sector_type, function in Utilities

mirage_helper_encoding_from_bom, function in Utilities

mirage_helper_find_data_file, function in Utilities

mirage_helper_get_suffix, function in Utilities

mirage_helper_has_suffix, function in Utilities

mirage_helper_hex2bcd, function in Utilities

mirage_helper_init_crc16_lut, function in Utilities

mirage_helper_init_crc32_lut, function in Utilities

mirage_helper_isrc2ascii, function in Utilities

mirage_helper_lba2msf, function in Utilities

mirage_helper_lba2msf_str, function in Utilities

mirage_helper_msf2lba, function in Utilities

mirage_helper_msf2lba_str, function in Utilities

mirage_helper_sector_edc_ecc_compute_ecc_block, function in Utilities

mirage_helper_sector_edc_ecc_compute_edc_block, function in Utilities

mirage_helper_strcasecmp, function in Utilities

mirage_helper_strncasecmp, function in Utilities

mirage_helper_subchannel_deinterleave, function in Utilities

mirage_helper_subchannel_interleave, function in Utilities

mirage_helper_subchannel_q_calculate_crc, function in Utilities

mirage_helper_subchannel_q_decode_isrc, function in Utilities

mirage_helper_subchannel_q_decode_mcn, function in Utilities

mirage_helper_subchannel_q_encode_isrc, function in Utilities

mirage_helper_subchannel_q_encode_mcn, function in Utilities

mirage_helper_validate_isrc, function in Utilities

I

MirageIndex, struct in MirageIndex

MirageIndexClass, struct in MirageIndex

mirage_index_get_address, function in MirageIndex

mirage_index_get_number, function in MirageIndex

mirage_index_set_address, function in MirageIndex

mirage_index_set_number, function in MirageIndex

mirage_initialize, function in Main

MIRAGE_ISRC_SIZE, macro in MirageTrack

L

MirageLanguage, struct in MirageLanguage

MirageLanguageClass, struct in MirageLanguage

MirageLanguagePackTypes, enum in MirageLanguage

mirage_language_get_code, function in MirageLanguage

mirage_language_get_pack_data, function in MirageLanguage

mirage_language_set_code, function in MirageLanguage

mirage_language_set_pack_data, function in MirageLanguage

M

MirageMainDataFormat, enum in MirageFragment

MIRAGE_MCN_SIZE, macro in MirageDisc

MirageMediumTypes, enum in MirageDisc

O

MirageObject, struct in MirageObject

MirageObject::context-changed, object signal in MirageObject

MirageObjectClass, struct in MirageObject

mirage_object_get_parent, function in MirageObject

mirage_object_set_parent, function in MirageObject

P

MirageParser, struct in MirageParser

MirageParserClass, struct in MirageParser

MirageParserInfo, struct in MirageParser

mirage_parser_add_redbook_pregap, function in MirageParser

mirage_parser_create_text_stream, function in MirageParser

mirage_parser_generate_info, function in MirageParser

mirage_parser_get_info, function in MirageParser

mirage_parser_guess_medium_type, function in MirageParser

mirage_parser_info_copy, function in MirageParser

mirage_parser_info_free, function in MirageParser

mirage_parser_load_image, function in MirageParser

MiragePasswordFunction, user_function in MirageContext

MiragePlugin, struct in MiragePlugin

MiragePlugin:filename, object property in MiragePlugin

MiragePluginClass, struct in MiragePlugin

mirage_plugin_new, function in MiragePlugin

S

MirageSector, struct in MirageSector

MirageSectorClass, struct in MirageSector

MirageSectorSubchannelFormat, enum in MirageSector

MirageSectorValidData, enum in MirageSector

mirage_sector_feed_data, function in MirageSector

mirage_sector_get_data, function in MirageSector

mirage_sector_get_edc_ecc, function in MirageSector

mirage_sector_get_header, function in MirageSector

mirage_sector_get_sector_type, function in MirageSector

mirage_sector_get_subchannel, function in MirageSector

mirage_sector_get_subheader, function in MirageSector

mirage_sector_get_sync, function in MirageSector

mirage_sector_verify_lec, function in MirageSector

mirage_sector_verify_subchannel_crc, function in MirageSector

MirageSession, struct in MirageSession

MirageSession::layout-changed, object signal in MirageSession

MirageSessionClass, struct in MirageSession

MirageSessionTypes, enum in MirageSession

mirage_session_add_language, function in MirageSession

mirage_session_add_track_by_index, function in MirageSession

mirage_session_add_track_by_number, function in MirageSession

mirage_session_enumerate_languages, function in MirageSession

mirage_session_enumerate_tracks, function in MirageSession

mirage_session_get_cdtext_data, function in MirageSession

mirage_session_get_language_by_code, function in MirageSession

mirage_session_get_language_by_index, function in MirageSession

mirage_session_get_leadout_length, function in MirageSession

mirage_session_get_next, function in MirageSession

mirage_session_get_number_of_languages, function in MirageSession

mirage_session_get_number_of_tracks, function in MirageSession

mirage_session_get_prev, function in MirageSession

mirage_session_get_session_type, function in MirageSession

mirage_session_get_track_after, function in MirageSession

mirage_session_get_track_before, function in MirageSession

mirage_session_get_track_by_address, function in MirageSession

mirage_session_get_track_by_index, function in MirageSession

mirage_session_get_track_by_number, function in MirageSession

mirage_session_layout_get_first_track, function in MirageSession

mirage_session_layout_get_length, function in MirageSession

mirage_session_layout_get_session_number, function in MirageSession

mirage_session_layout_get_start_sector, function in MirageSession

mirage_session_layout_set_first_track, function in MirageSession

mirage_session_layout_set_session_number, function in MirageSession

mirage_session_layout_set_start_sector, function in MirageSession

mirage_session_remove_language_by_code, function in MirageSession

mirage_session_remove_language_by_index, function in MirageSession

mirage_session_remove_language_by_object, function in MirageSession

mirage_session_remove_track_by_index, function in MirageSession

mirage_session_remove_track_by_number, function in MirageSession

mirage_session_remove_track_by_object, function in MirageSession

mirage_session_set_cdtext_data, function in MirageSession

mirage_session_set_leadout_length, function in MirageSession

mirage_session_set_session_type, function in MirageSession

mirage_shutdown, function in Main

mirage_soversion_major, variable in Version

MIRAGE_SOVERSION_MAJOR, macro in Version

mirage_soversion_minor, variable in Version

MIRAGE_SOVERSION_MINOR, macro in Version

mirage_soversion_patch, variable in Version

MIRAGE_SOVERSION_PATCH, macro in Version

MirageSubChannel, enum in Utilities

MirageSubchannelDataFormat, enum in MirageFragment

T

MirageTrack, struct in MirageTrack

MirageTrack::layout-changed, object signal in MirageTrack

MirageTrackClass, struct in MirageTrack

MirageTrackConstants, enum in MirageTrack

MirageTrackFlags, enum in MirageTrack

MirageTrackModes, enum in MirageTrack

mirage_track_add_fragment, function in MirageTrack

mirage_track_add_index, function in MirageTrack

mirage_track_add_language, function in MirageTrack

mirage_track_enumerate_fragments, function in MirageTrack

mirage_track_enumerate_indices, function in MirageTrack

mirage_track_enumerate_languages, function in MirageTrack

mirage_track_find_fragment_with_subchannel, function in MirageTrack

mirage_track_get_adr, function in MirageTrack

mirage_track_get_ctl, function in MirageTrack

mirage_track_get_flags, function in MirageTrack

mirage_track_get_fragment_by_address, function in MirageTrack

mirage_track_get_fragment_by_index, function in MirageTrack

mirage_track_get_index_by_address, function in MirageTrack

mirage_track_get_index_by_number, function in MirageTrack

mirage_track_get_isrc, function in MirageTrack

mirage_track_get_language_by_code, function in MirageTrack

mirage_track_get_language_by_index, function in MirageTrack

mirage_track_get_mode, function in MirageTrack

mirage_track_get_next, function in MirageTrack

mirage_track_get_number_of_fragments, function in MirageTrack

mirage_track_get_number_of_indices, function in MirageTrack

mirage_track_get_number_of_languages, function in MirageTrack

mirage_track_get_prev, function in MirageTrack

mirage_track_get_sector, function in MirageTrack

mirage_track_get_track_start, function in MirageTrack

mirage_track_layout_get_length, function in MirageTrack

mirage_track_layout_get_session_number, function in MirageTrack

mirage_track_layout_get_start_sector, function in MirageTrack

mirage_track_layout_get_track_number, function in MirageTrack

mirage_track_layout_set_start_sector, function in MirageTrack

mirage_track_layout_set_track_number, function in MirageTrack

mirage_track_remove_fragment_by_index, function in MirageTrack

mirage_track_remove_fragment_by_object, function in MirageTrack

mirage_track_remove_index_by_number, function in MirageTrack

mirage_track_remove_index_by_object, function in MirageTrack

mirage_track_remove_language_by_code, function in MirageTrack

mirage_track_remove_language_by_index, function in MirageTrack

mirage_track_remove_language_by_object, function in MirageTrack

mirage_track_set_ctl, function in MirageTrack

mirage_track_set_flags, function in MirageTrack

mirage_track_set_isrc, function in MirageTrack

mirage_track_set_mode, function in MirageTrack

mirage_track_set_track_start, function in MirageTrack

V

MIRAGE_VERSION_LONG, macro in Version

mirage_version_long, variable in Version

MIRAGE_VERSION_MAJOR, macro in Version

mirage_version_major, variable in Version

MIRAGE_VERSION_MICRO, macro in Version

mirage_version_micro, variable in Version

MIRAGE_VERSION_MINOR, macro in Version

mirage_version_minor, variable in Version

mirage_version_short, variable in Version

MIRAGE_VERSION_SHORT, macro in Version