src/vulkan/overlay-layer/overlay_params.c

   1 /*
   2  * Copyright © 2019 Intel Corporation
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice (including the next
  12  * paragraph) shall be included in all copies or substantial portions of the
  13  * Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  21  * IN THE SOFTWARE.
  22  */
  23
  24 #include <stdio.h>
  25 #include <string.h>
  26 #include <stdlib.h>
  27
  28 #include "overlay_params.h"
  29
  30 static enum overlay_param_position
  31 parse_position(const char *str)
  32 {
  33    if (!str || !strcmp(str, "top-left"))
  34       return LAYER_POSITION_TOP_LEFT;
  35    if (!strcmp(str, "top-right"))
  36       return LAYER_POSITION_TOP_RIGHT;
  37    if (!strcmp(str, "bottom-left"))
  38       return LAYER_POSITION_BOTTOM_LEFT;
  39    if (!strcmp(str, "bottom-right"))
  40       return LAYER_POSITION_BOTTOM_RIGHT;
  41    return LAYER_POSITION_TOP_LEFT;
  42 }
  43
  44 static FILE *
  45 parse_output_file(const char *str)
  46 {
  47    return fopen(str, "w+");
  48 }
  49
  50 static uint32_t
  51 parse_fps_sampling_period(const char *str)
  52 {
  53    return strtol(str, NULL, 0) * 1000;
  54 }
  55
  56 static bool
  57 parse_help(const char *str)
  58 {
  59    fprintf(stderr, "Layer params using VK_LAYER_MESA_OVERLAY_CONFIG=\n");
  60 #define OVERLAY_PARAM_BOOL(name)                \
  61    fprintf(stderr, "\t%s=0|1\n", #name);
  62 #define OVERLAY_PARAM_CUSTOM(name)
  63    OVERLAY_PARAMS
  64 #undef OVERLAY_PARAM_BOOL
  65 #undef OVERLAY_PARAM_CUSTOM
  66    fprintf(stderr, "\tposition=top-left|top-right|bottom-left|bottom-right\n");
  67    fprintf(stderr, "\tfps_sampling_period=number-of-milliseconds\n");
  68
  69    return true;
  70 }
  71
  72 static bool is_delimiter(char c)
  73 {
  74    return c == 0 || c == ',' || c == ':' || c == ';' || c == '=';
  75 }
  76
  77 static int
  78 parse_string(const char *s, char *out_param, char *out_value)
  79 {
  80    int i = 0;
  81
  82    for (; !is_delimiter(*s); s++, out_param++, i++)
  83       *out_param = *s;
  84
  85    *out_param = 0;
  86
  87    if (*s == '=') {
  88       s++;
  89       i++;
  90       for (; !is_delimiter(*s); s++, out_value++, i++)
  91          *out_value = *s;
  92    } else
  93       *(out_value++) = '1';
  94    *out_value = 0;
  95
  96    if (*s && is_delimiter(*s)) {
  97       s++;
  98       i++;
  99    }
 100
 101    if (*s && !i) {
 102       fprintf(stderr, "mesa-overlay: syntax error: unexpected '%c' (%i) while "
 103               "parsing a string\n", *s, *s);
 104       fflush(stderr);
 105    }
 106
 107    return i;
 108 }
 109
 110 const char *overlay_param_names[] = {
 111 #define OVERLAY_PARAM_BOOL(name) #name,
 112 #define OVERLAY_PARAM_CUSTOM(name)
 113    OVERLAY_PARAMS
 114 #undef OVERLAY_PARAM_BOOL
 115 #undef OVERLAY_PARAM_CUSTOM
 116 };
 117
 118 void
 119 parse_overlay_env(struct overlay_params *params,
 120                   const char *env)
 121 {
 122    uint32_t num;
 123    char key[256], value[256];
 124
 125    memset(params, 0, sizeof(*params));
 126
 127    /* Visible by default */
 128    params->enabled[OVERLAY_PARAM_ENABLED_fps] = true;
 129    params->enabled[OVERLAY_PARAM_ENABLED_frame_timing] = true;
 130    params->fps_sampling_period = 500000; /* 500ms */
 131
 132    if (!env)
 133       return;
 134
 135    while ((num = parse_string(env, key, value)) != 0) {
 136       env += num;
 137
 138 #define OVERLAY_PARAM_BOOL(name)                                        \
 139       if (!strcmp(#name, key)) {                                        \
 140          params->enabled[OVERLAY_PARAM_ENABLED_##name] =                \
 141             strtol(value, NULL, 0);                                     \
 142          continue;                                                      \
 143       }
 144 #define OVERLAY_PARAM_CUSTOM(name)               \
 145       if (!strcmp(#name, key)) {                 \
 146          params->name = parse_##name(value);     \
 147          continue;                               \
 148       }
 149       OVERLAY_PARAMS
 150 #undef OVERLAY_PARAM_BOOL
 151 #undef OVERLAY_PARAM_CUSTOM
 152       fprintf(stderr, "Unknown option '%s'\n", key);
 153    }
 154 }