## rhythmdb

rhythmdb

## Synopsis

    #define             RHYTHMDB_TYPE
    #define             RHYTHMDB                            (o)
    #define             RHYTHMDB_IS                         (o)
    #define             RHYTHMDB_GET_CLASS                  (o)
    typedef             RhythmDBEntryType;
    #define             RHYTHMDB_ENTRY_TYPE_SONG
    enum                RhythmDBQueryType;
    enum                RhythmDBPropType;
    #define             RHYTHMDB_TYPE_QUERY
                        RhythmDBQueryData;
    typedef             RhythmDBEntry;
                        RhythmDBEntryChange;
    void                rhythmdb_entry_get                  (RhythmDB *db,
                                                             RhythmDBEntry *entry,
                                                             RhythmDBPropType propid,
                                                             GValue *val);
    const char*         rhythmdb_entry_get_string           (RhythmDBEntry *entry,
                                                             RhythmDBPropType propid);
    gboolean            rhythmdb_entry_get_boolean          (RhythmDBEntry *entry,
                                                             RhythmDBPropType propid);
    guint64             rhythmdb_entry_get_uint64           (RhythmDBEntry *entry,
                                                             RhythmDBPropType propid);
    gulong              rhythmdb_entry_get_ulong            (RhythmDBEntry *entry,
                                                             RhythmDBPropType propid);
    double              rhythmdb_entry_get_double           (RhythmDBEntry *entry,
                                                             RhythmDBPropType propid);
    const char*         rb_refstring_get                    (const RBRefString *val);
    const char*         rb_refstring_get_sort_key           (RBRefString *val);
    const char*         rb_refstring_get_folded             (RBRefString *val);
    enum                RhythmDBError;
    #define             RHYTHMDB_ERROR
    GQuark              rhythmdb_error_quark                (void);
    typedef             RhythmDBPrivate;
    GType               rhythmdb_get_type                   (void);
    RhythmDB*           rhythmdb_new                        (const char *name);
    void                rhythmdb_shutdown                   (RhythmDB *db);
    void                rhythmdb_load                       (RhythmDB *db);
    void                rhythmdb_save                       (RhythmDB *db);
    void                rhythmdb_save_async                 (RhythmDB *db);
    void                rhythmdb_commit                     (RhythmDB *db);
    gboolean            rhythmdb_entry_is_editable          (RhythmDB *db,
                                                             RhythmDBEntry *entry);
    RhythmDBEntry*      rhythmdb_entry_new                  (RhythmDB *db,
                                                             RhythmDBEntryType type,
                                                             const char *uri);
    void                rhythmdb_add_uri                    (RhythmDB *db,
                                                             const char *uri);
    void                rhythmdb_entry_set                  (RhythmDB *db,
                                                             RhythmDBEntry *entry,
                                                             guint propid,
                                                             const GValue *value);
    void                rhythmdb_entry_delete               (RhythmDB *db,
                                                             RhythmDBEntry *entry);
    void                rhythmdb_entry_delete_by_type       (RhythmDB *db,
                                                             RhythmDBEntryType type);
    RhythmDBEntry*      rhythmdb_entry_lookup_by_location   (RhythmDB *db,
                                                             const char *uri);
    gboolean            rhythmdb_evaluate_query             (RhythmDB *db,
                                                             RhythmDBQuery *query,
                                                             RhythmDBEntry *entry);
    void                rhythmdb_entry_foreach              (RhythmDB *db,
                                                             GFunc func,
                                                             gpointer data);
    void                rhythmdb_do_full_query              (RhythmDB *db,
                                                             RhythmDBQueryResults *results,
                                                             ...);
    void                rhythmdb_do_full_query_parsed       (RhythmDB *db,
                                                             RhythmDBQueryResults *results,
                                                             RhythmDBQuery *query);
    void                rhythmdb_do_full_query_async        (RhythmDB *db,
                                                             RhythmDBQueryResults *results,
                                                             ...);
    void                rhythmdb_do_full_query_async_parsed (RhythmDB *db,
                                                             RhythmDBQueryResults *results,
                                                             RhythmDBQuery *query);
    RhythmDBQuery*      rhythmdb_query_parse                (RhythmDB *db,
                                                             ...);
    void                rhythmdb_query_append               (RhythmDB *db,
                                                             RhythmDBQuery *query,
                                                             ...);
    void                rhythmdb_query_free                 (RhythmDBQuery *query);
    RhythmDBQuery*      rhythmdb_query_copy                 (RhythmDBQuery *array);
    void                rhythmdb_query_serialize            (RhythmDB *db,
                                                             RhythmDBQuery *query,
                                                             xmlNodePtr node);
    RhythmDBQuery*      rhythmdb_query_deserialize          (RhythmDB *db,
                                                             xmlNodePtr node);
    void                rhythmdb_emit_entry_added           (RhythmDB *db,
                                                             RhythmDBEntry *entry);
    void                rhythmdb_emit_entry_deleted         (RhythmDB *db,
                                                             RhythmDBEntry *entry);
    gboolean            rhythmdb_is_busy                    (RhythmDB *db);
    char*               rhythmdb_compute_status_normal      (gint n_songs,
                                                             glong duration,
                                                             guint64 size,
                                                             const char *singular,
                                                             const char *plural);
    RhythmDBEntryType   rhythmdb_entry_register_type        (RhythmDB *db,
                                                             const char *name);
    RhythmDBEntryType   rhythmdb_entry_song_get_type        (void);
    GType               rhythmdb_get_property_type          (RhythmDB *db,
                                                             guint property_id);
    RhythmDBEntry*      rhythmdb_entry_ref                  (RhythmDBEntry *entry);
    void                rhythmdb_entry_unref                (RhythmDBEntry *entry);

## Description

## Details

### RHYTHMDB_TYPE

    #define             RHYTHMDB_TYPE

### RHYTHMDB()

    #define             RHYTHMDB(o)

`o` : |

### RHYTHMDB_IS()

    #define             RHYTHMDB_IS(o)

`o` : |

### RHYTHMDB_GET_CLASS()

    #define             RHYTHMDB_GET_CLASS(o)

`o` : |

### RhythmDBEntryType

### RHYTHMDB_ENTRY_TYPE_SONG

    #define             RHYTHMDB_ENTRY_TYPE_SONG

### enum RhythmDBQueryType

    typedef enum
    {
    	RHYTHMDB_QUERY_END,
    	RHYTHMDB_QUERY_DISJUNCTION,
    	RHYTHMDB_QUERY_SUBQUERY,

    	/* general */
    	RHYTHMDB_QUERY_PROP_EQUALS,

    	/* string */
    	RHYTHMDB_QUERY_PROP_LIKE,
    	RHYTHMDB_QUERY_PROP_NOT_LIKE,
    	RHYTHMDB_QUERY_PROP_PREFIX,
    	RHYTHMDB_QUERY_PROP_SUFFIX,

    	/* numerical */
    	RHYTHMDB_QUERY_PROP_GREATER,
    	RHYTHMDB_QUERY_PROP_LESS,

    	/* synthetic query types, translated into non-synthetic ones internally */
    	RHYTHMDB_QUERY_PROP_CURRENT_TIME_WITHIN,
    	RHYTHMDB_QUERY_PROP_CURRENT_TIME_NOT_WITHIN,
    	RHYTHMDB_QUERY_PROP_YEAR_EQUALS,
    	RHYTHMDB_QUERY_PROP_YEAR_GREATER,
    	RHYTHMDB_QUERY_PROP_YEAR_LESS,
    } RhythmDBQueryType;

### enum RhythmDBPropType

    typedef enum
    {
    	RHYTHMDB_PROP_TYPE = 0,
    	RHYTHMDB_PROP_ENTRY_ID,
    	RHYTHMDB_PROP_TITLE,
    	RHYTHMDB_PROP_GENRE,
    	RHYTHMDB_PROP_ARTIST,
    	RHYTHMDB_PROP_ALBUM,
    	RHYTHMDB_PROP_TRACK_NUMBER,
    	RHYTHMDB_PROP_DISC_NUMBER,
    	RHYTHMDB_PROP_DURATION,
    	RHYTHMDB_PROP_FILE_SIZE,
    	RHYTHMDB_PROP_LOCATION,
    	RHYTHMDB_PROP_MOUNTPOINT,
    	RHYTHMDB_PROP_MTIME,
    	RHYTHMDB_PROP_FIRST_SEEN,
    	RHYTHMDB_PROP_LAST_SEEN,
    	RHYTHMDB_PROP_RATING,
    	RHYTHMDB_PROP_PLAY_COUNT,
    	RHYTHMDB_PROP_LAST_PLAYED,
    	RHYTHMDB_PROP_BITRATE,
    	RHYTHMDB_PROP_DATE,
    	RHYTHMDB_PROP_TRACK_GAIN,
    	RHYTHMDB_PROP_TRACK_PEAK,
    	RHYTHMDB_PROP_ALBUM_GAIN,
    	RHYTHMDB_PROP_ALBUM_PEAK,
    	RHYTHMDB_PROP_MIMETYPE,
    	RHYTHMDB_PROP_TITLE_SORT_KEY,
    	RHYTHMDB_PROP_GENRE_SORT_KEY,
    	RHYTHMDB_PROP_ARTIST_SORT_KEY,
    	RHYTHMDB_PROP_ALBUM_SORT_KEY,
    	RHYTHMDB_PROP_TITLE_FOLDED,
    	RHYTHMDB_PROP_GENRE_FOLDED,
    	RHYTHMDB_PROP_ARTIST_FOLDED,
    	RHYTHMDB_PROP_ALBUM_FOLDED,
    	RHYTHMDB_PROP_LAST_PLAYED_STR,
    	RHYTHMDB_PROP_HIDDEN,
    	RHYTHMDB_PROP_PLAYBACK_ERROR,
    	RHYTHMDB_PROP_FIRST_SEEN_STR,
    	RHYTHMDB_PROP_LAST_SEEN_STR,

    	/* synthetic properties */
    	RHYTHMDB_PROP_SEARCH_MATCH,
    	RHYTHMDB_PROP_YEAR,

    	/* Podcast properties */
    	RHYTHMDB_PROP_STATUS,
    	RHYTHMDB_PROP_DESCRIPTION,
    	RHYTHMDB_PROP_SUBTITLE,
    	RHYTHMDB_PROP_SUMMARY,
    	RHYTHMDB_PROP_LANG,
    	RHYTHMDB_PROP_COPYRIGHT,
    	RHYTHMDB_PROP_IMAGE,
    	RHYTHMDB_PROP_POST_TIME,

    	RHYTHMDB_PROP_MUSICBRAINZ_TRACKID,

    	RHYTHMDB_NUM_PROPERTIES
    } RhythmDBPropType;

### RHYTHMDB_TYPE_QUERY

    #define             RHYTHMDB_TYPE_QUERY

### RhythmDBQueryData

    typedef struct {
    	guint type;
    	guint propid;
    	GValue *val;
    	RhythmDBQuery *subquery;
    } RhythmDBQueryData;

### RhythmDBEntry

### RhythmDBEntryChange

    typedef struct {
    	RhythmDBPropType prop;
    	GValue old;
    	GValue new;
    } RhythmDBEntryChange;

### rhythmdb_entry_get ()

    void                rhythmdb_entry_get                  (RhythmDB *db,
                                                             RhythmDBEntry *entry,
                                                             RhythmDBPropType propid,
                                                             GValue *val);

Gets a property of an entry, storing it in the given GValue.

`db` : |
`entry` : | a RhythmDBEntry.
`propid` : | the id of the property to get.
`val` : | return location for the property value.

### rhythmdb_entry_get_string ()

    const char*         rhythmdb_entry_get_string           (RhythmDBEntry *entry,
                                                             RhythmDBPropType propid);

`entry` : |
`propid` : |
Returns : |

### rhythmdb_entry_get_boolean ()

    gboolean            rhythmdb_entry_get_boolean          (RhythmDBEntry *entry,
                                                             RhythmDBPropType propid);

`entry` : |
`propid` : |
Returns : |

### rhythmdb_entry_get_uint64 ()

    guint64             rhythmdb_entry_get_uint64           (RhythmDBEntry *entry,
                                                             RhythmDBPropType propid);

`entry` : |
`propid` : |
Returns : |

### rhythmdb_entry_get_ulong ()

    gulong              rhythmdb_entry_get_ulong            (RhythmDBEntry *entry,
                                                             RhythmDBPropType propid);

`entry` : |
`propid` : |
Returns : |

### rhythmdb_entry_get_double ()

    double              rhythmdb_entry_get_double           (RhythmDBEntry *entry,
                                                             RhythmDBPropType propid);

`entry` : |
`propid` : |
Returns : |

### rb_refstring_get ()

    const char*         rb_refstring_get                    (const RBRefString *val);

`val` : |
Returns : |

### rb_refstring_get_sort_key ()

    const char*         rb_refstring_get_sort_key           (RBRefString *val);

`val` : |
Returns : |

### rb_refstring_get_folded ()

    const char*         rb_refstring_get_folded             (RBRefString *val);

`val` : |
Returns : |

### enum RhythmDBError

    typedef enum
    {
    	RHYTHMDB_ERROR_ACCESS_FAILED,
    } RhythmDBError;

### RHYTHMDB_ERROR

    #define             RHYTHMDB_ERROR

### rhythmdb_error_quark ()

    GQuark              rhythmdb_error_quark                (void);

Returns : |

### RhythmDBPrivate

### rhythmdb_get_type ()

    GType               rhythmdb_get_type                   (void);

Returns : |

### rhythmdb_new ()

    RhythmDB*           rhythmdb_new                        (const char *name);

`name` : |
Returns : |

### rhythmdb_shutdown ()

    void                rhythmdb_shutdown                   (RhythmDB *db);

Ceases all RhythmDB operations, including stopping all directory monitoring, and removing all actions and events currently queued.

`db` : |

### rhythmdb_load ()

    void                rhythmdb_load                       (RhythmDB *db);

Load the database from disk.

`db` : | a RhythmDB.

### rhythmdb_save ()

    void                rhythmdb_save                       (RhythmDB *db);

Save the database to disk, not returning until it has been saved.

`db` : | a RhythmDB.

### rhythmdb_save_async ()

    void                rhythmdb_save_async                 (RhythmDB *db);

Save the database to disk, asynchronously.

`db` : | a RhythmDB.

### rhythmdb_commit ()

    void                rhythmdb_commit                     (RhythmDB *db);

Apply all database changes, and send notification of changes and new entries. This needs to be called after any changes have been made, such as a group of `rhythmdb_entry_set()` calls, or a new entry has been added.

`db` : | a RhythmDB.

### rhythmdb_entry_is_editable ()

    gboolean            rhythmdb_entry_is_editable          (RhythmDB *db,
                                                             RhythmDBEntry *entry);

This determines whether any changes to the entries metadata can be saved. Usually this is only true for entries backed by files, where tag-writing is enabled, and the appropriate tag-writing facilities are available.

`db` : | a RhythmDB.
`entry` : | a RhythmDBEntry.
Returns : | whether the entries metadata can be changed.

### rhythmdb_entry_new ()

    RhythmDBEntry*      rhythmdb_entry_new                  (RhythmDB *db,
                                                             RhythmDBEntryType type,
                                                             const char *uri);

Creates a new entry of type `type` and location `uri`, and inserts it into the database. You must call `rhythmdb_commit()` at some point after invoking this function.

This may return NULL if entry creation fails. This can occur if there is already an entry with the given uri.

`db` : | a RhythmDB.
`type` : | type of entry to create
`uri` : | the location of the entry, this be unique amongst all entries.
Returns : | the newly created RhythmDBEntry

### rhythmdb_add_uri ()

    void                rhythmdb_add_uri                    (RhythmDB *db,
                                                             const char *uri);

Adds the file(s) pointed to by `uri` to the database, as entries of type RHYTHMDB_ENTRY_TYPE_SONG. If the URI is that of a file, they will be added. If the URI is that of a directory, everything under it will be added recursively.

`db` : | a RhythmDB.
`uri` : | the URI to add an entry/entries for

### rhythmdb_entry_set ()

    void                rhythmdb_entry_set                  (RhythmDB *db,
                                                             RhythmDBEntry *entry,
                                                             guint propid,
                                                             const GValue *value);

This function can be called by any code which wishes to change a song property and send a notification. It may be called when the database is read-only; in this case the change will be queued for an unspecified time in the future. The implication of this is that `rhythmdb_entry_get()` may not reflect the changes immediately. However, if this property is exposed in the user interface, you should still make the change in the widget. Then when the database returns to a writable state, your change will take effect in the database too, and a notification will be sent at that point.

Note that you must call `rhythmdb_commit()` at some point after invoking this function, and that even after the commit, your change may not have taken effect.

`db` : | # a RhythmDB.
`entry` : | a RhythmDBEntry.
`propid` : | the id of the property to set.
`value` : | the property value.

### rhythmdb_entry_delete ()

    void                rhythmdb_entry_delete               (RhythmDB *db,
                                                             RhythmDBEntry *entry);

Delete entry `entry` from the database, sending notification of it's deletion. This is usually used by sources where entries can disappear randomly, such as a network source.

`db` : | a RhythmDB.
`entry` : | a RhythmDBEntry.

### rhythmdb_entry_delete_by_type ()

    void                rhythmdb_entry_delete_by_type       (RhythmDB *db,
                                                             RhythmDBEntryType type);

Delete all entries from the database of the given type. This is usually used by non-permanent sources when they disappear, such as removable media being removed, or a network share becoming unavailable.

`db` : | a RhythmDB.
`type` : | type of entried to delete.

### rhythmdb_entry_lookup_by_location ()

    RhythmDBEntry*      rhythmdb_entry_lookup_by_location   (RhythmDB *db,
                                                             const char *uri);

Looks up the entry with location `uri`.

`db` : | a RhythmDB.
`uri` : | the URI of the entry to lookup.
Returns : | the entry with location `uri`, or NULL if no such entry exists.

### rhythmdb_evaluate_query ()

    gboolean            rhythmdb_evaluate_query             (RhythmDB *db,
                                                             RhythmDBQuery *query,
                                                             RhythmDBEntry *entry);

Evaluates the given entry against the given query.

`db` : | a RhythmDB.
`query` : | a query. `entry` a `RhythmDBEntry`.
`entry` : |
Returns : | whether the given entry matches the criteria of the given query.

### rhythmdb_entry_foreach ()

    void                rhythmdb_entry_foreach              (RhythmDB *db,
                                                             GFunc func,
                                                             gpointer data);

Calls the given function for each of the entries in the database.

`db` : | a RhythmDB.
`func` : | the function to call with each entry.
`data` : | user data to pass to the function.

### rhythmdb_do_full_query ()

    void                rhythmdb_do_full_query              (RhythmDB *db,
                                                             RhythmDBQueryResults *results,
                                                             ...);

`db` : |
`results` : |
`...` : |

### rhythmdb_do_full_query_parsed ()

    void                rhythmdb_do_full_query_parsed       (RhythmDB *db,
                                                             RhythmDBQueryResults *results,
                                                             RhythmDBQuery *query);

`db` : |
`results` : |
`query` : |

### rhythmdb_do_full_query_async ()

    void                rhythmdb_do_full_query_async        (RhythmDB *db,
                                                             RhythmDBQueryResults *results,
                                                             ...);

`db` : |
`results` : |
`...` : |

### rhythmdb_do_full_query_async_parsed ()

    void                rhythmdb_do_full_query_async_parsed (RhythmDB *db,
                                                             RhythmDBQueryResults *results,
                                                             RhythmDBQuery *query);

`db` : |
`results` : |
`query` : |

### rhythmdb_query_parse ()

    RhythmDBQuery*      rhythmdb_query_parse                (RhythmDB *db,
                                                             ...);

Creates a query from a list of criteria.

Most criteria consists of an operator (RhythmDBQueryType), a property (RhythmDBPropType) and the data to compare with. An entry matches a criteria if the operator returns true with the value of the entries property as the first argument, and the given data as the second argument.

Three types criteria are special. Passing RHYTHMDB_QUERY_END indicates the end of the list of criteria, and must be the last passes parameter.

The second special criteria is a subquery which is defined by passing RHYTHMDB_QUERY_SUBQUERY, followed by a query (GPtrArray). An entry will match a subquery criteria if it matches all criteria in the subquery.

The third special criteria is a disjunction which is defined by passing RHYTHMDB_QUERY_DISJUNCTION, which will make an entry match the query if it matches the criteria before the disjunction, the criteria after the disjunction, or both.

Example: rhythmdb_query_parse (db, RHYTHMDB_QUERY_SUBQUERY, subquery, RHYTHMDB_QUERY_DISJUNCTION RHYTHMDB_QUERY_PROP_LIKE, RHYTHMDB_PROP_TITLE, "cat", RHYTHMDB_QUERY_DISJUNCTION RHYTHMDB_QUERY_PROP_GREATER, RHYTHMDB_PROP_RATING, 2.5, RHYTHMDB_QUERY_PROP_LESS, RHYTHMDB_PROP_PLAY_COUNT, 10, RHYTHMDB_QUERY_END);

will create a query that matches entries: a) that match the query "subquery", or b) that have "cat" in their title, or c) have a rating of at least 2.5, and a play count of at most 10

`db` : | a RhythmDB instance
`...` : |
Returns : | a the newly created query. It must be freed with `rhythmdb_query_free()`

### rhythmdb_query_append ()

    void                rhythmdb_query_append               (RhythmDB *db,
                                                             RhythmDBQuery *query,
                                                             ...);

Appends new criteria to the query `query`.

The list of criteria must be in the same format as for rhythmdb_query_parse, and ended by RHYTHMDB_QUERY_END.

`db` : | a RhythmDB instance
`query` : | a query.
`...` : |

### rhythmdb_query_free ()

    void                rhythmdb_query_free                 (RhythmDBQuery *query);

Frees the query `query`

`query` : | a query.

### rhythmdb_query_copy ()

    RhythmDBQuery*      rhythmdb_query_copy                 (RhythmDBQuery *array);

Creates a copy of a query.

`array` : | the query to copy.
Returns : | a copy of the passed query. It must be freed with `rhythmdb_query_free()`

### rhythmdb_query_serialize ()

    void                rhythmdb_query_serialize            (RhythmDB *db,
                                                             RhythmDBQuery *query,
                                                             xmlNodePtr node);

`db` : |
`query` : |
`node` : |

### rhythmdb_query_deserialize ()

    RhythmDBQuery*      rhythmdb_query_deserialize          (RhythmDB *db,
                                                             xmlNodePtr node);

`db` : |
`node` : |
Returns : |

### rhythmdb_emit_entry_added ()

    void                rhythmdb_emit_entry_added           (RhythmDB *db,
                                                             RhythmDBEntry *entry);

`db` : |
`entry` : |

### rhythmdb_emit_entry_deleted ()

    void                rhythmdb_emit_entry_deleted         (RhythmDB *db,
                                                             RhythmDBEntry *entry);

`db` : |
`entry` : |

### rhythmdb_is_busy ()

    gboolean            rhythmdb_is_busy                    (RhythmDB *db);

`db` : | a RhythmDB.
Returns : | whether the RhythmDB has events to process.

### rhythmdb_compute_status_normal ()

    char*               rhythmdb_compute_status_normal      (gint n_songs,
                                                             glong duration,
                                                             guint64 size,
                                                             const char *singular,
                                                             const char *plural);

Creates a string containing the "status" information about a list of tracks. The singular and plural strings must be used in a direct ngettext call elsewhere in order for them to be marked for translation correctly.

`n_songs` : | the number of tracks.
`duration` : | the total duration of the tracks.
`size` : | the total size of the tracks.
`singular` : | singular form of the format string to use for entries (eg "`d` song")
`plural` : | plural form of the format string to use for entries (eg "`d` songs")
Returns : | the string, which should be freed with g_free.

### rhythmdb_entry_register_type ()

    RhythmDBEntryType   rhythmdb_entry_register_type        (RhythmDB *db,
                                                             const char *name);

Registers a new RhythmDBEntryType. This should be called to create a new entry type for non-permanent sources.

`db` : | a RhythmDB
`name` : | optional name for the entry type
Returns : | the new RhythmDBEntryType.

### rhythmdb_entry_song_get_type ()

    RhythmDBEntryType   rhythmdb_entry_song_get_type        (void);

Returns : |

### rhythmdb_get_property_type ()

    GType               rhythmdb_get_property_type          (RhythmDB *db,
                                                             guint property_id);

`db` : |
`property_id` : |
Returns : |

### rhythmdb_entry_ref ()

    RhythmDBEntry*      rhythmdb_entry_ref                  (RhythmDBEntry *entry);

Increase the reference count of the entry.

`entry` : | a RhythmDBEntry.
Returns : |

### rhythmdb_entry_unref ()

    void                rhythmdb_entry_unref                (RhythmDBEntry *entry);

Decrease the reference count of the entry, and destroy it if there are no references left.

`entry` : | a RhythmDBEntry.