X-Git-Url: http://git.tuebingen.mpg.de/?a=blobdiff_plain;f=afs.h;h=97bc03329e4c940d16428acea2291126eb6bb9bb;hb=0fa4e460a878fe80f937df5e1da31a33221e0ee0;hp=d6d0a86e2bdf2cbf51d72fa195e32cdab70bff3d;hpb=15151d60026dfe17cfaad02284d0abbb8b9389b2;p=paraslash.git

diff --git a/afs.h b/afs.h
index d6d0a86e..97bc0332 100644
--- a/afs.h
+++ b/afs.h
@@ -1,13 +1,26 @@
+/*
+ * Copyright (C) 2007 Andre Noll <maan@systemlinux.org>
+ *
+ * Licensed under the GPL v2. For licencing details see COPYING.
+ */
+
 #include <regex.h>
 #include "osl.h"
 #include "hash.h"
 
+/** Audio file selector data stored in the audio file table. */
 struct afs_info {
+	/** Seconds since the epoch. */
 	uint64_t last_played;
+	/** Bitfield of set attributes. */
 	uint64_t attributes;
+	/** Counts how many times the file was selected. */
 	uint32_t num_played;
+	/** Image blob associated with this file (foreign key). */
 	uint32_t image_id;
+	/** Lyrics blob associated with this file (foreign key). */
 	uint32_t lyrics_id;
+	/** Mp3, ogg or aac. */
 	uint8_t audio_format_id;
 };
 
@@ -15,67 +28,34 @@ enum afs_table_flags {TBLFLAG_SKIP_CREATE};
 
 struct table_info {
 	const struct osl_table_description *desc;
-	struct osl_table *table;
 	enum afs_table_flags flags;
 };
 
 enum ls_sorting_method {
-	LS_SORT_BY_PATH, /* -sp (default) */
-	LS_SORT_BY_SCORE, /* -ss */
-	LS_SORT_BY_LAST_PLAYED, /* -sl */
-	LS_SORT_BY_NUM_PLAYED, /* -sn */
-	LS_SORT_BY_FREQUENCY, /* -sf */
-	LS_SORT_BY_CHANNELS, /* -sc */
-	LS_SORT_BY_IMAGE_ID, /* -si */
-	LS_SORT_BY_LYRICS_ID, /* -sy */
-	LS_SORT_BY_BITRATE, /* -sb */
-	LS_SORT_BY_DURATION, /* -sd */
-	LS_SORT_BY_AUDIO_FORMAT, /* -sa */
-	LS_SORT_BY_HASH, /* -sh */
-};
-
-enum ls_listing_mode {
-	LS_MODE_SHORT,
-	LS_MODE_LONG,
-	LS_MODE_VERBOSE,
-	LS_MODE_MBOX
-};
-
-enum ls_flags {
-	LS_FLAG_FULL_PATH = 1,
-	LS_FLAG_ADMISSIBLE_ONLY = 2,
-	LS_FLAG_REVERSE = 4,
-};
-
-struct ls_widths {
-	unsigned short score_width;
-	unsigned short image_id_width;
-	unsigned short lyrics_id_width;
-	unsigned short bitrate_width;
-	unsigned short frequency_width;
-	unsigned short duration_width;
-	unsigned short num_played_width;
-};
-
-struct ls_data {
-	struct audio_format_info afhi;
-	struct afs_info afsi;
-	char *path;
-	long score;
-	HASH_TYPE *hash;
-};
-
-struct ls_options {
-	unsigned flags;
-	enum ls_sorting_method sorting;
-	enum ls_listing_mode mode;
-	char **patterns;
-	int num_patterns;
-	struct ls_widths widths;
-	uint32_t array_size;
-	uint32_t num_matching_paths;
-	struct ls_data *data;
-	struct ls_data **data_ptr;
+	/** -sp (default) */
+	LS_SORT_BY_PATH,
+	/** -ss */
+	LS_SORT_BY_SCORE,
+	/** -sl */
+	LS_SORT_BY_LAST_PLAYED,
+	/** -sn */
+	LS_SORT_BY_NUM_PLAYED,
+	/** -sf */
+	LS_SORT_BY_FREQUENCY,
+	/** -sc */
+	LS_SORT_BY_CHANNELS,
+	/** -si */
+	LS_SORT_BY_IMAGE_ID,
+	/** -sy */
+	LS_SORT_BY_LYRICS_ID,
+	/** -sb */
+	LS_SORT_BY_BITRATE,
+	/** -sd */
+	LS_SORT_BY_DURATION,
+	/** -sa */
+	LS_SORT_BY_AUDIO_FORMAT,
+	/** -sh */
+	LS_SORT_BY_HASH,
 };
 
 enum play_mode {PLAY_MODE_MOOD, PLAY_MODE_PLAYLIST};
@@ -140,11 +120,13 @@ int audio_file_loop(void *private_data, osl_rbtree_loop_func *func);
 int aft_check_callback(const struct osl_object *query, struct osl_object *result);
 
 /* mood */
-int mood_open(char *mood_name);
-void mood_close(void);
+int change_current_mood(char *mood_name);
+void close_current_mood(void);
 int mood_update_audio_file(const struct osl_row *aft_row, struct afs_info *old_afsi);
-int mood_reload(void);
+int reload_current_mood(void);
 int mood_delete_audio_file(const struct osl_row *aft_row);
+int mood_check_callback(__a_unused const struct osl_object *query,
+	struct osl_object *result);
 
 
 /* playlist */
@@ -162,6 +144,8 @@ int playlist_check_callback(__a_unused const struct osl_object *query,
 	int table_name ## _init(struct table_info *ti, const char *db); \
 	void table_name ## _shutdown(enum osl_close_flags flags); \
 	int cmd_prefix ## _get_name_by_id(uint32_t id, char **name); \
+	int cmd_prefix ## _get_name_and_def_by_row(const struct osl_row *row, \
+		char **name, struct osl_object *def); \
 	extern struct osl_table *table_name ## _table;
 
 DECLARE_BLOB_SYMBOLS(lyrics, lyr);
@@ -169,7 +153,18 @@ DECLARE_BLOB_SYMBOLS(images, img);
 DECLARE_BLOB_SYMBOLS(moods, mood);
 DECLARE_BLOB_SYMBOLS(playlists, pl);
 
-enum blob_table_columns {BLOBCOL_ID, BLOBCOL_NAME, BLOBCOL_DEF, NUM_BLOB_COLUMNS};
+/** The columns of an abstract blob table. */
+enum blob_table_columns {
+	/** The identifier, a positive integer that never repeats. */
+	BLOBCOL_ID,
+	/** The unique name of the blob. */
+	BLOBCOL_NAME,
+	/** The actual blob contents. */
+	BLOBCOL_DEF,
+	/** A blob table has that many columns. */
+	NUM_BLOB_COLUMNS
+};
+
 #define DEFINE_BLOB_TABLE_DESC(table_name) \
 	struct osl_table_description table_name ## _table_desc = { \
 		.name = #table_name, \