picoproj: add a note about image dimensions and native resolution
[libam7xxx.git] / examples / picoproj.c
index c3b199c..2c1b257 100644 (file)
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @example examples/picoproj.c
+ * A minimal example to show how to use libam7xxx to display a static image.
+ */
+
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
@@ -32,14 +37,18 @@ static void usage(char *name)
        printf("usage: %s [OPTIONS]\n\n", name);
        printf("OPTIONS:\n");
        printf("\t-f <filename>\t\tthe image file to upload\n");
        printf("usage: %s [OPTIONS]\n\n", name);
        printf("OPTIONS:\n");
        printf("\t-f <filename>\t\tthe image file to upload\n");
-       printf("\t-F <format>\t\tthe image format to use (default is JPEG).\n");
+       printf("\t-F <format>\t\tthe image format to use (default is JPEG)\n");
        printf("\t\t\t\tSUPPORTED FORMATS:\n");
        printf("\t\t\t\t\t1 - JPEG\n");
        printf("\t\t\t\tSUPPORTED FORMATS:\n");
        printf("\t\t\t\t\t1 - JPEG\n");
-       printf("\t\t\t\t\t2 - YUV - NV12\n");
+       printf("\t\t\t\t\t2 - NV12\n");
        printf("\t-l <log level>\t\tthe verbosity level of libam7xxx output (0-5)\n");
        printf("\t-l <log level>\t\tthe verbosity level of libam7xxx output (0-5)\n");
+       printf("\t-p <power level>\tpower level of device, between %x (off) and %x (maximum)\n", AM7XXX_POWER_OFF, AM7XXX_POWER_TURBO);
+       printf("\t\t\t\tWARNING: Level 2 and greater require the master AND\n\t\t\t\t\t the slave connector to be plugged in.\n");
        printf("\t-W <image width>\tthe width of the image to upload\n");
        printf("\t-H <image height>\tthe height of the image to upload\n");
        printf("\t-h \t\t\tthis help message\n");
        printf("\t-W <image width>\tthe width of the image to upload\n");
        printf("\t-H <image height>\tthe height of the image to upload\n");
        printf("\t-h \t\t\tthis help message\n");
+       printf("\n\nEXAMPLE OF USE:\n");
+       printf("\t%s -f file.jpg -F 1 -l 5 -W 800 -H 480\n", name);
 }
 
 int main(int argc, char *argv[])
 }
 
 int main(int argc, char *argv[])
@@ -54,6 +63,7 @@ int main(int argc, char *argv[])
        am7xxx_context *ctx;
        am7xxx_device *dev;
        int log_level = AM7XXX_LOG_INFO;
        am7xxx_context *ctx;
        am7xxx_device *dev;
        int log_level = AM7XXX_LOG_INFO;
+       am7xxx_power_mode power_mode = AM7XXX_POWER_LOW;
        int format = AM7XXX_IMAGE_FORMAT_JPEG;
        int width = 800;
        int height = 480;
        int format = AM7XXX_IMAGE_FORMAT_JPEG;
        int width = 800;
        int height = 480;
@@ -61,7 +71,7 @@ int main(int argc, char *argv[])
        unsigned int size;
        am7xxx_device_info device_info;
 
        unsigned int size;
        am7xxx_device_info device_info;
 
-       while ((opt = getopt(argc, argv, "f:F:l:W:H:h")) != -1) {
+       while ((opt = getopt(argc, argv, "f:F:l:p:W:H:h")) != -1) {
                switch (opt) {
                case 'f':
                        strncpy(filename, optarg, FILENAME_MAX);
                switch (opt) {
                case 'f':
                        strncpy(filename, optarg, FILENAME_MAX);
@@ -87,6 +97,21 @@ int main(int argc, char *argv[])
                                log_level = AM7XXX_LOG_ERROR;
                        }
                        break;
                                log_level = AM7XXX_LOG_ERROR;
                        }
                        break;
+               case 'p':
+                       power_mode = atoi(optarg);
+                       switch(power_mode) {
+                       case AM7XXX_POWER_OFF:
+                       case AM7XXX_POWER_LOW:
+                       case AM7XXX_POWER_MIDDLE:
+                       case AM7XXX_POWER_HIGH:
+                       case AM7XXX_POWER_TURBO:
+                               fprintf(stdout, "Power mode: %x\n", power_mode);
+                               break;
+                       default:
+                               fprintf(stderr, "Invalid power mode value, must be between %x and %x\n", AM7XXX_POWER_OFF, AM7XXX_POWER_TURBO);
+                               exit(EXIT_FAILURE);
+                       }
+                       break;
                case 'W':
                        width = atoi(optarg);
                        if (width < 0) {
                case 'W':
                        width = atoi(optarg);
                        if (width < 0) {
@@ -177,13 +202,17 @@ int main(int argc, char *argv[])
        printf("Native resolution: %dx%d\n",
               device_info.native_width, device_info.native_height);
 
        printf("Native resolution: %dx%d\n",
               device_info.native_width, device_info.native_height);
 
-       ret = am7xxx_set_power_mode(dev, AM7XXX_POWER_LOW);
+       ret = am7xxx_set_power_mode(dev, power_mode);
        if (ret < 0) {
                perror("am7xxx_set_power_mode");
                exit_code = EXIT_FAILURE;
                goto cleanup;
        }
 
        if (ret < 0) {
                perror("am7xxx_set_power_mode");
                exit_code = EXIT_FAILURE;
                goto cleanup;
        }
 
+       if ((unsigned int)width > device_info.native_width ||
+           (unsigned int)height > device_info.native_height)
+               fprintf(stderr, "WARNING: image not fitting the native resolution, it may be displayed wrongly!\n");
+
        ret = am7xxx_send_image(dev, format, width, height, image, size);
        if (ret < 0) {
                perror("am7xxx_send_image");
        ret = am7xxx_send_image(dev, format, width, height, image, size);
        if (ret < 0) {
                perror("am7xxx_send_image");