]> rtime.felk.cvut.cz Git - v4l-streaming.git/blob - doc/latex/camv4l_8h.tex
Initial commit
[v4l-streaming.git] / doc / latex / camv4l_8h.tex
1 \section{camv4l.h File Reference}
2 \label{camv4l_8h}\index{camv4l.h@{camv4l.h}}
3 {\tt \#include $<$stdio.h$>$}\par
4 {\tt \#include $<$unistd.h$>$}\par
5 {\tt \#include $<$stdlib.h$>$}\par
6 {\tt \#include $<$string.h$>$}\par
7 {\tt \#include $<$fcntl.h$>$}\par
8 {\tt \#include $<$signal.h$>$}\par
9 {\tt \#include $<$errno.h$>$}\par
10 {\tt \#include $<$time.h$>$}\par
11 {\tt \#include $<$math.h$>$}\par
12 {\tt \#include $<$stdarg.h$>$}\par
13 {\tt \#include $<$linux/types.h$>$}\par
14 {\tt \#include $<$linux/videodev.h$>$}\par
15 {\tt \#include $<$sys/mman.h$>$}\par
16 {\tt \#include $<$sys/ioctl.h$>$}\par
17 {\tt \#include $<$sys/file.h$>$}\par
18 {\tt \#include $<$sys/types.h$>$}\par
19 {\tt \#include $<$sys/stat.h$>$}\par
20
21
22 Include dependency graph for camv4l.h:
23
24 This graph shows which files directly or indirectly include this file:\subsection*{Data Structures}
25 \begin{CompactItemize}
26 \item 
27 struct {\bf vd\-In}
28 \end{CompactItemize}
29 \subsection*{Defines}
30 \begin{CompactItemize}
31 \item 
32 \#define {\bf DWIDTH}~320
33 \item 
34 \#define {\bf DHEIGHT}~240
35 \item 
36 \#define {\bf VIDEO\_\-PALETTE\_\-RGB565}~3
37 \item 
38 \#define {\bf VIDEO\_\-PALETTE\_\-RGB24}~4
39 \item 
40 \#define {\bf VIDEO\_\-PALETTE\_\-RGB32}~5
41 \item 
42 \#define {\bf VIDEO\_\-PALETTE\_\-YUV420P}~15
43 \item 
44 \#define {\bf VIDEO\_\-PALETTE\_\-RAW\_\-JPEG}~20
45 \end{CompactItemize}
46 \subsection*{Enumerations}
47 \begin{CompactItemize}
48 \item 
49 enum {\bf cam\_\-form} \{ \par
50 {\bf JPEG}, 
51 {\bf YUVY}, 
52 {\bf YYUV}, 
53 {\bf YUYV}, 
54 \par
55 {\bf GREY}, 
56 {\bf GBRG}, 
57 {\bf UNKNOW}
58  \}
59 \end{CompactItemize}
60 \subsection*{Functions}
61 \begin{CompactItemize}
62 \item 
63 int {\bf init\_\-v4l} (struct {\bf vd\-In} $\ast$vd)
64 \item 
65 int {\bf grab} (struct {\bf vd\-In} $\ast$vd)
66 \item 
67 int {\bf close\_\-v4l} (struct {\bf vd\-In} $\ast$vd)
68 \item 
69 int {\bf set\-Palette} (struct {\bf vd\-In} $\ast$vd)
70 \item 
71 int {\bf change\-Size} (struct {\bf vd\-In} $\ast$vd)
72 \item 
73 \_\-\_\-u8 {\bf get\-Brightness} (struct {\bf vd\-In} $\ast$vd)
74 \item 
75 void {\bf set\-Brightness} (struct {\bf vd\-In} $\ast$vd, \_\-\_\-u8 bright)
76 \item 
77 \_\-\_\-u8 {\bf get\-Contrast} (struct {\bf vd\-In} $\ast$vd)
78 \item 
79 void {\bf set\-Contrast} (struct {\bf vd\-In} $\ast$vd, \_\-\_\-u8 contrast)
80 \item 
81 \_\-\_\-u8 {\bf get\-Colors} (struct {\bf vd\-In} $\ast$vd)
82 \item 
83 void {\bf set\-Colors} (struct {\bf vd\-In} $\ast$vd, \_\-\_\-u8 colors)
84 \item 
85 \_\-\_\-u8 {\bf get\-Norme} (struct {\bf vd\-In} $\ast$vd)
86 \item 
87 void {\bf set\-Norme} (struct {\bf vd\-In} $\ast$vd, \_\-\_\-u8 norme)
88 \item 
89 \_\-\_\-u8 {\bf get\-Channel} (struct {\bf vd\-In} $\ast$vd)
90 \item 
91 void {\bf set\-Channel} (struct {\bf vd\-In} $\ast$vd, \_\-\_\-u8 channel)
92 \end{CompactItemize}
93
94
95 \subsection{Detailed Description}
96
97
98 Definition in file {\bf camv4l.h}.
99
100 \subsection{Define Documentation}
101 \index{camv4l.h@{camv4l.h}!DHEIGHT@{DHEIGHT}}
102 \index{DHEIGHT@{DHEIGHT}!camv4l.h@{camv4l.h}}
103 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define DHEIGHT~240}\label{camv4l_8h_2c0e9cadedb91327295c0249e8a3ad6f}
104
105
106
107
108 Definition at line 28 of file camv4l.h.\index{camv4l.h@{camv4l.h}!DWIDTH@{DWIDTH}}
109 \index{DWIDTH@{DWIDTH}!camv4l.h@{camv4l.h}}
110 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define DWIDTH~320}\label{camv4l_8h_7f32e26ea2ffbc0c5408e65b30d4f0c8}
111
112
113
114
115 Definition at line 27 of file camv4l.h.\index{camv4l.h@{camv4l.h}!VIDEO_PALETTE_RAW_JPEG@{VIDEO\_\-PALETTE\_\-RAW\_\-JPEG}}
116 \index{VIDEO_PALETTE_RAW_JPEG@{VIDEO\_\-PALETTE\_\-RAW\_\-JPEG}!camv4l.h@{camv4l.h}}
117 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define VIDEO\_\-PALETTE\_\-RAW\_\-JPEG~20}\label{camv4l_8h_f86678f63c4ac31acaf68b38d90d94a9}
118
119
120
121
122 Definition at line 35 of file camv4l.h.
123
124 Referenced by flip\-UV(), and Get\-Depth().\index{camv4l.h@{camv4l.h}!VIDEO_PALETTE_RGB24@{VIDEO\_\-PALETTE\_\-RGB24}}
125 \index{VIDEO_PALETTE_RGB24@{VIDEO\_\-PALETTE\_\-RGB24}!camv4l.h@{camv4l.h}}
126 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define VIDEO\_\-PALETTE\_\-RGB24~4}\label{camv4l_8h_8dd93a2c957ded118f8ff17680cbf220}
127
128
129
130
131 Definition at line 32 of file camv4l.h.
132
133 Referenced by flip\-UV(), and Get\-Depth().\index{camv4l.h@{camv4l.h}!VIDEO_PALETTE_RGB32@{VIDEO\_\-PALETTE\_\-RGB32}}
134 \index{VIDEO_PALETTE_RGB32@{VIDEO\_\-PALETTE\_\-RGB32}!camv4l.h@{camv4l.h}}
135 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define VIDEO\_\-PALETTE\_\-RGB32~5}\label{camv4l_8h_d50994973596a30826522de0701ad02b}
136
137
138
139
140 Definition at line 33 of file camv4l.h.
141
142 Referenced by flip\-UV(), and Get\-Depth().\index{camv4l.h@{camv4l.h}!VIDEO_PALETTE_RGB565@{VIDEO\_\-PALETTE\_\-RGB565}}
143 \index{VIDEO_PALETTE_RGB565@{VIDEO\_\-PALETTE\_\-RGB565}!camv4l.h@{camv4l.h}}
144 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define VIDEO\_\-PALETTE\_\-RGB565~3}\label{camv4l_8h_dbf692218d97fffa111494787562d9e8}
145
146
147
148
149 Definition at line 31 of file camv4l.h.
150
151 Referenced by flip\-UV(), and Get\-Depth().\index{camv4l.h@{camv4l.h}!VIDEO_PALETTE_YUV420P@{VIDEO\_\-PALETTE\_\-YUV420P}}
152 \index{VIDEO_PALETTE_YUV420P@{VIDEO\_\-PALETTE\_\-YUV420P}!camv4l.h@{camv4l.h}}
153 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define VIDEO\_\-PALETTE\_\-YUV420P~15}\label{camv4l_8h_dea1e94780da3ba61a1a1d9a11affdd2}
154
155
156
157
158 Definition at line 34 of file camv4l.h.
159
160 Referenced by flip\-UV(), Get\-Depth(), and processvideo().
161
162 \subsection{Enumeration Type Documentation}
163 \index{camv4l.h@{camv4l.h}!cam_form@{cam\_\-form}}
164 \index{cam_form@{cam\_\-form}!camv4l.h@{camv4l.h}}
165 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}enum {\bf cam\_\-form}}\label{camv4l_8h_2f8d40fca22af63d98fcaad73efe2161}
166
167
168 Camera type format date \begin{Desc}
169 \item[Enumerator: ]\par
170 \begin{description}
171 \index{JPEG@{JPEG}!camv4l.h@{camv4l.h}}\index{camv4l.h@{camv4l.h}!JPEG@{JPEG}}\item[{\em 
172 JPEG\label{camv4l_8h_2f8d40fca22af63d98fcaad73efe216196f4d8a8c2070cf7bdd2236a48eae07a}
173 }]\index{YUVY@{YUVY}!camv4l.h@{camv4l.h}}\index{camv4l.h@{camv4l.h}!YUVY@{YUVY}}\item[{\em 
174 YUVY\label{camv4l_8h_2f8d40fca22af63d98fcaad73efe21619c6051edb55a8fb694528d81aa2c92dc}
175 }]\index{YYUV@{YYUV}!camv4l.h@{camv4l.h}}\index{camv4l.h@{camv4l.h}!YYUV@{YYUV}}\item[{\em 
176 YYUV\label{camv4l_8h_2f8d40fca22af63d98fcaad73efe21614dd75c8cff6ed2dad455d9b1e3066a7c}
177 }]\index{YUYV@{YUYV}!camv4l.h@{camv4l.h}}\index{camv4l.h@{camv4l.h}!YUYV@{YUYV}}\item[{\em 
178 YUYV\label{camv4l_8h_2f8d40fca22af63d98fcaad73efe21610105757557d0eed9bac6f9f1c0185a0b}
179 }]\index{GREY@{GREY}!camv4l.h@{camv4l.h}}\index{camv4l.h@{camv4l.h}!GREY@{GREY}}\item[{\em 
180 GREY\label{camv4l_8h_2f8d40fca22af63d98fcaad73efe216138566822dbd9408c447abfd3ed4a85d2}
181 }]\index{GBRG@{GBRG}!camv4l.h@{camv4l.h}}\index{camv4l.h@{camv4l.h}!GBRG@{GBRG}}\item[{\em 
182 GBRG\label{camv4l_8h_2f8d40fca22af63d98fcaad73efe21613cae9f5260ee8e2b52164f174e076fa2}
183 }]\index{UNKNOW@{UNKNOW}!camv4l.h@{camv4l.h}}\index{camv4l.h@{camv4l.h}!UNKNOW@{UNKNOW}}\item[{\em 
184 UNKNOW\label{camv4l_8h_2f8d40fca22af63d98fcaad73efe216109b024ff449662360c66ce18d20096fa}
185 }]\end{description}
186 \end{Desc}
187
188
189
190 Definition at line 41 of file camv4l.h.