![]() |
![]() |
![]() |
libMirage Reference Manual | ![]() |
---|---|---|---|---|
Top | Description |
#include <mirage-utils.h> #define MIRAGE_CAST_DATA (buf, off, type) #define MIRAGE_CAST_PTR (buf, off, type) enum MirageSubChannel; guint8 mirage_helper_ascii2isrc (gchar c
); gint mirage_helper_bcd2hex (gint bcd
); guint16 mirage_helper_calculate_crc16 (const guint8 *data
,guint length
,const guint16 *crctab
,gboolean reflected
,gboolean invert
); guint32 mirage_helper_calculate_crc32_fast (const guint8 *data
,guint length
,const guint32 *crctab
,gboolean reflected
,gboolean invert
); guint32 mirage_helper_calculate_crc32_standard (const guint8 *data
,guint length
,const guint32 *crctab
,gboolean reflected
,gboolean invert
); MirageSectorType mirage_helper_determine_sector_type (const guint8 *buf
); const gchar * mirage_helper_encoding_from_bom (const guint8 *buffer
); gchar * mirage_helper_find_data_file (const gchar *filename
,const gchar *path
); const gchar * mirage_helper_get_suffix (const gchar *filename
); gboolean mirage_helper_has_suffix (const gchar *filename
,const gchar *suffix
); gint mirage_helper_hex2bcd (gint hex
); guint16 * mirage_helper_init_crc16_lut (guint16 genpoly
); guint32 * mirage_helper_init_crc32_lut (guint32 genpoly
,guint slices
); guint8 * mirage_helper_init_ecma_130b_scrambler_lut (void
); gchar mirage_helper_isrc2ascii (guint8 c
); void mirage_helper_lba2msf (gint lba
,gboolean diff
,guint8 *m
,guint8 *s
,guint8 *f
); gchar * mirage_helper_lba2msf_str (gint lba
,gboolean diff
); gint mirage_helper_msf2lba (guint8 m
,guint8 s
,guint8 f
,gboolean diff
); gint mirage_helper_msf2lba_str (const gchar *msf
,gboolean diff
); void mirage_helper_sector_edc_ecc_compute_ecc_block (const guint8 *src
,guint32 major_count
,guint32 minor_count
,guint32 major_mult
,guint32 minor_inc
,guint8 *dest
); void mirage_helper_sector_edc_ecc_compute_edc_block (const guint8 *src
,guint16 size
,guint8 *dest
); gint mirage_helper_strcasecmp (const gchar *str1
,const gchar *str2
); gint mirage_helper_strncasecmp (const gchar *str1
,const gchar *str2
,gint len
); gchar * mirage_helper_format_string (const gchar *format
,...
); gchar * mirage_helper_format_stringd (const gchar *format
,GHashTable *dictionary
); gchar * mirage_helper_format_stringv (const gchar *format
,va_list args
); void mirage_helper_subchannel_deinterleave (gint subchan
,const guint8 *channel96
,guint8 *channel12
); void mirage_helper_subchannel_interleave (gint subchan
,const guint8 *channel12
,guint8 *channel96
); guint16 mirage_helper_subchannel_q_calculate_crc (const guint8 *data
); void mirage_helper_subchannel_q_decode_isrc (const guint8 *buf
,gchar *isrc
); void mirage_helper_subchannel_q_decode_mcn (const guint8 *buf
,gchar *mcn
); void mirage_helper_subchannel_q_encode_isrc (guint8 *buf
,const gchar *isrc
); void mirage_helper_subchannel_q_encode_mcn (guint8 *buf
,const gchar *mcn
); gboolean mirage_helper_validate_isrc (const gchar *isrc
);
These functions cover various functionality. They are exported because, while primarily designed to be used within libMirage, they could also prove useful to other applications.
#define MIRAGE_CAST_DATA(buf,off,type) (*((type *)(buf+off)))
A macro for easy retrieval of data from (unsigned integer) buffer. Mostly to be used in binary image parsers, for example, to retrieve guint32 or guint16 value from buffer.
|
buffer to get data from |
|
offset in buffer at which to get data |
|
data type (i.e. 'guint64') |
#define MIRAGE_CAST_PTR(buf,off,type) ((type)(buf+off))
A macro for easy placing of pointers within (unsigned integer) buffer. Mostly to be used in binary image parsers, for example, to retrieve a string or a structure from buffer.
|
buffer to place pointer in |
|
offset in buffer at which to place pointer |
|
pointer type (i.e. 'gchar *') |
typedef enum { SUBCHANNEL_W = 0, SUBCHANNEL_V = 1, SUBCHANNEL_U = 2, SUBCHANNEL_T = 3, SUBCHANNEL_S = 4, SUBCHANNEL_R = 5, SUBCHANNEL_Q = 6, SUBCHANNEL_P = 7, } MirageSubChannel;
Subchannel type for interleaving/deinterleaving.
guint8 mirage_helper_ascii2isrc (gchar c
);
Converts ASCII character c
into ISRC character.
|
ASCII character. [in] |
Returns : |
ISRC character |
gint mirage_helper_bcd2hex (gint bcd
);
Converts bcd-encoded integer into hex-encoded integer.
|
bcd-encoded integer. [in] |
Returns : |
hex-encoded integer |
guint16 mirage_helper_calculate_crc16 (const guint8 *data
,guint length
,const guint16 *crctab
,gboolean reflected
,gboolean invert
);
Calculates the CRC-16 checksum of the data stored in data
.
|
buffer containing data. [in][array length=length] |
|
length of data. [in] |
|
pointer to CRC polynomial table. [in][array fixed-size=256] |
|
whether to use the reflected algorithm. [in] |
|
whether the result should be inverted. [in] |
Returns : |
CRC-16 checksum of data |
guint32 mirage_helper_calculate_crc32_fast (const guint8 *data
,guint length
,const guint32 *crctab
,gboolean reflected
,gboolean invert
);
Calculates the CRC-32 checksum of the data stored in data
. This is
fast slice-by-8 implementation that processes 8 bytes at a time, and
requires crctab
to be allocating using mirage_helper_init_crc32_lut()
with slice parameter set to 8.
|
buffer containing data. [in][array length=length] |
|
length of data. [in] |
|
pointer to CRC polynomial table. [in][array fixed-size=2048] |
|
whether to use the reflected algorithm. [in] |
|
whether the initial value and result should be inverted. [in] |
Returns : |
CRC-32 checksum of data |
guint32 mirage_helper_calculate_crc32_standard (const guint8 *data
,guint length
,const guint32 *crctab
,gboolean reflected
,gboolean invert
);
Calculates the CRC-32 checksum of the data stored in data
. This is
standard inplementation that processes 1 byte at a time, and requires
crctab
to be allocated using mirage_helper_init_crc32_lut()
with slice
parameter set to 1.
|
buffer containing data. [in][array length=length] |
|
length of data. [in] |
|
pointer to CRC polynomial table. [in][array fixed-size=256] |
|
whether to use the reflected algorithm. [in] |
|
whether the initial value and result should be inverted. [in] |
Returns : |
CRC-32 checksum of data |
MirageSectorType mirage_helper_determine_sector_type (const guint8 *buf
);
Determines sector type from its data, based on first 16 bytes, which correspond to sync pattern and header.
This function is intened to be used in image parsers, for determining track mode in cases when full (2352-byte) sector data is available.
|
buffer containing at least first 16 bytes of sector's data. [in] |
Returns : |
sector type (one of MirageSectorType ) |
const gchar * mirage_helper_encoding_from_bom (const guint8 *buffer
);
Tries to decode BOM provided in buffer
, and based on the result
returns the following encodings: UTF-32BE, UTF32-LE, UTF-16LE, UTF-16BE
or UTF-8 (if BOM is not valid).
|
a 4-byte buffer containing BOM. [in][transfer none][array fixed-size=4] |
Returns : |
the name of encoding, or NULL if UTF-8 is
assumed. The string is statically stored and should not be modified. [transfer none]
|
gchar * mirage_helper_find_data_file (const gchar *filename
,const gchar *path
);
Attempts to find a file with filename filename
and path path
. filename
can
be file's basename or an absolute path. path
can be either directory path (in
this case, it must end with '/') or a filename (i.e. of file descriptor).
If filename
is an absolute path, its existence is first checked. If it
does not exist, search (see below) is performed in filename
's dirname. If
still no match is found and path
is not NULL
, path
's dirname is combined
with filename
's basename, and the combination's existence is checked. If
that fails as well, search (see below) is performed in path
's dirname.
Searching in the directory is performed as follows. Directory is opened
and its content is case-insensitively compared to filename
's basename.
All filenames whose beginning match filename
are considered, and the
shortest one is returned. This way, all possible case variations
(i.e. file.iso, FILE.ISO, FiLe.IsO, etc.) are taken into account.
This function can return a filename with additional suffices, but only if
a file without those extra suffices does not exist. E.g., if search is
done for 'data.img', and only 'data.img.gz' exists, it will be returned.
However, if both 'data.img' and 'data.img.gz' exist, the former will be
returned.
The returned string should be freed when no longer needed.
|
declared filename. [in] |
|
path where to look for file (can be a filename), or NULL . [in][allow-none]
|
Returns : |
a newly allocated string containing the fullpath of file, or NULL . |
const gchar * mirage_helper_get_suffix (const gchar *filename
);
Retrieves suffix from filename
.
|
filename. [in] |
Returns : |
pointer to character in filename at which the suffix starts. [transfer none]
|
gboolean mirage_helper_has_suffix (const gchar *filename
,const gchar *suffix
);
Checks whether file name filename
ends with suffix suffix
.
|
filename. [in] |
|
suffix. [in] |
Returns : |
TRUE if filename contains suffix suffix , FALSE if not |
gint mirage_helper_hex2bcd (gint hex
);
Converts hex-encoded integer into bcd-encoded integer.
|
hex-encoded integer. [in] |
Returns : |
bcd-encoded integer |
guint16 * mirage_helper_init_crc16_lut (guint16 genpoly
);
Calculates a look-up table for CRC16 based on the generator polynomial.
|
generator polynomial. [in] |
Returns : |
Pointer to the CRC16 look-up table or NULL on failure. |
guint32 * mirage_helper_init_crc32_lut (guint32 genpoly
,guint slices
);
Calculates a look-up table for CRC32 based on the generator polynomial.
The size of the lookup table depends on slices
. The standard algorithm
processes 1 byte at a time and has a look-up table size of 1KiB, whereas
The slice-by-4 and slice-by-8 algorithms use 4 and 8 KiB look-up tables that
are derived from the initial look-up table.
|
generator polynomial. [in] |
|
number of bytes to process at once. [in] |
Returns : |
Pointer to the CRC32 look-up table or NULL on failure. |
guint8 * mirage_helper_init_ecma_130b_scrambler_lut
(void
);
Calculates a look-up table for sector data scrambler from ECMA-130, Annex B. The look-up table consists of 2340 entries, each being a scramble byte for corresponding byte in sector data.
Returns : |
Pointer to the generated scrambler look-up table or NULL on failure. |
gchar mirage_helper_isrc2ascii (guint8 c
);
Converts ISRC character c
into ASCII character.
|
ISRC character. [in] |
Returns : |
ACSII character |
void mirage_helper_lba2msf (gint lba
,gboolean diff
,guint8 *m
,guint8 *s
,guint8 *f
);
Converts LBA sector address stored in lba
into MSF address, storing each field
into m
, s
and f
, respectively.
If diff
is TRUE
, 150 frames difference is accounted for; this should be
used when converting absolute addresses. When converting relative addresses
(or lengths), diff
should be set to FALSE
.
|
LBA address. [in] |
|
account for the difference. [in] |
|
location to store minutes, or NULL . [out][allow-none]
|
|
location to store seconds, or NULL . [out][allow-none]
|
|
location to store frames, or NULL . [out][allow-none]
|
gchar * mirage_helper_lba2msf_str (gint lba
,gboolean diff
);
Converts LBA sector address stored in lba
into MSF address.
If diff
is TRUE
, 150 frames difference is accounted for; this should be
used when converting absolute addresses. When converting relative addresses
(or lengths), diff
should be set to FALSE
.
|
LBA address. [in] |
|
account for the difference. [in] |
Returns : |
a newly-allocated string containing MSF address; it should be freed
with g_free() when no longer needed. |
gint mirage_helper_msf2lba (guint8 m
,guint8 s
,guint8 f
,gboolean diff
);
Converts MSF sector address stored in m
, s
and f
into LBA address.
If diff
is TRUE
, 150 frames difference is accounted for; this should be
used when converting absolute addresses. When converting relative addresses
(or lengths), diff
should be set to FALSE
.
|
minutes. [in] |
|
seconds. [in] |
|
frames. [in] |
|
difference. [in] |
Returns : |
integer representing LBA address |
gint mirage_helper_msf2lba_str (const gchar *msf
,gboolean diff
);
Converts MSF sector address stored in msf
string into LBA address.
If diff
is TRUE
, 150 frames difference is accounted for; this should be
used when converting absolute addresses. When converting relative addresses
(or lengths), diff
should be set to FALSE
.
|
MSF string. [in] |
|
difference. [in] |
Returns : |
integer representing LBA address or -1 on failure. |
void mirage_helper_sector_edc_ecc_compute_ecc_block (const guint8 *src
,guint32 major_count
,guint32 minor_count
,guint32 major_mult
,guint32 minor_inc
,guint8 *dest
);
Calculates ECC (error correction code) for data in src
and writes the result
into dest
. The code assumes 2352 byte sectors. It can calculate both P and Q
layer of ECC data, depending on major_count
, minor_count
, major_mult
and
minor_inc.
To calculate ECC (first P, then Q layer) for different types of sectors and store it into sector data, use:
mirage_helper_sector_edc_ecc_compute_ecc_block(sector_buffer+0xC, 86, 24, 2, 86, sector_buffer+0x81C); mirage_helper_sector_edc_ecc_compute_ecc_block(sector_buffer+0xC, 52, 43, 86, 88, sector_buffer+0x8C8);
mirage_helper_sector_edc_ecc_compute_ecc_block(sector_buffer+0xC, 86, 24, 2, 86, sector_buffer+0x81C); \n mirage_helper_sector_edc_ecc_compute_ecc_block(sector_buffer+0xC, 52, 43, 86, 88, sector_buffer+0x8C8);
(This is assuming all other sector data, including EDC, is already stored in sector_buffer and that sector_buffer is 2532 bytes long)
|
data to calculate ECC data for. [in] |
|
major count. [in] |
|
minor count. [in] |
|
major multiplicator. [in] |
|
minor increment. [in] |
|
buffer to write calculated ECC data into. [out caller-allocates] |
void mirage_helper_sector_edc_ecc_compute_edc_block (const guint8 *src
,guint16 size
,guint8 *dest
);
Calculates EDC (error detection code) for data in src
of length size
and
writes the result into dest
.
To calculate EDC for different types of sectors and store it into sector data, use:
mirage_helper_sector_edc_ecc_compute_edc_block(sector_buffer+0x00, 0x810, sector_buffer+0x810);
mirage_helper_sector_edc_ecc_compute_edc_block(sector_buffer+0x10, 0x808, sector_buffer+0x818);
mirage_helper_sector_edc_ecc_compute_edc_block(sector_buffer+0x10, 0x91C, sector_buffer+0x92C);
(This is assuming all other sector data is already stored in sector_buffer and that sector_buffer is 2532 bytes long)
|
data to calculate EDC data for. [in][array length=size] |
|
size of data in src . [in]
|
|
buffer to write calculated EDC data into (4 bytes). [out caller-allocates][array fixed-size=4] |
gint mirage_helper_strcasecmp (const gchar *str1
,const gchar *str2
);
Replacement function for g_strcasecmp/strcasecmp, which can properly handle UTF-8. Glib docs state this is only an approximation, albeit it should be a fairly good one.
It compares the two strings str1
and str2
, ignoring the case of the characters.
It returns an integer less than, equal to, or greater than zero if str1
is found,
respectively, to be less than, to match, or be greater than str2
.
|
first string. [in] |
|
second string. [in] |
Returns : |
an integer less than, equal to, or greater than zero if str1
is found, respectively, to be less than, to match, or be greater than str2 . |
gint mirage_helper_strncasecmp (const gchar *str1
,const gchar *str2
,gint len
);
Replacement function for g_strncasecmp/strncasecmp, which can properly handle UTF-8. Glib docs state this is only an approximation, albeit it should be a fairly good one.
It compares first len
characters of string str1
and str2
, ignoring the case of
the characters. It returns an integer less than, equal to, or greater than zero if
first len
characters of str1
is found, respectively, to be less than, to match,
or be greater than first len
characters of str2
.
|
first string. [in] |
|
second string. [in] |
|
length of string to compare. [in] |
Returns : |
an integer less than, equal to, or greater than zero if first len
characters of str1 is found, respectively, to be less than, to match, or
be greater than first len characters of str2 . |
gchar * mirage_helper_format_string (const gchar *format
,...
);
General-purpose string formatter with token replacement. Similarly to sprintf, the tokens begin with percent character, but instead of denoting format type, the tokens denote placeholders for user-defined replacements. Sprintf-like field width and precision modifiers are supported for formatting the replacements. If replacement is not specified for a replacement token found in format, then the token is removed in the output string.
If replacement does not exist and the token to be replaced is preceded by other word-caracters (see GRegex documentation for details), in addition to the replacement token, all those word characters are removed together with the leading non-word character.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
// Example: formatting a filename output = mirage_helper_format_string("%b-%02s-track%t.%e", "b", g_variant_new_string("some_image"), "s", g_variant_new_int16(1), "t", g_variant_new_int16(3), "e", g_variant_new_string("iso"), NULL); // output = "some_image-01-track3.iso" // Example: removal of preceding characters when replacement does not exist output = mirage_helper_format_string("%b-%02s-track%t.%e", "b", g_variant_new_string("some_image"), "s", g_variant_new_int16(1), "e", g_variant_new_string("iso"), NULL); // output = "some_image-01.iso" |
Varargs
is a NULL
-terminated list of replacement token/value pairs,
where a replacement token/value pair is a pair of string and a GVariant.
|
format string. [in] |
|
NULL -terminated list of replacement token/value pairs. [in]
|
Returns : |
string with all replacement tokens either
replaced or removed. The string should be freed using g_free() when
no longer needed. [transfer full]
|
gchar * mirage_helper_format_stringd (const gchar *format
,GHashTable *dictionary
);
Dictionary-version of mirage_helper_format_string()
.
dictionary
is a GHashTable where keys are replacement token strings
and each value is a GVariant containing corresponding token replacement
value.
|
format string. [in] |
|
a GHashTable containing replacement token/value pairs. [in] |
Returns : |
string with all replacement tokens either
replaced or removed. The string should be freed using g_free() when
no longer needed. [transfer full]
|
gchar * mirage_helper_format_stringv (const gchar *format
,va_list args
);
Variable-argument-list-version of mirage_helper_format_string()
.
args
is a NULL
-terminated list of replacement token/value pairs,
where a replacement token/value pair is a pair of string and a GVariant.
|
format string. [in] |
|
NULL -terminated list of replacement token/value pairs. [in]
|
Returns : |
string with all replacement tokens either
replaced or removed. The string should be freed using g_free() when
no longer needed. [transfer full]
|
void mirage_helper_subchannel_deinterleave (gint subchan
,const guint8 *channel96
,guint8 *channel12
);
Deinterleaves subchannel data of type subchan
from subchannel data stored in
channel96
and writes the resulting subhcannel data into subchannel12
.
|
subchannel type. [in] |
|
buffer containing subchannel data to deinterleave (96 bytes). [in][array fixed-size=96] |
|
buffer to deinterleave subchannel data into (12 bytes). [out caller-allocates][array fixed-size=12] |
void mirage_helper_subchannel_interleave (gint subchan
,const guint8 *channel12
,guint8 *channel96
);
Interleaves subchannel data of type subchan
stored in channel12
into
subchannel data stored in subchannel96
.
|
subchannel type. [in] |
|
buffer containing subchannel data to interleave (12 bytes). [in][array fixed-size=12] |
|
buffer to interleave subchannel data into (96 bytes). [out caller-allocates][array fixed-size=96] |
guint16 mirage_helper_subchannel_q_calculate_crc
(const guint8 *data
);
Calculates the CRC-16 checksum of the Q subchannel data stored in data
.
|
buffer containing Q subchannel data (10 bytes). [in][array fixed-size=10] |
Returns : |
CRC-16 checksum of Q subchannel data |
void mirage_helper_subchannel_q_decode_isrc (const guint8 *buf
,gchar *isrc
);
Decodes ISRC stored in buf
into string isrc
.
|
buffer containing encoded ISRC (8 bytes). [in][array fixed-size=8] |
|
string to decode ISRC into (12 bytes). [out caller-allocates][array fixed-size=12] |
void mirage_helper_subchannel_q_decode_mcn (const guint8 *buf
,gchar *mcn
);
Decodes MCN stored in buf
into string mcn
.
|
buffer containing encoded MCN (7 bytes). [in][array fixed-size=7] |
|
string to decode MCN into (13 bytes). [out caller-allocates][array fixed-size=13] |
void mirage_helper_subchannel_q_encode_isrc (guint8 *buf
,const gchar *isrc
);
Encodes ISRC string isrc
into buffer buf
.
|
buffer to encode ISRC into (8 bytes). [out caller-allocates][array fixed-size=8] |
|
ISRC string (12 bytes). [in][array fixed-size=12] |
void mirage_helper_subchannel_q_encode_mcn (guint8 *buf
,const gchar *mcn
);
Encodes MCN string mcn
into buffer buf
.
|
buffer to encode MCN into (7 bytes). [out caller-allocates][array fixed-size=7] |
|
MCN string (13 bytes). [in][array fixed-size=13] |