root/branches/libfreebob-2.0/src/libstreaming/MotuPortInfo.h

Revision 265, 2.6 kB (checked in by jwoithe, 16 years ago)

Start adding detail in MOTU port infrastructure.
Clean up some "signed/unsigned comparison" compiler warnings.

Line 
1 /* $Id$ */
2
3 /*
4  *   FreeBob Streaming API
5  *   FreeBob = Firewire (pro-)audio for linux
6  *
7  *   http://freebob.sf.net
8  *
9  *   Copyright (C) 2005,2006 Pieter Palmers <pieterpalmers@users.sourceforge.net>
10  *
11  *   This program is free software {} you can redistribute it and/or modify
12  *   it under the terms of the GNU General Public License as published by
13  *   the Free Software Foundation {} either version 2 of the License, or
14  *   (at your option) any later version.
15  *
16  *   This program is distributed in the hope that it will be useful,
17  *   but WITHOUT ANY WARRANTY {} without even the implied warranty of
18  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  *   GNU General Public License for more details.
20  *
21  *   You should have received a copy of the GNU General Public License
22  *   along with this program {} if not, write to the Free Software
23  *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24  *
25  *
26  *
27  */
28 #ifndef __FREEBOB_MOTUPORTINFO__
29 #define __FREEBOB_MOTUPORTINFO__
30
31 #include "../debugmodule/debugmodule.h"
32 #include <string>
33
34 namespace FreebobStreaming {
35 /*!
36 \brief Class containing the stream information for a Motu channel
37
38  Contains the information that enables the decoding routine to find
39  this port's data in the ISO events
40
41 */
42 class MotuPortInfo {
43
44 public:
45     /**
46      * Sometimes a channel can have multiple formats, depending on the
47      * device configuration (e.g. an SPDIF port could be plain audio in 24bit integer
48      * or AC3 passthrough in IEC compliant frames.)
49      *
50      * This kind of enum allows to discriminate these formats when decoding
51      * If all channels always have the same format, you won't be needing this
52      */
53 //      enum E_Formats {
54 //              E_MBLA,     // Multibit linear audio
55 //              E_Midi,     // MIDI
56 //      };
57    
58         /**
59          * Initialize Motu portinfo
60          * should not be called directly, is inherited by motu ports
61          *
62          * the position parameter is an example
63          * the name parameter is mandatory
64          *
65          * @param name Port name
66          * @param position Start position of port's data in iso event
67          * @param format Format of data in iso event
68          * @param size Size in bits of port's data in iso event
69          * @return
70          */
71         MotuPortInfo(std::string name, int position, int size)
72           : m_name(name), m_position(position), m_size(size)
73         {};
74         virtual ~MotuPortInfo() {};
75
76
77         std::string getName() {return m_name;};
78         int getPosition()     {return m_position;};
79         int getSize()         {return m_size;};
80
81 protected:
82     std::string m_name;
83
84     int m_position;
85     int m_size;
86
87 };
88
89 } // end of namespace FreebobStreaming
90
91 #endif /* __FREEBOB_MOTUPORTINFO__ */
92
93
Note: See TracBrowser for help on using the browser.