HIKVISION DS-4 Series User Manual

Technical Manual
© 2006-2010 by HIKVISION. All rights reserved.
1
DS-4xxx Encoding/Decoding Card
SDK Documentation
Version 5.1
(For Linux)
Hangzhou Hikvision Digital Tech. Co., Ltd.

HIKVISION DS-4 Series Specifications

General

Model	DS-4 Series
Category	Media Converter
Ports	RJ45, SFP
RJ45 Port	10/100/1000Base-T
SFP Port	1000Base-X
Wavelength	Depends on SFP module
Storage Temperature	-40°C to 70°C
Weight	0.2kg
Operating Humidity	5% to 95% (non-condensing)

Summary

Hikvision Card Overview

SDK Version Update

Version 5.1 Release Notes

Key changes and compatibility notes for SDK Version 5.1.

Version 4.3 (Build 20080422) Features

Highlights new features and improvements introduced in SDK Version 4.3.

Version 4.2 (Build 20080422) Updates

Details enhancements and new APIs added in SDK Version 4.2.

Version 4.1 (Build 20080422) Updates

Lists support for new boards and image quality improvements in Version 4.1.

Version 4.0 (Build 20080422) Updates

Covers new board support and changes to the video preview mode in Version 4.0.

Decoding Functionality Overview

Details the decoding capabilities and supported resolutions.

Data Structure Definition

Frame Type Definitions

Defines various frame types used in data transmission and processing.

Video Standard Definitions

Specifies supported video standards like NTSC and PAL.

Channel Capability Structure

Defines structure for channel capabilities such as audio preview and watchdog.

Frame Statistics Structure

Structure for collecting frame statistics like lost frames and queue overflows.

Preview Rectangle Structure

Defines the rectangle structure used for preview window coordinates.

Edition Information Structure

Structure for holding version and build information of SDK components.

Motion Detection Data Definition

Defines data structures and parameters related to motion detection analysis.

Encoding Card SDK

4.1. Order of Function Call

Outlines the typical sequence of API calls for encoding operations.

4.2. API of Encoding Card

Detailed list and explanation of Encoding Card SDK APIs.

4.2.1. GetLastErrorNum()

Retrieves the last error number when an exception occurs.

4.2.2. InitDSPs()

Initializes all cards and returns the total encoding channel count.

4.2.3. DeInitDSPs()

Closes encoding functions and releases resources before application exit.

4.2.4. ChannelOpen()

Opens a channel and returns a handle for data callbacks.

4.2.5. ChannelClose()

Closes a channel and releases associated resources.

4.2.6. GetTotalChannels()

Retrieves the total number of valid channels in the system.

4.2.7. GetTotalDSPs()

Retrieves the total number of DSPs installed in the system.

4.2.8. GetBoardCount()

Retrieves the number of cards installed in the system.

4.2.9. GetBoardDetail()

Retrieves detailed information about a specific board.

4.2.10. GetDspDetail()

Retrieves detailed information about a specific DSP.

4.2.11. GetEncodeChannelCount()

Retrieves the total count of encoding channels in the system.

4.2.12. GetDecodeChannelCount()

Retrieves the total count of decoding channels in the system.

4.2.13. GetDisplayChannelCount()

Retrieves the total count of display channels in the system.

4.2.14. GetBoardInfo()

Retrieves the board type and serial number for a channel.

4.2.15. GetCapability()

Retrieves special function capabilities of a board.

4.2.16. StartVideoPreview()

Starts video preview for a channel, allowing video data copying.

4.2.17. StopVideoPreview()

Stops the video preview process for a channel.

4.2.18. SetVideoPara()

Sets video parameters like brightness, contrast, saturation, and hue.

4.2.19. GetVideoPara()

Retrieves video parameters for a specified channel.

4.2.20. GetSDKVersion()

Retrieves the SDK version information, including major, senior, and build numbers.

4.2.21. SetStreamType()

Sets the stream type (video, audio, or video/audio sync).

4.2.22. GetStreamType()

Retrieves the current stream type for a channel.

4.2.23. SetSubStreamType()

Sets the stream type for a sub-channel.

4.2.24. GetSubStreamType()

Retrieves the stream type for a sub-channel.

4.2.25. StartVideoCapture()

Starts the video capture process for a channel.

4.2.26. StopVideoCapture()

Stops the video capture process for a channel.

4.2.27. StartSubVideoCapture()

Starts video capture for a sub-channel.

4.2.28. StopSubVideoCapture()

Stops video capture for a sub-channel.

4.2.29. SetIBPMode()

Sets frame structure, key frame interval, B-frames, and frame rate.

4.2.30. SetDefaultQuant()

Sets video encode quantization parameters for image quality adjustment.

4.2.31. SetEncoderPictureFormat()

Sets the encoding picture format for the master channel.

4.2.32. SetSubEncoderPictureFormat()

Sets the encoding picture format for the sub-channel.

4.2.33. SetupBitrateControl()

Sets the maximum baud rate for bitrate control.

4.2.34. SetBitrateControlMode()

Sets the bitrate control mode (VBR or CBR).

4.2.35. SetVideoStandard()

Sets the video standard for the current video input.

4.2.36. SetDefaultVideoStandard()

Sets the system's default video standard (e.g., PAL).

4.2.37. SetVideoDetectPrecision()

Sets the precision for video signal detection.

4.2.38. GetVideoSignal()

Retrieves information about the connected video signal status.

4.2.39. SetInputVideoPosition()

Sets the position of the video input coordinates.

4.2.40. SetOsdDisplayMode()

Configures OSD display brightness, translucency, and twinkle.

4.2.41. SetOsd()

Enables or disables OSD display for system time or custom strings.

4.2.42. SetupDateTime()

Sets the system date and time.

4.2.43. SetOsdDisplayModeEx()

Expands OSD settings to support 8 lines and advanced configuration.

4.2.44. LoadYUVFromBmpFile()

Converts a 24-bit BMP file to YUV format data.

4.2.45. SetLogoDisplayMode()

Sets the logo display mode, including color key and transparency.

4.2.46. SetLogo()

Sets the position and data for the logo screen image.

4.2.47. StopLogo()

Stops the display of the logo.

4.2.48. SetupMask()

Sets up video masks to obscure specific regions of the video feed.

4.2.49. StopMask()

Stops the video mask function.

4.2.50. AdjustMotionDetectPrecision()

Adjusts motion detection sensitivity and parameters like frame interval.

4.2.51. SetupMotionDetection()

Sets up motion detection areas and parameters.

4.2.52. StartMotionDetection()

Starts the motion detection process, transmitting information via data stream.

4.2.53. StopMotionDetection()

Stops the motion detection process.

4.2.54. MotionAnalyzer()

Analyzes motion detection data to determine movement in specific areas.

4.2.55. SetupMotionDetectionEx()

Extended setup for motion detection with callback functionality.

Motion Detection Callback

Callback function description for motion detection events.

4.2.56. SetAudioPreview()

Configures audio preview for a selected channel.

4.2.57. GetSoundLevel()

Retrieves the current audio input level of a channel.

4.2.58. RegisterImageStreamCallback()

Registers a callback function for receiving image stream data.

4.2.59. SetImageStream()

Boots or stops getting the original picture data stream.

4.2.60. GetOriginalImage()

Retrieves the original image data for a channel.

4.2.61. SaveYUVToBmpFile()

Transfers YUV image data to a BMP file.

4.2.62. GetJpegImage()

Retrieves a JPEG image from the camera.

4.2.63. SetupSubChannel()

Sets parameters for sub-channels, affecting OSD, Logo, and StreamType.

4.2.64. GetSubChannelStreamType()

Retrieves the stream type of a sub-channel.

4.2.65. GetFramesStatistics()

Gets statistics information about frames processed by the channel.

4.2.66. CaptureIFrame()

Forces the current frame encoding to be an I-frame.

4.2.67. SetDeInterlace()

Configures deinterlace settings and intensity for video.

4.2.68. ResetDSP()

Resets the DSP (note: this function is currently invalid).

4.2.69. SetWatchDog()

Configures the watchdog timer for board reset functionality.

4.2.70. StartVideoPreviewEx()

Enhanced video preview with extended modes and synchronization options.

4.2.71. SetEncoderAudioOutput()

Configures audio output for encoding channels.

Decoding Card SDK

5.1. API of Decoding Card

Lists and explains the available APIs for the decoding card.

5.1.1. HW_InitDecDevice()

Initializes the decoding system for operation.

5.1.2. HW_ReleaseDecDevice()

Closes the decoding system and releases resources before exit.

5.1.3. HW_ChannelOpen()

Opens a decoding channel and obtains a channel handler.

5.1.4. HW_ChannelClose()

Closes a decoding channel, releasing its resources.

5.1.5. HW_OpenStream()

Opens the interface for stream mode, similar to opening a file.

5.1.6. HW_CloseStream()

Closes the stream mode for a decoding channel.

5.1.7. HW_InputData()

Inputs data into the stream after it has been opened.

5.1.8. HW_OpenFile()

Opens a file that is intended to be decoded.

5.1.9. HW_CloseFile()

Closes the decoding file.

5.1.10. HW_Play()

Starts the decoding process.

5.1.11. HW_Stop()

Stops the decoding process.

5.1.12. HW_Pause()

Pauses or continues the decoding process.

5.1.13. HW_PlaySound()

Opens the audio decoding function, which is closed by default.

5.1.14. HW_StopSound()

Closes the audio decoding function.

5.1.15. HW_SetVolume()

Adjusts the volume level for audio playback.

5.1.16. HW_StartCapFile()

Captures decoding data and saves it to a specified file.

5.1.17. HW_StopCapFile()

Stops the capturing of decoding data.

5.1.18. HW_GetPictureSize()

Retrieves the size (width and height) of the decoded picture.

5.1.19. HW_GetYV12Image()

Captures the current image in YV12 format into a buffer.

5.1.20. HW_ConvertToBmpFile()

Converts YUV image data to a BMP file format.

5.1.21. HW_GetSpeed()

Retrieves the current decoding speed.

5.1.22. HW_SetSpeed()

Sets the decoding speed for playback.

5.1.23. HW_SetPlayPos()

Sets the playback position within the file using a percentage.

5.1.24. HW_GetPlayPos()

Gets the current playback position percentage in the file.

5.1.25. HW_SetJumpInterval()

Sets the interval in seconds for jumping within the file.

5.1.26. HW_Jump()

Sets the direction for jumping within the file (forward or backward).

5.1.27. HW_GetVersion()

Retrieves version information for the decoding card SDK components.

5.1.28. HW_GetCurrentFrameRate()

Gets the current frame rate of the decoding process.

5.1.29. HW_GetCurrentFrameNum()

Gets the current frame index during the decoding process.

5.1.30. HW_GetFileTotalFrames()

Gets the total number of frames contained within the file.

5.1.31. HW_GetFileTime()

Gets the total duration of the file in milliseconds.

5.1.32. HW_GetCurrentFrameTime()

Gets the current time elapsed during the decoding process.

5.1.33. HW_GetPlayedFrames()

Gets the count of frames that have successfully been decoded.

5.1.34. HW_SetFileEndMsg()

Registers a semaphore to signal the end of file decoding.

5.1.35. HW_SetStreamOpenMode()

Sets the stream decoding mode, affecting smoothness and delay.

5.1.36. HW_GetStreamOpenMode()

Retrieves the current stream decoding mode.

5.1.37. HW_SetAudioPreview()

Sets up and enables audio preview for a channel.

5.1.38. HW_StartDecVgaDisplay()

Starts video display on the VGA output with preview configuration.

5.1.39. HW_StopDecChanVgaDisplay()

Stops video display for a specific decoding channel.

5.1.40. SetDisplayStandard()

Sets the video standard for the video output.

5.1.41. SetDisplayRegion()

Partitions the display into multiple areas with specified parameters.

5.1.42. ClearDisplayRegion()

Clears display areas or sets the background color.

5.1.43. SetDisplayRegionPosition()

Adjusts the position of a display region.

5.1.44. FillDisplayRegion()

Fills a display area with YUV420 image data.

5.1.45. SetDecoderAudioOutput()

Sets the audio output for a decoding channel to a display channel.

5.1.46. SetDecoderVideoOutput()

Sets the video output for a decoding channel to a specific display channel and port.

5.1.47. SetDecoderVideoExtOutput()

Extended video output for matrix output to other boards.

5.1.48. SetEncoderVideoExtOutput()

Sets encoding data for display output, supporting matrix output.

5.1.49. HW_SetFileRef()

Sets the index for the decoding file before opening it.

5.1.50. HW_GetFileAbsoluteTime()

Gets the absolute start and end time for a recording file.

5.1.51. HW_GetCurrentAbsoluteTime()

Gets the current absolute time of the recording file.

5.1.52. HW_LocateByAbsoluteTime()

Locates playback by absolute time within the file.

5.1.53. HW_LocateByFrameNumber()

Locates playback by frame number within the file.

5.1.54. HW_InputDataByFrame()

Inputs data for stream processing in real-time using frames.

5.1.55. HW_SetDecoderPostProcess()

Avoids the flash effect of the image during decoding.

5.1.56. RegisterDecoderVideoCaptureCallback()

Registers a callback function to receive decoded video data.

5.1.57. HW_SetDecoderVideoCapture()

Starts or stops grabbing decoded data in YUV420 format.