diff options
Diffstat (limited to 'gphoto2/gphoto2-file.h')
| -rw-r--r-- | gphoto2/gphoto2-file.h | 153 |
1 files changed, 153 insertions, 0 deletions
diff --git a/gphoto2/gphoto2-file.h b/gphoto2/gphoto2-file.h new file mode 100644 index 000000000..0416a9540 --- /dev/null +++ b/gphoto2/gphoto2-file.h @@ -0,0 +1,153 @@ +/** \file + * + * \author Copyright 2000 Scott Fritzinger + * + * \note + * 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. + * + * \note + * 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. + * + * \note + * 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. + */ + +#ifndef __GPHOTO2_FILE_H__ +#define __GPHOTO2_FILE_H__ + +#include <time.h> + +#ifdef __cplusplus +extern "C" { +#endif /* __cplusplus */ + +#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_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" + +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; + +/*! \class CameraFile + * + * The internals of the #CameraFile struct are private. + */ +typedef struct _CameraFile CameraFile; + +int gp_file_new (CameraFile **file); +int gp_file_ref (CameraFile *file); +int gp_file_unref (CameraFile *file); +int gp_file_free (CameraFile *file); + +/* "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); + +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_type (CameraFile *file, CameraFileType type); +int gp_file_get_type (CameraFile *file, CameraFileType *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_append (CameraFile*, const char *data, + unsigned long int size); +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); + +/* Conversion */ + +/* + * Please don't use the following in front-ends and camera drivers that are + * not in gphoto CVS. We need to do some more work here, and this part of + * the API is subject to change. + * + * If you like to do some work on conversion raw -> image/ *, please + * step forward and write to gphoto-devel@lists.sourceforge.net. + */ +typedef enum { + GP_FILE_CONVERSION_METHOD_CHUCK +} CameraFileConversionMethod; + +int gp_file_set_color_table (CameraFile *file, + const unsigned char *red_table, int red_size, + const unsigned char *green_table, int green_size, + const unsigned char *blue_table, int blue_size); +int gp_file_set_width_and_height (CameraFile *file, int width, int height); +int gp_file_set_header (CameraFile *file, const char *header); +int gp_file_set_conversion_method (CameraFile *file, + CameraFileConversionMethod method); + +int gp_file_convert (CameraFile *file, const char *mime_type); + +#ifdef __cplusplus +} +#endif /* __cplusplus */ + +#endif /* __GPHOTO2_FILE_H__ */ |