# libMirage API Reference

## Annotation Glossary

### A

allow-none

  NULL is OK, both for passing and for returning.

array

  Parameter points to an array of items.

### C

closure

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

### E

element-type

  Generics and defining elements of containers and arrays.

### I

in

  Parameter for input. Default is transfer none.

### O

out

  Parameter for returning results. Default is transfer full.

out callee-allocates

  Out parameter, where callee must allocate storage.

out caller-allocates

  Out parameter, where caller must allocate storage.

### S

scope call

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

scope notified

  The callback is valid until the GDestroyNotify argument is called.

### T

transfer full

  Free data after the code is done.

transfer none

  Don't free data after the code is done.

type

  Override the parsed C type with given type.

### 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_input_stream, function in MirageContextual
mirage_contextual_create_output_stream, function in MirageContextual
mirage_contextual_debug_is_active, function in MirageContextual
mirage_contextual_debug_message, function in MirageContextual
mirage_contextual_debug_messagev, function in MirageContextual
mirage_contextual_debug_print_buffer, function in MirageContextual
mirage_contextual_get_context, 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_input_stream, function in MirageContext
mirage_context_create_output_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_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
mirage_create_writer, function in Main

### D

MIRAGE_DEBUG, macro in Debug
MirageDebugMask, enum in Debug
MirageDebugMaskInfo, struct in Main
MIRAGE_DEBUG_ON, macro in Debug
MIRAGE_DEBUG_PRINT_BUFFER, macro 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_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_contains_address, 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_put_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_medium_type, function in MirageDisc

### E

mirage_enumerate_filter_streams, function in Main
mirage_enumerate_parsers, function in Main
mirage_enumerate_writers, function in Main
MirageEnumFilterStreamInfoCallback, 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
MirageEnumWriterInfoCallback, user_function in Main
MirageErrorCode, enum in Error
mirage_error_quark, function in Error

### F

MirageFileStream, struct in MirageFileStream
MirageFileStreamClass, struct in MirageFileStream
mirage_file_stream_open, function in MirageFileStream
MirageFilterStream, struct in MirageFilterStream
MirageFilterStreamClass, struct in MirageFilterStream
MirageFilterStreamInfo, struct in MirageFilterStream
mirage_filter_stream_generate_info, function in MirageFilterStream
mirage_filter_stream_get_info, function in MirageFilterStream
mirage_filter_stream_get_underlying_stream, function in MirageFilterStream
mirage_filter_stream_info_copy, function in MirageFilterStream
mirage_filter_stream_info_free, function in MirageFilterStream
mirage_filter_stream_open, function in MirageFilterStream
mirage_filter_stream_simplified_get_position, function in MirageFilterStream
mirage_filter_stream_simplified_set_stream_length, function in MirageFilterStream
MirageFragment, struct in MirageFragment
MirageFragment::layout-changed, object signal in MirageFragment
MirageFragmentClass, struct in MirageFragment
MirageFragmentRole, enum in MirageWriter
mirage_fragment_contains_address, function in MirageFragment
mirage_fragment_get_address, function in MirageFragment
mirage_fragment_get_length, function in MirageFragment
mirage_fragment_is_writable, 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
mirage_fragment_write_main_data, function in MirageFragment
mirage_fragment_write_subchannel_data, function in MirageFragment

### G

mirage_get_filter_streams_info, function in Main
mirage_get_filter_streams_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
mirage_get_writers_info, function in Main
mirage_get_writers_type, 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_fast, function in Utilities
mirage_helper_calculate_crc32_standard, 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_format_string, function in Utilities
mirage_helper_format_stringd, function in Utilities
mirage_helper_format_stringv, 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_init_ecma_130b_scrambler_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
MirageLanguagePackType, 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 MirageSession
MirageMediumType, 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
MirageSectorType, enum in MirageSector
MirageSectorValidData, enum in MirageSector
mirage_sector_extract_data, function in MirageSector
mirage_sector_feed_data, function in MirageSector
mirage_sector_get_address, 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_scramble, function in MirageSector
mirage_sector_set_data, function in MirageSector
mirage_sector_set_edc_ecc, function in MirageSector
mirage_sector_set_header, function in MirageSector
mirage_sector_set_subchannel, function in MirageSector
mirage_sector_set_subheader, function in MirageSector
mirage_sector_set_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
MirageSessionType, 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_mcn, 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_contains_address, 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_mcn, function in MirageSession
mirage_session_set_session_type, function in MirageSession
mirage_shutdown, function in Main
MIRAGE_SOVERSION_MAJOR, macro in Version
mirage_soversion_major, variable in Version
MIRAGE_SOVERSION_MINOR, macro in Version
mirage_soversion_minor, variable in Version
MIRAGE_SOVERSION_PATCH, macro in Version
mirage_soversion_patch, variable in Version
MirageStream, struct in MirageStream
MirageStreamInterface, struct in MirageStream
mirage_stream_get_filename, function in MirageStream
mirage_stream_get_g_input_stream, function in MirageStream
mirage_stream_is_writable, function in MirageStream
mirage_stream_move_file, function in MirageStream
mirage_stream_read, function in MirageStream
mirage_stream_seek, function in MirageStream
mirage_stream_tell, function in MirageStream
mirage_stream_write, function in MirageStream
MirageSubChannel, enum in Utilities
MirageSubchannelDataFormat, enum in MirageFragment

### T

MirageTrack, struct in MirageTrack
MirageTrack::layout-changed, object signal in MirageTrack
MirageTrackClass, struct in MirageTrack
MirageTrackConstant, enum in MirageTrack
MirageTrackFlag, 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_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_sector_type, function in MirageTrack
mirage_track_get_track_start, function in MirageTrack
mirage_track_layout_contains_address, 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_put_sector, 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_sector_type, 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, macro in Version
mirage_version_short, variable in Version

### W

MirageWriter, struct in MirageWriter
MirageWriter::conversion-progress, object signal in MirageWriter
MirageWriterClass, struct in MirageWriter
MirageWriterInfo, struct in MirageWriter
MirageWriterParameter, struct in MirageWriter
mirage_writer_add_parameter_boolean, function in MirageWriter
mirage_writer_add_parameter_enum, function in MirageWriter
mirage_writer_add_parameter_int, function in MirageWriter
mirage_writer_add_parameter_string, function in MirageWriter
mirage_writer_convert_image, function in MirageWriter
mirage_writer_create_fragment, function in MirageWriter
mirage_writer_finalize_image, function in MirageWriter
mirage_writer_generate_info, function in MirageWriter
mirage_writer_get_conversion_progress_step, function in MirageWriter
mirage_writer_get_info, function in MirageWriter
mirage_writer_get_parameter_boolean, function in MirageWriter
mirage_writer_get_parameter_enum, function in MirageWriter
mirage_writer_get_parameter_int, function in MirageWriter
mirage_writer_get_parameter_string, function in MirageWriter
mirage_writer_info_copy, function in MirageWriter
mirage_writer_info_free, function in MirageWriter
mirage_writer_lookup_parameter_ids, function in MirageWriter
mirage_writer_lookup_parameter_info, function in MirageWriter
mirage_writer_open_image, function in MirageWriter
mirage_writer_set_conversion_progress_step, function in MirageWriter