00001
00028 #ifndef LIBMTP_H_INCLUSION_GUARD
00029 #define LIBMTP_H_INCLUSION_GUARD
00030
00031 #define LIBMTP_VERSION 0.2.0
00032 #define LIBMTP_VERSION_STRING "0.2.0"
00033
00034
00035 #ifdef _MSC_VER
00036 #include <windows.h>
00037 #define __WIN32__
00038 #define snprintf _snprintf
00039 #define ssize_t SSIZE_T
00040 #endif
00041
00042 #include <stdio.h>
00043 #include <usb.h>
00044 #include <stdint.h>
00045
00046 #ifdef __WIN32__
00047
00048
00049
00050
00051 typedef char int8_t;
00052 typedef unsigned char uint8_t;
00053 typedef __int16 int16_t;
00054 typedef unsigned __int16 uint16_t;
00055 typedef __int32 int32_t;
00056 typedef unsigned __int32 uint32_t;
00057 typedef unsigned __int64 uint64_t;
00058 #endif
00059
00067 typedef enum {
00068 LIBMTP_FILETYPE_WAV,
00069 LIBMTP_FILETYPE_MP3,
00070 LIBMTP_FILETYPE_WMA,
00071 LIBMTP_FILETYPE_OGG,
00072 LIBMTP_FILETYPE_AUDIBLE,
00073 LIBMTP_FILETYPE_MP4,
00074 LIBMTP_FILETYPE_UNDEF_AUDIO,
00075 LIBMTP_FILETYPE_WMV,
00076 LIBMTP_FILETYPE_AVI,
00077 LIBMTP_FILETYPE_MPEG,
00078 LIBMTP_FILETYPE_ASF,
00079 LIBMTP_FILETYPE_QT,
00080 LIBMTP_FILETYPE_UNDEF_VIDEO,
00081 LIBMTP_FILETYPE_JPEG,
00082 LIBMTP_FILETYPE_JFIF,
00083 LIBMTP_FILETYPE_TIFF,
00084 LIBMTP_FILETYPE_BMP,
00085 LIBMTP_FILETYPE_GIF,
00086 LIBMTP_FILETYPE_PICT,
00087 LIBMTP_FILETYPE_PNG,
00088 LIBMTP_FILETYPE_VCALENDAR1,
00089 LIBMTP_FILETYPE_VCALENDAR2,
00090 LIBMTP_FILETYPE_VCARD2,
00091 LIBMTP_FILETYPE_VCARD3,
00092 LIBMTP_FILETYPE_WINDOWSIMAGEFORMAT,
00093 LIBMTP_FILETYPE_WINEXEC,
00094 LIBMTP_FILETYPE_TEXT,
00095 LIBMTP_FILETYPE_HTML,
00096 LIBMTP_FILETYPE_FIRMWARE,
00097 LIBMTP_FILETYPE_AAC,
00098 LIBMTP_FILETYPE_MEDIACARD,
00099 LIBMTP_FILETYPE_FLAC,
00100 LIBMTP_FILETYPE_MP2,
00101 LIBMTP_FILETYPE_M4A,
00102 LIBMTP_FILETYPE_DOC,
00103 LIBMTP_FILETYPE_XML,
00104 LIBMTP_FILETYPE_XLS,
00105 LIBMTP_FILETYPE_PPT,
00106 LIBMTP_FILETYPE_MHT,
00107 LIBMTP_FILETYPE_JP2,
00108 LIBMTP_FILETYPE_JPX,
00109 LIBMTP_FILETYPE_UNKNOWN
00110 } LIBMTP_filetype_t;
00115 typedef enum {
00116 LIBMTP_ERROR_NONE,
00117 LIBMTP_ERROR_GENERAL,
00118 LIBMTP_ERROR_PTP_LAYER,
00119 LIBMTP_ERROR_USB_LAYER,
00120 LIBMTP_ERROR_MEMORY_ALLOCATION,
00121 LIBMTP_ERROR_NO_DEVICE_ATTACHED,
00122 LIBMTP_ERROR_STORAGE_FULL,
00123 LIBMTP_ERROR_CONNECTING
00124 } LIBMTP_error_number_t;
00125 typedef struct LIBMTP_device_entry_struct LIBMTP_device_entry_t;
00126 typedef struct LIBMTP_error_struct LIBMTP_error_t;
00127 typedef struct LIBMTP_mtpdevice_struct LIBMTP_mtpdevice_t;
00128 typedef struct LIBMTP_file_struct LIBMTP_file_t;
00129 typedef struct LIBMTP_track_struct LIBMTP_track_t;
00130 typedef struct LIBMTP_playlist_struct LIBMTP_playlist_t;
00131 typedef struct LIBMTP_album_struct LIBMTP_album_t;
00132 typedef struct LIBMTP_folder_struct LIBMTP_folder_t;
00133 typedef struct LIBMTP_object_struct LIBMTP_object_t;
00134 typedef struct LIBMTP_filesampledata_struct LIBMTP_filesampledata_t;
00135 typedef struct LIBMTP_devicestorage_struct LIBMTP_devicestorage_t;
00147 typedef int (* LIBMTP_progressfunc_t) (uint64_t const sent, uint64_t const total,
00148 void const * const data);
00149
00159 struct LIBMTP_device_entry_struct {
00160 char *name;
00161 uint16_t vendor_id;
00162 uint16_t product_id;
00163 uint32_t device_flags;
00164 };
00165
00169 struct LIBMTP_error_struct {
00170 LIBMTP_error_number_t errornumber;
00171 char *error_text;
00172 LIBMTP_error_t *next;
00173 };
00174
00178 struct LIBMTP_mtpdevice_struct {
00180 uint8_t interface_number;
00185 void *params;
00190 void *usbinfo;
00196 LIBMTP_devicestorage_t *storage;
00201 LIBMTP_error_t *errorstack;
00203 uint8_t maximum_battery_level;
00205 uint32_t default_music_folder;
00207 uint32_t default_playlist_folder;
00209 uint32_t default_picture_folder;
00211 uint32_t default_video_folder;
00213 uint32_t default_organizer_folder;
00215 uint32_t default_zencast_folder;
00217 uint32_t default_album_folder;
00219 uint32_t default_text_folder;
00221 void *cd;
00222
00224 LIBMTP_mtpdevice_t *next;
00225 };
00226
00230 struct LIBMTP_file_struct {
00231 uint32_t item_id;
00232 uint32_t parent_id;
00233 char *filename;
00234 uint64_t filesize;
00235 LIBMTP_filetype_t filetype;
00236 LIBMTP_file_t *next;
00237 };
00238
00242 struct LIBMTP_track_struct {
00243 uint32_t item_id;
00244 uint32_t parent_id;
00245 char *title;
00246 char *artist;
00247 char *genre;
00248 char *album;
00249 char *date;
00250 char *filename;
00251 uint16_t tracknumber;
00252 uint32_t duration;
00253 uint32_t samplerate;
00254 uint16_t nochannels;
00255 uint32_t wavecodec;
00256 uint32_t bitrate;
00257 uint16_t bitratetype;
00258 uint16_t rating;
00259 uint32_t usecount;
00260 uint64_t filesize;
00261 LIBMTP_filetype_t filetype;
00262 LIBMTP_track_t *next;
00263 };
00264
00268 struct LIBMTP_playlist_struct {
00269 uint32_t playlist_id;
00270 char *name;
00271 uint32_t *tracks;
00272 uint32_t no_tracks;
00273 LIBMTP_playlist_t *next;
00274 };
00275
00279 struct LIBMTP_album_struct {
00280 uint32_t album_id;
00281 char *name;
00282 char *artist;
00283 char *genre;
00284 uint32_t *tracks;
00285 uint32_t no_tracks;
00286 LIBMTP_album_t *next;
00287 };
00288
00292 struct LIBMTP_folder_struct {
00293 uint32_t folder_id;
00294 uint32_t parent_id;
00295 char *name;
00296 LIBMTP_folder_t *sibling;
00297 LIBMTP_folder_t *child;
00298 };
00299
00303 struct LIBMTP_filesampledata_struct {
00304 uint32_t width;
00305 uint32_t height;
00306 uint32_t duration;
00307 LIBMTP_filetype_t filetype;
00308 uint64_t size;
00309 char *data;
00310 };
00311
00315 struct LIBMTP_devicestorage_struct {
00316 uint32_t id;
00317 uint16_t StorageType;
00318 uint16_t FilesystemType;
00319 uint16_t AccessCapability;
00320 uint64_t MaxCapacity;
00321 uint64_t FreeSpaceInBytes;
00322 uint64_t FreeSpaceInObjects;
00323 char *StorageDescription;
00324 char *VolumeIdentifier;
00325 LIBMTP_devicestorage_t *next;
00326 LIBMTP_devicestorage_t *prev;
00327 };
00328
00329
00332
00333 #ifdef __cplusplus
00334 extern "C" {
00335 #endif
00336
00341 void LIBMTP_Init(void);
00342 int LIBMTP_Get_Supported_Devices_List(LIBMTP_device_entry_t ** const, int * const);
00348 int LIBMTP_Detect_Descriptor(uint16_t*,uint16_t*);
00349 LIBMTP_mtpdevice_t *LIBMTP_Get_First_Device(void);
00350 LIBMTP_error_number_t LIBMTP_Get_Connected_Devices(LIBMTP_mtpdevice_t **);
00351 uint32_t LIBMTP_Number_Devices_In_List(LIBMTP_mtpdevice_t *);
00352 void LIBMTP_Release_Device_List(LIBMTP_mtpdevice_t*);
00353 void LIBMTP_Release_Device(LIBMTP_mtpdevice_t*);
00354 void LIBMTP_Dump_Device_Info(LIBMTP_mtpdevice_t*);
00355 int LIBMTP_Reset_Device(LIBMTP_mtpdevice_t*);
00356 char *LIBMTP_Get_Modelname(LIBMTP_mtpdevice_t*);
00357 char *LIBMTP_Get_Serialnumber(LIBMTP_mtpdevice_t*);
00358 char *LIBMTP_Get_Deviceversion(LIBMTP_mtpdevice_t*);
00359 char *LIBMTP_Get_Friendlyname(LIBMTP_mtpdevice_t*);
00360 int LIBMTP_Set_Friendlyname(LIBMTP_mtpdevice_t*, char const * const);
00361 char *LIBMTP_Get_Syncpartner(LIBMTP_mtpdevice_t*);
00362 int LIBMTP_Set_Syncpartner(LIBMTP_mtpdevice_t*, char const * const);
00363 int LIBMTP_Get_Batterylevel(LIBMTP_mtpdevice_t *,
00364 uint8_t * const,
00365 uint8_t * const);
00366 int LIBMTP_Get_Secure_Time(LIBMTP_mtpdevice_t *, char ** const);
00367 int LIBMTP_Get_Device_Certificate(LIBMTP_mtpdevice_t *, char ** const);
00368 int LIBMTP_Get_Supported_Filetypes(LIBMTP_mtpdevice_t *, uint16_t ** const, uint16_t * const);
00369 LIBMTP_error_t *LIBMTP_Get_Errorstack(LIBMTP_mtpdevice_t*);
00370 void LIBMTP_Clear_Errorstack(LIBMTP_mtpdevice_t*);
00371 void LIBMTP_Dump_Errorstack(LIBMTP_mtpdevice_t*);
00372
00373 #define LIBMTP_STORAGE_SORTBY_NOTSORTED 0
00374 #define LIBMTP_STORAGE_SORTBY_FREESPACE 1
00375 #define LIBMTP_STORAGE_SORTBY_MAXSPACE 2
00376
00377 int LIBMTP_Get_Storage(LIBMTP_mtpdevice_t *, int const);
00378 int LIBMTP_Format_Storage(LIBMTP_mtpdevice_t *, LIBMTP_devicestorage_t *);
00379
00380
00386 LIBMTP_file_t *LIBMTP_new_file_t(void);
00387 void LIBMTP_destroy_file_t(LIBMTP_file_t*);
00388 char const * LIBMTP_Get_Filetype_Description(LIBMTP_filetype_t);
00389 LIBMTP_file_t *LIBMTP_Get_Filelisting(LIBMTP_mtpdevice_t *);
00390 LIBMTP_file_t *LIBMTP_Get_Filelisting_With_Callback(LIBMTP_mtpdevice_t *,
00391 LIBMTP_progressfunc_t const, void const * const);
00392 LIBMTP_file_t *LIBMTP_Get_Filemetadata(LIBMTP_mtpdevice_t *, uint32_t const);
00393 int LIBMTP_Get_File_To_File(LIBMTP_mtpdevice_t*, uint32_t, char const * const,
00394 LIBMTP_progressfunc_t const, void const * const);
00395 int LIBMTP_Get_File_To_File_Descriptor(LIBMTP_mtpdevice_t*, uint32_t const, int const,
00396 LIBMTP_progressfunc_t const, void const * const);
00397 int LIBMTP_Send_File_From_File(LIBMTP_mtpdevice_t *, char const * const,
00398 LIBMTP_file_t * const, LIBMTP_progressfunc_t const,
00399 void const * const, uint32_t const);
00400 int LIBMTP_Send_File_From_File_Descriptor(LIBMTP_mtpdevice_t *, int const,
00401 LIBMTP_file_t * const, LIBMTP_progressfunc_t const,
00402 void const * const, uint32_t const);
00403 LIBMTP_filesampledata_t *LIBMTP_new_filesampledata_t(void);
00404 void LIBMTP_destroy_filesampledata_t(LIBMTP_filesampledata_t *);
00405 int LIBMTP_Get_Representative_Sample_Format(LIBMTP_mtpdevice_t *,
00406 LIBMTP_filetype_t const,
00407 LIBMTP_filesampledata_t **);
00408 int LIBMTP_Send_Representative_Sample(LIBMTP_mtpdevice_t *, uint32_t const,
00409 LIBMTP_filesampledata_t *);
00410
00416 LIBMTP_track_t *LIBMTP_new_track_t(void);
00417 void LIBMTP_destroy_track_t(LIBMTP_track_t*);
00418 LIBMTP_track_t *LIBMTP_Get_Tracklisting(LIBMTP_mtpdevice_t*);
00419 LIBMTP_track_t *LIBMTP_Get_Tracklisting_With_Callback(LIBMTP_mtpdevice_t*,
00420 LIBMTP_progressfunc_t const, void const * const);
00421 LIBMTP_track_t *LIBMTP_Get_Trackmetadata(LIBMTP_mtpdevice_t*, uint32_t const);
00422 int LIBMTP_Get_Track_To_File(LIBMTP_mtpdevice_t*, uint32_t, char const * const,
00423 LIBMTP_progressfunc_t const, void const * const);
00424 int LIBMTP_Get_Track_To_File_Descriptor(LIBMTP_mtpdevice_t*, uint32_t const, int const,
00425 LIBMTP_progressfunc_t const, void const * const);
00426 int LIBMTP_Send_Track_From_File(LIBMTP_mtpdevice_t *,
00427 char const * const, LIBMTP_track_t * const,
00428 LIBMTP_progressfunc_t const,
00429 void const * const, uint32_t const);
00430 int LIBMTP_Send_Track_From_File_Descriptor(LIBMTP_mtpdevice_t *,
00431 int const, LIBMTP_track_t * const,
00432 LIBMTP_progressfunc_t const,
00433 void const * const, uint32_t const);
00434 int LIBMTP_Update_Track_Metadata(LIBMTP_mtpdevice_t *,
00435 LIBMTP_track_t const * const);
00436 int LIBMTP_Track_Exists(LIBMTP_mtpdevice_t *, uint32_t);
00444 LIBMTP_folder_t *LIBMTP_new_folder_t(void);
00445 void LIBMTP_destroy_folder_t(LIBMTP_folder_t*);
00446 LIBMTP_folder_t *LIBMTP_Get_Folder_List(LIBMTP_mtpdevice_t*);
00447 LIBMTP_folder_t *LIBMTP_Find_Folder(LIBMTP_folder_t*, uint32_t const);
00448 uint32_t LIBMTP_Create_Folder(LIBMTP_mtpdevice_t*, char *, uint32_t);
00457 LIBMTP_playlist_t *LIBMTP_new_playlist_t(void);
00458 void LIBMTP_destroy_playlist_t(LIBMTP_playlist_t *);
00459 LIBMTP_playlist_t *LIBMTP_Get_Playlist_List(LIBMTP_mtpdevice_t *);
00460 LIBMTP_playlist_t *LIBMTP_Get_Playlist(LIBMTP_mtpdevice_t *, uint32_t const);
00461 int LIBMTP_Create_New_Playlist(LIBMTP_mtpdevice_t *, LIBMTP_playlist_t * const, uint32_t const);
00462 int LIBMTP_Update_Playlist(LIBMTP_mtpdevice_t *, LIBMTP_playlist_t const * const);
00463
00469 LIBMTP_album_t *LIBMTP_new_album_t(void);
00470 void LIBMTP_destroy_album_t(LIBMTP_album_t *);
00471 LIBMTP_album_t *LIBMTP_Get_Album_List(LIBMTP_mtpdevice_t *);
00472 LIBMTP_album_t *LIBMTP_Get_Album(LIBMTP_mtpdevice_t *, uint32_t const);
00473 int LIBMTP_Create_New_Album(LIBMTP_mtpdevice_t *, LIBMTP_album_t * const, uint32_t const);
00474 int LIBMTP_Update_Album(LIBMTP_mtpdevice_t *, LIBMTP_album_t const * const);
00475
00481 int LIBMTP_Delete_Object(LIBMTP_mtpdevice_t *, uint32_t);
00482
00485
00486 #ifdef __cplusplus
00487 }
00488 #endif
00489
00490 #endif
00491