gphoto2-filesys.h

Go to the documentation of this file.

#ifndef __GPHOTO2_FILESYS_H__
#define __GPHOTO2_FILESYS_H__

#include <time.h>
#include <stdint.h>

#include <gphoto2/gphoto2-context.h>
#include <gphoto2/gphoto2-list.h>
#include <gphoto2/gphoto2-file.h>

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

typedef enum {
        GP_FILE_INFO_NONE            = 0,       
        GP_FILE_INFO_TYPE            = 1 << 0,  
        GP_FILE_INFO_SIZE            = 1 << 2,  
        GP_FILE_INFO_WIDTH           = 1 << 3,  
        GP_FILE_INFO_HEIGHT          = 1 << 4,  
        GP_FILE_INFO_PERMISSIONS     = 1 << 5,  
        GP_FILE_INFO_STATUS          = 1 << 6,  
        GP_FILE_INFO_MTIME           = 1 << 7,  
        GP_FILE_INFO_ALL             = 0xFF     
} CameraFileInfoFields;

typedef enum {
        GP_FILE_PERM_NONE       = 0,            
        GP_FILE_PERM_READ       = 1 << 0,       
        GP_FILE_PERM_DELETE     = 1 << 1,       
        GP_FILE_PERM_ALL        = 0xFF          
} CameraFilePermissions;

typedef enum {
        GP_FILE_STATUS_NOT_DOWNLOADED,  
        GP_FILE_STATUS_DOWNLOADED       
} CameraFileStatus;

typedef struct _CameraFileInfoFile {
        CameraFileInfoFields fields;    
        CameraFileStatus status;        
        uint64_t size;                  
        char type[64];                  
        uint32_t width;                 
        uint32_t height;                
        CameraFilePermissions permissions;
        time_t mtime;                   
} CameraFileInfoFile;

typedef struct _CameraFileInfoPreview {
        CameraFileInfoFields fields;    
        CameraFileStatus status;        
        uint64_t size;                  
        char type[64];                  
        uint32_t width;                 
        uint32_t height;                
} CameraFileInfoPreview;

typedef struct _CameraFileInfoAudio {
        CameraFileInfoFields fields;    
        CameraFileStatus status;        
        uint64_t size;          
        char type[64];                  
} CameraFileInfoAudio;

typedef struct _CameraFileInfo {
        CameraFileInfoPreview preview;
        CameraFileInfoFile    file;
        CameraFileInfoAudio   audio;
} CameraFileInfo;

typedef enum {
        GP_STORAGEINFO_BASE             = (1<<0),       
        GP_STORAGEINFO_LABEL            = (1<<1),       
        GP_STORAGEINFO_DESCRIPTION      = (1<<2),       
        GP_STORAGEINFO_ACCESS           = (1<<3),       
        GP_STORAGEINFO_STORAGETYPE      = (1<<4),       
        GP_STORAGEINFO_FILESYSTEMTYPE   = (1<<5),       
        GP_STORAGEINFO_MAXCAPACITY      = (1<<6),       
        GP_STORAGEINFO_FREESPACEKBYTES  = (1<<7),       
        GP_STORAGEINFO_FREESPACEIMAGES  = (1<<8)        
} CameraStorageInfoFields;

typedef enum {
        GP_STORAGEINFO_ST_UNKNOWN       = 0,    
        GP_STORAGEINFO_ST_FIXED_ROM     = 1,    
        GP_STORAGEINFO_ST_REMOVABLE_ROM = 2,    
        GP_STORAGEINFO_ST_FIXED_RAM     = 3,    
        GP_STORAGEINFO_ST_REMOVABLE_RAM = 4     
} CameraStorageType;

typedef enum {
        GP_STORAGEINFO_AC_READWRITE             = 0,    
        GP_STORAGEINFO_AC_READONLY              = 1,    
        GP_STORAGEINFO_AC_READONLY_WITH_DELETE  = 2     
} CameraStorageAccessType;

typedef enum {
        GP_STORAGEINFO_FST_UNDEFINED            = 0,    
        GP_STORAGEINFO_FST_GENERICFLAT          = 1,    
        GP_STORAGEINFO_FST_GENERICHIERARCHICAL  = 2,    
        GP_STORAGEINFO_FST_DCF                  = 3     
} CameraStorageFilesystemType;

typedef struct _CameraStorageInformation {
        CameraStorageInfoFields         fields; 
        char                            basedir[256];   
        char                            label[256];     
        char                            description[256];
        CameraStorageType               type;           
        CameraStorageFilesystemType     fstype;         
        CameraStorageAccessType         access;         
        uint64_t                        capacitykbytes; 
        uint64_t                        freekbytes;     
        uint64_t                        freeimages;     
} CameraStorageInformation;

typedef struct _CameraFilesystem CameraFilesystem;

int gp_filesystem_new    (CameraFilesystem **fs);
int gp_filesystem_free   (CameraFilesystem *fs);

/* Manual editing */
int gp_filesystem_append           (CameraFilesystem *fs, const char *folder,
                                    const char *filename, GPContext *context);
int gp_filesystem_set_info_noop    (CameraFilesystem *fs,
                                    const char *folder, const char *filename,
                                    CameraFileInfo info, GPContext *context);
int gp_filesystem_set_file_noop    (CameraFilesystem *fs,
                                    const char *folder, const char *filename,
                                    CameraFileType type,
                                    CameraFile *file, GPContext *context);
int gp_filesystem_delete_file_noop (CameraFilesystem *fs, const char *folder,
                                    const char *filename, GPContext *context);
int gp_filesystem_reset            (CameraFilesystem *fs);

/* Information retrieval */
int gp_filesystem_count        (CameraFilesystem *fs, const char *folder,
                                GPContext *context);
int gp_filesystem_name         (CameraFilesystem *fs, const char *folder,
                                int filenumber, const char **filename,
                                GPContext *context);
int gp_filesystem_get_folder   (CameraFilesystem *fs, const char *filename,
                                char **folder, GPContext *context);
int gp_filesystem_number       (CameraFilesystem *fs, const char *folder,
                                const char *filename, GPContext *context);

/* Listings */
typedef int (*CameraFilesystemListFunc) (CameraFilesystem *fs,
                                         const char *folder, CameraList *list,
                                         void *data, GPContext *context);
int gp_filesystem_list_files     (CameraFilesystem *fs, const char *folder,
                                  CameraList *list, GPContext *context);
int gp_filesystem_list_folders   (CameraFilesystem *fs, const char *folder,
                                  CameraList *list, GPContext *context);

/* File information */
typedef int (*CameraFilesystemSetInfoFunc) (CameraFilesystem *fs,
                                            const char *folder,
                                            const char *filename,
                                            CameraFileInfo info, void *data,
                                            GPContext *context);
typedef int (*CameraFilesystemGetInfoFunc) (CameraFilesystem *fs,
                                            const char *folder,
                                            const char *filename,
                                            CameraFileInfo *info, void *data,
                                            GPContext *context);
int gp_filesystem_get_info       (CameraFilesystem *fs, const char *folder,
                                  const char *filename, CameraFileInfo *info,
                                  GPContext *context);
int gp_filesystem_set_info       (CameraFilesystem *fs, const char *folder,
                                  const char *filename, CameraFileInfo info,
                                  GPContext *context);

/* Files */
typedef int (*CameraFilesystemGetFileFunc)    (CameraFilesystem *fs,
                                               const char *folder,
                                               const char *filename,
                                               CameraFileType type,
                                               CameraFile *file, void *data,
                                               GPContext *context);
typedef int (*CameraFilesystemReadFileFunc)    (CameraFilesystem *fs,
                                               const char *folder,
                                               const char *filename,
                                               CameraFileType type,
                                               uint64_t offset,
                                               char *buf,
                                               uint64_t *size,
                                               void *data,
                                               GPContext *context);
typedef int (*CameraFilesystemDeleteFileFunc) (CameraFilesystem *fs,
                                               const char *folder,
                                               const char *filename,
                                               void *data, GPContext *context);
int gp_filesystem_get_file       (CameraFilesystem *fs, const char *folder,
                                  const char *filename, CameraFileType type,
                                  CameraFile *file, GPContext *context);
int gp_filesystem_read_file     (CameraFilesystem *fs, const char *folder,
                                 const char *filename, CameraFileType type,
                                 uint64_t offset, char *buf, uint64_t *size,
                                 GPContext *context);
int gp_filesystem_delete_file    (CameraFilesystem *fs, const char *folder,
                                  const char *filename, GPContext *context);

/* Folders */
typedef int (*CameraFilesystemPutFileFunc)   (CameraFilesystem *fs,
                                              const char *folder,
                                              const char *filename,
                                              CameraFileType type,
                                              CameraFile *file,
                                              void *data,
                                              GPContext *context);
typedef int (*CameraFilesystemDeleteAllFunc) (CameraFilesystem *fs,
                                              const char *folder, void *data,
                                              GPContext *context);
typedef int (*CameraFilesystemDirFunc)       (CameraFilesystem *fs,
                                              const char *folder,
                                              const char *name, void *data,
                                              GPContext *context);

typedef int (*CameraFilesystemStorageInfoFunc) (CameraFilesystem *fs,
                                              CameraStorageInformation **,
                                              int *nrofstorageinformations,
                                              void *data, GPContext *context);

int gp_filesystem_get_storageinfo (CameraFilesystem *fs,
                                   CameraStorageInformation **,
                                   int *nrofstorageinformations,
                                   GPContext *context);

typedef struct _CameraFilesystemFuncs CameraFilesystemFuncs;
struct _CameraFilesystemFuncs {
        CameraFilesystemListFunc        file_list_func;
        CameraFilesystemListFunc        folder_list_func;
        CameraFilesystemPutFileFunc     put_file_func;
        CameraFilesystemDeleteAllFunc   delete_all_func;
        CameraFilesystemGetInfoFunc     get_info_func;
        CameraFilesystemSetInfoFunc     set_info_func;
        CameraFilesystemDirFunc         make_dir_func;
        CameraFilesystemDirFunc         remove_dir_func;
        CameraFilesystemGetFileFunc     get_file_func;
        CameraFilesystemReadFileFunc    read_file_func;
        CameraFilesystemDeleteFileFunc  del_file_func;
        CameraFilesystemStorageInfoFunc storage_info_func;

        /* for later use. Remove one if you add a new function */
        void                            *unused[31];
};
int gp_filesystem_set_funcs     (CameraFilesystem *fs,
                                 CameraFilesystemFuncs *funcs,
                                 void *data);
int gp_filesystem_put_file   (CameraFilesystem *fs, const char *folder, const char *filename,
                              CameraFileType type, CameraFile *file, GPContext *context);
int gp_filesystem_delete_all (CameraFilesystem *fs, const char *folder,
                              GPContext *context);
int gp_filesystem_make_dir   (CameraFilesystem *fs, const char *folder,
                              const char *name, GPContext *context);
int gp_filesystem_remove_dir (CameraFilesystem *fs, const char *folder,
                              const char *name, GPContext *context);

/* For debugging */
int gp_filesystem_dump         (CameraFilesystem *fs);

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* __GPHOTO2_FILESYS_H__ */