gphoto2-file.h
Go to the documentation of this file.
#ifndef LIBGPHOTO2_GPHOTO2_FILE_H
#define LIBGPHOTO2_GPHOTO2_FILE_H
#include <time.h>
#include <stdint.h>
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
#define GP_MIME_TXT "text/plain"
#define GP_MIME_WAV "audio/wav"
#define GP_MIME_RAW "image/x-raw"
#define GP_MIME_PNG "image/png"
#define GP_MIME_PGM "image/x-portable-graymap"
#define GP_MIME_PPM "image/x-portable-pixmap"
#define GP_MIME_PNM "image/x-portable-anymap"
#define GP_MIME_JPEG "image/jpeg"
#define GP_MIME_TIFF "image/tiff"
#define GP_MIME_BMP "image/bmp"
#define GP_MIME_QUICKTIME "video/quicktime"
#define GP_MIME_AVI "video/x-msvideo"
#define GP_MIME_CRW "image/x-canon-raw"
#define GP_MIME_CR2 "image/x-canon-cr2"
#define GP_MIME_CR3 "image/x-canon-cr3"
#define GP_MIME_NEF "image/x-nikon-nef"
#define GP_MIME_UNKNOWN "application/octet-stream"
#define GP_MIME_EXIF "application/x-exif"
#define GP_MIME_MP3 "audio/mpeg"
#define GP_MIME_OGG "application/ogg"
#define GP_MIME_WMA "audio/x-wma"
#define GP_MIME_ASF "audio/x-asf"
#define GP_MIME_MPEG "video/mpeg"
#define GP_MIME_AVCHD "video/mp2t"
#define GP_MIME_RW2 "image/x-panasonic-raw2"
#define GP_MIME_ARW "image/x-sony-arw"
typedef enum {
GP_FILE_TYPE_PREVIEW,
GP_FILE_TYPE_NORMAL,
GP_FILE_TYPE_RAW,
GP_FILE_TYPE_AUDIO,
GP_FILE_TYPE_EXIF,
GP_FILE_TYPE_METADATA
} CameraFileType;
typedef enum {
GP_FILE_ACCESSTYPE_MEMORY,
GP_FILE_ACCESSTYPE_FD,
GP_FILE_ACCESSTYPE_HANDLER
} CameraFileAccessType;
/* FIXME: api might be unstable. function return gphoto results codes. */
typedef struct _CameraFileHandler {
int (*size) (void*priv, uint64_t *size); /* only for read? */
int (*read) (void*priv, unsigned char *data, uint64_t *len);
int (*write) (void*priv, unsigned char *data, uint64_t *len);
/* FIXME: should we have both read/write methods? */
/* FIXME: how to finish method, due to LRU it might be longlived. */
} CameraFileHandler;
typedef struct _CameraFile CameraFile;
int gp_file_new (CameraFile **file);
int gp_file_new_from_fd (CameraFile **file, int fd);
int gp_file_new_from_handler (CameraFile **file, CameraFileHandler *handler, void*priv);
int gp_file_ref (CameraFile *file);
int gp_file_unref (CameraFile *file);
int gp_file_free (CameraFile *file);
int gp_file_set_name (CameraFile *file, const char *name);
int gp_file_get_name (CameraFile *file, const char **name);
int gp_file_set_mime_type (CameraFile *file, const char *mime_type);
int gp_file_get_mime_type (CameraFile *file, const char **mime_type);
int gp_file_set_mtime (CameraFile *file, time_t mtime);
int gp_file_get_mtime (CameraFile *file, time_t *mtime);
int gp_file_detect_mime_type (CameraFile *file);
int gp_file_adjust_name_for_mime_type (CameraFile *file);
int gp_file_get_name_by_type (CameraFile *file, const char *basename, CameraFileType type, char **newname);
int gp_file_set_data_and_size (CameraFile*, char *data,
unsigned long int size);
int gp_file_get_data_and_size (CameraFile*, const char **data,
unsigned long int *size);
/* "Do not use those"
*
* These functions probably were originally intended for internal use only.
* However, due to
* - the lack of good documentation
* - this being the obvious way to save a file
* - the fact that libgphoto2 has been exporting all its internal
* symbols for years (until 2005-06)
* - our in-house frontends gphoto2 and gtkam using them
* a number of external frontends started to use these functions, as
* of 2005-06:
* - digikam
* - f-spot
* - gthumb
* But a few frontends can live without it (and thus are likely to
* use the correct API):
* - flphoto
* - kamera
*
* So we're going to phase these functions out over the next year or
* so, going the GTK way of keeping the ABI but breaking the API. So
* we'll continue to export functionally equivalent functions, but the
* header files will not contain definitions for you to use any more.
*/
int gp_file_open (CameraFile *file, const char *filename);
int gp_file_save (CameraFile *file, const char *filename);
int gp_file_clean (CameraFile *file);
int gp_file_copy (CameraFile *destination, CameraFile *source);
/* These are for use by camera drivers only */
int gp_file_append (CameraFile*, const char *data,
unsigned long int size);
int gp_file_slurp (CameraFile*, char *data,
size_t size, size_t *readlen);
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* !defined(LIBGPHOTO2_GPHOTO2_FILE_H) */
gp_file_new_from_fd
int gp_file_new_from_fd(CameraFile **file, int fd)
Definition: gphoto2-file.c:106
gp_file_get_data_and_size
int gp_file_get_data_and_size(CameraFile *, const char **data, unsigned long int *size)
Definition: gphoto2-file.c:399
gp_file_get_mime_type
int gp_file_get_mime_type(CameraFile *file, const char **mime_type)
Definition: gphoto2-file.c:980
gp_file_save
int gp_file_save(CameraFile *file, const char *filename)
Definition: gphoto2-file.c:487
gp_file_get_name
int gp_file_get_name(CameraFile *file, const char **name)
Definition: gphoto2-file.c:874
gp_file_slurp
int gp_file_slurp(CameraFile *, char *data, size_t size, size_t *readlen)
Definition: gphoto2-file.c:255
gp_file_clean
int gp_file_clean(CameraFile *file)
Definition: gphoto2-file.c:700
gp_file_adjust_name_for_mime_type
int gp_file_adjust_name_for_mime_type(CameraFile *file)
Definition: gphoto2-file.c:1084
gp_file_open
int gp_file_open(CameraFile *file, const char *filename)
Definition: gphoto2-file.c:604
gp_file_new_from_handler
int gp_file_new_from_handler(CameraFile **file, CameraFileHandler *handler, void *priv)
Definition: gphoto2-file.c:127
gp_file_copy
int gp_file_copy(CameraFile *destination, CameraFile *source)
Definition: gphoto2-file.c:730
gp_file_unref
int gp_file_unref(CameraFile *file)
Decrease reference counter for CameraFile object.
Definition: gphoto2-file.c:185
gp_file_set_data_and_size
int gp_file_set_data_and_size(CameraFile *, char *data, unsigned long int size)
Definition: gphoto2-file.c:314
gp_file_set_mime_type
int gp_file_set_mime_type(CameraFile *file, const char *mime_type)
Definition: gphoto2-file.c:1014
gp_file_set_name
int gp_file_set_name(CameraFile *file, const char *name)
Definition: gphoto2-file.c:997
gp_file_get_name_by_type
int gp_file_get_name_by_type(CameraFile *file, const char *basename, CameraFileType type, char **newname)
Definition: gphoto2-file.c:900
CameraFileType
CameraFileType
The type of view on the specified file.
Definition: gphoto2-file.h:73
GP_FILE_TYPE_PREVIEW
@ GP_FILE_TYPE_PREVIEW
Definition: gphoto2-file.h:74
GP_FILE_TYPE_METADATA
@ GP_FILE_TYPE_METADATA
Definition: gphoto2-file.h:81
GP_FILE_TYPE_AUDIO
@ GP_FILE_TYPE_AUDIO
Definition: gphoto2-file.h:79
GP_FILE_TYPE_NORMAL
@ GP_FILE_TYPE_NORMAL
Definition: gphoto2-file.h:75
GP_FILE_TYPE_EXIF
@ GP_FILE_TYPE_EXIF
Definition: gphoto2-file.h:80
GP_FILE_TYPE_RAW
@ GP_FILE_TYPE_RAW
Definition: gphoto2-file.h:76
gp_file_get_mtime
int gp_file_get_mtime(CameraFile *file, time_t *mtime)
Definition: gphoto2-file.c:1133
gp_file_free
int gp_file_free(CameraFile *file)
descruct a CameraFile object.
Definition: gphoto2-file.c:148
gp_file_detect_mime_type
int gp_file_detect_mime_type(CameraFile *file)
Definition: gphoto2-file.c:1030
gp_file_ref
int gp_file_ref(CameraFile *file)
Increase reference counter for CameraFile object.
Definition: gphoto2-file.c:168
gp_file_set_mtime
int gp_file_set_mtime(CameraFile *file, time_t mtime)
Definition: gphoto2-file.c:1150
CameraFileAccessType
CameraFileAccessType
File storage type.
Definition: gphoto2-file.h:90
GP_FILE_ACCESSTYPE_FD
@ GP_FILE_ACCESSTYPE_FD
Definition: gphoto2-file.h:92
GP_FILE_ACCESSTYPE_MEMORY
@ GP_FILE_ACCESSTYPE_MEMORY
Definition: gphoto2-file.h:91
GP_FILE_ACCESSTYPE_HANDLER
@ GP_FILE_ACCESSTYPE_HANDLER
Definition: gphoto2-file.h:93
gp_file_new
int gp_file_new(CameraFile **file)
Definition: gphoto2-file.c:84
gp_file_append
int gp_file_append(CameraFile *, const char *data, unsigned long int size)
Definition: gphoto2-file.c:206
CameraFile
File structure.
_CameraFileHandler
Definition: gphoto2-file.h:97
_CameraFile
Definition: gphoto2-file.c:56