summaryrefslogtreecommitdiff
path: root/linux/Documentation
diff options
context:
space:
mode:
authorHans Verkuil <devnull@localhost>2006-01-01 13:19:40 +0000
committerHans Verkuil <devnull@localhost>2006-01-01 13:19:40 +0000
commitaed249933ee45e7cb2f7a401d4aa9312386367fa (patch)
treea2615acbacd33cf1a07440b08e654391aaf9eb1f /linux/Documentation
parente3a72190b72cc2085c7e8f1c3f1bc049ebd761e6 (diff)
downloadmediapointer-dvb-s2-aed249933ee45e7cb2f7a401d4aa9312386367fa.tar.gz
mediapointer-dvb-s2-aed249933ee45e7cb2f7a401d4aa9312386367fa.tar.bz2
Made API names consistent.
Signed-off-by: Hans Verkuil <hverkuil@xs4all.nl>
Diffstat (limited to 'linux/Documentation')
-rw-r--r--linux/Documentation/video4linux/cx2341x/fw-decoder-api.txt34
-rw-r--r--linux/Documentation/video4linux/cx2341x/fw-encoder-api.txt58
-rw-r--r--linux/Documentation/video4linux/cx2341x/fw-osd-api.txt2
3 files changed, 47 insertions, 47 deletions
diff --git a/linux/Documentation/video4linux/cx2341x/fw-decoder-api.txt b/linux/Documentation/video4linux/cx2341x/fw-decoder-api.txt
index 5ebac91c4..34b5c3c7d 100644
--- a/linux/Documentation/video4linux/cx2341x/fw-decoder-api.txt
+++ b/linux/Documentation/video4linux/cx2341x/fw-decoder-api.txt
@@ -39,7 +39,7 @@ Param[2]
-------------------------------------------------------------------------------
-Name CX2341X_DEC_PLAYBACK_SPEED
+Name CX2341X_DEC_SET_PLAYBACK_SPEED
Enum 3/0x03
Description
Playback stream at speed other than normal. There are two modes of
@@ -89,7 +89,7 @@ Param[0]
-------------------------------------------------------------------------------
-Name CX2341X_DEC_DMA_BLOCKSIZE
+Name CX2341X_DEC_SET_DMA_BLOCKSIZE
Enum 8/0x08
Description
Set DMA transfer block size. Counterpart to API 0xC9
@@ -99,7 +99,7 @@ Param[0]
-------------------------------------------------------------------------------
-Name CX2341X_DEC_XFER_INFO
+Name CX2341X_DEC_GET_XFER_INFO
Enum 9/0x09
Description
This API call may be used to detect an end of stream condtion.
@@ -114,7 +114,7 @@ Result[3]
-------------------------------------------------------------------------------
-Name CX2341X_DEC_DMA_STATUS
+Name CX2341X_DEC_GET_DMA_STATUS
Enum 10/0x0A
Description
Status of the last DMA transfer
@@ -127,7 +127,7 @@ Result[1]
-------------------------------------------------------------------------------
-Name CX2341X_DEC_DMA_FROM_HOST
+Name CX2341X_DEC_SCHED_DMA_FROM_HOST
Enum 11/0x0B
Description
Setup DMA from host operation. Counterpart to API 0xCC
@@ -159,7 +159,7 @@ Description
-------------------------------------------------------------------------------
-Name CX2341X_DEC_DISP_STANDARD
+Name CX2341X_DEC_SET_STANDARD
Enum 16/0x10
Description
Selects display standard
@@ -168,7 +168,7 @@ Param[0]
-------------------------------------------------------------------------------
-Name CX2341X_DEC_GETVER
+Name CX2341X_DEC_GET_VERSION
Enum 17/0x11
Description
Returns decoder firmware version information
@@ -180,7 +180,7 @@ Result[0]
-------------------------------------------------------------------------------
-Name CX2341X_DEC_STREAM_INPUT
+Name CX2341X_DEC_SET_STREAM_INPUT
Enum 20/0x14
Description
Select decoder stream input port
@@ -189,7 +189,7 @@ Param[0]
-------------------------------------------------------------------------------
-Name CX2341X_DEC_TIMING_INFO
+Name CX2341X_DEC_GET_TIMING_INFO
Enum 21/0x15
Description
Returns timing information from start of playback
@@ -206,7 +206,7 @@ Result[4]
-------------------------------------------------------------------------------
-Name CX2341X_DEC_SELECT_AUDIO
+Name CX2341X_DEC_SET_AUDIO_MODE
Enum 22/0x16
Description
Select audio mode
@@ -218,7 +218,7 @@ Param[1]
-------------------------------------------------------------------------------
-Name CX2341X_DEC_EVENT_NOTIFICATION
+Name CX2341X_DEC_SET_EVENT_NOTIFICATION
Enum 23/0x17
Description
Setup firmware to notify the host about a particular event.
@@ -229,12 +229,12 @@ Param[1]
Notification 0=disabled, 1=enabled
Param[2]
Interrupt bit
-Param[32]
+Param[3]
Mailbox slot, -1 if no mailbox required.
-------------------------------------------------------------------------------
-Name CX2341X_DEC_DISPLAY_BUFFERS
+Name CX2341X_DEC_SET_DISPLAY_BUFFERS
Enum 24/0x18
Description
Number of display buffers. To decode all frames in reverse playback you
@@ -257,7 +257,7 @@ Result[1]
-------------------------------------------------------------------------------
-Name CX2341X_DEC_DECODE_SOURCE
+Name CX2341X_DEC_SET_DECODER_SOURCE
Enum 26/0x1A
Description
Selects decoder source. Ensure that the parameters passed to this
@@ -273,7 +273,7 @@ Param[3]
-------------------------------------------------------------------------------
-Name CX2341X_DEC_AUDIO_OUTPUT
+Name CX2341X_DEC_SET_AUDIO_OUTPUT
Enum 27/0x1B
Description
Select audio output format
@@ -289,7 +289,7 @@ Param[0]
'01' 4 channels
'10' 6 channels
'11' 6 channels with one line data mode
- (for left justified MSB first mode, 20 bit only)
+ (for left justified MSB first mode, 20 bit only)
10:11 Unused
12:13 Channel format:
'00' right justified MSB first mode
@@ -310,7 +310,7 @@ Param[0]
-------------------------------------------------------------------------------
-Name CX2341X_DEC_BUFFER
+Name CX2341X_DEC_SET_PREBUFFERING
Enum 30/0x1E
Description
Decoder prebuffering, when enabled up to 128KB are buffered for
diff --git a/linux/Documentation/video4linux/cx2341x/fw-encoder-api.txt b/linux/Documentation/video4linux/cx2341x/fw-encoder-api.txt
index d10f9afb0..cac7c2f7b 100644
--- a/linux/Documentation/video4linux/cx2341x/fw-encoder-api.txt
+++ b/linux/Documentation/video4linux/cx2341x/fw-encoder-api.txt
@@ -49,7 +49,7 @@ Param[2]
-------------------------------------------------------------------------------
-Name CX2341X_ENC_ASSIGN_AUDIO_ID
+Name CX2341X_ENC_SET_AUDIO_ID
Enum 137/0x89
Description
Assigns the transport stream ID of the encoded audio stream
@@ -58,7 +58,7 @@ Param[0]
-------------------------------------------------------------------------------
-Name CX2341X_ENC_ASSIGN_VIDEO_ID
+Name CX2341X_ENC_SET_VIDEO_ID
Enum 139/0x8B
Description
Set video transport stream ID
@@ -67,7 +67,7 @@ Param[0]
-------------------------------------------------------------------------------
-Name CX2341X_ENC_ASSIGN_PCR_ID
+Name CX2341X_ENC_SET_PCR_ID
Enum 141/0x8D
Description
Assigns the transport stream ID for PCR packets
@@ -76,7 +76,7 @@ Param[0]
-------------------------------------------------------------------------------
-Name CX2341X_ENC_ASSIGN_FRAMERATE
+Name CX2341X_ENC_SET_FRAMERATE
Enum 143/0x8F
Description
Set video frames per second. Change occurs at start of new GOP.
@@ -86,7 +86,7 @@ Param[0]
-------------------------------------------------------------------------------
-Name CX2341X_ENC_ASSIGN_FRAME_SIZE
+Name CX2341X_ENC_SET_FRAME_SIZE
Enum 145/0x91
Description
Select video stream encoding resolution.
@@ -97,7 +97,7 @@ Param[1]
-------------------------------------------------------------------------------
-Name CX2341X_ENC_ASSIGN_BITRATES
+Name CX2341X_ENC_SET_BITRATES
Enum 149/0x95
Description
Assign average video stream bitrate.
@@ -110,7 +110,7 @@ Param[2]
-------------------------------------------------------------------------------
-Name CX2341X_ENC_ASSIGN_GOP_PROPERTIES
+Name CX2341X_ENC_SET_GOP_PROPERTIES
Enum 151/0x97
Description
Setup the GOP structure
@@ -122,7 +122,7 @@ Param[1]
-------------------------------------------------------------------------------
-Name CX2341X_ENC_ASSIGN_ASPECT_RATIO
+Name CX2341X_ENC_SET_ASPECT_RATIO
Enum 153/0x99
Description
Sets the encoding aspect ratio. Changes in the aspect ratio take effect
@@ -139,7 +139,7 @@ Param[0]
-------------------------------------------------------------------------------
-Name CX2341X_ENC_ASSIGN_DNR_FILTER_MODE
+Name CX2341X_ENC_SET_DNR_FILTER_MODE
Enum 155/0x9B
Description
Assign Dynamic Noise Reduction operating mode
@@ -156,7 +156,7 @@ Param[1]
-------------------------------------------------------------------------------
-Name CX2341X_ENC_ASSIGN_DNR_FILTER_PROPS
+Name CX2341X_ENC_SET_DNR_FILTER_PROPS
Enum 157/0x9D
Description
These Dynamic Noise Reduction filter values are only meaningful when
@@ -168,7 +168,7 @@ Param[1]
-------------------------------------------------------------------------------
-Name CX2341X_ENC_ASSIGN_CORING_LEVELS
+Name CX2341X_ENC_SET_CORING_LEVELS
Enum 159/0x9F
Description
Assign Dynamic Noise Reduction median filter properties.
@@ -187,7 +187,7 @@ Param[3]
-------------------------------------------------------------------------------
-Name CX2341X_ENC_ASSIGN_SPATIAL_FILTER_TYPE
+Name CX2341X_ENC_SET_SPATIAL_FILTER_TYPE
Enum 161/0xA1
Description
Assign spatial prefilter parameters
@@ -205,7 +205,7 @@ Param[1]
-------------------------------------------------------------------------------
-Name CX2341X_ENC_ASSIGN_3_2_PULLDOWN
+Name CX2341X_ENC_SET_3_2_PULLDOWN
Enum 177/0xB1
Description
3:2 pulldown properties
@@ -215,7 +215,7 @@ Param[0]
-------------------------------------------------------------------------------
-Name CX2341X_ENC_SELECT_VBI_LINE
+Name CX2341X_ENC_SET_VBI_LINE
Enum 183/0xB7
Description
Selects VBI line number.
@@ -237,7 +237,7 @@ Param[4]
-------------------------------------------------------------------------------
-Name CX2341X_ENC_ASSIGN_STREAM_TYPE
+Name CX2341X_ENC_SET_STREAM_TYPE
Enum 185/0xB9
Description
Assign stream type
@@ -253,7 +253,7 @@ Param[0]
-------------------------------------------------------------------------------
-Name CX2341X_ENC_ASSIGN_OUTPUT_PORT
+Name CX2341X_ENC_SET_OUTPUT_PORT
Enum 187/0xBB
Description
Assign stream output port (not recommended you change setting from default)
@@ -264,7 +264,7 @@ Param[0]
-------------------------------------------------------------------------------
-Name CX2341X_ENC_ASSIGN_AUDIO_PROPERTIES
+Name CX2341X_ENC_SET_AUDIO_PROPERTIES
Enum 189/0xBD
Description
Set audio stream properties, may be called while encoding is in progress.
@@ -347,7 +347,7 @@ Description
-------------------------------------------------------------------------------
-Name CX2341X_ENC_GETVER
+Name CX2341X_ENC_GET_VERSION
Enum 196/0xC4
Description
Returns the version of the encoder firmware.
@@ -359,7 +359,7 @@ Result[0]
-------------------------------------------------------------------------------
-Name CX2341X_ENC_ASSIGN_GOP_CLOSURE
+Name CX2341X_ENC_SET_GOP_CLOSURE
Enum 197/0xC5
Description
Assigns the GOP open/close property.
@@ -384,7 +384,7 @@ Result[1]
-------------------------------------------------------------------------------
-Name CX2341X_ENC_ASSIGN_PGM_INDEX_INFO
+Name CX2341X_ENC_SET_PGM_INDEX_INFO
Enum 199/0xC7
Description
Sets the Program Index Information.
@@ -403,7 +403,7 @@ Result[1]
-------------------------------------------------------------------------------
-Name CX2341X_ENC_CONFIG_VBI
+Name CX2341X_ENC_SET_VBI_CONFIG
Enum 200/0xC8
Description
Configure VBI settings
@@ -437,7 +437,7 @@ Result[2]
-------------------------------------------------------------------------------
-Name CX2341X_ENC_ASSIGN_DMA_BLOCKLEN
+Name CX2341X_ENC_SET_DMA_BLOCKLEN
Enum 201/0xC9
Description
Set DMA transfer block size
@@ -449,7 +449,7 @@ Param[1]
-------------------------------------------------------------------------------
-Name CX2341X_ENC_PREV_DMA_INFO_MB_10
+Name CX2341X_ENC_GET_PREV_DMA_INFO_MB_10
Enum 202/0xCA
Description
Returns information on the previous DMA transfer in conjunction with
@@ -463,7 +463,7 @@ Result[2]
-------------------------------------------------------------------------------
-Name CX2341X_ENC_PREV_DMA_INFO_MB_9
+Name CX2341X_ENC_GET_PREV_DMA_INFO_MB_9
Enum 203/0xCB
Description
Returns information on the previous DMA transfer in conjunction with
@@ -502,7 +502,7 @@ Description
-------------------------------------------------------------------------------
-Name CX2341X_ENC_ASSIGN_FRAME_DROP_RATE
+Name CX2341X_ENC_SET_FRAME_DROP_RATE
Enum 208/0xD0
Description
For each frame captured, skip specified number of frames.
@@ -528,7 +528,7 @@ Description
-------------------------------------------------------------------------------
-Name CX2341X_ENC_ASSIGN_COPYRIGHT
+Name CX2341X_ENC_SET_COPYRIGHT
Enum 212/0xD4
Description
Sets stream copyright property
@@ -538,7 +538,7 @@ Param[0]
-------------------------------------------------------------------------------
-Name CX2341X_ENC_EVENT_NOTIFICATION
+Name CX2341X_ENC_SET_EVENT_NOTIFICATION
Enum 213/0xD5
Description
Setup firmware to notify the host about a particular event. Host must
@@ -554,7 +554,7 @@ Param[3]
-------------------------------------------------------------------------------
-Name CX2341X_ENC_ASSIGN_NUM_VSYNC_LINES
+Name CX2341X_ENC_SET_NUM_VSYNC_LINES
Enum 214/0xD6
Description
Depending on the analog video decoder used, this assigns the number
@@ -572,7 +572,7 @@ Param[1]
-------------------------------------------------------------------------------
-Name CX2341X_ENC_ASSIGN_PLACEHOLDER
+Name CX2341X_ENC_SET_PLACEHOLDER
Enum 215/0xD7
Description
Provides a mechanism of inserting custom user data in the MPEG stream.
diff --git a/linux/Documentation/video4linux/cx2341x/fw-osd-api.txt b/linux/Documentation/video4linux/cx2341x/fw-osd-api.txt
index f0979a5f6..da98ae30a 100644
--- a/linux/Documentation/video4linux/cx2341x/fw-osd-api.txt
+++ b/linux/Documentation/video4linux/cx2341x/fw-osd-api.txt
@@ -206,7 +206,7 @@ Param[2]
output_pixel = destination_pixel
if 256 > source_alpha > 1:
output_pixel = ((source_alpha + 1)*source_pixel +
- (255 - source_alpha)*destination_pixel)/256
+ (255 - source_alpha)*destination_pixel)/256
'10' if destination_alpha=0:
output_pixel = source_pixel