Lines Matching +full:hardware +full:- +full:wise
1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later OR GPL-2.0
14 The DVB OSD device controls the OnScreen-Display of the AV7110 based
15 DVB-cards with hardware MPEG2 decoder. It can be accessed through
20 The OSD is not a frame-buffer like on many other cards.
22 The color-depth is limited depending on the memory size installed.
31 -----------
36 .. code-block:: c
39 /* All functions return -2 on "not open" */
67 .. note:: All functions return -2 on "not open"
69 .. flat-table::
70 :header-rows: 1
71 :stub-columns: 0
73 - ..
75 - Command
77 - | Used variables of ``struct`` `osd_cmd_t`_.
80 - :cspan:`2` Description
84 - ..
86 - ``OSD_Close``
88 - -
90 - | Disables OSD and releases the buffers.
93 - ..
95 - ``OSD_Open``
97 - | x0,y0,x1,y1,
101 - | Opens OSD with this size and bit depth
103 | -1 on DRAM allocation error,
104 | -2 on "already open".
106 - ..
108 - ``OSD_Show``
110 - -
112 - | Enables OSD mode.
115 - ..
117 - ``OSD_Hide``
119 - -
121 - | Disables OSD mode.
124 - ..
126 - ``OSD_Clear``
128 - -
130 - | Sets all pixel to color 0.
133 - ..
135 - ``OSD_Fill``
137 - color
139 - | Sets all pixel to color <color>.
142 - ..
144 - ``OSD_SetColor``
146 - | color,
150 - | Set palette entry <num> to <r,g,b>, <mix> and <trans> apply
156 | Returns 0 on success, -1 on error.
158 - ..
160 - ``OSD_SetPalette``
162 - | firstcolor{color},
165 - | Set a number of entries in the palette.
169 | R,G,B, and a opacity value: 0->transparent, 1..254->mix,
170 255->pixel
172 - ..
174 - ``OSD_SetTrans``
176 - transparency{color}
178 - | Sets transparency of mixed pixel (0..15).
181 - ..
183 - ``OSD_SetPixel``
185 - x0,y0,color
187 - | Sets pixel <x>,<y> to color number <color>.
188 | Returns 0 on success, -1 on error.
190 - ..
192 - ``OSD_GetPixel``
194 - x0,y0
196 - | Returns color number of pixel <x>,<y>, or -1.
199 - ..
201 - ``OSD_SetRow``
203 - x0,y0,x1,data
205 - | Fills pixels x0,y through x1,y with the content of data[].
206 | Returns 0 on success, -1 on clipping all pixel (no pixel
209 - ..
211 - ``OSD_SetBlock``
213 - | x0,y0,x1,y1,
217 - | Fills pixels x0,y0 through x1,y1 with the content of data[].
220 | Returns 0 on success, -1 on clipping all pixel.
222 - ..
224 - ``OSD_FillRow``
226 - x0,y0,x1,color
228 - | Fills pixels x0,y through x1,y with the color <color>.
229 | Returns 0 on success, -1 on clipping all pixel.
231 - ..
233 - ``OSD_FillBlock``
235 - x0,y0,x1,y1,color
237 - | Fills pixels x0,y0 through x1,y1 with the color <color>.
238 | Returns 0 on success, -1 on clipping all pixel.
240 - ..
242 - ``OSD_Line``
244 - x0,y0,x1,y1,color
246 - | Draw a line from x0,y0 to x1,y1 with the color <color>.
249 - ..
251 - ``OSD_Query``
253 - | x0,y0,x1,y1,
256 - | Fills parameters with the picture dimensions and the pixel
261 - ..
263 - ``OSD_Test``
265 - -
267 - | Draws a test picture.
270 - ..
272 - ``OSD_Text``
274 - x0,y0,size,color,text
276 - Draws a text at position x0,y0 with the color <color>.
278 - ..
280 - ``OSD_SetWindow``
282 - x0
284 - Set window with number 0<x0<8 as current.
286 - ..
288 - ``OSD_MoveWindow``
290 - x0,y0
292 - Move current window to (x0, y0).
294 - ..
296 - ``OSD_OpenRaw``
298 - | x0,y0,x1,y1,
301 - Open other types of OSD windows.
310 -----
313 ---------
318 .. code-block:: c
333 .. flat-table::
334 :header-rows: 0
335 :stub-columns: 0
337 - ..
339 - ``OSD_Command cmd``
341 - `OSD_Command`_ to be executed.
343 - ..
345 - ``int x0``
347 - First horizontal position.
349 - ..
351 - ``int y0``
353 - First vertical position.
355 - ..
357 - ``int x1``
359 - Second horizontal position.
361 - ..
363 - ``int y1``
365 - Second vertical position.
367 - ..
369 - ``int color``
371 - Number of the color in the palette.
373 - ..
375 - ``void __user *data``
377 - Command specific Data.
388 -----
392 ----------------
397 .. code-block:: c
425 .. flat-table::
426 :header-rows: 0
427 :stub-columns: 0
429 - ..
431 - ``OSD_BITMAP1``
433 - :cspan:`1` 1 bit bitmap
435 - ..
437 - ``OSD_BITMAP2``
439 - 2 bit bitmap
441 - ..
443 - ``OSD_BITMAP4``
445 - 4 bit bitmap
447 - ..
449 - ``OSD_BITMAP8``
451 - 8 bit bitmap
453 - ..
455 - ``OSD_BITMAP1HR``
457 - 1 Bit bitmap half resolution
459 - ..
461 - ``OSD_BITMAP2HR``
463 - 2 Bit bitmap half resolution
465 - ..
467 - ``OSD_BITMAP4HR``
469 - 4 Bit bitmap half resolution
471 - ..
473 - ``OSD_BITMAP8HR``
475 - 8 Bit bitmap half resolution
477 - ..
479 - ``OSD_YCRCB422``
481 - 4:2:2 YCRCB Graphic Display
483 - ..
485 - ``OSD_YCRCB444``
487 - 4:4:4 YCRCB Graphic Display
489 - ..
491 - ``OSD_YCRCB444HR``
493 - 4:4:4 YCRCB graphic half resolution
495 - ..
497 - ``OSD_VIDEOTSIZE``
499 - True Size Normal MPEG Video Display
501 - ..
503 - ``OSD_VIDEOHSIZE``
505 - MPEG Video Display Half Resolution
507 - ..
509 - ``OSD_VIDEOQSIZE``
511 - MPEG Video Display Quarter Resolution
513 - ..
515 - ``OSD_VIDEODSIZE``
517 - MPEG Video Display Double Resolution
519 - ..
521 - ``OSD_VIDEOTHSIZE``
523 - True Size MPEG Video Display Half Resolution
525 - ..
527 - ``OSD_VIDEOTQSIZE``
529 - True Size MPEG Video Display Quarter Resolution
531 - ..
533 - ``OSD_VIDEOTDSIZE``
535 - True Size MPEG Video Display Double Resolution
537 - ..
539 - ``OSD_VIDEONSIZE``
541 - Full Size MPEG Video Display
543 - ..
545 - ``OSD_CURSOR``
547 - Cursor
556 -----
560 ---------
565 .. code-block:: c
576 .. flat-table::
577 :header-rows: 0
578 :stub-columns: 0
580 - ..
582 - ``int cmd``
584 - Capability to query.
586 - ..
588 - ``long val``
590 - Used to store the Data.
595 .. flat-table::
596 :header-rows: 0
597 :stub-columns: 0
599 - ..
601 - ``OSD_CAP_MEMSIZE``
603 - Memory size installed on the card.
611 -----
618 ------------
625 .. code-block:: c
633 .. flat-table::
634 :header-rows: 0
635 :stub-columns: 0
637 - ..
639 - ``int fd``
641 - :cspan:`1` File descriptor returned by a previous call
644 - ..
646 - ``int request``
648 - Pointer to the location of the structure `osd_cmd_t`_ for this
662 On success 0 is returned, on error -1 and the ``errno`` variable is set
664 :ref:`Generic Error Codes <gen-errors>` chapter.
666 .. flat-table::
667 :header-rows: 0
668 :stub-columns: 0
670 - ..
672 - ``EINVAL``
674 - Command is out of range.
677 -----
681 ------------------
688 .. code-block:: c
696 .. flat-table::
697 :header-rows: 0
698 :stub-columns: 0
700 - ..
702 - ``int fd``
704 - :cspan:`1` File descriptor returned by a previous call
707 - ..
709 - ``int request``
711 - Equals ``OSD_GET_CAPABILITY`` for this command.
713 - ..
715 - ``unsigned int *cap``
717 - Pointer to the location of the structure `osd_cap_t`_ for this
727 DVB-decoder-card in use.
736 On success 0 is returned, on error -1 and the ``errno`` variable is set
738 :ref:`Generic Error Codes <gen-errors>` chapter.
740 .. flat-table::
741 :header-rows: 0
742 :stub-columns: 0
745 - ..
747 - ``EINVAL``
749 - Unsupported capability.
752 -----
756 ------
761 .. code-block:: c
770 .. flat-table::
771 :header-rows: 0
772 :stub-columns: 0
774 - ..
776 - ``const char *deviceName``
778 - Name of specific OSD device.
780 - ..
782 - :rspan:`3` ``int flags``
784 - :cspan:`1` A bit-wise OR of the following flags:
786 - ..
788 - ``O_RDONLY``
790 - read-only access
792 - ..
794 - ``O_RDWR``
796 - read/write access
798 - ..
800 - ``O_NONBLOCK``
801 - | Open in non-blocking mode
813 .. flat-table::
814 :header-rows: 0
815 :stub-columns: 0
817 - ..
819 - ``ENODEV``
821 - Device driver not loaded/available.
823 - ..
825 - ``EINTERNAL``
827 - Internal error.
829 - ..
831 - ``EBUSY``
833 - Device or resource busy.
835 - ..
837 - ``EINVAL``
839 - Invalid argument.
842 -----
846 -------
856 .. flat-table::
857 :header-rows: 0
858 :stub-columns: 0
860 - ..
862 - ``int fd``
864 - :cspan:`1` File descriptor returned by a previous call
875 .. flat-table::
876 :header-rows: 0
877 :stub-columns: 0
879 - ..
881 - ``EBADF``
883 - fd is not a valid open file descriptor.