xref: /haiku/src/add-ons/kernel/drivers/audio/echo/generic/CGina.h (revision f2b4344867e97c3f4e742a1b4a15e6879644601a)
1 // ****************************************************************************
2 //
3 //		CGina.H
4 //
5 //		Include file for interfacing with the CGina generic driver class
6 //		Set editor tabs to 3 for your viewing pleasure.
7 //
8 // ----------------------------------------------------------------------------
9 //
10 // This file is part of Echo Digital Audio's generic driver library.
11 // Copyright Echo Digital Audio Corporation (c) 1998 - 2005
12 // All rights reserved
13 // www.echoaudio.com
14 //
15 // This library is free software; you can redistribute it and/or
16 // modify it under the terms of the GNU Lesser General Public
17 // License as published by the Free Software Foundation; either
18 // version 2.1 of the License, or (at your option) any later version.
19 //
20 // This library is distributed in the hope that it will be useful,
21 // but WITHOUT ANY WARRANTY; without even the implied warranty of
22 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
23 // Lesser General Public License for more details.
24 //
25 // You should have received a copy of the GNU Lesser General Public
26 // License along with this library; if not, write to the Free Software
27 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
28 //
29 // ****************************************************************************
30 
31 //	Prevent problems with multiple includes
32 #ifndef _GINAOBJECT_
33 #define _GINAOBJECT_
34 
35 #include "CEchoGals.h"
36 #include "CGinaDspCommObject.h"
37 
38 //
39 //	Class used for interfacing with the Gina audio card.
40 //
41 class CGina : public CEchoGals
42 {
43 public:
44 	//
45 	//	Construction/destruction
46 	//
47 	CGina( PCOsSupport pOsSupport );
48 
49 	virtual ~CGina();
50 
51 	//
52 	// Setup & initialization methods
53 	//
54 
55 	virtual ECHOSTATUS InitHw();
56 
57 	//
58 	//	Adapter information methods
59 	//
60 	virtual ECHOSTATUS GetCapabilities
61 	(
62 		PECHOGALS_CAPS	pCapabilities
63 	);
64 
65 	//
66 	// Get a bitmask of all the clocks the hardware is currently detecting
67 	//
68 	virtual ECHOSTATUS GetInputClockDetect(DWORD &dwClockDetectBits);
69 
70 	//
71 	//	Audio Interface methods
72 	//
73 	virtual ECHOSTATUS QueryAudioSampleRate
74 	(
75 		DWORD		dwSampleRate
76 	);
77 
78 	virtual void QuerySampleRateRange(DWORD &dwMinRate,DWORD &dwMaxRate);
79 
80 	//
81 	//  Overload new & delete so memory for this object is allocated from non-paged memory.
82 	//
83 	PVOID operator new( size_t Size );
84 	VOID  operator delete( PVOID pVoid );
85 
86 protected:
87 	//
88 	//	Get access to the appropriate DSP comm object
89 	//
90 	PCGinaDspCommObject GetDspCommObject()
91 		{ return( (PCGinaDspCommObject) m_pDspCommObject ); }
92 };		// class CGina
93 
94 typedef CGina * PCGina;
95 
96 #endif
97 
98 // *** CGina.H ***
99