mirror of
https://github.com/owntone/owntone-server.git
synced 2024-12-26 23:25:56 -05:00
139 lines
4.7 KiB
C
139 lines
4.7 KiB
C
/*
|
|
* $Id$
|
|
* Header info for generic database
|
|
*
|
|
* Copyright (C) 2005 Ron Pedde (ron@pedde.com)
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
*/
|
|
|
|
#ifndef _DB_GENERIC_H_
|
|
#define _DB_GENERIC_H_
|
|
|
|
#include "ff-dbstruct.h" /** for MP3FILE */
|
|
#include "smart-parser.h" /** for PARSETREE */
|
|
#include "webserver.h" /** for WS_CONNINFO */
|
|
|
|
typedef enum {
|
|
queryTypeItems,
|
|
queryTypePlaylists,
|
|
queryTypePlaylistItems,
|
|
queryTypeBrowseArtists,
|
|
queryTypeBrowseAlbums,
|
|
queryTypeBrowseGenres,
|
|
queryTypeBrowseComposers
|
|
} QueryType_t;
|
|
|
|
typedef enum {
|
|
indexTypeNone,
|
|
indexTypeFirst,
|
|
indexTypeLast,
|
|
indexTypeSub
|
|
} IndexType_t;
|
|
|
|
typedef enum {
|
|
countSongs,
|
|
countPlaylists
|
|
} CountType_t;
|
|
|
|
typedef struct tag_dbqueryinfo {
|
|
QueryType_t query_type;
|
|
IndexType_t index_type;
|
|
int zero_length; /* emit zero-length strings? */
|
|
int index_low;
|
|
int index_high;
|
|
int playlist_id;
|
|
int db_id;
|
|
int session_id;
|
|
int want_count;
|
|
int specifiedtotalcount;
|
|
int uri_count;
|
|
int correct_order;
|
|
char *uri_sections[10];
|
|
PARSETREE pt;
|
|
void *output_info;
|
|
WS_CONNINFO *pwsc;
|
|
} DBQUERYINFO;
|
|
|
|
extern int db_open(char **pe, char *type, char *parameters);
|
|
extern int db_init(int reload);
|
|
extern int db_deinit(void);
|
|
|
|
extern int db_revision(void);
|
|
|
|
extern int db_add(char **pe, MP3FILE *pmp3, int *id);
|
|
|
|
extern int db_enum_start(char **pe, DBQUERYINFO *pinfo);
|
|
extern int db_enum_fetch_row(char **pe, PACKED_MP3FILE *row, DBQUERYINFO *pinfo);
|
|
extern int db_enum_reset(char **pe, DBQUERYINFO *pinfo);
|
|
extern int db_enum_end(char **pe);
|
|
extern int db_start_scan(void);
|
|
extern int db_end_song_scan(void);
|
|
extern int db_end_scan(void);
|
|
extern int db_exists(char *path);
|
|
extern int db_scanning(void);
|
|
|
|
extern int db_add_playlist(char **pe, char *name, int type, char *clause, char *path, int index, int *playlistid);
|
|
extern int db_add_playlist_item(char **pe, int playlistid, int songid);
|
|
extern int db_edit_playlist(char **pe, int id, char *name, char *clause);
|
|
extern int db_delete_playlist(char **pe, int playlistid);
|
|
extern int db_delete_playlist_item(char **pe, int playlistid, int songid);
|
|
|
|
extern void db_get_error(char **pe, int err, ...);
|
|
|
|
extern MP3FILE *db_fetch_item(char **pe, int id);
|
|
extern MP3FILE *db_fetch_path(char **pe, char *path, int index);
|
|
extern M3UFILE *db_fetch_playlist(char **pe, char *path, int index);
|
|
|
|
|
|
/* Holdover functions from old db interface...
|
|
* should these be removed? Refactored?
|
|
*/
|
|
|
|
extern int db_playcount_increment(char **pe, int id);
|
|
extern int db_get_song_count(char **pe, int *count);
|
|
extern int db_get_playlist_count(char **pe, int *count);
|
|
extern void db_dispose_item(MP3FILE *pmp3);
|
|
extern void db_dispose_playlist(M3UFILE *pm3u);
|
|
extern int db_force_rescan(char **pe);
|
|
|
|
#define DB_E_SUCCESS 0x00
|
|
#define DB_E_SQL_ERROR 0x01 /**< some kind of sql error - typically bad syntax */
|
|
#define DB_E_DUPLICATE_PLAYLIST 0x02 /**< playlist already exists when adding */
|
|
#define DB_E_NOCLAUSE 0x03 /**< adding smart playlist with no clause */
|
|
#define DB_E_INVALIDTYPE 0x04 /**< trying to add playlist items to invalid type */
|
|
#define DB_E_NOROWS 0x05 /**< sql query returned no rows */
|
|
#define DB_E_INVALID_PLAYLIST 0x06 /**< bad playlist id */
|
|
#define DB_E_INVALID_SONGID 0x07 /**< bad song id */
|
|
#define DB_E_PARSE 0x08 /**< could not parse result */
|
|
#define DB_E_BADPROVIDER 0x09 /**< requested db backend not there */
|
|
#define DB_E_PROC 0x0A /**< could not start threadpool */
|
|
#define DB_E_SIZE 0x0B /**< passed buffer too small */
|
|
#define DB_E_WRONGVERSION 0x0C /**< must upgrade db */
|
|
#define DB_E_DB_ERROR 0x0D /**< gdbm error */
|
|
#define DB_E_MALLOC 0x0E /**< malloc error */
|
|
#define DB_E_NOTFOUND 0x0F /**< path not found */
|
|
|
|
/* describes the individual database handlers */
|
|
typedef struct tag_dbinfo {
|
|
char *handler_name;
|
|
char *description;
|
|
int stores_playlists;
|
|
} DB_INFO;
|
|
|
|
|
|
|
|
#endif /* _DB_GENERIC_H_ */
|