![]() |
![]() |
![]() |
libMirage Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Implemented Interfaces | Signals |
#include <mirage-session.h> gboolean (*MirageEnumLanguageCallback) (MirageLanguage *language
,gpointer user_data
); gboolean (*MirageEnumTrackCallback) (MirageTrack *track
,gpointer user_data
); MirageSession; struct MirageSessionClass; enum MirageSessionTypes; gboolean mirage_session_add_language (MirageSession *self
,gint code
,MirageLanguage *language
,GError **error
); void mirage_session_add_track_by_index (MirageSession *self
,gint index
,MirageTrack *track
); gboolean mirage_session_add_track_by_number (MirageSession *self
,gint number
,MirageTrack *track
,GError **error
); gboolean mirage_session_enumerate_languages (MirageSession *self
,MirageEnumLanguageCallback func
,gpointer user_data
); gboolean mirage_session_enumerate_tracks (MirageSession *self
,MirageEnumTrackCallback func
,gpointer user_data
); gboolean mirage_session_get_cdtext_data (MirageSession *self
,guint8 **data
,gint *len
,GError **error
); MirageLanguage * mirage_session_get_language_by_code (MirageSession *self
,gint code
,GError **error
); MirageLanguage * mirage_session_get_language_by_index (MirageSession *self
,gint index
,GError **error
); gint mirage_session_get_leadout_length (MirageSession *self
); MirageSession * mirage_session_get_next (MirageSession *self
,GError **error
); gint mirage_session_get_number_of_languages (MirageSession *self
); gint mirage_session_get_number_of_tracks (MirageSession *self
); MirageSession * mirage_session_get_prev (MirageSession *self
,GError **error
); MirageSessionTypes mirage_session_get_session_type (MirageSession *self
); MirageTrack * mirage_session_get_track_after (MirageSession *self
,MirageTrack *track
,GError **error
); MirageTrack * mirage_session_get_track_before (MirageSession *self
,MirageTrack *track
,GError **error
); MirageTrack * mirage_session_get_track_by_address (MirageSession *self
,gint address
,GError **error
); MirageTrack * mirage_session_get_track_by_index (MirageSession *self
,gint index
,GError **error
); MirageTrack * mirage_session_get_track_by_number (MirageSession *self
,gint number
,GError **error
); gint mirage_session_layout_get_first_track (MirageSession *self
); gint mirage_session_layout_get_length (MirageSession *self
); gint mirage_session_layout_get_session_number (MirageSession *self
); gint mirage_session_layout_get_start_sector (MirageSession *self
); void mirage_session_layout_set_first_track (MirageSession *self
,gint first_track
); void mirage_session_layout_set_session_number (MirageSession *self
,gint number
); void mirage_session_layout_set_start_sector (MirageSession *self
,gint start_sector
); gboolean mirage_session_remove_language_by_code (MirageSession *self
,gint code
,GError **error
); gboolean mirage_session_remove_language_by_index (MirageSession *self
,gint index
,GError **error
); void mirage_session_remove_language_by_object (MirageSession *self
,MirageLanguage *language
); gboolean mirage_session_remove_track_by_index (MirageSession *self
,gint index
,GError **error
); gboolean mirage_session_remove_track_by_number (MirageSession *self
,gint number
,GError **error
); void mirage_session_remove_track_by_object (MirageSession *self
,MirageTrack *track
); gboolean mirage_session_set_cdtext_data (MirageSession *self
,guint8 *data
,gint len
,GError **error
); void mirage_session_set_leadout_length (MirageSession *self
,gint length
); void mirage_session_set_session_type (MirageSession *self
,MirageSessionTypes type
);
MirageSession object represents a session in the disc layout. It provides functions for manipulating session layout; setting session type, adding and removing tracks and languages, setting CD-TEXT data, etc.
gboolean (*MirageEnumLanguageCallback) (MirageLanguage *language
,gpointer user_data
);
Callback function type used with mirage_session_enumerate_languages()
and
mirage_track_enumerate_languages()
. A pointer to a language object is
stored in language
, without incrementing its reference counter.
user_data
is user data passed to enumeration function.
|
language. [in] |
|
user data passed to enumeration function. [in][closure] |
Returns : |
TRUE on success, otherwise FALSE
|
gboolean (*MirageEnumTrackCallback) (MirageTrack *track
,gpointer user_data
);
Callback function type used with mirage_session_enumerate_tracks()
.
A pointer to a track object is stored in track
, without incrementing
its reference counter. user_data
is user data passed to enumeration function.
|
track. [in] |
|
user data passed to enumeration function. [in][closure] |
Returns : |
TRUE on success, otherwise FALSE
|
typedef struct _MirageSession MirageSession;
All the fields in the MirageSession structure are private to the MirageSession implementation and should never be accessed directly.
struct MirageSessionClass { MirageObjectClass parent_class; };
The class structure for the MirageSession type.
MirageObjectClass |
the parent class |
typedef enum { MIRAGE_SESSION_CD_DA = 0x00, MIRAGE_SESSION_CD_ROM = 0x00, MIRAGE_SESSION_CD_I = 0x10, MIRAGE_SESSION_CD_ROM_XA = 0x20, } MirageSessionTypes;
Session types
gboolean mirage_session_add_language (MirageSession *self
,gint code
,MirageLanguage *language
,GError **error
);
Adds language to session.
code
is language code that should be assigned to added language. If
language with that code is already present in the session, the function fails.
|
a MirageSession |
|
language code for the added language. [in] |
|
a MirageLanguage to be added. [in][transfer full] |
|
location to store error, or NULL . [out][allow-none]
|
Returns : |
TRUE on success, FALSE on failure |
void mirage_session_add_track_by_index (MirageSession *self
,gint index
,MirageTrack *track
);
Adds track to session layout.
index
is the index at which track is added. Negative index denotes
index going backwards (i.e. -1 adds track at the end, -2 adds track
second-to-last, etc.). If index, either negative or positive, is too big,
track is respectively added at the beginning or at the end of the layout.
|
a MirageSession |
|
index at which track should be added. [in] |
|
a MirageTrack to be added. [in][transfer full] |
gboolean mirage_session_add_track_by_number (MirageSession *self
,gint number
,MirageTrack *track
,GError **error
);
Adds track to session layout.
number
is track number that should be assigned to added track. It determines
track's position in the layout. If track with that number already exists in
the layout, the function fails.
|
a MirageSession |
|
track number for the added track. [in] |
|
a MirageTrack to be added. [in][transfer full] |
|
location to store error, or NULL . [out][allow-none]
|
Returns : |
TRUE on success, FALSE on failure |
gboolean mirage_session_enumerate_languages (MirageSession *self
,MirageEnumLanguageCallback func
,gpointer user_data
);
Iterates over languages list, calling func
for each language.
If func
returns FALSE
, the function immediately returns FALSE
.
|
a MirageSession |
|
callback function. [in][scope call] |
|
data to be passed to callback function. [in][closure] |
Returns : |
TRUE on success, FALSE on failure |
gboolean mirage_session_enumerate_tracks (MirageSession *self
,MirageEnumTrackCallback func
,gpointer user_data
);
Iterates over tracks list, calling func
for each track in the layout.
If func
returns FALSE
, the function immediately returns FALSE
.
|
a MirageSession |
|
callback function. [in][scope call] |
|
data to be passed to callback function. [in][closure] |
Returns : |
TRUE on success, FALSE on failure |
gboolean mirage_session_get_cdtext_data (MirageSession *self
,guint8 **data
,gint *len
,GError **error
);
Returns CD-TEXT data for session. It internally creates and uses MirageCdTextCoder
object as an encoder to encode data from MirageLanguage objects from both session and
its tracks. Buffer with encoded data is stored in data
; it should be freed with
g_free()
when no longer needed.
|
a MirageSession |
|
location to return buffer with encoded CD-TEXT data. [out callee-allocates][transfer full][array length=len] |
|
location to return length of data in buffer. [out] |
|
location to store error, or NULL . [out][allow-none]
|
Returns : |
TRUE on success, FALSE on failure |
MirageLanguage * mirage_session_get_language_by_code (MirageSession *self
,gint code
,GError **error
);
Retrieves language by language code.
|
a MirageSession |
|
language code of language to be retrieved. [in] |
|
location to store error, or NULL . [out][allow-none]
|
Returns : |
a MirageLanguage on success, NULL on failure.
The reference to the object should be released using g_object_unref()
when no longer needed. [transfer full]
|
MirageLanguage * mirage_session_get_language_by_index (MirageSession *self
,gint index
,GError **error
);
Retrieves language by index. If index
is negative, languages from the end of
session are retrieved (e.g. -1 is for last language, -2 for second-to-last
language, etc.). If index
is out of range, regardless of the sign, the
function fails.
|
a MirageSession |
|
index of language to be retrieved. [in] |
|
location to store error, or NULL . [out][allow-none]
|
Returns : |
a MirageLanguage on success, NULL on failure.
The reference to the object should be released using g_object_unref()
when no longer needed. [transfer full]
|
gint mirage_session_get_leadout_length (MirageSession *self
);
Retrieves session's leadout length. The returned length is given in sectors.
|
a MirageSession |
Returns : |
leadout length |
MirageSession * mirage_session_get_next (MirageSession *self
,GError **error
);
Retrieves session that is placed after self
in disc layout.
|
a MirageSession |
|
location to store error, or NULL . [out][allow-none]
|
Returns : |
a MirageSession on success, NULL on failure.
The reference to the object should be released using g_object_unref()
when no longer needed. [transfer full]
|
gint mirage_session_get_number_of_languages
(MirageSession *self
);
Retrieves number of languages the session contains.
|
a MirageSession |
Returns : |
number of languages |
gint mirage_session_get_number_of_tracks (MirageSession *self
);
Retrieves number of tracks in the session layout.
|
a MirageSession |
Returns : |
number of tracks |
MirageSession * mirage_session_get_prev (MirageSession *self
,GError **error
);
Retrieves session that is placed before self
in disc layout.
|
a MirageSession |
|
location to store error, or NULL . [out][allow-none]
|
Returns : |
a MirageSession on success, NULL on failure.
The reference to the object should be released using g_object_unref()
when no longer needed. [transfer full]
|
MirageSessionTypes mirage_session_get_session_type (MirageSession *self
);
Retrieves session type.
|
a MirageSession |
Returns : |
session type |
MirageTrack * mirage_session_get_track_after (MirageSession *self
,MirageTrack *track
,GError **error
);
Retrieves track that comes after track
.
|
a MirageSession |
|
a track. [in] |
|
location to store error, or NULL . [out][allow-none]
|
Returns : |
a MirageTrack on success, NULL on failure.
The reference to the object should be released using g_object_unref()
when no longer needed. [transfer full]
|
MirageTrack * mirage_session_get_track_before (MirageSession *self
,MirageTrack *track
,GError **error
);
Retrieves track that comes before track
.
|
a MirageSession |
|
a track. [in] |
|
location to store error, or NULL . [out][allow-none]
|
Returns : |
a MirageTrack on success, NULL on failure.
The reference to the object should be released using g_object_unref()
when no longer needed. [transfer full]
|
MirageTrack * mirage_session_get_track_by_address (MirageSession *self
,gint address
,GError **error
);
Retrieves track by address. address
must be valid (disc-relative) sector
address that is part of the track to be retrieved (i.e. lying between tracks's
start and end sector).
|
a MirageSession |
|
address belonging to track to be retrieved. [in] |
|
location to store error, or NULL . [out][allow-none]
|
Returns : |
a MirageTrack on success, NULL on failure.
The reference to the object should be released using g_object_unref()
when no longer needed. [transfer full]
|
MirageTrack * mirage_session_get_track_by_index (MirageSession *self
,gint index
,GError **error
);
Retrieves track by index. If index
is negative, tracks from the end of
layout are retrieved (e.g. -1 is for last track, -2 for second-to-last
track, etc.). If index
is out of range, regardless of the sign, the
function fails.
|
a MirageSession |
|
index of track to be retrieved. [in] |
|
location to store error, or NULL . [out][allow-none]
|
Returns : |
a MirageTrack on success, NULL on failure.
The reference to the object should be released using g_object_unref()
when no longer needed. [transfer full]
|
MirageTrack * mirage_session_get_track_by_number (MirageSession *self
,gint number
,GError **error
);
Retrieves track by track number.
|
a MirageSession |
|
number of track to be retrieved. [in] |
|
location to store error, or NULL . [out][allow-none]
|
Returns : |
a MirageTrack on success, NULL on failure.
The reference to the object should be released using g_object_unref()
when no longer needed. [transfer full]
|
gint mirage_session_layout_get_first_track
(MirageSession *self
);
Retrieves track number of the first track in the session layout.
|
a MirageSession |
Returns : |
first track number |
gint mirage_session_layout_get_length (MirageSession *self
);
Retrieves length of the session layout. This means the length of all tracks combined, including lead-in and lead-out tracks. The returned length is given in sectors.
|
a MirageSession |
Returns : |
session layout length |
gint mirage_session_layout_get_session_number
(MirageSession *self
);
Retrieves sessions's session number.
|
a MirageSession |
Returns : |
session number |
gint mirage_session_layout_get_start_sector
(MirageSession *self
);
Retrieves start sector of the session layout.
|
a MirageSession |
Returns : |
start sector |
void mirage_session_layout_set_first_track (MirageSession *self
,gint first_track
);
Sets first track number to first_track
. This is a number that is
assigned to the first track in the session layout.
|
a MirageSession |
|
first track number. [in] |
void mirage_session_layout_set_session_number (MirageSession *self
,gint number
);
Sets sessions's session number.
|
a MirageSession |
|
session number. [in] |
void mirage_session_layout_set_start_sector (MirageSession *self
,gint start_sector
);
Sets start sector of the session layout to start_sector
. This is a sector at which
the first track in the session layout will start.
|
a MirageSession |
|
start sector. [in] |
gboolean mirage_session_remove_language_by_code (MirageSession *self
,gint code
,GError **error
);
Removes language from session.
code
is language code the language to be removed.
|
a MirageSession |
|
language code of language to be removed. [in] |
|
location to store error, or NULL . [out][allow-none]
|
Returns : |
TRUE on success, FALSE on failure |
gboolean mirage_session_remove_language_by_index (MirageSession *self
,gint index
,GError **error
);
Removes language from session.
index
is the index of the language to be removed. This function calls
mirage_session_get_language_by_index()
so index
behavior is determined by that
function.
|
a MirageSession |
|
index of language to be removed. [in] |
|
location to store error, or NULL . [out][allow-none]
|
Returns : |
TRUE on success, FALSE on failure |
void mirage_session_remove_language_by_object (MirageSession *self
,MirageLanguage *language
);
Removes language from session.
language
is a MirageLanguage object to be removed.
|
a MirageSession |
|
language object to be removed. [in] |
gboolean mirage_session_remove_track_by_index (MirageSession *self
,gint index
,GError **error
);
Removes track from session layout.
index
is the index of the track to be removed. This function calls
mirage_session_get_track_by_index()
so index
behavior is determined by that
function.
|
a MirageSession |
|
index of track to be removed. [in] |
|
location to store error, or NULL . [out][allow-none]
|
Returns : |
TRUE on success, FALSE on failure |
gboolean mirage_session_remove_track_by_number (MirageSession *self
,gint number
,GError **error
);
Removes track from session layout.
number
is track number of the track to be removed.
|
a MirageSession |
|
track number of track to be removed. [in] |
|
location to store error, or NULL . [out][allow-none]
|
Returns : |
TRUE on success, FALSE on failure |
void mirage_session_remove_track_by_object (MirageSession *self
,MirageTrack *track
);
Removes track from session layout.
track
is a MirageTrack object to be removed.
|
a MirageSession |
|
track object to be removed. [in] |
gboolean mirage_session_set_cdtext_data (MirageSession *self
,guint8 *data
,gint len
,GError **error
);
Sets CD-TEXT data for session. It internally creates and uses MirageCdTextCoder
object as a decoder to decode data in data
. Decoded data is stored in MirageLanguage
objects in both session and its tracks. Therefore session must have same number of tracks
as the encoded CD-TEXT data.
|
a MirageSession |
|
buffer containing encoded CD-TEXT data. [in][array length=len] |
|
length of data in buffer. [in] |
|
location to store error, or NULL . [out][allow-none]
|
Returns : |
TRUE on success, FALSE on failure |
void mirage_session_set_leadout_length (MirageSession *self
,gint length
);
Sets session's leadout length to length
. It does so by creating NULL fragment
and adding it to leadout. This function is internally used to properly handle
multi-session disc layouts. The length is given in sectors.
|
a MirageSession |
|
leadout length. [in] |
void mirage_session_set_session_type (MirageSession *self
,MirageSessionTypes type
);
Sets session type. type
must be one of MirageSessionTypes.
|
a MirageSession |
|
session type. [in] |
"layout-changed"
signalvoid user_function (MirageSession *session,
gpointer user_data) : Run Last
Emitted when a layout of MirageSession changed in a way that causes a bottom-up change.
|
a MirageSession |
|
user data set when the signal handler was connected. |