rockbox/lib/rbcodec/dsp/dsp_proc_entry.h
Michael Sevakis 56f17c4164 Make rbcodec/dsp includes more specific.
Change-Id: Idb6af40df26f5b8499a40e8b98602261ef227044
2012-04-29 17:31:30 -04:00

154 lines
5 KiB
C

/***************************************************************************
* __________ __ ___.
* Open \______ \ ____ ____ | | _\_ |__ _______ ___
* Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
* Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
* Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
* \/ \/ \/ \/ \/
* $Id$
*
* Copyright (C) 2012 Michael Sevakis
*
* 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 software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
* KIND, either express or implied.
*
****************************************************************************/
#ifndef DSP_PROC_ENTRY_H
#define DSP_PROC_ENTRY_H
#if 0 /* Set to '1' to enable local debug messages */
#include <debug.h>
#else
#undef DEBUGF
#define DEBUGF(...)
#endif
/* Macros to generate the right stuff */
#ifdef DSP_PROC_DB_CREATE
struct dsp_proc_db_entry;
#define DSP_PROC_DB_START
#define DSP_PROC_DB_ITEM(name) \
extern const struct dsp_proc_db_entry name##_proc_db_entry;
#define DSP_PROC_DB_STOP
/* Create database as externs to be able to build array */
#include "dsp_proc_database.h"
#define DSP_PROC_DB_START \
static struct dsp_proc_db_entry const * const dsp_proc_database[] = {
#define DSP_PROC_DB_ITEM(name) \
&name##_proc_db_entry,
#define DSP_PROC_DB_STOP };
/* Create database as array */
#include "dsp_proc_database.h"
/* Number of effects in database - all available in audio DSP */
#define DSP_NUM_PROC_STAGES ARRAYLEN(dsp_proc_database)
/* Number of possible effects for voice DSP */
#ifdef HAVE_SW_TONE_CONTROLS
#define DSP_VOICE_NUM_PROC_STAGES 2 /* resample, tone */
#else
#define DSP_VOICE_NUM_PROC_STAGES 1 /* resample */
#endif
#else /* !DSP_PROC_DB_CREATE */
#ifdef DEBUG
#define DSP_PROC_DB_ENTRY(_name, _configure) \
const struct dsp_proc_db_entry _name##_proc_db_entry = \
{ .id = DSP_PROC_##_name, .configure = _configure, \
.name = #_name };
#else /* !DEBUG */
#define DSP_PROC_DB_ENTRY(_name, _configure) \
const struct dsp_proc_db_entry _name##_proc_db_entry = \
{ .id = DSP_PROC_##_name, .configure = _configure };
#endif /* DEBUG */
#endif /* DSP_PROC_DB_CREATE */
#define DSP_PROC_DB_START \
enum dsp_proc_ids \
{ \
___DSP_PROC_ID_FIRST = -1,
#define DSP_PROC_DB_ITEM(name) \
DSP_PROC_##name,
#define DSP_PROC_DB_STOP };
/* Create database as enums for use as ids */
#include "dsp_proc_database.h"
struct dsp_proc_entry;
#include "dsp_core.h"
/* DSP sample transform function prototype */
typedef void (*dsp_proc_fn_type)(struct dsp_proc_entry *this,
struct dsp_buffer **buf);
/**
* dsp_proc_entry
* The structure allocated to every stage when enabled.
*
* default settings:
* .data = 0
* .ip_mask = BIT_N(dsp_proc_db_entry.id)
* .process[0] = dsp_process_null
* .process[1] = dsp_format_change_process
*
* DSP_PROC_INIT handler just has to change what it needs to change. It may
* also be modified at any time to implement the stage's demands.
*/
struct dsp_proc_entry
{
intptr_t data; /* 00h: any value, at beginning for easy asm use */
uint32_t ip_mask; /* In-place id bit (0 or id bit flag if in-place) */
dsp_proc_fn_type process[2]; /* Processing normal/format changes */
};
/* DSP transform configure function prototype */
typedef intptr_t (*dsp_proc_config_fn_type)(struct dsp_proc_entry *this,
struct dsp_config *dsp,
unsigned int setting,
intptr_t value);
/* Enable/disable a processing stage - not to be called during processing
* by processing code! */
void dsp_proc_enable(struct dsp_config *dsp, enum dsp_proc_ids id,
bool enable);
/* Activate/deactivate processing stage, doesn't affect enabled status
* thus will not enable anything -
* may be called during processing to activate/deactivate for format
* changes */
void dsp_proc_activate(struct dsp_config *dsp, enum dsp_proc_ids id,
bool activate);
/* Is the specified stage active on the DSP? */
bool dsp_proc_active(struct dsp_config *dsp, enum dsp_proc_ids id);
/* Call this->process[fmt] according to the rules
* pass (unsigned)-1 to call function 0 with no restriction */
bool dsp_proc_call(struct dsp_proc_entry *this, struct dsp_buffer **buf_p,
unsigned int fmt);
struct dsp_proc_db_entry
{
enum dsp_proc_ids id; /* id of this stage */
dsp_proc_config_fn_type configure; /* dsp_configure hook */
#ifdef DEBUG
const char *name;
#endif
};
#endif /* DSP_PROC_ENTRY_H */