gphoto2-camera.h
Go to the documentation of this file.
#ifndef LIBGPHOTO2_GPHOTO2_CAMERA_H
#define LIBGPHOTO2_GPHOTO2_CAMERA_H
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
typedef struct _Camera Camera;
#ifdef __cplusplus
}
#endif /* __cplusplus */
#include <gphoto2/gphoto2-abilities-list.h>
#include <gphoto2/gphoto2-port.h>
#include <gphoto2/gphoto2-widget.h>
#include <gphoto2/gphoto2-filesys.h>
#include <gphoto2/gphoto2-result.h>
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
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,
GP_EVENT_TIMEOUT,
GP_EVENT_FILE_ADDED,
GP_EVENT_FOLDER_ADDED,
GP_EVENT_CAPTURE_COMPLETE,
GP_EVENT_FILE_CHANGED
} CameraEventType;
typedef int (*CameraExitFunc) (Camera *camera, GPContext *context);
typedef int (*CameraGetConfigFunc) (Camera *camera, CameraWidget **widget,
GPContext *context);
typedef int (*CameraGetSingleConfigFunc) (Camera *camera, const char *name, CameraWidget **widget,
GPContext *context);
typedef int (*CameraListConfigFunc) (Camera *camera, CameraList *list, GPContext *context);
typedef int (*CameraSetConfigFunc) (Camera *camera, CameraWidget *widget,
GPContext *context);
typedef int (*CameraSetSingleConfigFunc) (Camera *camera, const char *name, CameraWidget *widget,
GPContext *context);
typedef int (*CameraCaptureFunc) (Camera *camera, CameraCaptureType type,
CameraFilePath *path, GPContext *context);
typedef int (*CameraTriggerCaptureFunc) (Camera *camera, 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);
typedef int (*CameraPrePostFunc) (Camera *camera, GPContext *context);
typedef struct _CameraFunctions {
CameraPrePostFunc pre_func;
CameraPrePostFunc post_func;
CameraExitFunc exit;
/* Configuration */
CameraGetConfigFunc get_config;
CameraSetConfigFunc set_config;
CameraListConfigFunc list_config;
CameraGetSingleConfigFunc get_single_config;
CameraSetSingleConfigFunc set_single_config;
/* Capturing */
CameraCaptureFunc capture;
CameraTriggerCaptureFunc trigger_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;
void *reserved8;
} CameraFunctions;
typedef struct _CameraPrivateLibrary CameraPrivateLibrary;
typedef struct _CameraPrivateCore CameraPrivateCore;
struct _Camera {
GPPort *port;
CameraFilesystem *fs;
CameraFunctions *functions;
CameraPrivateLibrary *pl;
CameraPrivateCore *pc;
};
int gp_camera_new (Camera **camera);
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);
int gp_camera_set_port_speed (Camera *camera, int speed);
int gp_camera_get_port_speed (Camera *camera);
int gp_camera_autodetect (CameraList *list, GPContext *context);
int gp_camera_init (Camera *camera, GPContext *context);
int gp_camera_exit (Camera *camera, GPContext *context);
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_list_config (Camera *camera, CameraList *list,
GPContext *context);
int gp_camera_get_single_config (Camera *camera, const char *name, CameraWidget **widget,
GPContext *context);
int gp_camera_set_config (Camera *camera, CameraWidget *window,
GPContext *context);
int gp_camera_set_single_config (Camera *camera, const char *name, CameraWidget *widget,
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_trigger_capture (Camera *camera, 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);
int gp_camera_get_storageinfo (Camera *camera, CameraStorageInformation**,
int *, GPContext *context);
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, const char *filename,
CameraFileType type,
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);
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_read (Camera *camera, const char *folder, const char *file,
CameraFileType type,
uint64_t offset, char *buf, uint64_t *size,
GPContext *context);
int gp_camera_file_delete (Camera *camera, const char *folder,
const char *file, GPContext *context);
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);
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* !defined(LIBGPHOTO2_GPHOTO2_CAMERA_H) */
gphoto2-abilities-list.h
List of supported camera models including their abilities.
gp_camera_get_port_speed
int gp_camera_get_port_speed(Camera *camera)
Definition gphoto2-camera.c:479
CameraFunctions
struct _CameraFunctions CameraFunctions
Various camera specific functions.
gp_camera_get_about
int gp_camera_get_about(Camera *camera, CameraText *about, GPContext *context)
Definition gphoto2-camera.c:1294
gp_camera_set_config
int gp_camera_set_config(Camera *camera, CameraWidget *window, GPContext *context)
Definition gphoto2-camera.c:1102
gp_camera_folder_delete_all
int gp_camera_folder_delete_all(Camera *camera, const char *folder, GPContext *context)
Definition gphoto2-camera.c:1522
gp_camera_folder_list_files
int gp_camera_folder_list_files(Camera *camera, const char *folder, CameraList *list, GPContext *context)
Definition gphoto2-camera.c:1467
gp_camera_set_port_speed
int gp_camera_set_port_speed(Camera *camera, int speed)
Definition gphoto2-camera.c:444
gp_camera_folder_remove_dir
int gp_camera_folder_remove_dir(Camera *camera, const char *folder, const char *name, GPContext *context)
Definition gphoto2-camera.c:1802
gp_camera_file_set_info
int gp_camera_file_set_info(Camera *camera, const char *folder, const char *file, CameraFileInfo info, GPContext *context)
Definition gphoto2-camera.c:1644
gp_camera_file_read
int gp_camera_file_read(Camera *camera, const char *folder, const char *file, CameraFileType type, uint64_t offset, char *buf, uint64_t *size, GPContext *context)
Definition gphoto2-camera.c:1714
gp_camera_get_abilities
int gp_camera_get_abilities(Camera *camera, CameraAbilities *abilities)
Definition gphoto2-camera.c:384
gp_camera_file_get
int gp_camera_file_get(Camera *camera, const char *folder, const char *file, CameraFileType type, CameraFile *camera_file, GPContext *context)
Definition gphoto2-camera.c:1671
CameraSetConfigFunc
int(* CameraSetConfigFunc)(Camera *camera, CameraWidget *widget, GPContext *context)
Set the configuration in the camera.
Definition gphoto2-camera.h:223
CameraSetSingleConfigFunc
int(* CameraSetSingleConfigFunc)(Camera *camera, const char *name, CameraWidget *widget, GPContext *context)
Set a single configuration variable in the camera.
Definition gphoto2-camera.h:237
gp_camera_get_manual
int gp_camera_get_manual(Camera *camera, CameraText *manual, GPContext *context)
Definition gphoto2-camera.c:1262
CameraPrePostFunc
int(* CameraPrePostFunc)(Camera *camera, GPContext *context)
Definition gphoto2-camera.h:271
CameraEventType
CameraEventType
Specify what event we received from the camera.
Definition gphoto2-camera.h:103
GP_EVENT_FILE_ADDED
@ GP_EVENT_FILE_ADDED
Definition gphoto2-camera.h:106
GP_EVENT_FOLDER_ADDED
@ GP_EVENT_FOLDER_ADDED
Definition gphoto2-camera.h:107
GP_EVENT_TIMEOUT
@ GP_EVENT_TIMEOUT
Definition gphoto2-camera.h:105
GP_EVENT_UNKNOWN
@ GP_EVENT_UNKNOWN
Definition gphoto2-camera.h:104
GP_EVENT_FILE_CHANGED
@ GP_EVENT_FILE_CHANGED
Definition gphoto2-camera.h:109
GP_EVENT_CAPTURE_COMPLETE
@ GP_EVENT_CAPTURE_COMPLETE
Definition gphoto2-camera.h:108
gp_camera_ref
int gp_camera_ref(Camera *camera)
Definition gphoto2-camera.c:495
gp_camera_file_delete
int gp_camera_file_delete(Camera *camera, const char *folder, const char *file, GPContext *context)
Definition gphoto2-camera.c:1752
gp_camera_trigger_capture
int gp_camera_trigger_capture(Camera *camera, GPContext *context)
Definition gphoto2-camera.c:1358
gp_camera_unref
int gp_camera_unref(Camera *camera)
Definition gphoto2-camera.c:516
gp_camera_start_timeout
int gp_camera_start_timeout(Camera *camera, unsigned int timeout, CameraTimeoutFunc func)
Definition gphoto2-camera.c:1893
gp_camera_wait_for_event
int gp_camera_wait_for_event(Camera *camera, int timeout, CameraEventType *eventtype, void **eventdata, GPContext *context)
Definition gphoto2-camera.c:1438
CameraCaptureType
CameraCaptureType
Type of the capture to do.
Definition gphoto2-camera.h:90
GP_CAPTURE_IMAGE
@ GP_CAPTURE_IMAGE
Capture an image.
Definition gphoto2-camera.h:91
GP_CAPTURE_SOUND
@ GP_CAPTURE_SOUND
Capture audio.
Definition gphoto2-camera.h:93
GP_CAPTURE_MOVIE
@ GP_CAPTURE_MOVIE
Capture a movie.
Definition gphoto2-camera.h:92
gp_camera_folder_make_dir
int gp_camera_folder_make_dir(Camera *camera, const char *folder, const char *name, GPContext *context)
Definition gphoto2-camera.c:1778
gp_camera_stop_timeout
void gp_camera_stop_timeout(Camera *camera, unsigned int id)
Definition gphoto2-camera.c:1934
gp_camera_exit
int gp_camera_exit(Camera *camera, GPContext *context)
Definition gphoto2-camera.c:249
gp_camera_free
int gp_camera_free(Camera *camera)
Definition gphoto2-camera.c:550
gp_camera_get_summary
int gp_camera_get_summary(Camera *camera, CameraText *summary, GPContext *context)
Definition gphoto2-camera.c:1231
gp_camera_folder_list_folders
int gp_camera_folder_list_folders(Camera *camera, const char *folder, CameraList *list, GPContext *context)
Definition gphoto2-camera.c:1495
gp_camera_capture
int gp_camera_capture(Camera *camera, CameraCaptureType type, CameraFilePath *path, GPContext *context)
Definition gphoto2-camera.c:1327
gp_camera_set_abilities
int gp_camera_set_abilities(Camera *camera, CameraAbilities abilities)
Sets the camera abilities.
Definition gphoto2-camera.c:356
gp_camera_get_storageinfo
int gp_camera_get_storageinfo(Camera *camera, CameraStorageInformation **, int *, GPContext *context)
Gets information on the camera attached storage.
Definition gphoto2-camera.c:1837
gp_camera_folder_put_file
int gp_camera_folder_put_file(Camera *camera, const char *folder, const char *filename, CameraFileType type, CameraFile *file, GPContext *context)
Definition gphoto2-camera.c:1548
CameraGetConfigFunc
int(* CameraGetConfigFunc)(Camera *camera, CameraWidget **widget, GPContext *context)
Get a configuration tree for the camera and its driver.
Definition gphoto2-camera.h:159
gp_camera_init
int gp_camera_init(Camera *camera, GPContext *context)
Definition gphoto2-camera.c:671
gp_camera_get_single_config
int gp_camera_get_single_config(Camera *camera, const char *name, CameraWidget **widget, GPContext *context)
Definition gphoto2-camera.c:891
CameraExitFunc
int(* CameraExitFunc)(Camera *camera, GPContext *context)
The camera exit function.
Definition gphoto2-camera.h:138
gp_camera_capture_preview
int gp_camera_capture_preview(Camera *camera, CameraFile *file, GPContext *context)
Definition gphoto2-camera.c:1388
CameraGetSingleConfigFunc
int(* CameraGetSingleConfigFunc)(Camera *camera, const char *name, CameraWidget **widget, GPContext *context)
Get a configuration widget for a specific configuration.
Definition gphoto2-camera.h:184
gp_camera_new
int gp_camera_new(Camera **camera)
Definition gphoto2-camera.c:305
gp_camera_file_get_info
int gp_camera_file_get_info(Camera *camera, const char *folder, const char *file, CameraFileInfo *info, GPContext *context)
Definition gphoto2-camera.c:1578
gp_camera_set_single_config
int gp_camera_set_single_config(Camera *camera, const char *name, CameraWidget *widget, GPContext *context)
Definition gphoto2-camera.c:1134
CameraListConfigFunc
int(* CameraListConfigFunc)(Camera *camera, CameraList *list, GPContext *context)
List all configuration widgets for a specific configuration.
Definition gphoto2-camera.h:209
gp_camera_autodetect
int gp_camera_autodetect(CameraList *list, GPContext *context)
Definition gphoto2-camera.c:606
gp_camera_get_config
int gp_camera_get_config(Camera *camera, CameraWidget **window, GPContext *context)
Definition gphoto2-camera.c:858
gp_camera_set_timeout_funcs
void gp_camera_set_timeout_funcs(Camera *camera, CameraTimeoutStartFunc start_func, CameraTimeoutStopFunc stop_func, void *data)
Definition gphoto2-camera.c:1867
CameraFileType
CameraFileType
The type of view on the specified file.
Definition gphoto2-file.h:73
gphoto2-filesys.h
Filesystem related operations and declarations.
gphoto2-port.h
gphoto2-result.h
gphoto2-widget.h
CameraAbilities
Describes the properties of a specific camera.
Definition gphoto2-abilities-list.h:120
CameraFilePath
A structure created by the capture operation.
Definition gphoto2-camera.h:79
CameraFile
File structure.
CameraText
CameraText structure used in various functions.
Definition gphoto2-camera.h:68
_CameraFileInfo
File information structure.
Definition gphoto2-filesys.h:141
_CameraFilesystem
The internal camera filesystem structure.
Definition gphoto2-filesys.c:226
_CameraFunctions
Various camera specific functions.
Definition gphoto2-camera.h:285
_CameraFunctions::reserved5
void * reserved5
reserved for future use
Definition gphoto2-camera.h:316
_CameraFunctions::reserved4
void * reserved4
reserved for future use
Definition gphoto2-camera.h:315
_CameraFunctions::set_single_config
CameraSetSingleConfigFunc set_single_config
Called for setting a single configuration widget.
Definition gphoto2-camera.h:297
_CameraFunctions::reserved2
void * reserved2
reserved for future use
Definition gphoto2-camera.h:313
_CameraFunctions::get_single_config
CameraGetSingleConfigFunc get_single_config
Called for requesteing a single widget.
Definition gphoto2-camera.h:296
_CameraFunctions::capture_preview
CameraCapturePreviewFunc capture_preview
Preview viewfinder content.
Definition gphoto2-camera.h:302
_CameraFunctions::post_func
CameraPrePostFunc post_func
Function called after each camera operation.
Definition gphoto2-camera.h:287
_CameraFunctions::manual
CameraManualFunc manual
Give a brief manual about any specific items a user has to know, translated.
Definition gphoto2-camera.h:306
_CameraFunctions::wait_for_event
CameraWaitForEvent wait_for_event
Wait for a specific event from the camera.
Definition gphoto2-camera.h:310
_CameraFunctions::reserved8
void * reserved8
reserved for future use
Definition gphoto2-camera.h:319
_CameraFunctions::reserved6
void * reserved6
reserved for future use
Definition gphoto2-camera.h:317
_CameraFunctions::pre_func
CameraPrePostFunc pre_func
Function called before each camera operation.
Definition gphoto2-camera.h:286
_CameraFunctions::get_config
CameraGetConfigFunc get_config
Called for requesting the configuration widgets.
Definition gphoto2-camera.h:292
_CameraFunctions::about
CameraAboutFunc about
A little About text, including authors and credits.
Definition gphoto2-camera.h:307
_CameraFunctions::set_config
CameraSetConfigFunc set_config
Called after a configuration was changed.
Definition gphoto2-camera.h:293
_CameraFunctions::summary
CameraSummaryFunc summary
Give a summary about the current camera status, translated.
Definition gphoto2-camera.h:305
_CameraFunctions::exit
CameraExitFunc exit
Function called on closing the camera.
Definition gphoto2-camera.h:289
_CameraFunctions::trigger_capture
CameraTriggerCaptureFunc trigger_capture
Remote control the camera to trigger capture.
Definition gphoto2-camera.h:301
_CameraFunctions::capture
CameraCaptureFunc capture
Remote control the camera to capture.
Definition gphoto2-camera.h:300
_CameraFunctions::list_config
CameraListConfigFunc list_config
Called for listing the available configuration widgets.
Definition gphoto2-camera.h:295
_CameraFunctions::reserved7
void * reserved7
reserved for future use
Definition gphoto2-camera.h:318
_CameraFunctions::reserved1
void * reserved1
reserved for future use
Definition gphoto2-camera.h:312
_CameraFunctions::reserved3
void * reserved3
reserved for future use
Definition gphoto2-camera.h:314
_CameraList
Definition gphoto2-list.c:47
_CameraPrivateCore
Definition gphoto2-camera.c:204
_CameraStorageInformation
Storage information structue.
Definition gphoto2-filesys.h:214
_CameraWidget
Definition gphoto2-widget.c:39
_Camera
Definition gphoto2-camera.h:325
_Camera::pl
CameraPrivateLibrary * pl
Definition gphoto2-camera.h:334
_Camera::pc
CameraPrivateCore * pc
Definition gphoto2-camera.h:335
_GPContext
Definition gphoto2-context.c:39
_GPPortInfo
Definition gphoto2-port-info.h:32
_GPPort
The GPhoto port structure.
Definition gphoto2-port.h:139