root/trunk/libffado/src/libcontrol/MatrixMixer.h

Revision 1742, 2.9 kB (checked in by arnonym, 11 years ago)

Extend the interface of the MatrixMixer?:

  • Have booleans indicating if names and/or connections are supported. These functions are pure virtual.
  • Allow names and connections to be read and written, the default implementations of these (not anymore pure) virtual functions do nothing and return false or nothing.
Line 
1 /*
2  * Copyright (C) 2005-2008 by Pieter Palmers
3  *
4  * This file is part of FFADO
5  * FFADO = Free Firewire (pro-)audio drivers for linux
6  *
7  * FFADO is based upon FreeBoB
8  *
9  * This program is free software: you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation, either version 2 of the License, or
12  * (at your option) version 3 of the License.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
21  *
22  */
23
24 #ifndef CONTROL_MATRIX_MIXER_H
25 #define CONTROL_MATRIX_MIXER_H
26
27 #include "debugmodule/debugmodule.h"
28
29 #include "Element.h"
30
31 #include <vector>
32 #include <string>
33
34 namespace Control {
35
36 /*!
37 @brief Abstract Base class for Matrix Mixer elements
38
39 */
40 class MatrixMixer : public Element
41 {
42 public:
43     MatrixMixer(Element *p) : Element(p) {};
44     MatrixMixer(Element *p, std::string n) : Element(p, n) {};
45     virtual ~MatrixMixer() {};
46
47     virtual void show() = 0;
48
49     /*!
50       @{
51       @brief general dimensions
52       */
53     virtual int getRowCount() = 0;
54     virtual int getColCount() = 0;
55     // @}
56
57     /*!
58       @{
59       @brief per-coefficient access
60       */
61     virtual int canWrite(const int, const int) = 0;
62     virtual double setValue(const int, const int, const double) = 0;
63     virtual double getValue(const int, const int) = 0;
64     // @}
65
66     /*!
67       @{
68       @brief functions to access the entire coefficient map at once
69       */
70     virtual bool getCoefficientMap(int &) = 0;
71     virtual bool storeCoefficientMap(int &) = 0;
72     // @}
73
74     /*!
75       @{
76       @brief names for the channels
77
78       If named channels are not supported, just implement hasNames() to return false
79
80       The default implementations do nothing
81       */
82     virtual bool hasNames() const = 0;
83     virtual std::string getRowName(const int);
84     virtual std::string getColName(const int);
85     virtual bool setRowName(const int row, const std::string& name);
86     virtual bool setColName(const int col, const std::string& name);
87     // @}
88
89     /*!
90       @{
91       @brief connections for channels
92
93       If connections are not supported, implement canConnect() to return false.
94
95       The default implementations do nothing.
96       */
97     virtual bool canConnect() const = 0;
98     virtual std::vector<std::string> availableConnectionsForRow(const int);
99     virtual std::vector<std::string> availableConnectionsForCol(const int);
100     virtual bool connectRowTo(const int row, const std::string& target);
101     virtual bool connectColTo(const int col, const std::string& target);
102     // @}
103
104 protected:
105
106 };
107
108
109 }; // namespace Control
110
111 #endif // CONTROL_MATRIX_MIXER_H
Note: See TracBrowser for help on using the browser.