root/branches/libfreebob-2.0/src/libfreebobavc/avc_definitions.h

Revision 245, 3.2 kB (checked in by pieterpalmers, 18 years ago)

- added doxygen documentation to the make process
- wrote some preliminary documentation

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
1 /* avc_definitions.h
2  * Copyright (C) 2005 by Daniel Wagner
3  *
4  * This file is part of FreeBob.
5  *
6  * FreeBob is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  * FreeBob is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with FreeBob; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
18  * MA 02111-1307 USA.
19  */
20
21 #ifndef AVCDefinitions_h
22 #define AVCDefinitions_h
23
24 #include <libavc1394/avc1394.h>
25 #include <ostream>
26
27 typedef byte_t ctype_t;
28 typedef byte_t unit_t;
29 typedef byte_t unit_type_t;
30 typedef byte_t subunit_t;
31 typedef byte_t opcode_t;
32 typedef byte_t plug_type_t;
33 typedef byte_t plug_id_t;
34 typedef byte_t reserved_t;
35 typedef byte_t function_block_type_t;
36 typedef byte_t function_block_id_t;
37 typedef byte_t plug_direction_t;
38 typedef byte_t plug_address_mode_t;
39 typedef byte_t status_t;
40 typedef byte_t number_of_channels_t;
41 typedef byte_t stream_format_t;
42 typedef byte_t sampling_frequency_t;
43 typedef byte_t rate_control_t;
44 typedef byte_t number_of_stream_format_infos_t;
45 typedef byte_t nr_of_plugs_t;
46 typedef byte_t subunit_id_t;
47 typedef byte_t subfunction_t;
48 typedef byte_t opcode_t;
49 typedef byte_t page_t;
50 typedef byte_t extension_code_t;
51 typedef byte_t subunit_type_t;
52 typedef byte_t max_subunit_id_t;
53 typedef byte_t nr_of_channels_t;
54 typedef byte_t stream_position_t;
55 typedef byte_t stream_position_location_t;
56 typedef byte_t nr_of_clusters_t;
57 typedef byte_t string_length_t;
58 typedef byte_t cluster_index_t;
59 typedef byte_t port_type_t;
60 typedef byte_t number_of_output_plugs_t;
61 typedef byte_t function_block_type_t;
62 typedef byte_t function_block_id_t;
63 typedef byte_t function_block_special_purpose_t;
64 typedef byte_t no_of_input_plugs_t;
65 typedef byte_t no_of_output_plugs_t;
66 typedef byte_t info_type_t;
67
68 typedef quadlet_t company_id_t;
69
70 /**
71  * \brief the possible sampling frequencies
72  */
73 enum ESamplingFrequency {
74     eSF_22050Hz = 0x00,
75     eSF_24000Hz = 0x01,
76     eSF_32000Hz = 0x02,
77     eSF_44100Hz = 0x03,
78     eSF_48000Hz = 0x04,
79     eSF_88200Hz = 0x0A,
80     eSF_96000Hz = 0x05,
81     eSF_176400Hz = 0x06,
82     eSF_192000Hz = 0x07,
83     eSF_DontCare = 0x0F,
84 };
85
86 /**
87  * \brief Convert from ESamplingFrequency to an integer
88  * @param freq
89  * @return
90  */
91 int convertESamplingFrequency(ESamplingFrequency freq);
92 /**
93  * \brief Convert from integer to ESamplingFrequency
94  * @param sampleRate
95  * @return
96  */
97 ESamplingFrequency parseSampleRate( int sampleRate );
98
99 std::ostream& operator<<( std::ostream& stream, ESamplingFrequency samplingFrequency );
100
101 #define AVC1394_SUBUNIT_AUDIO 1
102 #define AVC1394_SUBUNIT_PRINTER 2
103 #define AVC1394_SUBUNIT_CA 6
104 #define AVC1394_SUBUNIT_PANEL 9
105 #define AVC1394_SUBUNIT_BULLETIN_BOARD 0xA
106 #define AVC1394_SUBUNIT_CAMERA_STORAGE 0xB
107 #define AVC1394_SUBUNIT_MUSIC 0xC
108 #define AVC1394_SUBUNIT_RESERVED 0x1D
109
110 #define AVC1394_SUBUNIT_ID_RESERVED 0x06
111
112 #endif // AVCDefinitions_h
Note: See TracBrowser for help on using the browser.