1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
/* Copyright (c) 2012 The Chromium OS Authors. All rights reserved.
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*/
#ifndef CRAS_DSP_MODULE_H_
#define CRAS_DSP_MODULE_H_
#ifdef __cplusplus
extern "C" {
#endif
#include "cras_dsp_ini.h"
#define MAX_EXT_DSP_PORTS 8
/* Holds the functions we can use on a dsp module. */
struct dsp_module {
/* Opaque data used by the implementation of this module */
void *data;
/* Initializes the module for a given sampling rate. To change
* the sampling rate, deinstantiate() must be called before
* calling instantiate again.
* Args:
* sample_rate - The sampling rate for the audio data, like 44100.
* Returns:
* 0 if the initialization is successful. -1 otherwise.
*/
int (*instantiate)(struct dsp_module *mod, unsigned long sample_rate);
/* Assigns the memory location for a port of this module.
* Args:
* port - The index of the port.
* data_location - The memory address of the data for this port.
*/
void (*connect_port)(struct dsp_module *mod, unsigned long port,
float *data_location);
/* Returns the buffering delay of this module. This should be called
* only after all input control ports have been connected.
* Returns:
* The buffering delay in frames. The value returned should only be
* based on the sampling rate and the input control ports values and not
* the audio data itself.
*/
int (*get_delay)(struct dsp_module *mod);
/* Processes a block of samples using this module. The memory
* location for the input and output data are assigned by the
* connect_port() call.
* Args:
* sample_count - The number of samples to be processed.
*/
void (*run)(struct dsp_module *mod, unsigned long sample_count);
/* Free resources used by the module. This module can be used
* again by calling instantiate() */
void (*deinstantiate)(struct dsp_module *mod);
/* Frees all resources used by this module. After calling
* free_module(), this struct dsp_module cannot be used
* anymore.
*/
void (*free_module)(struct dsp_module *mod);
/* Returns special properties of this module, see the enum
* below for details */
int (*get_properties)(struct dsp_module *mod);
/* Dumps the information about current state of this module */
void (*dump)(struct dsp_module *mod, struct dumper *d);
};
/* An external module interface working with existing dsp pipeline.
* __________ ___________ ____________ __________
* | | | | | | | |
* | |->| dsp mod |-> ...->| dsp mod | ---> | |
* | device | |_________| |__________| | stream |
* | | | ___________ | |
* | | | | ext | | |
* | | ->| dsp mod | -> | |
* |________| |_________| |________|
*
* According to above diagram, an ext_dsp_module works by appending to
* the sink of existing dsp pipeline. For audio input, this creates a
* multiple output pipeline that stream can read processed buffer from.
* This is useful for a stream to apply special processing effects while
* sharing the common dsp with the other streams.
*
* Members:
* ports - A list of ports can connect to existing dsp ports in a pipeline.
* run - Processes |nframes| of data.
* configure - Configures given external dsp module by the device buffer
* size, rate, and number of channels of the format of the device that
* the associated pipeline runs for.
*/
struct ext_dsp_module {
float *ports[MAX_EXT_DSP_PORTS];
void (*run)(struct ext_dsp_module *ext, unsigned int nframes);
void (*configure)(struct ext_dsp_module *ext, unsigned int buffer_size,
unsigned int num_channels, unsigned int rate);
};
enum { MODULE_INPLACE_BROKEN = 1 }; /* See ladspa.h for explanation */
/* Connects an external dsp module to a builtin sink module. */
void cras_dsp_module_set_sink_ext_module(struct dsp_module *module,
struct ext_dsp_module *ext_module);
struct dsp_module *cras_dsp_module_load_ladspa(struct plugin *plugin);
struct dsp_module *cras_dsp_module_load_builtin(struct plugin *plugin);
#ifdef __cplusplus
} /* extern "C" */
#endif
#endif /* CRAS_DSP_MODULE_H_ */
|
