Itdb_Track

typedef struct {
  Itdb_iTunesDB *itdb;
  gchar   *title;
  gchar   *ipod_path;
  gchar   *album;
  gchar   *artist;
  gchar   *genre;
  gchar   *filetype;
  gchar   *comment;
  gchar   *category;
  gchar   *composer;
  gchar   *grouping;
  gchar   *description;
  gchar   *podcasturl;
  gchar   *podcastrss;
  Itdb_Chapterdata *chapterdata;
  gchar   *subtitle;
/* the following 5 are new in libgpod 0.4.2... */
  gchar   *tvshow;
  gchar   *tvepisode;
  gchar   *tvnetwork;
  gchar   *albumartist;
  gchar   *keywords;
/* the following 6 are new in libgpod 0.5.0... */
  /* You can set these strings to override the standard
     sortorder. When set they take precedence over the default
     'artist', 'album'... fields.

     For example, in the case of an artist name like "The Artist",
     iTunes will set sort_artist to "Artist, The" followed by five
     0x01 characters. Why five 0x01 characters are added is not
     completely understood.

     If you do not set the sort_artist field, libgpod will pre-sort
     the lists displayed by the iPod according to "Artist, The",
     without setting the field.
  */
  gchar   *sort_artist;
  gchar   *sort_title;
  gchar   *sort_album;
  gchar   *sort_albumartist;
  gchar   *sort_composer;
  gchar   *sort_tvshow;
/* end of new fields in libgpod 0.5.0 */
  guint32 id;
  gint32  size;
  gint32  tracklen;
  gint32  cd_nr;
  gint32  cds;
  gint32  track_nr;
  gint32  tracks;
  gint32  bitrate;
  guint16 samplerate;
  guint16 samplerate_low;
  gint32  year;
  gint32  volume;
  guint32 soundcheck;
  time_t  time_added;
  time_t  time_modified;
  time_t  time_played;
  guint32 bookmark_time;
  guint32 rating;
  guint32 playcount;
  guint32 playcount2;
  guint32 recent_playcount;
  gboolean transferred;
  gint16  BPM;
  guint8  app_rating;
  guint8  type1;
  guint8  type2;
  guint8  compilation;
  guint32 starttime;
  guint32 stoptime;
  guint8  checked;
  guint64 dbid;
  guint32 drm_userid;
  guint32 visible;
  guint32 filetype_marker;
  guint16 artwork_count;
  guint32 artwork_size;
  float samplerate2;
  guint16 unk126;
  guint32 unk132;
  time_t  time_released;
  guint16 unk144;
  guint16 explicit_flag;
  guint32 unk148;
  guint32 unk152;
  guint32 skipcount;
  guint32 recent_skipcount;
  guint32 last_skipped;
  guint8 has_artwork;
  guint8 skip_when_shuffling;
  guint8 remember_playback_position;
  guint8 flag4;
  guint64 dbid2;
  guint8 lyrics_flag;
  guint8 movie_flag;
  guint8 mark_unplayed;
  guint8 unk179;
  guint32 unk180;
  guint32 pregap;
  guint64 samplecount;
  guint32 unk196;
  guint32 postgap;
  guint32 unk204;
  guint32 mediatype;
  guint32 season_nr;
  guint32 episode_nr;
  guint32 unk220;
  guint32 unk224;
  guint32 unk228, unk232, unk236, unk240, unk244;
  guint32 gapless_data;
  guint32 unk252;
  guint16 gapless_track_flag;
  guint16 gapless_album_flag;
  guint16 album_id;

  /* This is for Cover Art support */
  struct _Itdb_Artwork *artwork;

  /* This is for sparse artwork support, new in libgpod-0.7.0 */
  guint32 mhii_link;

  /* reserved for future use */
  gint32 reserved_int1;
  gint32 reserved_int2;
  gint32 reserved_int3;
  gint32 reserved_int4;
  gint32 reserved_int5;
  gint32 reserved_int6;
  gpointer reserved1;
  gpointer reserved2;
  gpointer reserved3;
  gpointer reserved4;
  gpointer reserved5;
  gpointer reserved6;

  /* +++***+++***+++***+++***+++***+++***+++***+++***+++***+++***
     When adding string fields don't forget to add them in
     itdb_track_duplicate as well
     +++***+++***+++***+++***+++***+++***+++***+++***+++***+++*** */

  /* below is for use by application */
  guint64 usertype;
  gpointer userdata;
  /* functions called to duplicate/free userdata */
  ItdbUserDataDuplicateFunc userdata_duplicate;
  ItdbUserDataDestroyFunc userdata_destroy;
} Itdb_Track;

Structure representing a track in an iTunesDB

Many of the parameter descriptions are copied verbatim from http://ipodlinux.org/ITunesDB, which is the best source for information about the iTunesDB and related files.

enum Itdb_Mediatype

typedef enum
{
    ITDB_MEDIATYPE_AUDIO      = 0x0001,
    ITDB_MEDIATYPE_MOVIE      = 0x0002,
    ITDB_MEDIATYPE_PODCAST    = 0x0004,
    ITDB_MEDIATYPE_AUDIOBOOK  = 0x0008,
    ITDB_MEDIATYPE_MUSICVIDEO = 0x0020,
    ITDB_MEDIATYPE_TVSHOW     = 0x0040,
} Itdb_Mediatype;

Mediatype definitions

The mediatype is used to determine what menu a track appears under. For example, setting the mediatype to ITDB_MEDIATYPE_PODCAST makes the track appear on the Podcast menu.

Since 0.5.0

ITDB_RATING_STEP

#define ITDB_RATING_STEP 20

The multiplier for each star in track->rating

itdb_track_new ()

Itdb_Track*         itdb_track_new                      (void);

Creates an empty Itdb_Track

itdb_track_free ()

void                itdb_track_free                     (Itdb_Track *track);

Frees the memory used by track

itdb_track_add ()

void                itdb_track_add                      (Itdb_iTunesDB *itdb,
                                                         Itdb_Track *track,
                                                         gint32 pos);

Adds track to itdb->tracks at position pos (or at the end if pos is -1). The application is responsible to also add it to the master playlist. The itdb gets ownership of the track and will take care of freeing the memory it uses when it's no longer necessary.

itdb_track_remove ()

void                itdb_track_remove                   (Itdb_Track *track);

Removes track from the Itdb_iTunesDB it's associated with, and frees the memory it uses. It doesn't remove the track from the playlists it may have been added to, in particular it won't be removed from the master playlist.

itdb_track_unlink ()

void                itdb_track_unlink                   (Itdb_Track *track);

Removes track from the Itdb_iTunesDB it's associated with, but do not free memory. It doesn't remove the track from the playlists it may have been added to, in particular it won't be removed from the master playlist. track->itdb is set to NULL.

itdb_track_duplicate ()

Itdb_Track*         itdb_track_duplicate                (Itdb_Track *tr);

Duplicates an existing track

itdb_track_by_id ()

Itdb_Track*         itdb_track_by_id                    (Itdb_iTunesDB *itdb,
                                                         guint32 id);

Looks up a track using its ID in itdb.

Looking up tracks by ID is not really a good idea because the IDs are created by itdb just before export. The functions are here because they are needed during import of the iTunesDB which is referencing tracks by IDs.

This function is very slow (linear in the number of tracks contained in the database). If you need to lookup many IDs use itdb_track_id_tree_create(), itdb_track_id_tree_destroy(), and itdb_track_id_tree_by_id().

itdb_track_id_tree_create ()

GTree*              itdb_track_id_tree_create           (Itdb_iTunesDB *itdb);

Creates a balanced-binary tree for quick ID lookup that is used in itdb_track_by_id_tree()

itdb_track_id_tree_destroy ()

void                itdb_track_id_tree_destroy          (GTree *idtree);

Frees the memory used by idtree

itdb_track_id_tree_by_id ()

Itdb_Track*         itdb_track_id_tree_by_id            (GTree *idtree,
                                                         guint32 id);

Lookup an Itdb_Track by id using idtree for faster lookup (compared to itdb_track_by_id())

itdb_track_get_thumbnail ()

gpointer            itdb_track_get_thumbnail            (Itdb_Track *track,
                                                         gint width,
                                                         gint height);

Get a thumbnail representing the cover associated with the current track, scaling it if appropriate. If either height or width is -1, then the biggest unscaled thumbnail available will be returned.

Since 0.7.0

itdb_track_has_thumbnails ()

gboolean            itdb_track_has_thumbnails           (Itdb_Track *track);

Determine if a track has thumbnails

Since 0.7.0

itdb_track_set_thumbnails ()

gboolean            itdb_track_set_thumbnails           (Itdb_Track *track,
                                                         const gchar *filename);

Uses the image contained in filename to generate iPod thumbnails. The image can be in any format supported by gdk-pixbuf. To save memory, the thumbnails will only be generated when necessary, i.e. when itdb_save() or a similar function is called.

Since 0.3.0

itdb_track_set_thumbnails_from_data ()

gboolean            itdb_track_set_thumbnails_from_data (Itdb_Track *track,
                                                         const guchar *image_data,
                                                         gsize image_data_len);

Uses image_data to generate iPod thumbnails. The image can be in any format supported by gdk-pixbuf. To save memory, the thumbnails will only be generated when necessary, i.e. when itdb_save() or a similar function is called.

Since 0.4.0

itdb_track_set_thumbnails_from_pixbuf ()

gboolean            itdb_track_set_thumbnails_from_pixbuf
                                                        (Itdb_Track *track,
                                                         gpointer pixbuf);

Uses pixbuf to generate iPod thumbnails. To save memory, the thumbnails will only be generated when necessary, i.e. when itdb_save() or a similar function is called.

Since 0.5.0

itdb_track_remove_thumbnails ()

void                itdb_track_remove_thumbnails        (Itdb_Track *track);

Removes the thumbnails associated with track

Since 0.3.0