DXR2 TEMPORARY IOCTL INTERFACE v0.1

DXR2_IOC_GET_REGION_CODE
Get the region code for the card. Places it in supplied buffer
Arguments: Instance of dxr2_oneArg_t.

arg will be set to the region code

Returns: 0 on success, <0 on failure

DXR2_IOC_SET_TV_OUTPUT_FORMAT
Set the tv output TV format
Arguments: instance of dxr2_oneArg_t.

arg should be one of DXR2_OUTPUTFORMAT_*

Returns: 0 on success, <0 on failure

DXR2_IOC_SET_TV_INTERLACED_MODE
Set the tv output interlaced mode
Arguments: instance of dxr2_oneArg_t.

arg should be one of DXR2_INTERLACED_*

Returns: 0 on success, <0 on failure

DXR2_IOC_SET_TV_BLACKWHITE_MODE
Set the tv black/white mode
Arguments: instance of dxr2_oneArg_t.

arg should be one of DXR2_BLACKWHITE_*

Returns: 0 on success, <0 on failure

DXR2_IOC_SET_TV_PIXEL_MODE
Set the tv output pixel mode
Arguments: instance of dxr2_oneArg_t.

arg should be one of DXR2_PIXEL_*

Returns: 0 on success, <0 on failure

DXR2_IOC_SET_TV_75IRE_MODE
Set the tv output 7.5 IRE mode
Arguments: instance of dxr2_oneArg_t.

arg should be one of DXR2_75IRE_*

Returns: 0 on success, <0 on failure

DXR2_IOC_SET_SOURCE_VIDEO_FORMAT
Set the source video format
Arguments: instance of dxr2_threeArg_t.

arg1 should be one of DXR2_SRC_VIDEO_FREQ_30, DXR2_SRC_VIDEO_FREQ_25
arg2 should be x resolution
arg3 should be y resolution

Returns: 0 on success, <0 on failure

DXR2_IOC_GET_CAPABILITIES
Get device capabilities. This doesn't actually do anything yet, since I'm not quite sure what sort of things should be returned.
Arguments: buffer to put capabilities in.
Returns: 0 on success, <0 on failure

DXR2_IOC_CLEAR_VIDEO
Clear ziva video screen
Arguments: None
Returns: 0 on success, <0 on failure

DXR2_IOC_PAUSE
Pause the current video stream if not already paused or stopped
Arguments: None
Returns: 0 on success, <0 on failure

DXR2_IOC_SET_AUDIO_VOLUME
Set the audio volume
Arguments: instance of dxr2_oneArg_t.

arg should be volume to set (0<=arg<=19, where 0 is min volume)

Returns: 0 on success, <0 on failure

DXR2_IOC_SET_OUTPUT_ASPECT_RATIO
Set the output aspect ratio
Arguments: instance of dxr2_oneArg_t.

arg is one of DXR2_ASPECTRATIO_4_3 or DXR2_ASPECTRATIO_16_9

Returns: 0 on success, <0 on failure

DXR2_IOC_ABORT
Abort playback
Arguments: None
Returns: 0 on success, <0 on failure

DXR2_IOC_STOP
Stop playback
Arguments: None
Returns: 0 on success, <0 on failure

DXR2_IOC_ENABLE_SUBPICTURE
Enable subpicture
Arguments: instance of dxr2_oneArg_t.

arg should be one of DXR2_SUBPICTURE_OFF or DXR2_SUBPICTURE_ON

Returns: 0 on success, <0 on failure

DXR2_IOC_SLOW_FORWARDS
Slow Forwards
Arguments: instance of dxr2_oneArg_t.

arg is one of DXR2_PLAYRATE_2x, or DXR2_PLAYRATE_3x, DXR2_PLAYRATE_4x, DXR2_PLAYRATE_5x, DXR2_PLAYRATE_6x

Returns: 0 on success, <0 on failure

DXR2_IOC_SLOW_BACKWARDS
Slow Backwards
Arguments: instance of dxr2_oneArg_t.

arg is one of DXR2_PLAYRATE_2x, or DXR2_PLAYRATE_3x, DXR2_PLAYRATE_4x, DXR2_PLAYRATE_5x, DXR2_PLAYRATE_6x

Returns: 0 on success, <0 on failure

DXR2_IOC_FAST_FORWARDS
Fast Forwards
Arguments: instance of dxr2_oneArg_t.

arg is one of DXR2_PLAYRATE_2x, or DXR2_PLAYRATE_3x, DXR2_PLAYRATE_4x, DXR2_PLAYRATE_5x, DXR2_PLAYRATE_6x

Returns: 0 on success, <0 on failure

DXR2_IOC_FAST_BACKWARDS
Fast Backwards
Arguments: instance of dxr2_oneArg_t.

arg is one of DXR2_PLAYRATE_2x, or DXR2_PLAYRATE_3x, DXR2_PLAYRATE_4x, DXR2_PLAYRATE_5x, DXR2_PLAYRATE_6x

Returns: 0 on success, <0 on failure

DXR2_IOC_SET_SOURCE_ASPECT_RATIO
Set source aspect ratio
Arguments: instance of dxr2_oneArg_t.

arg is one of DXR2_ASPECTRATIO_4_3, or DXR2_ASPECTRATIO_16_9

Returns: 0 on success, <0 on failure

DXR2_IOC_SET_ASPECT_RATIO_MODE
Set aspect ratio mode
Arguments: instance of dxr2_oneArg_t

arg is one of DXR2_ASPECTRATIOMODE_NORMAL, DXR2_ASPECTRATIOMODE_PAN_SCAN, DXR2_ASPECTRATIOMODE_LETTERBOX

Returns: 0 on success, <0 on failure

DXR2_IOC_SINGLE_STEP
Single step the picture
Arguments: None
Returns: 0 on success, <0 on failure

DXR2_IOC_REVERSE_PLAY
Reverse play
Arguments: None
Returns: 0 on success, <0 on failure

DXR2_IOC_SET_SUBPICTURE_PALETTES
Set the subpicture palette
Arguments: instance of dxr2_palette_t
Returns: 0 on success, <0 on failure

DXR2_IOC_GET_CHALLENGE_KEY
Get the challenge key from the DXR2
Arguments: instance of dxr2_challengeKey_t
Returns: 0 on success, <0 on failure

DXR2_IOC_SEND_CHALLENGE_KEY
Send the challenge key to the DXR2
Arguments: instance of dxr2_challengeKey_t
Returns: 0 on success, <0 on failure

DXR2_IOC_GET_RESPONSE_KEY
Get the response key from the DXR2
Arguments: instance of dxr2_responseKey_t
Returns: 0 on success, <0 on failure

DXR2_IOC_SEND_RESPONSE_KEY
Send the response key to the DXR2
Arguments: instance of dxr2_responseKey_t
Returns: 0 on success, <0 on failure

DXR2_IOC_SEND_DISC_KEY
Send the disc key to the DXR2
Arguments: instance of dxr2_discKey_t
Returns: 0 on success, <0 on failure

DXR2_IOC_SEND_TITLE_KEY
Send the title key to the DXR2
Arguments: instance of dxr2_titleKey_t
Returns: 0 on success, <0 on failure

DXR2_IOC_SET_DECRYPTION_MODE
Set decryption mode
Arguments: instance of dxr2_oneArg_t

arg is one of DXR2_CSSDECRMODE_OFF, DXR2_CSSDECRMODE_ON

Returns: 0 on success, <0 on failure

DXR2_IOC_INIT_ZIVADS
Load ucode into the Ziva & initialise it
Arguments: instance of dxr2_uCode_t
Returns: 0 on success, <0 on failure

DXR2_IOC_SET_TV_MACROVISION_MODE
Set bt865 Macrovision mode
Arguments: instance of dxr2_oneArg_t

arg = one of DXR2_MACROVISION_*

Returns: 0 on success, <0 on failure

DXR2_IOC_RESET
Reset DXR2
Arguments: None
Returns: 0 on success, <0 on failure

DXR2_IOC_SET_BITSTREAM_TYPE
Set bitstream type
Arguments: instance of dxr2_oneArg_t

arg is one of DXR2_BITSTREAM_TYPE_MPEG_VOB, DXR2_BITSTREAM_TYPE_CDROM_VCD, DXR2_BITSTREAM_TYPE_MPEG_VCD, DXR2_BITSTREAM_TYPE_CDDA, DXR2_BITSTREAM_TYPE_4

Returns: 0 on success, <0 on failure

DXR2_IOC_PLAY
Play
Arguments: None
Returns: 0 on success, <0 on failure

DXR2_IOC_GET_STC
Get System Time Clock
Arguments: instance of dxr2_oneArg_t

arg will be set to result

Returns: 0 on success, <0 on failure

DXR2_IOC_SET_AUDIO_SAMPLE_FREQENCY
Set audio sample frequency
Arguments: instance of dxr2_oneArg_t.

arg: DXR2_AUDIO_FREQ_441, DXR2_AUDIO_FREQ_96, DXR2_AUDIO_FREQ_24, DXR2_AUDIO_FREQ_2205, DXR2_AUDIO_FREQ_32

Returns: 0 on success, <0 on failure

DXR2_IOC_SET_AUDIO_DATA_WIDTH
Set audio data width
Arguments: instance of dxr2_oneArg_t.

arg= DXR2_AUDIO_WIDTH_16, DXR2_AUDIO_WIDTH_24, DXR2_AUDIO_WIDTH_32

Returns: 0 on success, <0 on failure

DXR2_IOC_IEC958_OUTPUT_MODE
Sets the IEC-958 output mode (either decoded AC3, or encoded AC3)
Arguments: instance of dxr2_oneArg_t.

arg= DXR2_IEC958_DECODED, DXR2_IEC958_ENCODED

Returns: 0 on success, <0 on failure

DXR2_IOC_SET_AC3_MODE
Set the AC3 mode... probably for Karaoke... Mmmmm... how useful ;)
Arguments: instance of dxr2_oneArg_t.

arg= DXR2_AC3MODE_LR_STEREO, DXR2_AC3MODE_LR_STEREO_PROLOGIC, DXR2_AC3MODE_LR_MONOR

Returns: 0 on success, <0 on failure

DXR2_IOC_SELECT_AC3_VOICE
Selects AC3 voice, either to NONE, or V1V2. This is for karaoke
Arguments: instance of dxr2_oneArg_t.

arg= DXR2_AC3VOICE_NONE, DXR2_AC3VOICE_V1V2

Returns: 0 on success, <0 on failure

DXR2_IOC_AUDIO_MUTE
Mute/unmute audio
Arguments: instance of dxr2_oneArg_t.

arg= DXR2_AUDIO_MUTE_ON, DXR2_AUDIO_MUTE_OFF

Returns: 0 on success, <0 on failure

DXR2_IOC_SET_STEREO_MODE
Set stereo mode
Arguments: instance of dxr2_oneArg_t.

arg=DXR2_AUDIO_STEREO_NORMAL, DXR2_AUDIO_STEREO_MONOL, DXR2_AUDIO_STEREO_MONOR, DXR2_AUDIO_STEREO_REVERSE

Returns: 0 on success, <0 on failure

DXR2_IOC_SELECT_STREAM
FIXME... what to do with MPEG1 audio streams...Select stream
Arguments: instance of dxr2_twoArg_t.

arg1 = stream type: DXR2_STREAM_VIDEO, DXR2_STREAM_SUBPICTURE, DXR2_STREAM_AUDIO_AC3, DXR2_STREAM_AUDIO_MPEG, DXR2_STREAM_AUDIO_LPCM, DXR2_STREAM_AUDIO_5
arg2 = stream to select

Returns: 0 on success, <0 on failure

DXR2_IOC_HIGHLIGHT
FIXME.. don't know what all of these doHighlight a button
Arguments: instance of dxr2_twoArg_t.

arg1 = button to highlight (1-36), or DXR2_BUTTON_NONE, DXR2_BUTTON_UP, DXR2_BUTTON_DOWN, DXR2_BUTTON_LEFT, DXR2_BUTTON_RIGHT
arg2 = action to perform on button: DXR2_BUTTONACTION_SELECT, DXR2_BUTTONACTION_UNHIGHLIGHT,DXR2_BUTTONACTION_ACTIVATE, DXR2_BUTTONACTION_ACTIVATE_SELECTED, DXR2_BUTTONACTION_ (4-8)

Returns: 0 on success, <0 on failure

DXR2_IOC_SET_OVERLAY_COLOUR
Set the overlay colour
Arguments: instance of dxr2_sixArg_t.

arg1= Lower bound for red
arg2= Upper bound for red
arg3= Lower bound for green
arg4= Upper bound for green
arg5= Lower bound for blue
arg6= Upper bound for blue

Returns: 0 on success, <0 on failure

DXR2_IOC_SET_OVERLAY_GAIN
Set the colour gain
Arguments: instance of dxr2_fourArg_t.

arg1= Common gain (0 - 0x3f)
arg2= red gain (0- 63)
arg3= green gain (0- 63)
arg4= blue gain (0- 63)

Returns: 0 on success, <0 on failure

DXR2_IOC_SET_OVERLAY_IN_DELAY
Sets the "in delay" value
Arguments: instance of dxr2_oneArg_t.

arg= In delay value (0-3)

Returns: 0 on success, <0 on failure

DXR2_IOC_SET_OVERLAY_MODE
Set overlay mode
Arguments: instance of dxr2_oneArg_t.

arg= One of DXR2_OVERLAY_*

DXR2_IOC_SET_OVERLAY_CROPPING
Sets the cropping values
Arguments: instance of dxr2_fourArg_t.

arg1= Left cropping in pixels
arg2= Right cropping in pixels
arg3= Top cropping in pixels
arg4= Bottom cropping in pixels

Returns: 0 on success, <0 on failure

DXR2_IOC_SET_OVERLAY_DIMENSION
Sets the dimension of the overlay window
Arguments: instance of dxr2_twoArg_t.

arg1= Width in pixels
arg2= Height in pixels

Returns: 0 on success, <0 on failure

DXR2_IOC_SET_OVERLAY_POSITION
Sets the overlay position
Arguments: instance of dxr2_twoArg_t.

arg1= xpos in pixels
arg2= ypos in pixels

Returns: 0 on success, <0 on failure

DXR2_IOC_SET_OVERLAY_RATIO
Set the x ratio, for fine tuning display ratios
Arguments: instance of dxr2_oneArg_t.

arg= X-Ratio adjust (1-2500)

Returns: 0 on success, <0 on failure

DXR2_IOC_CALCULATE_VGA_PARAMETERS
Calculates necessary VGA parameters
Arguments: instance of dxr2_vgaParams_t

The screenWidth parameter should be initalised to the width of the screen in pixels. The other parameters will be updated by this call.

Returns: 0 on success, or error if <0

DXR2_IOC_SET_VGA_PARAMETERS
Sets VGA parameters to supplied values
Arguments: instance of dxr2_vgaParams_t

arg= Instance of structure as derived from DXR2_IOC_CALCULATE_VGA_PARAMETERS

Returns: timer 0 on succes, or <0 on failure

DXR2_IOC_SET_OVERLAY_PICTURE_CONTROLS
Sets the overlay picture controls
Arguments: instance of dxr2_fourArg_t.

arg1= Gamma control value (0 to 96)
arg2= Contrast control value (-128 to 127)
arg3= Brightness control value (-128 to 127)
arg4= Saturation control value (-128 to 127)

Returns: 0 on success, <0 on failure

DXR2_IOC_BUFFERS_EMPTY
Checks if the dxr2's video and audio buffers are empty yet
Arguments: instance of dxr2_oneArg_t.

arg= Set to 1 if buffers are empty, 0 if not

Returns: 0 on success, <0 on failure