src/main/drivers/osd.h

   1 /*
   2  * This file is part of Cleanflight, Betaflight and INAV
   3  *
   4  * Cleanflight, Betaflight and INAV are free software. You can
   5  * redistribute this software and/or modify this software under
   6  * the terms of the GNU General Public License as published by
   7  * the Free Software Foundation, either version 3 of the License,
   8  * or (at your option) any later version.
   9  *
  10  * Cleanflight, Betaflight and INAV are distributed in the hope that
  11  * they will be useful, but WITHOUT ANY WARRANTY; without even the
  12  * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  13  * PURPOSE. See the GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this software.
  17  *
  18  * If not, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21 #pragma once
  22
  23 #include <stdint.h>
  24
  25 #include "common/utils.h"
  26
  27 #define OSD_CHAR_WIDTH 12
  28 #define OSD_CHAR_HEIGHT 18
  29 #define OSD_CHAR_BITS_PER_PIXEL 2
  30 #define OSD_CHAR_VISIBLE_BYTES (OSD_CHAR_WIDTH * OSD_CHAR_HEIGHT * OSD_CHAR_BITS_PER_PIXEL / 8)
  31 // Only the first 54 bytes of a character represent visible data. However, some OSD drivers
  32 // accept 64 bytes and use the extra 10 bytes for metadata.
  33 #define OSD_CHAR_BYTES 64
  34
  35 #define OSD_CHARACTER_COLOR_BLACK 0
  36 #define OSD_CHARACTER_COLOR_TRANSPARENT 1
  37 #define OSD_CHARACTER_COLOR_WHITE 2
  38
  39 // 3 is unused but it's interpreted as transparent by all drivers
  40
  41 // Video Character Display parameters
  42
  43 typedef enum {
  44     VIDEO_SYSTEM_AUTO = 0,
  45     VIDEO_SYSTEM_PAL,
  46     VIDEO_SYSTEM_NTSC,
  47     VIDEO_SYSTEM_HD
  48 } videoSystem_e;
  49
  50 typedef enum {
  51     OSD_DRIVER_NONE = 0,
  52     OSD_DRIVER_MAX7456 = 1,
  53 } osdDriver_e;
  54
  55 // osdCharacter_t represents the binary data for an OSD
  56 // character. All OSD drivers use the same character format
  57 // as defined by OSD_CHARACTER_WIDTH, OSD_CHARACTER_HEIGHT
  58 // and OSD_CHARACTER_BITS_PER_PIXEL.
  59 typedef struct osdCharacter_s {
  60     uint8_t data[OSD_CHAR_BYTES];
  61 } osdCharacter_t;