libgphoto2 photo camera library (libgphoto2) API: gphoto2/gphoto2-file.h Source File

libgphoto2 photo camera library (libgphoto2) API 2.5.10

- Main Page
- Related Pages
- Data Structures
- Files

- File List
- Globals

gphoto2-file.h
Go to the documentation of this file.
1
26 #ifndef __GPHOTO2_FILE_H__
27 #define __GPHOTO2_FILE_H__
28
29 #include <time.h>
30 #include <stdint.h>
31
32 #ifdef __cplusplus
33 extern "C" {
34 #endif /* __cplusplus */
35
36 #define GP_MIME_TXT "text/plain"
37 #define GP_MIME_WAV "audio/wav"
38 #define GP_MIME_RAW "image/x-raw"
39 #define GP_MIME_PNG "image/png"
40 #define GP_MIME_PGM "image/x-portable-graymap"
41 #define GP_MIME_PPM "image/x-portable-pixmap"
42 #define GP_MIME_PNM "image/x-portable-anymap"
43 #define GP_MIME_JPEG "image/jpeg"
44 #define GP_MIME_TIFF "image/tiff"
45 #define GP_MIME_BMP "image/bmp"
46 #define GP_MIME_QUICKTIME "video/quicktime"
47 #define GP_MIME_AVI "video/x-msvideo"
48 #define GP_MIME_CRW "image/x-canon-raw"
49 #define GP_MIME_CR2 "image/x-canon-cr2"
50 #define GP_MIME_NEF "image/x-nikon-nef"
51 #define GP_MIME_UNKNOWN "application/octet-stream"
52 #define GP_MIME_EXIF "application/x-exif"
53 #define GP_MIME_MP3 "audio/mpeg"
54 #define GP_MIME_OGG "application/ogg"
55 #define GP_MIME_WMA "audio/x-wma"
56 #define GP_MIME_ASF "audio/x-asf"
57 #define GP_MIME_MPEG "video/mpeg"
58 #define GP_MIME_AVCHD "video/mp2t"
59 #define GP_MIME_RW2 "image/x-panasonic-raw2"
60 #define GP_MIME_ARW "image/x-sony-arw"
61
72 typedef enum {
73 GP_FILE_TYPE_PREVIEW,
74 GP_FILE_TYPE_NORMAL,
75 GP_FILE_TYPE_RAW,
78 GP_FILE_TYPE_AUDIO,
79 GP_FILE_TYPE_EXIF,
80 GP_FILE_TYPE_METADATA
81 } CameraFileType;
82
89 typedef enum {
90 GP_FILE_ACCESSTYPE_MEMORY,
91 GP_FILE_ACCESSTYPE_FD,
92 GP_FILE_ACCESSTYPE_HANDLER
93 } CameraFileAccessType;
94
95 /* FIXME: api might be unstable. function return gphoto results codes. */
96 typedef struct _CameraFileHandler {
97 int (*size) (void*priv, uint64_t *size); /* only for read? */
98 int (*read) (void*priv, unsigned char *data, uint64_t *len);
99 int (*write) (void*priv, unsigned char *data, uint64_t *len);
100 /* FIXME: should we have both read/write methods? */
101 /* FIXME: how to finish method, due to LRU it might be longlived. */
102 } CameraFileHandler;
103
110 typedef struct _CameraFile CameraFile;
111
112 int gp_file_new (CameraFile **file);
113 int gp_file_new_from_fd (CameraFile **file, int fd);
114 int gp_file_new_from_handler (CameraFile **file, CameraFileHandler *handler, void*priv);
115 int gp_file_ref (CameraFile *file);
116 int gp_file_unref (CameraFile *file);
117 int gp_file_free (CameraFile *file);
118
119 int gp_file_set_name (CameraFile *file, const char *name);
120 int gp_file_get_name (CameraFile *file, const char **name);
121
122 int gp_file_set_mime_type (CameraFile *file, const char *mime_type);
123 int gp_file_get_mime_type (CameraFile *file, const char **mime_type);
124
125 int gp_file_set_mtime (CameraFile *file, time_t mtime);
126 int gp_file_get_mtime (CameraFile *file, time_t *mtime);
127
128 int gp_file_detect_mime_type (CameraFile *file);
129 int gp_file_adjust_name_for_mime_type (CameraFile *file);
130 int gp_file_get_name_by_type (CameraFile *file, const char *basename, CameraFileType type, char **newname);
131
132 int gp_file_set_data_and_size (CameraFile*, char *data,
133 unsigned long int size);
134 int gp_file_get_data_and_size (CameraFile*, const char **data,
135 unsigned long int *size);
136 /* "Do not use those"
137 *
138 * These functions probably were originally intended for internal use only.
139 * However, due to
140 * - the lack of good documentation
141 * - this being the obvious way to save a file
142 * - the fact that libgphoto2 has been exporting all its internal
143 * symbols for years (until 2005-06)
144 * - our in-house frontends gphoto2 and gtkam using them
145 * a number of external frontends started to use these functions, as
146 * of 2005-06:
147 * - digikam
148 * - f-spot
149 * - gthumb
150 * But a few frontends can live without it (and thus are likely to
151 * use the correct API):
152 * - flphoto
153 * - kamera
154 *
155 * So we're going to phase these functions out over the next year or
156 * so, going the GTK way of keeping the ABI but breaking the API. So
157 * we'll continue to export functionally equivalent functions, but the
158 * header files will not contain definitions for you to use any more.
159 */
160 int gp_file_open (CameraFile *file, const char *filename);
161 int gp_file_save (CameraFile *file, const char *filename);
162 int gp_file_clean (CameraFile *file);
163 int gp_file_copy (CameraFile *destination, CameraFile *source);
164
165
166 /* These are for use by camera drivers only */
167 int gp_file_append (CameraFile*, const char *data,
168 unsigned long int size);
169 int gp_file_slurp (CameraFile*, char *data,
170 size_t size, size_t *readlen);
171
172 #ifdef __cplusplus
173 }
174 #endif /* __cplusplus */
175
176 #endif /* __GPHOTO2_FILE_H__ */
GP_FILE_TYPE_NORMAL
Definition: gphoto2-file.h:74
gp_file_save
int gp_file_save(CameraFile *file, const char *filename)
Definition: gphoto2-file.c:480
GP_FILE_ACCESSTYPE_FD
Definition: gphoto2-file.h:91
gp_file_free
int gp_file_free(CameraFile *file)
descruct a CameraFile object.
Definition: gphoto2-file.c:145
GP_FILE_TYPE_PREVIEW
Definition: gphoto2-file.h:73
GP_FILE_TYPE_EXIF
Definition: gphoto2-file.h:79
gp_file_new_from_fd
int gp_file_new_from_fd(CameraFile **file, int fd)
Definition: gphoto2-file.c:103
gp_file_new_from_handler
int gp_file_new_from_handler(CameraFile **file, CameraFileHandler *handler, void *priv)
Definition: gphoto2-file.c:124
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:893
gp_file_set_mtime
int gp_file_set_mtime(CameraFile *file, time_t mtime)
Definition: gphoto2-file.c:1141
gp_file_get_mime_type
int gp_file_get_mime_type(CameraFile *file, const char **mime_type)
Definition: gphoto2-file.c:973
GP_FILE_TYPE_METADATA
Definition: gphoto2-file.h:80
GP_FILE_TYPE_RAW
Definition: gphoto2-file.h:75
GP_FILE_ACCESSTYPE_HANDLER
Definition: gphoto2-file.h:92
CameraFile
File structure.
gp_file_detect_mime_type
int gp_file_detect_mime_type(CameraFile *file)
Definition: gphoto2-file.c:1023
gp_file_adjust_name_for_mime_type
int gp_file_adjust_name_for_mime_type(CameraFile *file)
Definition: gphoto2-file.c:1077
gp_file_new
int gp_file_new(CameraFile **file)
Definition: gphoto2-file.c:83
gp_file_set_data_and_size
int gp_file_set_data_and_size(CameraFile *, char *data, unsigned long int size)
Definition: gphoto2-file.c:311
gp_file_get_name
int gp_file_get_name(CameraFile *file, const char **name)
Definition: gphoto2-file.c:867
gp_file_set_mime_type
int gp_file_set_mime_type(CameraFile *file, const char *mime_type)
Definition: gphoto2-file.c:1007
GP_FILE_TYPE_AUDIO
Definition: gphoto2-file.h:78
gp_file_open
int gp_file_open(CameraFile *file, const char *filename)
Definition: gphoto2-file.c:597
gp_file_slurp
int gp_file_slurp(CameraFile *, char *data, size_t size, size_t *readlen)
Definition: gphoto2-file.c:252
gp_file_get_mtime
int gp_file_get_mtime(CameraFile *file, time_t *mtime)
Definition: gphoto2-file.c:1124
_CameraFileHandler
Definition: gphoto2-file.h:96
GP_FILE_ACCESSTYPE_MEMORY
Definition: gphoto2-file.h:90
gp_file_clean
int gp_file_clean(CameraFile *file)
Definition: gphoto2-file.c:693
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:392
gp_file_append
int gp_file_append(CameraFile *, const char *data, unsigned long int size)
Definition: gphoto2-file.c:203
gp_file_copy
int gp_file_copy(CameraFile *destination, CameraFile *source)
Definition: gphoto2-file.c:723
CameraFileAccessType
CameraFileAccessType
File storage type.
Definition: gphoto2-file.h:89
gp_file_ref
int gp_file_ref(CameraFile *file)
Increase reference counter for CameraFile object.
Definition: gphoto2-file.c:165
gp_file_set_name
int gp_file_set_name(CameraFile *file, const char *name)
Definition: gphoto2-file.c:990
gp_file_unref
int gp_file_unref(CameraFile *file)
Decrease reference counter for CameraFile object.
Definition: gphoto2-file.c:182
CameraFileType
CameraFileType
The type of view on the specified file.
Definition: gphoto2-file.h:72
_CameraFile
Definition: gphoto2-file.c:55