2014-11-08 20:53:08 -05:00
|
|
|
/**
|
|
|
|
* Copyright 2014 (c) Anna Schumaker.
|
|
|
|
*/
|
|
|
|
#ifndef OCARINA_CORE_TAGS_ALBUM_H
|
|
|
|
#define OCARINA_CORE_TAGS_ALBUM_H
|
|
|
|
|
2015-10-22 09:58:12 -04:00
|
|
|
#include <core/database.h>
|
2014-11-08 20:53:08 -05:00
|
|
|
|
|
|
|
/**
|
|
|
|
* The Album tag is used to store the name and year of albums
|
|
|
|
* added to the tag database.
|
|
|
|
*
|
|
|
|
* When writing an Album tag to disk, write out the _year field and
|
|
|
|
* then call GenericTag to write anything else.
|
|
|
|
*
|
|
|
|
* ... << year1 << GenericTag::write()
|
|
|
|
* ... << year2 << GenericTag::write()
|
|
|
|
* ... << year3 << GenericTag::write()
|
|
|
|
*/
|
2015-10-31 11:44:29 -04:00
|
|
|
struct album : public db_entry {
|
2015-10-22 09:58:12 -04:00
|
|
|
unsigned int al_year; /* This album's year. */
|
|
|
|
std::string al_name; /* This album's name. */
|
|
|
|
std::string al_lower; /* This album's name (lowercased). */
|
2014-11-08 20:53:08 -05:00
|
|
|
|
2015-10-22 08:16:53 -04:00
|
|
|
album(); /**< Album tag constructor */
|
2014-11-08 20:53:08 -05:00
|
|
|
};
|
|
|
|
|
2015-11-04 12:23:00 -05:00
|
|
|
#define ALBUM(dbe) ((struct album *)dbe);
|
|
|
|
|
2014-11-16 14:47:51 -05:00
|
|
|
|
2015-09-24 11:18:48 -04:00
|
|
|
/* Called to initialize the album database. */
|
|
|
|
void album_db_init();
|
2014-11-16 14:47:51 -05:00
|
|
|
|
2015-09-24 11:18:48 -04:00
|
|
|
/* Called to clean up the album database. */
|
|
|
|
void album_db_deinit();
|
2015-09-24 11:09:59 -04:00
|
|
|
|
2015-09-24 11:13:12 -04:00
|
|
|
/* Called to find an album tag by name and year. */
|
|
|
|
struct album *album_find(const std::string &, unsigned int);
|
|
|
|
|
2015-09-24 11:09:59 -04:00
|
|
|
/* Called to get an album tag with a specific index. */
|
|
|
|
struct album *album_get(const unsigned int);
|
|
|
|
|
2015-10-22 09:58:12 -04:00
|
|
|
/* Called to compare two album tags. */
|
|
|
|
int album_compare(struct album *, struct album *);
|
|
|
|
|
2015-11-03 10:39:06 -05:00
|
|
|
#ifdef CONFIG_TESTING
|
|
|
|
const struct db_ops *test_album_ops();
|
|
|
|
#endif /* CONFIG_TESTING */
|
2014-11-08 20:53:08 -05:00
|
|
|
#endif /* OCARINA_CORE_TAGS_ALBUM_H */
|