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