root/trunk/libffado/src/libstreaming/digidesign/DigidesignPortInfo.h

Revision 2803, 2.0 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, 2011 by Jonathan Woithe
3  * Copyright (C) 2005-2008 by Pieter Palmers
4  *
5  * This file is part of FFADO
6  * FFADO = Free FireWire (pro-)audio drivers for Linux
7  *
8  * FFADO is based upon FreeBoB.
9  *
10  * This program is free software: you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation, either version 2 of the License, or
13  * (at your option) version 3 of the License.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
22  *
23  */
24
25 #ifndef __FFADO_DIGIDESIGNPORTINFO__
26 #define __FFADO_DIGIDESIGNPORTINFO__
27
28 #include "debugmodule/debugmodule.h"
29 #include <string>
30
31 namespace Streaming {
32 /*!
33 \brief Class containing the stream information for a Digidesign channel
34
35  Contains the information that enables the decoding routine to find
36  this port's data in the ISO events
37
38 */
39 class DigidesignPortInfo {
40
41 public:
42     /**
43      * Initialize Digidesign portinfo
44      * should not be called directly, is inherited by digidesign ports
45      *
46      * the position parameter is an example
47      * the name parameter is mandatory
48      *
49      * @param position Start position of port's data in iso event
50      * @param format Format of data in iso event
51      * @param size Size in bits of port's data in iso event
52      * @return
53      */
54     DigidesignPortInfo( int position, int size)
55       : m_position(position), m_size(size)
56     {};
57     virtual ~DigidesignPortInfo() {};
58
59
60     int getPosition()     {return m_position;};
61     int getSize()         {return m_size;};
62
63 protected:
64
65     int m_position;
66     int m_size;
67
68 };
69
70 } // end of namespace Streaming
71
72 #endif /* __FFADO_DIGIDESIGNPORTINFO__ */
Note: See TracBrowser for help on using the browser.