template.c File Reference

---

Detailed Description

Documented source code template for a camera driver (camlib).

Author:

Copyright © 2001 Lutz Müller <lutz@users.sourceforge.net>

Copyright © 2005 Hans Ulrich Niedermann <gp@n-dimensional.de>

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.

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.

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.

Introduction to camera drivers (camlibs)

Every camlib must implement the following three function groups:

• Camera object member functions
• CameraFilesystem object member functions
• camlib API functions

We implement the camlib API functions last in this file because camera_init() must reference all the object member functions and by making camera_init() the last function in this file, we can avoid the need for forward declarations of the object member functions.

Note about "static" functions and exporting symbols

The build system uses libtool to explicitly specify the list of exported symbols. Only the three functions of the camlib API (camera_init(), camera_id(), and camera_abilities()) are exported.

Therefore it doesn't matter whether you declare your other functions static or not - regardless of whether they are object member functions or internal camlib functions.

We do not define the object member functions as static in this template in order to have autogenerated documentation about them.

Definition in file template.c.

#include "config.h"
#include <string.h>
#include <gphoto2/gphoto2-library.h>
#include <gphoto2/gphoto2-result.h>

Go to the source code of this file.

camlib API functions
CameraFilesystemFuncs	fsfuncs
int	camera_abilities (CameraAbilitiesList *list)
int	camera_id (CameraText *id)
int	camera_init (Camera *camera, GPContext *context)
Defines
#define	_(String)   (String)
#define	N_(String)   (String)
Functions
Camera object member functions
The prototypes for these functions are defined in gphoto2-camera.h
int	camera_about (Camera *camera, CameraText *about, GPContext *context)
int	camera_capture (Camera *camera, CameraCaptureType type, CameraFilePath *path, GPContext *context)
int	camera_capture_preview (Camera *camera, CameraFile *file, GPContext *context)
int	camera_config_get (Camera *camera, CameraWidget **window, GPContext *context)
int	camera_config_set (Camera *camera, CameraWidget *window, GPContext *context)
int	camera_exit (Camera *camera, GPContext *context)
int	camera_manual (Camera *camera, CameraText *manual, GPContext *context)
int	camera_summary (Camera *camera, CameraText *summary, GPContext *context)
CameraFilesystem member functions
int	delete_all_func (CameraFilesystem *fs, const char *folder, void *data, GPContext *context)
int	delete_file_func (CameraFilesystem *fs, const char *folder, const char *filename, void *data, GPContext *context)
int	file_list_func (CameraFilesystem *fs, const char *folder, CameraList *list, void *data, GPContext *context)
int	folder_list_func (CameraFilesystem *fs, const char *folder, CameraList *list, void *data, GPContext *context)
int	get_file_func (CameraFilesystem *fs, const char *folder, const char *filename, CameraFileType type, CameraFile *file, void *data, GPContext *context)
int	get_info_func (CameraFilesystem *fs, const char *folder, const char *filename, CameraFileInfo *info, void *data, GPContext *context)
int	put_file_func (CameraFilesystem *fs, const char *folder, CameraFile *file, void *data, GPContext *context)
int	set_info_func (CameraFilesystem *fs, const char *folder, const char *file, CameraFileInfo info, void *data, GPContext *context)
int	storage_info_func (CameraFilesystem *fs, CameraStorageInformation **storageinformations, int *nrofstorageinformations, void *data, GPContext *context)