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