From 3bbda54ee409524d8bad5fba5aa375ddc3f7182d Mon Sep 17 00:00:00 2001 From: Marcus Meissner Date: Thu, 8 May 2014 20:09:31 +0000 Subject: [PATCH] added a chdk ptp header copy git-svn-id: https://svn.code.sf.net/p/gphoto/code/trunk/libgphoto2@14942 67ed7778-7388-44ab-90cf-0a291f65f57c --- camlibs/ptp2/chkd_ptp.h | 200 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 200 insertions(+) create mode 100644 camlibs/ptp2/chkd_ptp.h diff --git a/camlibs/ptp2/chkd_ptp.h b/camlibs/ptp2/chkd_ptp.h new file mode 100644 index 000000000..e4aa91201 --- /dev/null +++ b/camlibs/ptp2/chkd_ptp.h @@ -0,0 +1,200 @@ +/* + * Get https://trac.assembla.com/chdk/browser/trunk/core/ptp.h?format=txt + */ + +#ifndef __CHDK_PTP_H +#define __CHDK_PTP_H + +// CHDK PTP protocol interface (can also be used in client PTP programs) + +// Note: used in modules and platform independent code. +// Do not add platform dependent stuff in here (#ifdef/#endif compile options or camera dependent values) + +#define PTP_CHDK_VERSION_MAJOR 2 // increase only with backwards incompatible changes (and reset minor) +#define PTP_CHDK_VERSION_MINOR 6 // increase with extensions of functionality + // minor > 1000 for development versions + +/* +protocol version history +0.1 - initial proposal from mweerden, + luar +0.2 - Added ScriptStatus and ScriptSupport, based on work by ultimA +1.0 - removed old script result code (luar), replace with message system +2.0 - return PTP_CHDK_TYPE_TABLE for tables instead of TYPE_STRING, allow return of empty strings +2.1 - experimental live view, not formally released +2.2 - live view (work in progress) +2.3 - live view - released in 1.1 +2.4 - live view protocol 2.1 +2.5 - remote capture +2.6 - script execution flags +*/ + +#define PTP_OC_CHDK 0x9999 + +// N.B.: unused parameters should be set to 0 +enum ptp_chdk_command { + PTP_CHDK_Version = 0, // return param1 is major version number + // return param2 is minor version number + PTP_CHDK_GetMemory, // param2 is base address (not NULL; circumvent by taking 0xFFFFFFFF and size+1) + // param3 is size (in bytes) + // return data is memory block + PTP_CHDK_SetMemory, // param2 is address + // param3 is size (in bytes) + // data is new memory block + PTP_CHDK_CallFunction, // data is array of function pointer and 32 bit int arguments (max: 10 args prior to protocol 2.5) + // return param1 is return value + PTP_CHDK_TempData, // data is data to be stored for later + // param2 is for the TD flags below + PTP_CHDK_UploadFile, // data is 4-byte length of filename, followed by filename and contents + PTP_CHDK_DownloadFile, // preceded by PTP_CHDK_TempData with filename + // return data are file contents + PTP_CHDK_ExecuteScript, // data is script to be executed + // param2 is language of script + // in proto 2.6 and later, language is the lower byte, rest is used for PTP_CHDK_SCRIPT_FL* flags + // return param1 is script id, like a process id + // return param2 is status from ptp_chdk_script_error_type + PTP_CHDK_ScriptStatus, // Script execution status + // return param1 bits + // PTP_CHDK_SCRIPT_STATUS_RUN is set if a script running, cleared if not + // PTP_CHDK_SCRIPT_STATUS_MSG is set if script messages from script waiting to be read + // all other bits and params are reserved for future use + PTP_CHDK_ScriptSupport, // Which scripting interfaces are supported in this build + // param1 CHDK_PTP_SUPPORT_LUA is set if lua is supported, cleared if not + // all other bits and params are reserved for future use + PTP_CHDK_ReadScriptMsg, // read next message from camera script system + // return param1 is chdk_ptp_s_msg_type + // return param2 is message subtype: + // for script return and users this is ptp_chdk_script_data_type + // for error ptp_chdk_script_error_type + // return param3 is script id of script that generated the message + // return param4 is length of the message data. + // return data is message. + // A minimum of 1 bytes of zeros is returned if the message has no data (empty string or type NONE) + PTP_CHDK_WriteScriptMsg, // write a message for scripts running on camera + // input param2 is target script id, 0=don't care. Messages for a non-running script will be discarded + // data length is handled by ptp data phase + // input messages do not have type or subtype, they are always a string destined for the script (similar to USER/string) + // output param1 is ptp_chdk_script_msg_status + PTP_CHDK_GetDisplayData, // Return camera display data + // This is defined as separate sub protocol in live_view.h + // Changes to the sub-protocol will always be considered a minor change to the main protocol + // param2 bitmask of data + // output param1 = total size of data + // return data is protocol information, frame buffer descriptions and selected display data + // Currently a data phase is always returned. Future versions may define other behavior + // for values in currently unused parameters. + // Direct image capture over USB. + // Use lua get_usb_capture_support for available data types, lua init_usb_capture for setup + PTP_CHDK_RemoteCaptureIsReady, // Check if data is available + // return param1 is status + // 0 = not ready + // 0x10000000 = remote capture not initialized + // otherwise bitmask of PTP_CHDK_CAPTURE_* datatypes + // return param2 is image number + PTP_CHDK_RemoteCaptureGetData // retrieve data + // param2 is bit indicating data type to get + // return param1 is length + // return param2 more chunks available? + // 0 = no more chunks of selected format + // return param3 seek required to pos (-1 = no seek) +}; + +// data types as used by ReadScriptMessage +enum ptp_chdk_script_data_type { + PTP_CHDK_TYPE_UNSUPPORTED = 0, // type name will be returned in data + PTP_CHDK_TYPE_NIL, + PTP_CHDK_TYPE_BOOLEAN, + PTP_CHDK_TYPE_INTEGER, + PTP_CHDK_TYPE_STRING, // Empty strings are returned with length=0 + PTP_CHDK_TYPE_TABLE, // tables are converted to a string by usb_msg_table_to_string, + // this function can be overridden in lua to change the format + // the string may be empty for an empty table +}; + +// TempData flags +#define PTP_CHDK_TD_DOWNLOAD 0x1 // download data instead of upload +#define PTP_CHDK_TD_CLEAR 0x2 // clear the stored data; with DOWNLOAD this + // means first download, then clear and + // without DOWNLOAD this means no uploading, + // just clear + +// Script Languages - for execution only lua is supported for now +#define PTP_CHDK_SL_LUA 0 +#define PTP_CHDK_SL_UBASIC 1 +#define PTP_CHDK_SL_MASK 0xFF + +// bit flags for script start +#define PTP_CHDK_SCRIPT_FL_NOKILL 0x100 // if script is running return error instead of killing +#define PTP_CHDK_SCRIPT_FL_FLUSH_CAM_MSGS 0x200 // discard existing cam->host messages before starting +#define PTP_CHDK_SCRIPT_FL_FLUSH_HOST_MSGS 0x400 // discard existing host->cam messages before starting + +// bit flags for script status +#define PTP_CHDK_SCRIPT_STATUS_RUN 0x1 // script running +#define PTP_CHDK_SCRIPT_STATUS_MSG 0x2 // messages waiting +// bit flags for scripting support +#define PTP_CHDK_SCRIPT_SUPPORT_LUA 0x1 + + +// bit flags for remote capture +// used to select and also to indicate available data in PTP_CHDK_RemoteCaptureIsReady +/* +Full jpeg file. Note supported on all cameras, use Lua get_usb_capture_support to check +*/ +#define PTP_CHDK_CAPTURE_JPG 0x1 + +/* +Raw framebuffer data, in camera native format. +A subset of rows may be re + 0K ........quested in init_usb_capture. +*/ +#define PTP_CHDK_CAPTURE_RAW 0x2 + +/* +DNG header. +The header will be DNG version 1.3 +Does not include image data, clients wanting to create a DNG file should also request RAW +Raw data for all known cameras will be packed, little endian. Client is responsible for +reversing the byte order if creating a DNG. +Can requested without RAW to get sensor dimensions, exif values etc. + +ifd 0 specifies a 128x96 RGB thumbnail, 4 byte aligned following the header +client is responsible for generating thumbnail data. + +ifd 0 subifd 0 specifies the main image +The image dimensions always contain the full sensor dimensions, if a sub-image was requested +with init_usb_capture, the client is responsible for padding the data to the full image or +adjusting dimensions. + +Bad pixels will not be patched, but DNG opcodes will specify how to patch them +*/ +#define PTP_CHDK_CAPTURE_DNGHDR 0x4 + +// status from PTP_CHDK_RemoteCaptureIsReady if capture not enabled +#define PTP_CHDK_CAPTURE_NOTSET 0x10000000 + +// message types +enum ptp_chdk_script_msg_type { + PTP_CHDK_S_MSGTYPE_NONE = 0, // no messages waiting + PTP_CHDK_S_MSGTYPE_ERR, // error message + PTP_CHDK_S_MSGTYPE_RET, // script return value + PTP_CHDK_S_MSGTYPE_USER, // message queued by script +// TODO chdk console data ? +}; + +// error subtypes for PTP_CHDK_S_MSGTYPE_ERR and script startup status +enum ptp_chdk_script_error_type { + PTP_CHDK_S_ERRTYPE_NONE = 0, + PTP_CHDK_S_ERRTYPE_COMPILE, + PTP_CHDK_S_ERRTYPE_RUN, + // the following are for ExecuteScript status only, not message types + PTP_CHDK_S_ERR_SCRIPTRUNNING = 0x1000, // script already running with NOKILL +}; + +// message status +enum ptp_chdk_script_msg_status { + PTP_CHDK_S_MSGSTATUS_OK = 0, // queued ok + PTP_CHDK_S_MSGSTATUS_NOTRUN, // no script is running + PTP_CHDK_S_MSGSTATUS_QFULL, // queue is full + PTP_CHDK_S_MSGSTATUS_BADID, // specified ID is not running +}; + +#endif // __CHDK_PTP_H