HACKING.asciidoc: mention how to use valgrind
[libam7xxx.git] / src / am7xxx.h
1 /* am7xxx - communication with AM7XXX based USB Pico Projectors and DPFs
2  *
3  * Copyright (C) 2012  Antonio Ospite <ospite@studenti.unina.it>
4  *
5  * This program is free software: you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation, either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
17  */
18
19 #ifndef __AM7XXX_H
20 #define __AM7XXX_H
21
22 #ifdef __cplusplus
23 extern "C" {
24 #endif
25
26
27 struct _am7xxx_context;
28 typedef struct _am7xxx_context am7xxx_context;
29
30 struct _am7xxx_device;
31 typedef struct _am7xxx_device am7xxx_device;
32
33 typedef enum {
34         AM7XXX_LOG_FATAL   = 0,
35         AM7XXX_LOG_ERROR   = 1,
36         AM7XXX_LOG_WARNING = 2,
37         AM7XXX_LOG_INFO    = 3,
38         AM7XXX_LOG_DEBUG   = 4,
39         AM7XXX_LOG_TRACE   = 5,
40 } am7xxx_log_level;
41
42 typedef enum {
43         AM7XXX_IMAGE_FORMAT_JPEG = 1,
44         AM7XXX_IMAGE_FORMAT_NV12 = 2,
45 } am7xxx_image_format;
46
47 typedef enum {
48         AM7XXX_POWER_OFF    = 0,
49         AM7XXX_POWER_LOW    = 1,
50         AM7XXX_POWER_MIDDLE = 2,
51         AM7XXX_POWER_HIGH   = 3,
52         AM7XXX_POWER_TURBO  = 4,
53 } am7xxx_power_mode;
54
55 int am7xxx_init(am7xxx_context **ctx);
56
57 void am7xxx_shutdown(am7xxx_context *ctx);
58
59 void am7xxx_set_log_level(am7xxx_context *ctx, am7xxx_log_level log_level);
60
61 int am7xxx_open_device(am7xxx_context *ctx,
62                        am7xxx_device **dev,
63                        unsigned int device_index);
64
65 int am7xxx_close_device(am7xxx_device *dev);
66
67 int am7xxx_get_device_info(am7xxx_device *dev,
68                            unsigned int *native_width,
69                            unsigned int *native_height,
70                            unsigned int *unknown0,
71                            unsigned int *unknown1);
72
73 int am7xxx_send_image(am7xxx_device *dev,
74                       am7xxx_image_format format,
75                       unsigned int width,
76                       unsigned int height,
77                       unsigned char *image,
78                       unsigned int size);
79
80 /*
81  * NOTE: if we set the mode to AM7XXX_POWER_OFF we can't turn the
82  * display on again by using only am7xxx_set_power_mode().
83  *
84  * Remember to mention that when writing the API doc.
85  */
86 int am7xxx_set_power_mode(am7xxx_device *dev, am7xxx_power_mode mode);
87
88 #ifdef __cplusplus
89 }
90 #endif
91
92 #endif /* __AM7XXX_H */