// **************************************************************************** // // EchoGalsXface.H // // Include file for interfacing with the CEchoGals generic driver class. // // Set editor tabs to 3 for your viewing pleasure. // // ---------------------------------------------------------------------------- // // This file is part of Echo Digital Audio's generic driver library. // Copyright Echo Digital Audio Corporation (c) 1998 - 2005 // All rights reserved // www.echoaudio.com // // This library is free software; you can redistribute it and/or // modify it under the terms of the GNU Lesser General Public // License as published by the Free Software Foundation; either // version 2.1 of the License, or (at your option) any later version. // // This library is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU // Lesser General Public License for more details. // // You should have received a copy of the GNU Lesser General Public // License along with this library; if not, write to the Free Software // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA // // **************************************************************************** /* Here's a block diagram of how most of the cards work: +-----------+ record | |<-------------------- Inputs <-------| | | PCI | Transport | | bus | engine | \|/ ------->| | +-------+ play | |--->|monitor|-------> Outputs +-----------+ | mixer | +-------+ The lines going to and from the PCI bus represent "pipes". A pipe performs audio transport - moving audio data to and from buffers on the host via bus mastering. The inputs and outputs on the right represent input and output "busses." A bus is a physical, real connection to the outside world. An example of a bus would be the 1/4" analog connectors on the back of Layla or an RCA S/PDIF connector. For most cards, there is a one-to-one correspondence between outputs and busses; that is, each individual pipe is hard-wired to a single bus. Cards that work this way are Darla20, Gina20, Layla20, Darla24, Gina24, Layla24, Mona, Indigo, Indigo io, and Indigo dj. Mia has a feature called "virtual outputs." +-----------+ record | |<----------------------------- Inputs <-------| | | PCI | Transport | | bus | engine | \|/ ------->| | +------+ +-------+ play | |-->|vmixer|-->|monitor|-------> Outputs +-----------+ +------+ | mixer | +-------+ Obviously, the difference here is the box labeled "vmixer." Vmixer is short for "virtual output mixer." For Mia, pipes are *not* hard-wired to a single bus; the vmixer lets you mix any pipe to any bus in any combination. Note, however, that the left-hand side of the diagram is unchanged. Transport works exactly the same way - the difference is in the mixer stage. Pipes and busses are numbered starting at zero. Pipe index ========== A number of calls in CEchoGals refer to a "pipe index". A pipe index is a unique number for a pipe that unambiguously refers to a playback or record pipe. Pipe indices are numbered starting with analog outputs, followed by digital outputs, then analog inputs, then digital inputs. Take Gina24 as an example: Pipe index 0-7 Analog outputs 8-15 Digital outputs 16-17 Analog inputs 18-25 Digital inputs You get the pipe index by calling CEchoGals::OpenAudio; the other transport functions take the pipe index as a parameter. If you need a pipe index for some other reason, use the handy MakePipeIndex method. Some calls take a CChannelMask parameter; CChannelMask is a handy way to group pipe indices. Digital mode switch =================== Some cards (right now, Gina24, Layla24, and Mona) have a Digital Mode Switch or DMS. Cards with a DMS can be set to one of three mutually exclusive digital modes: S/PDIF RCA, S/PDIF optical, or ADAT optical. This may create some confusion since ADAT optical is 8 channels wide and S/PDIF is only two channels wide. Gina24, Layla24, and Mona handle this by acting as if they always have 8 digital outs and ins. If you are in either S/PDIF mode, the last 6 channels don't do anything - data sent out these channels is thrown away and you will always record zeros. Note that with Gina24, Layla24, and Mona, sample rates above 50 kHz are only available if you have the card configured for S/PDIF optical or S/PDIF RCA. Double speed mode ================= Some of the cards support 88.2 kHz and 96 kHz sampling (Darla24, Gina24, Layla24, Mona, Mia, and Indigo). For these cards, the driver sometimes has to worry about "double speed mode"; double speed mode applies whenever the sampling rate is above 50 kHz. For instance, Mona and Layla24 support word clock sync. However, they actually support two different word clock modes - single speed (below 50 kHz) and double speed (above 50 kHz). The hardware detects if a single or double speed word clock signal is present; the generic code uses that information to determine which mode to use. The generic code takes care of all this for you. For hardware that supports 176.4 and 192 kHz, there is a corresponding quad speed mode. */ // Prevent problems with multiple includes #ifndef _ECHOGALSXFACE_ #define _ECHOGALSXFACE_ //*********************************************************************** // // PCI configuration space // //*********************************************************************** // // PCI vendor ID and device IDs for the hardware // #define VENDOR_ID 0x1057 #define DEVICE_ID_56301 0x1801 #define DEVICE_ID_56361 0x3410 #define SUBVENDOR_ID ((ULONG)0xECC0) // // Valid Echo PCI subsystem card IDs // #define DARLA 0x0010 #define GINA 0x0020 #define LAYLA 0x0030 #define DARLA24 0x0040 #define GINA24 0x0050 #define LAYLA24 0x0060 #define MONA 0x0070 #define MIA 0x0080 #define INDIGO 0x0090 #define INDIGO_IO 0x00a0 #define INDIGO_DJ 0x00b0 #define DC8 0x00c0 #define ECHO3G 0x0100 #define BASEPCI 0xfff0 //*********************************************************************** // // Array sizes and so forth // //*********************************************************************** // // Sizes // #define ECHO_MAXNAMELEN 128 // Max card name length // (includes 0 terminator) #define ECHO_MAXAUDIOINPUTS 32 // Max audio input channels #define ECHO_MAXAUDIOOUTPUTS 32 // Max audio output channels #define ECHO_MAXAUDIOPIPES 32 // Max number of input and output pipes #define ECHO_MAXMIDIJACKS 1 // Max MIDI ports #define ECHO_MTC_QUEUE_SZ 32 // Max MIDI time code input queue entries // // MIDI activity indicator timeout // #define MIDI_ACTIVITY_TIMEOUT_USEC 200000 //***************************************************************************** // // Clocks // //***************************************************************************** // // Clock numbers // #define ECHO_CLOCK_INTERNAL 0 #define ECHO_CLOCK_WORD 1 #define ECHO_CLOCK_SUPER 2 #define ECHO_CLOCK_SPDIF 3 #define ECHO_CLOCK_ADAT 4 #define ECHO_CLOCK_ESYNC 5 #define ECHO_CLOCK_ESYNC96 6 #define ECHO_CLOCK_MTC 7 #define ECHO_CLOCK_NONE 0xffff // // Clock bit numbers - used to report capabilities and whatever clocks // are being detected dynamically. // #define ECHO_CLOCK_BIT_INTERNAL (1<