Merge tag 'v0.1.3' into debian
[libam7xxx.git] / src / am7xxx.c
index 4ed7cf9..83d9a91 100644 (file)
@@ -22,6 +22,7 @@
 #include <stdarg.h>
 #include <errno.h>
 #include <libusb.h>
+#include <math.h>
 
 #include "am7xxx.h"
 #include "serialize.h"
 #  define  __attribute__(x)  /*NOTHING*/
 #endif
 
+/* Control shared library symbols visibility */
+#if defined _WIN32 || defined __CYGWIN__
+       #define AM7XXX_PUBLIC __declspec(dllexport)
+       #define AM7XXX_LOCAL
+#else
+       #if __GNUC__ >= 4
+               #define AM7XXX_PUBLIC __attribute__ ((visibility ("default")))
+               #define AM7XXX_LOCAL  __attribute__ ((visibility ("hidden")))
+       #else
+               #define AM7XXX_PUBLIC
+               #define AM7XXX_LOCAL
+       #endif
+#endif
+
 static void log_message(am7xxx_context *ctx,
                        int level,
                        const char *function,
@@ -62,14 +77,29 @@ static struct am7xxx_usb_device_descriptor supported_devices[] = {
                .product_id = 0xc101,
        },
        {
+               .name       = "Acer C112",
+               .vendor_id  = 0x1de1,
+               .product_id = 0x5501,
+       },
+       {
+               .name       ="Aiptek PocketCinema T25",
+               .vendor_id  = 0x08ca,
+               .product_id = 0x2144,
+       },
+       {
                .name       = "Philips/Sagemcom PicoPix 1020",
                .vendor_id  = 0x21e7,
                .product_id = 0x000e,
        },
+       {
+               .name       = "Philips/Sagemcom PicoPix 2055",
+               .vendor_id  = 0x21e7,
+               .product_id = 0x0016,
+       },
 };
 
 /* The header size on the wire is known to be always 24 bytes, regardless of
- * the memory configuration enforced by different architechtures or compilers
+ * the memory configuration enforced by different architectures or compilers
  * for struct am7xxx_header
  */
 #define AM7XXX_HEADER_WIRE_SIZE 24
@@ -77,6 +107,7 @@ static struct am7xxx_usb_device_descriptor supported_devices[] = {
 struct _am7xxx_device {
        libusb_device_handle *usb_device;
        uint8_t buffer[AM7XXX_HEADER_WIRE_SIZE];
+       am7xxx_device_info *device_info;
        am7xxx_context *ctx;
        am7xxx_device *next;
 };
@@ -91,7 +122,7 @@ typedef enum {
        AM7XXX_PACKET_TYPE_DEVINFO = 0x01,
        AM7XXX_PACKET_TYPE_IMAGE   = 0x02,
        AM7XXX_PACKET_TYPE_POWER   = 0x04,
-       AM7XXX_PACKET_TYPE_UNKNOWN = 0x05,
+       AM7XXX_PACKET_TYPE_ZOOM    = 0x05,
 } am7xxx_packet_type;
 
 struct am7xxx_generic_header {
@@ -121,6 +152,11 @@ struct am7xxx_power_header {
        uint32_t bit0;
 };
 
+struct am7xxx_zoom_header {
+       uint32_t bit1;
+       uint32_t bit0;
+};
+
 /*
  * Examples of packet headers:
  *
@@ -131,9 +167,13 @@ struct am7xxx_power_header {
  * 04 00 00 00 00 0c ff ff 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
  */
 
+/* Direction of the communication from the host point of view */
+#define AM7XXX_DIRECTION_OUT 0 /* host -> device */
+#define AM7XXX_DIRECTION_IN  1 /* host <- device */
+
 struct am7xxx_header {
        uint32_t packet_type;
-       uint8_t unknown0;
+       uint8_t direction;
        uint8_t header_data_len;
        uint8_t unknown2;
        uint8_t unknown3;
@@ -142,6 +182,7 @@ struct am7xxx_header {
                struct am7xxx_devinfo_header devinfo;
                struct am7xxx_image_header image;
                struct am7xxx_power_header power;
+               struct am7xxx_zoom_header zoom;
        } header_data;
 };
 
@@ -182,6 +223,16 @@ static void debug_dump_power_header(am7xxx_context *ctx, struct am7xxx_power_hea
        debug(ctx, "\tbit0: 0x%08x (%u)\n", p->bit0, p->bit0);
 }
 
+static void debug_dump_zoom_header(am7xxx_context *ctx, struct am7xxx_zoom_header *z)
+{
+       if (ctx == NULL || z == NULL)
+               return;
+
+       debug(ctx, "Zoom header:\n");
+       debug(ctx, "\tbit1: 0x%08x (%u)\n", z->bit1, z->bit1);
+       debug(ctx, "\tbit0: 0x%08x (%u)\n", z->bit0, z->bit0);
+}
+
 static void debug_dump_header(am7xxx_context *ctx, struct am7xxx_header *h)
 {
        if (ctx == NULL || h == NULL)
@@ -189,7 +240,10 @@ static void debug_dump_header(am7xxx_context *ctx, struct am7xxx_header *h)
 
        debug(ctx, "BEGIN\n");
        debug(ctx, "packet_type:     0x%08x (%u)\n", h->packet_type, h->packet_type);
-       debug(ctx, "unknown0:        0x%02hhx (%hhu)\n", h->unknown0, h->unknown0);
+       debug(ctx, "direction:       0x%02hhx (%hhu) (%s)\n", h->direction, h->direction,
+             h->direction == AM7XXX_DIRECTION_IN ? "IN" :
+             h->direction == AM7XXX_DIRECTION_OUT ? "OUT" :
+             "UNKNOWN");
        debug(ctx, "header_data_len: 0x%02hhx (%hhu)\n", h->header_data_len, h->header_data_len);
        debug(ctx, "unknown2:        0x%02hhx (%hhu)\n", h->unknown2, h->unknown2);
        debug(ctx, "unknown3:        0x%02hhx (%hhu)\n", h->unknown3, h->unknown3);
@@ -207,6 +261,10 @@ static void debug_dump_header(am7xxx_context *ctx, struct am7xxx_header *h)
                debug_dump_power_header(ctx, &(h->header_data.power));
                break;
 
+       case AM7XXX_PACKET_TYPE_ZOOM:
+               debug_dump_zoom_header(ctx, &(h->header_data.zoom));
+               break;
+
        default:
                debug(ctx, "Packet type not supported!\n");
                break;
@@ -244,6 +302,7 @@ static void debug_dump_header(am7xxx_context *ctx, struct am7xxx_header *h)
        (void)ctx;
        (void)h;
 }
+
 static void trace_dump_buffer(am7xxx_context *ctx, const char *message,
                              uint8_t *buffer, unsigned int len)
 {
@@ -278,7 +337,7 @@ static int send_data(am7xxx_device *dev, uint8_t *buffer, unsigned int len)
 
        trace_dump_buffer(dev->ctx, "sending -->", buffer, len);
 
-       ret = libusb_bulk_transfer(dev->usb_device, 1, buffer, len, &transferred, 0);
+       ret = libusb_bulk_transfer(dev->usb_device, 0x1, buffer, len, &transferred, 0);
        if (ret != 0 || (unsigned int)transferred != len) {
                error(dev->ctx, "ret: %d\ttransferred: %d (expected %u)\n",
                      ret, transferred, len);
@@ -293,7 +352,7 @@ static void serialize_header(struct am7xxx_header *h, uint8_t *buffer)
        uint8_t **buffer_iterator = &buffer;
 
        put_le32(h->packet_type, buffer_iterator);
-       put_8(h->unknown0, buffer_iterator);
+       put_8(h->direction, buffer_iterator);
        put_8(h->header_data_len, buffer_iterator);
        put_8(h->unknown2, buffer_iterator);
        put_8(h->unknown3, buffer_iterator);
@@ -308,7 +367,7 @@ static void unserialize_header(uint8_t *buffer, struct am7xxx_header *h)
        uint8_t **buffer_iterator = &buffer;
 
        h->packet_type = get_le32(buffer_iterator);
-       h->unknown0 = get_8(buffer_iterator);
+       h->direction = get_8(buffer_iterator);
        h->header_data_len = get_8(buffer_iterator);
        h->unknown2 = get_8(buffer_iterator);
        h->unknown3 = get_8(buffer_iterator);
@@ -328,9 +387,16 @@ static int read_header(am7xxx_device *dev, struct am7xxx_header *h)
 
        unserialize_header(dev->buffer, h);
 
-       debug_dump_header(dev->ctx, h);
+       if (h->direction == AM7XXX_DIRECTION_IN) {
+               ret = 0;
+       } else {
+               error(dev->ctx,
+                     "Expected an AM7XXX_DIRECTION_IN packet, got one with direction = %d. Weird!\n",
+                     h->direction);
+               ret = -EINVAL;
+       }
 
-       ret = 0;
+       debug_dump_header(dev->ctx, h);
 
 out:
        return ret;
@@ -342,7 +408,13 @@ static int send_header(am7xxx_device *dev, struct am7xxx_header *h)
 
        debug_dump_header(dev->ctx, h);
 
+       /* For symmetry with read_header() we should check here for
+        * h->direction == AM7XXX_DIRECTION_OUT but we just ensure that in all
+        * the callers and save some cycles here.
+        */
+
        serialize_header(h, dev->buffer);
+
        ret = send_data(dev, dev->buffer, AM7XXX_HEADER_WIRE_SIZE);
        if (ret < 0)
                error(dev->ctx, "failed to send data\n");
@@ -389,8 +461,6 @@ static am7xxx_device *add_new_device(am7xxx_context *ctx)
                return NULL;
        }
 
-       devices_list = &(ctx->devices_list);
-
        new_device = malloc(sizeof(*new_device));
        if (new_device == NULL) {
                fatal("cannot allocate a new device (%s)\n", strerror(errno));
@@ -400,6 +470,8 @@ static am7xxx_device *add_new_device(am7xxx_context *ctx)
 
        new_device->ctx = ctx;
 
+       devices_list = &(ctx->devices_list);
+
        if (*devices_list == NULL) {
                *devices_list = new_device;
        } else {
@@ -445,7 +517,7 @@ typedef enum {
  * device with index 'open_device_index' and returns the correspondent
  * am7xxx_device in the 'dev' parameter; the function returns 0 on success,
  * 1 if the device was already open and a negative value on error.
- * 
+ *
  * NOTES:
  * if scan_devices() fails when called with 'op' == SCAN_OP_BUILD_DEVLIST,
  * the caller might want to call am7xxx_shutdown() in order to remove
@@ -485,8 +557,8 @@ static int scan_devices(am7xxx_context *ctx, scan_op op,
                        continue;
 
                for (j = 0; j < ARRAY_SIZE(supported_devices); j++) {
-                       if (desc.idVendor == supported_devices[j].vendor_id
-                           && desc.idProduct == supported_devices[j].product_id) {
+                       if (desc.idVendor == supported_devices[j].vendor_id &&
+                           desc.idProduct == supported_devices[j].product_id) {
 
                                if (op == SCAN_OP_BUILD_DEVLIST) {
                                        am7xxx_device *new_device;
@@ -526,7 +598,7 @@ static int scan_devices(am7xxx_context *ctx, scan_op op,
                                                goto out;
                                        }
 
-                                       libusb_set_configuration((*dev)->usb_device, 1);
+                                       libusb_set_configuration((*dev)->usb_device, 2);
                                        libusb_claim_interface((*dev)->usb_device, 0);
                                        goto out;
                                }
@@ -549,7 +621,9 @@ out:
        return ret;
 }
 
-int am7xxx_init(am7xxx_context **ctx)
+/* Public API */
+
+AM7XXX_PUBLIC int am7xxx_init(am7xxx_context **ctx)
 {
        int ret = 0;
 
@@ -588,7 +662,7 @@ out:
        return ret;
 }
 
-void am7xxx_shutdown(am7xxx_context *ctx)
+AM7XXX_PUBLIC void am7xxx_shutdown(am7xxx_context *ctx)
 {
        am7xxx_device *current;
 
@@ -601,6 +675,7 @@ void am7xxx_shutdown(am7xxx_context *ctx)
        while (current) {
                am7xxx_device *next = current->next;
                am7xxx_close_device(current);
+               free(current->device_info);
                free(current);
                current = next;
        }
@@ -610,12 +685,12 @@ void am7xxx_shutdown(am7xxx_context *ctx)
        ctx = NULL;
 }
 
-void am7xxx_set_log_level(am7xxx_context *ctx, am7xxx_log_level log_level)
+AM7XXX_PUBLIC void am7xxx_set_log_level(am7xxx_context *ctx, am7xxx_log_level log_level)
 {
        ctx->log_level = log_level;
 }
 
-int am7xxx_open_device(am7xxx_context *ctx, am7xxx_device **dev,
+AM7XXX_PUBLIC int am7xxx_open_device(am7xxx_context *ctx, am7xxx_device **dev,
                       unsigned int device_index)
 {
        int ret;
@@ -628,16 +703,32 @@ int am7xxx_open_device(am7xxx_context *ctx, am7xxx_device **dev,
        ret = scan_devices(ctx, SCAN_OP_OPEN_DEVICE, device_index, dev);
        if (ret < 0) {
                errno = ENODEV;
+               goto out;
        } else if (ret > 0) {
                warning(ctx, "device %d already open\n", device_index);
                errno = EBUSY;
                ret = -EBUSY;
+               goto out;
+       }
+
+       /* Philips/Sagemcom PicoPix projectors require that the DEVINFO packet
+        * is the first one to be sent to the device in order for it to
+        * successfully return the correct device information.
+        *
+        * So, if there is not a cached version of it (from a previous open),
+        * we ask for device info at open time,
+        */
+       if ((*dev)->device_info == NULL) {
+               ret = am7xxx_get_device_info(*dev, NULL);
+               if (ret < 0)
+                       error(ctx, "cannot get device info\n");
        }
 
+out:
        return ret;
 }
 
-int am7xxx_close_device(am7xxx_device *dev)
+AM7XXX_PUBLIC int am7xxx_close_device(am7xxx_device *dev)
 {
        if (dev == NULL) {
                fatal("dev must not be NULL!\n");
@@ -651,16 +742,13 @@ int am7xxx_close_device(am7xxx_device *dev)
        return 0;
 }
 
-int am7xxx_get_device_info(am7xxx_device *dev,
-                          unsigned int *native_width,
-                          unsigned int *native_height,
-                          unsigned int *unknown0,
-                          unsigned int *unknown1)
+AM7XXX_PUBLIC int am7xxx_get_device_info(am7xxx_device *dev,
+                          am7xxx_device_info *device_info)
 {
        int ret;
        struct am7xxx_header h = {
                .packet_type     = AM7XXX_PACKET_TYPE_DEVINFO,
-               .unknown0        = 0x00,
+               .direction       = AM7XXX_DIRECTION_OUT,
                .header_data_len = 0x00,
                .unknown2        = 0x3e,
                .unknown3        = 0x10,
@@ -674,6 +762,11 @@ int am7xxx_get_device_info(am7xxx_device *dev,
                },
        };
 
+       if (dev->device_info) {
+               memcpy(device_info, dev->device_info, sizeof(*device_info));
+               return 0;
+       }
+
        ret = send_header(dev, &h);
        if (ret < 0)
                return ret;
@@ -682,25 +775,105 @@ int am7xxx_get_device_info(am7xxx_device *dev,
        if (ret < 0)
                return ret;
 
-       *native_width = h.header_data.devinfo.native_width;
-       *native_height = h.header_data.devinfo.native_height;
-       *unknown0 = h.header_data.devinfo.unknown0;
-       *unknown1 = h.header_data.devinfo.unknown1;
+       if (h.packet_type != AM7XXX_PACKET_TYPE_DEVINFO) {
+               error(dev->ctx, "expected packet type: %d, got %d instead!\n",
+                     AM7XXX_PACKET_TYPE_DEVINFO, h.packet_type);
+               errno = ENOTSUP;
+               return -ENOTSUP;
+       }
+
+       dev->device_info = malloc(sizeof(*dev->device_info));
+       if (dev->device_info == NULL) {
+               error(dev->ctx, "cannot allocate a device info (%s)\n",
+                      strerror(errno));
+               return -ENOMEM;
+       }
+       memset(dev->device_info, 0, sizeof(*dev->device_info));
+
+       dev->device_info->native_width = h.header_data.devinfo.native_width;
+       dev->device_info->native_height = h.header_data.devinfo.native_height;
+#if 0
+       /* No reason to expose these in the public API until we know what they mean */
+       dev->device_info->unknown0 = h.header_data.devinfo.unknown0;
+       dev->device_info->unknown1 = h.header_data.devinfo.unknown1;
+#endif
+
+       return 0;
+}
+
+AM7XXX_PUBLIC int am7xxx_calc_scaled_image_dimensions(am7xxx_device *dev,
+                                       unsigned int upscale,
+                                       unsigned int original_width,
+                                       unsigned int original_height,
+                                       unsigned int *scaled_width,
+                                       unsigned int *scaled_height)
+{
+
+       am7xxx_device_info device_info;
+       float width_ratio;
+       float height_ratio;
+       int ret;
+
+       ret = am7xxx_get_device_info(dev, &device_info);
+       if (ret < 0) {
+               error(dev->ctx, "cannot get device info\n");
+               return ret;
+       }
+
+       /*
+        * Check if we need to rescale; if the input image fits the native
+        * dimensions there is no need to, unless we want to upscale.
+        */
+       if (!upscale &&
+           original_width <= device_info.native_width &&
+           original_height <= device_info.native_height ) {
+               debug(dev->ctx, "CASE 0, no rescaling, the original image fits already\n");
+               *scaled_width = original_width;
+               *scaled_height = original_height;
+               return 0;
+       }
+
+       /* Input dimensions relative to the device native dimensions */
+       width_ratio =  (float)original_width / device_info.native_width;
+       height_ratio = (float)original_height / device_info.native_height;
+
+       if (width_ratio > height_ratio) {
+               /*
+                * The input is proportionally "wider" than the device viewport
+                * so its height needs to be adjusted
+                */
+               debug(dev->ctx, "CASE 1, original image wider, adjust the scaled height\n");
+               *scaled_width = device_info.native_width;
+               *scaled_height = (unsigned int)lroundf(original_height / width_ratio);
+       } else if (width_ratio < height_ratio) {
+               /*
+                * The input is proportionally "taller" than the device viewport
+                * so its width needs to be adjusted
+                */
+               debug(dev->ctx, "CASE 2 original image taller, adjust the scaled width\n");
+               *scaled_width = (unsigned int)lroundf(original_width / height_ratio);
+               *scaled_height = device_info.native_height;
+       } else {
+               debug(dev->ctx, "CASE 3, just rescale, same aspect ratio already\n");
+               *scaled_width = device_info.native_width;
+               *scaled_height = device_info.native_height;
+       }
+       debug(dev->ctx, "scaled dimensions: %dx%d\n", *scaled_width, *scaled_height);
 
        return 0;
 }
 
-int am7xxx_send_image(am7xxx_device *dev,
+AM7XXX_PUBLIC int am7xxx_send_image(am7xxx_device *dev,
                      am7xxx_image_format format,
                      unsigned int width,
                      unsigned int height,
                      uint8_t *image,
-                     unsigned int size)
+                     unsigned int image_size)
 {
        int ret;
        struct am7xxx_header h = {
                .packet_type     = AM7XXX_PACKET_TYPE_IMAGE,
-               .unknown0        = 0x00,
+               .direction       = AM7XXX_DIRECTION_OUT,
                .header_data_len = sizeof(struct am7xxx_image_header),
                .unknown2        = 0x3e,
                .unknown3        = 0x10,
@@ -709,7 +882,7 @@ int am7xxx_send_image(am7xxx_device *dev,
                                .format     = format,
                                .width      = width,
                                .height     = height,
-                               .image_size = size,
+                               .image_size = image_size,
                        },
                },
        };
@@ -718,26 +891,26 @@ int am7xxx_send_image(am7xxx_device *dev,
        if (ret < 0)
                return ret;
 
-       if (image == NULL || size == 0) {
-               warning(dev->ctx, "Not sending any data, check the 'data' or 'size' parameters\n");
+       if (image == NULL || image_size == 0) {
+               warning(dev->ctx, "Not sending any data, check the 'image' or 'image_size' parameters\n");
                return 0;
        }
 
-       return send_data(dev, image, size);
+       return send_data(dev, image, image_size);
 }
 
-int am7xxx_set_power_mode(am7xxx_device *dev, am7xxx_power_mode mode)
+AM7XXX_PUBLIC int am7xxx_set_power_mode(am7xxx_device *dev, am7xxx_power_mode power)
 {
        int ret;
        struct am7xxx_header h = {
                .packet_type     = AM7XXX_PACKET_TYPE_POWER,
-               .unknown0        = 0x00,
+               .direction       = AM7XXX_DIRECTION_OUT,
                .header_data_len = sizeof(struct am7xxx_power_header),
                .unknown2        = 0x3e,
                .unknown3        = 0x10,
        };
 
-       switch(mode) {
+       switch(power) {
        case AM7XXX_POWER_OFF:
                h.header_data.power.bit2 = 0;
                h.header_data.power.bit1 = 0;
@@ -748,6 +921,7 @@ int am7xxx_set_power_mode(am7xxx_device *dev, am7xxx_power_mode mode)
                h.header_data.power.bit2 = 0;
                h.header_data.power.bit1 = 0;
                h.header_data.power.bit0 = 1;
+               break;
 
        case AM7XXX_POWER_MIDDLE:
                h.header_data.power.bit2 = 0;
@@ -768,7 +942,51 @@ int am7xxx_set_power_mode(am7xxx_device *dev, am7xxx_power_mode mode)
                break;
 
        default:
-               error(dev->ctx, "Power mode not supported!\n");
+               error(dev->ctx, "Unsupported power mode.\n");
+               return -EINVAL;
+       };
+
+       ret = send_header(dev, &h);
+       if (ret < 0)
+               return ret;
+
+       return 0;
+}
+
+AM7XXX_PUBLIC int am7xxx_set_zoom_mode(am7xxx_device *dev, am7xxx_zoom_mode zoom)
+{
+       int ret;
+       struct am7xxx_header h = {
+               .packet_type     = AM7XXX_PACKET_TYPE_ZOOM,
+               .direction       = AM7XXX_DIRECTION_OUT,
+               .header_data_len = sizeof(struct am7xxx_zoom_header),
+               .unknown2        = 0x3e,
+               .unknown3        = 0x10,
+       };
+
+       switch(zoom) {
+       case AM7XXX_ZOOM_ORIGINAL:
+               h.header_data.zoom.bit1 = 0;
+               h.header_data.zoom.bit0 = 0;
+               break;
+
+       case AM7XXX_ZOOM_H:
+               h.header_data.zoom.bit1 = 0;
+               h.header_data.zoom.bit0 = 1;
+               break;
+
+       case AM7XXX_ZOOM_H_V:
+               h.header_data.zoom.bit1 = 1;
+               h.header_data.zoom.bit0 = 0;
+               break;
+
+       case AM7XXX_ZOOM_TEST:
+               h.header_data.zoom.bit1 = 1;
+               h.header_data.zoom.bit0 = 1;
+               break;
+
+       default:
+               error(dev->ctx, "Unsupported zoom mode.\n");
                return -EINVAL;
        };