Changeset 1919

Timestamp:

06/17/12 22:24:59 (12 months ago)

Author:

reyalp

Message:

liveview - renamed PTP_CHDK_GetLiveData to PTP_CHDK_GetDisplayData, add some documentation

Location:

branches/reyalp-ptp-live/core

Files:

• live_view.h (modified) (1 diff)
• ptp.c (modified) (1 diff)
• ptp.h (modified) (2 diffs)

branches/reyalp-ptp-live/core/live_view.h

@@ -2 +2 @@
 #define __LIVE_VIEW_H
 
+/*
+Protocol notes:
+- Unless otherwise specified, all structure values are packed in camera native (little
+  endian) byte order
+- Frame buffer and palette data are in native camera formats
+  Some documentation may be found at http://chdk.wikia.com/wiki/Frame_buffers 
+- The frame buffer descriptions returned may not be correct depending on the
+  camera model and various camera settings (shooting mode, digital zoom, aspect ratio)
+  This may result in partial images, garbage in the "valid" area or incorrect position
+- In some cases, the requested data may not be available. If this happens, the framebuffer
+  or palette data offset will be zero. 
+- The frame buffer descriptions are returned regardless of whether the data is available
+*/
 // Live View protocol version
 #define LIVE_VIEW_VERSION_MAJOR 2  // increase only with backwards incompatible changes (and reset minor)
 #define LIVE_VIEW_VERSION_MINOR 0  // increase with extensions of functionality
+
+/*
+protocol version history
+< 2.0 - development versions
+*/
+
 
 // Control flags for determining which data block to transfer

branches/reyalp-ptp-live/core/ptp.c

@@ -624 +624 @@
 #endif
 
-    case PTP_CHDK_GetLiveData:
+    case PTP_CHDK_GetDisplayData:
         ptp.num_param = 1;
         ptp.param1 = live_view_get_data(data,param2);

branches/reyalp-ptp-live/core/ptp.h

@@ -9 +9 @@
 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 - eperimental live view, not formally released
+2.1 - experimental live view, not formally released
 2.2 - live view (work in progress)
 2.3 - live view (work in progress)
@@ -67 +67 @@
                             // 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_GetLiveData,     // TODO not final
+  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.
 };