Itdb_Device

typedef struct {
    gchar *mountpoint;
    gint   musicdirs;
    guint  byte_order;
    GHashTable *sysinfo;
    SysInfoIpodProperties *sysinfo_extended;
    gboolean sysinfo_changed;
    gint timezone_shift;
} Itdb_Device;

Structure representing an iPod device

Since 0.4.0

itdb_device_new ()

Itdb_Device*        itdb_device_new                     (void);

Creates a new Itdb_Device structure

Since 0.4.0

itdb_device_free ()

void                itdb_device_free                    (Itdb_Device *device);

Frees memory used by device

Since 0.4.0

itdb_device_set_mountpoint ()

void                itdb_device_set_mountpoint          (Itdb_Device *device,
                                                         const gchar *mp);

Sets the mountpoint of device to mp and update the cached device information (in particular, re-read the SysInfo file)

Since 0.4.0

itdb_device_read_sysinfo ()

gboolean            itdb_device_read_sysinfo            (Itdb_Device *device);

Reads the SysInfo file and stores information in device->sysinfo for later use.

Since 0.4.0

itdb_device_get_sysinfo ()

gchar*              itdb_device_get_sysinfo             (const Itdb_Device *device,
                                                         const gchar *field);

Retrieve specified field from the SysInfo file.

Since 0.4.0

itdb_device_set_sysinfo ()

void                itdb_device_set_sysinfo             (Itdb_Device *device,
                                                         const gchar *field,
                                                         const gchar *value);

Set specified field. It can later be written to the iPod using itdb_device_write_sysinfo()

Since 0.4.0

itdb_device_write_sysinfo ()

gboolean            itdb_device_write_sysinfo           (Itdb_Device *device,
                                                         GError **error);

Fills the SysInfo file with information in device->sysinfo. Note: no directories are created if not already existent.

Since 0.4.0

Itdb_IpodInfo

typedef struct {
    const gchar *model_number;
    const double capacity;
    const Itdb_IpodModel ipod_model;
    const Itdb_IpodGeneration ipod_generation;
    const guint musicdirs;
    /* reserved for future use */
    const gint32 reserved_int1;
    const gint32 reserved_int2;
    gconstpointer reserved1;
    gconstpointer reserved2;
} Itdb_IpodInfo;

Structure representing information about an iPod

Since 0.4.0

itdb_device_get_ipod_info ()

const Itdb_IpodInfo* itdb_device_get_ipod_info          (const Itdb_Device *device);

Retrieve the Itdb_IpodInfo entry for this iPod

Since 0.4.0

itdb_device_supports_artwork ()

gboolean            itdb_device_supports_artwork        (const Itdb_Device *device);

Indicates whether device can display artwork or not. When dealing with a non-art capable iPod, no artwork data will be written to the iPod so you can spare calls to the artwork handling methods.

Since 0.5.0

itdb_device_supports_photo ()

gboolean            itdb_device_supports_photo          (const Itdb_Device *device);

Indicates whether device can display photos or not.

Since 0.5.0

itdb_device_supports_video ()

gboolean            itdb_device_supports_video          (const Itdb_Device *device);

Indicates whether device can play videos or not.

Since 0.7.0

itdb_info_get_ipod_info_table ()

const Itdb_IpodInfo* itdb_info_get_ipod_info_table      (void);

Return a pointer to the start of valid iPod model descriptions, which is an array of Itdb_IpodInfo entries.

Since 0.4.0

enum Itdb_IpodGeneration

typedef enum {
    ITDB_IPOD_GENERATION_UNKNOWN,
    ITDB_IPOD_GENERATION_FIRST,
    ITDB_IPOD_GENERATION_SECOND,
    ITDB_IPOD_GENERATION_THIRD,
    ITDB_IPOD_GENERATION_FOURTH,
    ITDB_IPOD_GENERATION_PHOTO,
    ITDB_IPOD_GENERATION_MOBILE,
    ITDB_IPOD_GENERATION_MINI_1,
    ITDB_IPOD_GENERATION_MINI_2,
    ITDB_IPOD_GENERATION_SHUFFLE_1,
    ITDB_IPOD_GENERATION_SHUFFLE_2,
    ITDB_IPOD_GENERATION_SHUFFLE_3,
    ITDB_IPOD_GENERATION_NANO_1,
    ITDB_IPOD_GENERATION_NANO_2,
    ITDB_IPOD_GENERATION_NANO_3,
    ITDB_IPOD_GENERATION_NANO_4,
    ITDB_IPOD_GENERATION_VIDEO_1,
    ITDB_IPOD_GENERATION_VIDEO_2,
    ITDB_IPOD_GENERATION_CLASSIC_1,
    ITDB_IPOD_GENERATION_CLASSIC_2,
    ITDB_IPOD_GENERATION_TOUCH_1,
    ITDB_IPOD_GENERATION_IPHONE_1,
} Itdb_IpodGeneration;

iPod generation information

See http://support.apple.com/kb/HT1353 and http://en.wikipedia.org/wiki/IPod for more details.

Since 0.4.0

itdb_info_get_ipod_generation_string ()

const gchar*        itdb_info_get_ipod_generation_string
                                                        (Itdb_IpodGeneration generation);

Return the iPod's generic generation name, like "First Generation", "Mobile Phone"...

Since 0.4.0

enum Itdb_IpodModel

typedef enum {
    ITDB_IPOD_MODEL_INVALID,
    ITDB_IPOD_MODEL_UNKNOWN,
    ITDB_IPOD_MODEL_COLOR,
    ITDB_IPOD_MODEL_COLOR_U2,
    ITDB_IPOD_MODEL_REGULAR,
    ITDB_IPOD_MODEL_REGULAR_U2,
    ITDB_IPOD_MODEL_MINI,
    ITDB_IPOD_MODEL_MINI_BLUE,
    ITDB_IPOD_MODEL_MINI_PINK,
    ITDB_IPOD_MODEL_MINI_GREEN,
    ITDB_IPOD_MODEL_MINI_GOLD,
    ITDB_IPOD_MODEL_SHUFFLE,
    ITDB_IPOD_MODEL_NANO_WHITE,
    ITDB_IPOD_MODEL_NANO_BLACK,
    ITDB_IPOD_MODEL_VIDEO_WHITE,
    ITDB_IPOD_MODEL_VIDEO_BLACK,
    ITDB_IPOD_MODEL_MOBILE_1,
    ITDB_IPOD_MODEL_VIDEO_U2,
    ITDB_IPOD_MODEL_NANO_SILVER,
    ITDB_IPOD_MODEL_NANO_BLUE,
    ITDB_IPOD_MODEL_NANO_GREEN,
    ITDB_IPOD_MODEL_NANO_PINK,
    ITDB_IPOD_MODEL_NANO_RED,
    ITDB_IPOD_MODEL_NANO_YELLOW,
    ITDB_IPOD_MODEL_NANO_PURPLE,
    ITDB_IPOD_MODEL_NANO_ORANGE,
    ITDB_IPOD_MODEL_IPHONE_1,
    ITDB_IPOD_MODEL_SHUFFLE_SILVER,
    ITDB_IPOD_MODEL_SHUFFLE_PINK,
    ITDB_IPOD_MODEL_SHUFFLE_BLUE,
    ITDB_IPOD_MODEL_SHUFFLE_GREEN,
    ITDB_IPOD_MODEL_SHUFFLE_ORANGE,
    ITDB_IPOD_MODEL_SHUFFLE_PURPLE,
    ITDB_IPOD_MODEL_SHUFFLE_RED,
    ITDB_IPOD_MODEL_CLASSIC_SILVER,
    ITDB_IPOD_MODEL_CLASSIC_BLACK,
    ITDB_IPOD_MODEL_TOUCH_BLACK,
} Itdb_IpodModel;

iPod model information

Since 0.4.0

itdb_info_get_ipod_model_name_string ()

const gchar*        itdb_info_get_ipod_model_name_string
                                                        (Itdb_IpodModel model);

Return the iPod's generic model name, like "Color", "Nano"...

Since 0.4.0

itdb_init_ipod ()

gboolean            itdb_init_ipod                      (const gchar *mountpoint,
                                                         const gchar *model_number,
                                                         const gchar *ipod_name,
                                                         GError **error);

Initialise an iPod device from scratch. The function attempts to create a blank database, complete with master playlist and device information as well as the directory structure required for the type of iPod.

Since 0.4.0

Itdb_ArtworkFormat

typedef struct {
        gint format_id;
        gint width;
        gint height;
        ItdbThumbFormat format;
        gint32 padding;
        gboolean crop;
        gint rotation;
        guchar back_color[4];

        gint display_width;
        gboolean interlaced;
        gboolean align_row_bytes;
        gint color_adjustment;
        gdouble gamma;
        gint associated_format;
} Itdb_ArtworkFormat;

Structure representing the characteristics of the thumbnails to write to a given .ithmb file. The format of the structure is based on the way artwork formats are written to SysInfoExtended.