1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
|
/** \file
*
* Implement Camera object representing a camera attached to the system.
*
* \author Copyright 2000 Scott Fritzinger
*
* \note
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* \note
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* \note
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
#ifndef __GPHOTO2_CAMERA_H__
#define __GPHOTO2_CAMERA_H__
#include <gphoto2/gphoto2-context.h>
/**
* \brief Object representing a camera attached to the system.
*
* A Camera object represents a specific instance of a (physical of
* virtual) camera attached to the system.
*
* The abilities of this type of camera are stored in a CameraAbility
* object.
*
* The details of the Camera object are internal.
*/
typedef struct _Camera Camera;
#include <gphoto2/gphoto2-port.h>
#include <gphoto2/gphoto2-port-info-list.h>
#include <gphoto2/gphoto2-widget.h>
#include <gphoto2/gphoto2-list.h>
#include <gphoto2/gphoto2-file.h>
#include <gphoto2/gphoto2-filesys.h>
#include <gphoto2/gphoto2-abilities-list.h>
#include <gphoto2/gphoto2-result.h>
#include <gphoto2/gphoto2-context.h>
typedef struct {
char text [32 * 1024];
} CameraText;
typedef struct {
char name [128];
char folder [1024];
} CameraFilePath;
typedef enum {
GP_CAPTURE_IMAGE,
GP_CAPTURE_MOVIE,
GP_CAPTURE_SOUND
} CameraCaptureType;
typedef enum {
GP_EVENT_UNKNOWN, /* unknown and unhandled event */
GP_EVENT_TIMEOUT, /* timeout, no arguments */
GP_EVENT_FILE_ADDED, /* CameraFilePath* = file path on camfs */
GP_EVENT_FOLDER_ADDED /* CameraFilePath* = folder on camfs */
} CameraEventType;
/**
* \name Camera object member functions
*
* These functions must be implemented by a camlib and the camlib's
* camera_init() function will add them to a Camera object.
*
* @{
*/
typedef int (*CameraExitFunc) (Camera *camera, GPContext *context);
typedef int (*CameraGetConfigFunc) (Camera *camera, CameraWidget **widget,
GPContext *context);
typedef int (*CameraSetConfigFunc) (Camera *camera, CameraWidget *widget,
GPContext *context);
typedef int (*CameraCaptureFunc) (Camera *camera, CameraCaptureType type,
CameraFilePath *path, GPContext *context);
typedef int (*CameraCapturePreviewFunc) (Camera *camera, CameraFile *file,
GPContext *context);
typedef int (*CameraSummaryFunc) (Camera *camera, CameraText *text,
GPContext *context);
typedef int (*CameraManualFunc) (Camera *camera, CameraText *text,
GPContext *context);
typedef int (*CameraAboutFunc) (Camera *camera, CameraText *text,
GPContext *context);
typedef int (*CameraWaitForEvent) (Camera *camera, int timeout,
CameraEventType *eventtype, void **eventdata,
GPContext *context);
/**@}*/
/**
* \param camera a \ref Camera object
* \param context a \ref GPContext object
* \return a gphoto2 error code
*
* Implement this function in the camera driver if the camera needs to
* be initialized before or reset the after each access from
* libgphoto2.
*
* For example, you would probably set the speed to the highest one
* right before downloading an image, and reset it to the default speed
* afterwards so that other programs will not be affected by this speed
* change.
*/
typedef int (*CameraPrePostFunc) (Camera *camera, GPContext *context);
typedef struct _CameraFunctions CameraFunctions;
struct _CameraFunctions {
/* Those will be called before and after each operation */
CameraPrePostFunc pre_func;
CameraPrePostFunc post_func;
CameraExitFunc exit;
/* Configuration */
CameraGetConfigFunc get_config;
CameraSetConfigFunc set_config;
/* Capturing */
CameraCaptureFunc capture;
CameraCapturePreviewFunc capture_preview;
/* Textual information */
CameraSummaryFunc summary;
CameraManualFunc manual;
CameraAboutFunc about;
/* Event Interface */
CameraWaitForEvent wait_for_event;
/* Reserved space to use in the future without changing the struct size */
void *reserved1;
void *reserved2;
void *reserved3;
void *reserved4;
void *reserved5;
void *reserved6;
void *reserved7;
};
/* Those are DEPRECATED */
typedef GPPort CameraPort;
typedef GPPortInfo CameraPortInfo;
typedef struct _CameraPrivateLibrary CameraPrivateLibrary;
typedef struct _CameraPrivateCore CameraPrivateCore;
struct _Camera {
/** \name Those should be accessed only by the camera driver.
* @{ */
GPPort *port;
CameraFilesystem *fs;
CameraFunctions *functions;
/**@}*/
CameraPrivateLibrary *pl; /**< Private data of camera libraries. */
CameraPrivateCore *pc; /**< Private data of the core of gphoto2. */
};
/** Create a new camera device. */
int gp_camera_new (Camera **camera);
/** \name Preparing initialization
* @{
*/
int gp_camera_set_abilities (Camera *camera, CameraAbilities abilities);
int gp_camera_get_abilities (Camera *camera, CameraAbilities *abilities);
int gp_camera_set_port_info (Camera *camera, GPPortInfo info);
int gp_camera_get_port_info (Camera *camera, GPPortInfo *info);
/**@}*/
/**
* \name camera speed
*
* You normally don't use that. If you do, you prevent the camera driver
* from selecting the optimal speed.
*
* @{
*/
int gp_camera_set_port_speed (Camera *camera, int speed);
int gp_camera_get_port_speed (Camera *camera);
/**@}*/
/** \name Initialization
* @{
*/
int gp_camera_init (Camera *camera, GPContext *context);
int gp_camera_exit (Camera *camera, GPContext *context);
/**@}*/
/** \name Operations on cameras
* @{
*/
int gp_camera_ref (Camera *camera);
int gp_camera_unref (Camera *camera);
int gp_camera_free (Camera *camera);
int gp_camera_get_config (Camera *camera, CameraWidget **window,
GPContext *context);
int gp_camera_set_config (Camera *camera, CameraWidget *window,
GPContext *context);
int gp_camera_get_summary (Camera *camera, CameraText *summary,
GPContext *context);
int gp_camera_get_manual (Camera *camera, CameraText *manual,
GPContext *context);
int gp_camera_get_about (Camera *camera, CameraText *about,
GPContext *context);
int gp_camera_capture (Camera *camera, CameraCaptureType type,
CameraFilePath *path, GPContext *context);
int gp_camera_capture_preview (Camera *camera, CameraFile *file,
GPContext *context);
int gp_camera_wait_for_event (Camera *camera, int timeout,
CameraEventType *eventtype, void **eventdata,
GPContext *context);
/**@}*/
/** \name Operations on folders
* @{
*/
int gp_camera_folder_list_files (Camera *camera, const char *folder,
CameraList *list, GPContext *context);
int gp_camera_folder_list_folders (Camera *camera, const char *folder,
CameraList *list, GPContext *context);
int gp_camera_folder_delete_all (Camera *camera, const char *folder,
GPContext *context);
int gp_camera_folder_put_file (Camera *camera, const char *folder,
CameraFile *file, GPContext *context);
int gp_camera_folder_make_dir (Camera *camera, const char *folder,
const char *name, GPContext *context);
int gp_camera_folder_remove_dir (Camera *camera, const char *folder,
const char *name, GPContext *context);
/**@}*/
/** \name Operations on files
* @{
*/
int gp_camera_file_get_info (Camera *camera, const char *folder,
const char *file, CameraFileInfo *info,
GPContext *context);
int gp_camera_file_set_info (Camera *camera, const char *folder,
const char *file, CameraFileInfo info,
GPContext *context);
int gp_camera_file_get (Camera *camera, const char *folder,
const char *file, CameraFileType type,
CameraFile *camera_file, GPContext *context);
int gp_camera_file_delete (Camera *camera, const char *folder,
const char *file, GPContext *context);
/**@}*/
/**
* \name Some cameras need 'keep-alive-messages'.
* @{
*/
typedef int (* CameraTimeoutFunc) (Camera *camera,
GPContext *context);
typedef unsigned int (* CameraTimeoutStartFunc) (Camera *camera,
unsigned int timeout,
CameraTimeoutFunc func,
void *data);
typedef void (* CameraTimeoutStopFunc) (Camera *camera,
unsigned int id, void *data);
void gp_camera_set_timeout_funcs (Camera *camera,
CameraTimeoutStartFunc start_func,
CameraTimeoutStopFunc stop_func,
void *data);
int gp_camera_start_timeout (Camera *camera, unsigned int timeout,
CameraTimeoutFunc func);
void gp_camera_stop_timeout (Camera *camera, unsigned int id);
/**@}*/
#endif /* __GPHOTO2_CAMERA_H__ */
|
