/*
- * Copyright (C) 2007 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2007-2014 Andre Noll <maan@systemlinux.org>
*
* Licensed under the GPL v2. For licencing details see COPYING.
*/
/** \file afs.h Exported symbols of the audio file selector. */
#include <regex.h>
-#include "osl.h"
-#include "hash.h"
/** Audio file selector data stored in the audio file table. */
struct afs_info {
uint32_t image_id;
/** Lyrics blob associated with this file (foreign key). */
uint32_t lyrics_id;
- /** Mp3, ogg or aac. */
+ /** Mp3, ogg, ... */
uint8_t audio_format_id;
+ /** Amplification value. */
+ uint8_t amp;
};
/**
BLOB_REMOVE,
};
+/**
+ * Used as data for \ref afs_event() for events of type \p ATTRIBUTE_ADD.
+ */
struct rmatt_event_data {
+ /** The name of the attribute being added. */
const char *name;
+ /** Its bit number. */
unsigned char bitnum;
};
-
+/**
+ * Used as data for \ref afs_event() for events of type \p ATTRIBUTE_AFSI_CHANGE.
+ */
struct afsi_change_event_data {
- const struct osl_row *aft_row;
+ /** Pointer to the row that has changed. */
+ struct osl_row *aft_row;
+ /** Afs info before the change. */
struct afs_info *old_afsi;
};
/** Handles afs events. */
int (*event_handler)(enum afs_events event, struct para_buffer *pb,
void *data);
- /* int *(check)() */
};
-enum play_mode {PLAY_MODE_MOOD, PLAY_MODE_PLAYLIST};
+/** How audio files are selected by afs. */
+enum play_mode {
+ /** Admissible files are determined by a mood definition. */
+ PLAY_MODE_MOOD,
+ /** All listed files are admissible. */
+ PLAY_MODE_PLAYLIST,
+};
/**
* Data about one audio file.
char *path;
/** The score value (if -a was given). */
long score;
- /** The sha1 hash of audio file. */
- HASH_TYPE *hash;
+ /** The hash value of audio file data. */
+ unsigned char *hash;
};
-int make_status_items(struct ls_data *d, struct para_buffer *pb);
-
-#define VERBOSE_LS_OUTPUT_SIZE 4096
-/*
- * Data about the current audio file, passed from afs to server.
- */
+/** Data about the current audio file, passed from afs to server. */
struct audio_file_data {
- /* Same info as ls -lv -p <current audio file>. */
- char verbose_ls_output[VERBOSE_LS_OUTPUT_SIZE];
- /* The open file descriptor to the current audio file. */
+ /** The open file descriptor to the current audio file. */
int fd;
- /* Vss needs this for streaming. */
+ /** Vss needs this for streaming. */
struct afh_info afhi;
+ /** Size of the largest chunk. */
+ uint32_t max_chunk_size;
+ /** Needed to get the audio file header. */
+ uint8_t audio_format_id;
};
+/**
+ * Codes used for communication between the server and the afs process.
+ *
+ * Before forking the afs child, para_server creates a bidirectional pipe
+ * through which both processes communicate. Usually para_server requests a new
+ * audio in order to start streaming or when the end of the current audio file
+ * has been reached. The afs process responds to such a request by sending
+ * back an eight byte buffer. The first four bytes is the uint32_t
+ * representation of the code, usually \p NEXT_AUDIO_FILE if an admissible
+ * audio file was found, successfully opened and verified. The other four bytes
+ * represent the shared memory id of the shared memory area that contains
+ * details about the audio file to be streamed next. The open file descriptor
+ * of that file is also passed from afs to para_server through the same pipe.
+ */
enum afs_server_code {
+ /** An audio file was successfully opened. */
NEXT_AUDIO_FILE,
- AFD_CHANGE
+ /** No admissible audio file was found. */
+ NO_ADMISSIBLE_FILES,
};
/** Flags passed to for_each_matching_row(). */
struct osl_object patterns;
/** Data pointer passed to the action function. */
void *data;
+ /** Gets increased by one for each match. */
+ unsigned num_matches;
/** For each matching row, this function will be called. */
int (*action)(struct osl_table *table, struct osl_row *row, const char *name, void *data);
};
-/* afs */
-typedef int callback_function(const struct osl_object *, struct osl_object *);
+
+/**
+ * Afs command handlers run as a process which is not related to the afs
+ * process, i.e. they can not change the address space of afs directly.
+ * Therefore afs commands typically consist of two functions: The command
+ * handler and the corresponding callback function that runs in afs context.
+ *
+ * \sa send_callback_request().
+ */
+typedef void callback_function(int fd, const struct osl_object *);
+
+/**
+ * Callbacks send chunks to data back to the command handler. Pointers to
+ * this type of function are used by \ref send_callback_request and friends
+ * to deal with the data in the command handler process.
+ *
+ * \sa \ref send_callback_request().
+ */
+typedef int callback_result_handler(struct osl_object *result, uint8_t band, void *private);
+int afs_cb_result_handler(struct osl_object *result, uint8_t band, void *private);
+int pass_buffer_as_shm(int fd, uint8_t band, const char *buf, size_t size);
+
+/** Structure passed to the AFS max_size handler. */
+struct afs_max_size_handler_data {
+ /** Local socket connecting the command handler and the AFS process. */
+ int fd;
+ /** The sideband designator for this data packet. */
+ uint8_t band;
+};
+
+/**
+ * Standard max_size handler for AFS commands.
+ *
+ * \param buf Contains (part of) the AFS command output.
+ * \param size The number of bytes in \a buf.
+ * \param private Pointer to a \ref afs_max_size_handler_data structure.
+ *
+ * Whenever the output of an AFS command exceeds the maximal size of a shared
+ * memory area, the max size handler of the para_buffer which holds the command
+ * output is called with \a private being a pointer to a structure of type
+ * afs_max_size_handler_data.
+ *
+ * \return The return value of the underlying call to \ref
+ * pass_buffer_as_shm().
+ */
+_static_inline_ int afs_max_size_handler(char *buf, size_t size, void *private)
+{
+ struct afs_max_size_handler_data *amshd = private;
+ return pass_buffer_as_shm(amshd->fd, amshd->band, buf, size);
+}
+
__noreturn void afs_init(uint32_t cookie, int socket_fd);
void afs_event(enum afs_events event, struct para_buffer *pb,
void *data);
int send_callback_request(callback_function *f, struct osl_object *query,
- struct osl_object *result);
-int send_standard_callback_request(int argc, char * const * const argv,
- callback_function *f, struct osl_object *result);
+ callback_result_handler *result_handler,
+ void *private_result_data);
int send_option_arg_callback_request(struct osl_object *options,
- int argc, char * const * const argv, callback_function *f,
- struct osl_object *result);
-int stdin_command(int fd, struct osl_object *arg_obj, callback_function *f,
- unsigned max_len, struct osl_object *result);
+ int argc, char * const * const argv, callback_function *f,
+ callback_result_handler *result_handler,
+ void *private_result_data);
+int send_standard_callback_request(int argc, char * const * const argv,
+ callback_function *f, callback_result_handler *result_handler,
+ void *private_result_data);
int string_compare(const struct osl_object *obj1, const struct osl_object *obj2);
-int close_audio_file(struct audio_file_data *afd);
int for_each_matching_row(struct pattern_match_data *pmd);
/* score */
/* aft */
void aft_init(struct afs_table *t);
int aft_get_row_of_path(const char *path, struct osl_row **row);
-int open_and_update_audio_file(struct osl_row *aft_row,
- struct audio_file_data *afd, long score);
+int open_and_update_audio_file(struct osl_row *aft_row, long score,
+ struct audio_file_data *afd);
int load_afd(int shmid, struct audio_file_data *afd);
-int load_afsi(struct afs_info *afsi, struct osl_object *obj);
-void save_afsi(struct afs_info *afsi, struct osl_object *obj);
int get_afsi_of_row(const struct osl_row *row, struct afs_info *afsi);
int get_afhi_of_row(const struct osl_row *row, struct afh_info *afhi);
-int get_afsi_of_path(const char *path, struct afs_info *afsi);
int get_audio_file_path_of_row(const struct osl_row *row, char **path);
-int get_afsi_object_of_row(const struct osl_row *row, struct osl_object *obj);
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 change_current_mood(char *mood_name);
-void close_current_mood(void);
-int reload_current_mood(void);
-int mood_check_callback(__a_unused const struct osl_object *query,
- struct osl_object *result);
-
+void aft_check_callback(int fd, __a_unused const struct osl_object *query);
/* playlist */
int playlist_open(char *name);
void playlist_close(void);
-int playlist_check_callback(__a_unused const struct osl_object *query,
- struct osl_object *result);
+void playlist_check_callback(int fd, __a_unused const struct osl_object *query);
/** evaluates to 1 if x < y, to -1 if x > y and to 0 if x == y */
#define NUM_COMPARE(x, y) ((int)((x) < (y)) - (int)((x) > (y)))
/** A blob table has that many columns. */
NUM_BLOB_COLUMNS
};
-
-/** Define an osl table decription for a blob table. */
-#define DEFINE_BLOB_TABLE_DESC(table_name) \
- struct osl_table_description table_name ## _table_desc = { \
- .name = #table_name, \
- .num_columns = NUM_BLOB_COLUMNS, \
- .flags = OSL_LARGE_TABLE, \
- .column_descriptions = blob_cols \
- };
-
-/** Define a pointer to an osl blob table with a canonical name. */
-#define DEFINE_BLOB_TABLE_PTR(table_name) struct osl_table *table_name ## _table;
-
-/** Define a blob table. */
-#define INIT_BLOB_TABLE(table_name) \
- DEFINE_BLOB_TABLE_DESC(table_name); \
- DEFINE_BLOB_TABLE_PTR(table_name);
-
projects / paraslash.git / blobdiff