1 /* SPDX-License-Identifier: LGPL-2.1+ WITH Linux-syscall-note */
2 /*
3  * osd.h
4  *
5  * Copyright (C) 2001 Ralph  Metzler <ralph@convergence.de>
6  *                  & Marcus Metzler <marcus@convergence.de>
7  *                    for convergence integrated media GmbH
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Lesser Public License
11  * as published by the Free Software Foundation; either version 2.1
12  * of the License, or (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22  *
23  */
24 
25 #ifndef _DVBOSD_H_
26 #define _DVBOSD_H_
27 
28 #include <linux/compiler.h>
29 
30 typedef enum {
31   // All functions return -2 on "not open"
32   OSD_Close=1,    // ()
33   // Disables OSD and releases the buffers
34   // returns 0 on success
35   OSD_Open,       // (x0,y0,x1,y1,BitPerPixel[2/4/8](color&0x0F),mix[0..15](color&0xF0))
36   // Opens OSD with this size and bit depth
37   // returns 0 on success, -1 on DRAM allocation error, -2 on "already open"
38   OSD_Show,       // ()
39   // enables OSD mode
40   // returns 0 on success
41   OSD_Hide,       // ()
42   // disables OSD mode
43   // returns 0 on success
44   OSD_Clear,      // ()
45   // Sets all pixel to color 0
46   // returns 0 on success
47   OSD_Fill,       // (color)
48   // Sets all pixel to color <col>
49   // returns 0 on success
50   OSD_SetColor,   // (color,R{x0},G{y0},B{x1},opacity{y1})
51   // set palette entry <num> to <r,g,b>, <mix> and <trans> apply
52   // R,G,B: 0..255
53   // R=Red, G=Green, B=Blue
54   // opacity=0:      pixel opacity 0% (only video pixel shows)
55   // opacity=1..254: pixel opacity as specified in header
56   // opacity=255:    pixel opacity 100% (only OSD pixel shows)
57   // returns 0 on success, -1 on error
58   OSD_SetPalette, // (firstcolor{color},lastcolor{x0},data)
59   // Set a number of entries in the palette
60   // sets the entries "firstcolor" through "lastcolor" from the array "data"
61   // data has 4 byte for each color:
62   // R,G,B, and a opacity value: 0->transparent, 1..254->mix, 255->pixel
63   OSD_SetTrans,   // (transparency{color})
64   // Sets transparency of mixed pixel (0..15)
65   // returns 0 on success
66   OSD_SetPixel,   // (x0,y0,color)
67   // sets pixel <x>,<y> to color number <col>
68   // returns 0 on success, -1 on error
69   OSD_GetPixel,   // (x0,y0)
70   // returns color number of pixel <x>,<y>,  or -1
71   OSD_SetRow,     // (x0,y0,x1,data)
72   // fills pixels x0,y through  x1,y with the content of data[]
73   // returns 0 on success, -1 on clipping all pixel (no pixel drawn)
74   OSD_SetBlock,   // (x0,y0,x1,y1,increment{color},data)
75   // fills pixels x0,y0 through  x1,y1 with the content of data[]
76   // inc contains the width of one line in the data block,
77   // inc<=0 uses blockwidth as linewidth
78   // returns 0 on success, -1 on clipping all pixel
79   OSD_FillRow,    // (x0,y0,x1,color)
80   // fills pixels x0,y through  x1,y with the color <col>
81   // returns 0 on success, -1 on clipping all pixel
82   OSD_FillBlock,  // (x0,y0,x1,y1,color)
83   // fills pixels x0,y0 through  x1,y1 with the color <col>
84   // returns 0 on success, -1 on clipping all pixel
85   OSD_Line,       // (x0,y0,x1,y1,color)
86   // draw a line from x0,y0 to x1,y1 with the color <col>
87   // returns 0 on success
88   OSD_Query,      // (x0,y0,x1,y1,xasp{color}}), yasp=11
89   // fills parameters with the picture dimensions and the pixel aspect ratio
90   // returns 0 on success
91   OSD_Test,       // ()
92   // draws a test picture. for debugging purposes only
93   // returns 0 on success
94 // TODO: remove "test" in final version
95   OSD_Text,       // (x0,y0,size,color,text)
96   OSD_SetWindow, //  (x0) set window with number 0<x0<8 as current
97   OSD_MoveWindow, //  move current window to (x0, y0)
98   OSD_OpenRaw,	// Open other types of OSD windows
99 } OSD_Command;
100 
101 typedef struct osd_cmd_s {
102 	OSD_Command cmd;
103 	int x0;
104 	int y0;
105 	int x1;
106 	int y1;
107 	int color;
108 	void __user *data;
109 } osd_cmd_t;
110 
111 /* OSD_OpenRaw: set 'color' to desired window type */
112 typedef enum {
113 	OSD_BITMAP1,           /* 1 bit bitmap */
114 	OSD_BITMAP2,           /* 2 bit bitmap */
115 	OSD_BITMAP4,           /* 4 bit bitmap */
116 	OSD_BITMAP8,           /* 8 bit bitmap */
117 	OSD_BITMAP1HR,         /* 1 Bit bitmap half resolution */
118 	OSD_BITMAP2HR,         /* 2 bit bitmap half resolution */
119 	OSD_BITMAP4HR,         /* 4 bit bitmap half resolution */
120 	OSD_BITMAP8HR,         /* 8 bit bitmap half resolution */
121 	OSD_YCRCB422,          /* 4:2:2 YCRCB Graphic Display */
122 	OSD_YCRCB444,          /* 4:4:4 YCRCB Graphic Display */
123 	OSD_YCRCB444HR,        /* 4:4:4 YCRCB graphic half resolution */
124 	OSD_VIDEOTSIZE,        /* True Size Normal MPEG Video Display */
125 	OSD_VIDEOHSIZE,        /* MPEG Video Display Half Resolution */
126 	OSD_VIDEOQSIZE,        /* MPEG Video Display Quarter Resolution */
127 	OSD_VIDEODSIZE,        /* MPEG Video Display Double Resolution */
128 	OSD_VIDEOTHSIZE,       /* True Size MPEG Video Display Half Resolution */
129 	OSD_VIDEOTQSIZE,       /* True Size MPEG Video Display Quarter Resolution*/
130 	OSD_VIDEOTDSIZE,       /* True Size MPEG Video Display Double Resolution */
131 	OSD_VIDEONSIZE,        /* Full Size MPEG Video Display */
132 	OSD_CURSOR             /* Cursor */
133 } osd_raw_window_t;
134 
135 typedef struct osd_cap_s {
136 	int  cmd;
137 #define OSD_CAP_MEMSIZE         1  /* memory size */
138 	long val;
139 } osd_cap_t;
140 
141 
142 #define OSD_SEND_CMD            _IOW('o', 160, osd_cmd_t)
143 #define OSD_GET_CAPABILITY      _IOR('o', 161, osd_cap_t)
144 
145 #endif
146