root/trunk/libffado/src/libstreaming/amdtp/AmdtpPortInfo.h

Revision 2803, 2.3 kB (checked in by jwoithe, 3 years ago)

Cosmetic: capitalise "L" in "Linux".

"Linux" is a proper noun so it should start with a capital letter. These
changes are almost all within comments.

This patch was originally proposed by pander on the ffado-devel mailing
list. It has been expanded to cover all similar cases to maintain
consistency throughout the source tree.

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 __FFADO_AMDTPPORTINFO__
25 #define __FFADO_AMDTPPORTINFO__
26
27 #include "debugmodule/debugmodule.h"
28 #include <string>
29
30 namespace Streaming {
31 /*!
32 \brief Class containing the stream information for an AMDTP channel
33
34  Contains the information that maps the port to an AMDTP stream position (i.e. channel)
35  this allows the AMDTP stream demultiplexer to find the channel associated
36  to this port.
37
38 */
39 class AmdtpPortInfo {
40
41 public:
42     /**
43      * Sometimes a channel can have multiple formats, depending on the
44      * device configuration (e.g. an SPDIF port could be plain audio in 24bit integer
45      * or AC3 passthrough in IEC compliant frames.)
46      *
47      * This kind of enum allows to discriminate these formats when decoding
48      * If all channels always have the same format, you won't be needing this
49      */
50     enum E_Formats {
51         E_MBLA, ///< multibit linear audio
52         E_Midi, ///< midi
53         E_SPDIF,///< IEC.... format
54     };
55
56     AmdtpPortInfo( int position, int location, enum E_Formats format)
57       : m_position(position), m_location(location), m_format(format)
58     {};
59     virtual ~AmdtpPortInfo() {};
60
61
62     unsigned int getLocation()     {return m_location;};
63     unsigned int getPosition()     {return m_position;};
64     enum E_Formats getFormat()       {return m_format;};
65
66 protected:
67     unsigned int m_position;
68     unsigned int m_location;
69     enum E_Formats m_format;
70
71 };
72
73 } // end of namespace Streaming
74
75 #endif /* __FFADO_AMDTPPORTINFO__ */
Note: See TracBrowser for help on using the browser.