GM8126 DVR DRIVER. User Guide Rev.: 1.1 Issue Date: June 2011

Transcription

1 GM8126 DVR DRIVER User Guide Rev.: 1.1 Issue Date: June 2011

2

3 REVISION HISTORY Date Rev. From To Feb Original Jun Added the DVR_DEC driver Updated Sections 2.2, 2.4, 3.1 through 3.4, and 3.7 Added Section 3.5 Copyright 2011 Grain Media, Inc. All Rights Reserved. Printed in Taiwan 2011 Grain Media and the Grain Media Logo are trademarks of Grain Media, Inc. in Taiwan and/or other countries. Other company, product and service names may be trademarks or service marks of others. All information contained in this document is subject to change without notice. The products described in this document are NOT intended for use in implantation or other life support application where malfunction may result in injury or death to persons. The information contained in this document does not affect or change Grain Media s product specification or warranties. Nothing in this document shall operate as an express or implied license or indemnity under the intellectual property rights of Grain Media or third parties. All information contained in this document was obtained in specific environments, and is presented as an illustration. The results obtained in other operating environments may vary. THE INFORMATION CONTAINED IN THIS DOCUMENT IS PROVIDED ON AN AS IS BASIS. In no event will Grain Media be liable for damages arising directly or indirectly from any use of the information contained in this document. Grain Media, Inc. 5F, No. 5, Li-Hsin Road III, Hsinchu Science Park, Hsinchu City, Taiwan 300, R.O.C. Grain Media's home page can be found at:

4

5 TABLE OF CONTENTS Chapter 1 Introduction... 1 Chapter 2 IPCAM Driver Design P High Resolution File List Memory Configuration File Graph Construction Allocate Queue Buffer... 9 Chapter 3 API Header File for User Application DVR_COMMON ioctl DVR_DISP ioctl DVR_ENC ioctl DVR_DEC ioctl Bit-stream Data Allocation DVR Graph Flow Chart Set Dimension for Source and Destination Set Processing Rate for Source and Destination i

6

7 Chapter 1 Introduction DVR driver is an assistant module that helps users implement the IPCAM functionalities. This module includes four drivers: DVR_DISP driver, DVR_ENC driver, DVR_DEC driver, and DVR_COMMON driver. These drivers are designed to control the flow of the video drives via VideoGraph. 1

8 DVR_DISP The DVR_DISP driver selects the input source as the capture device. The output destination is a display device, which generally is a LCD/TV plane. DVR_ENC The DVR_ENC driver is usually used for the IPCAM record functionality. Users need to specify the input channel and then, receive the encoded bit-stream. The supported format is H.264 MPEG4 and MJPEG. DVR_COMMON This DVR_COMMON driver contains DVR Graph, which is an encapsulated version of the video graph interface. This module allows users create many different graphs and operate them independently. DVR_DEC The DVR_DEC driver is used to playback the record files. Users need to specify the channel numbers. The supported formats are MPEG4, and MJPEG. 2

9 Chapter 2 IPCAM Driver Design This chapter contains the following sections: P High Resolution 2.2 File List 2.3 Memory Configuration File 2.4 Graph Construction 2.5 Allocate Queue Buffer 3

10 P High Resolution Grain Media supports four channels for the applications, which includes two channels for the RTSP/record applications, one channel for liveviews, and one channel for the mobile phone application. CAP0_0: CAP0 is the high-resolution channel. CAP0_1: CAP1 is the general-resolution channel by using the Scalar entity to reproduce two sub-bit-streams. CAP1_0: CAP2 is for liveview. CAP1_1: CAP3 is for the small resolution channel used by the mobile phone. 4

11 2.2 File List File Name dvr_common_api.h dvr_disp_api.h dvr_enc_api.h dvr_dec_api.h dvr_mod_define.h dvr_type_define.h Dvr_scenario_define.h disp_main.c disp_main.h enc_main.c enc_main.h dec_main.c dec_main.h Datain_entity.c datain_entity.h dataout_entity.c dataout_entity.h dvr_graph.c dvr_graph.h nodirty.c h264e_ratecontrol.c h264e_ratecontrol.h mcp210_process.c mcp100_process.c util_cfg.c util_cfg.h Makefile Description IPCAM driver interface Please include these files to access the IPCAM drivers. This file defines the major and minor numbers at each entity. This file defines the common types. The platform dependent pre-definitions IPCAM DISP source code IPCAM ENC source code IPCAM DEC source code DataIn entity source code DataOut entity source code DVR Graph source code, this is part of DVR_COMMON. Please include the header file from the DVR driver to use the DVR Graph. The rate control source code Encoder will use these files. This defines the pre-process/post-process for the H264 encoder. User can use this interface to access the H264 encoder before and after processing the image. This defines the pre-process/post-process for the MJPEG encoder. User can use this interface to access the MJPEG encoder before and after processing the image. These files support to read the config. files from kernel. This is part of DVR_COMMON. Please include the header file before using the utilities. Make file 5

12 2.3 Memory Configuration File Memory configuration file specifies the queue size and locations. This information is needed when inserting the DVR drivers. Users can modify the memory configuration file to achieve the maxinum performance. The relative module is frammap and responsible to allocate the memory from different DDR sources. Default file name: gmdvr_mem.cfg Default file path for read: /mnt/mtd Configuration format Format Description <queue_name><n>_size The size of one element (Such as the size of one frame) < queue_name><n>_count The count of one element for this entity (Reserved four frames for LCD) < queue_name><n>_ddr The DDR number ( 0 is the system DDR, while 1 means another DDR.) < queue_name><n>_limit_count Maximum count of the in-used buffer < queue_name><n>_max_w Maximum width < queue_name><n>_max_h Maximum height < queue_name>: Queue name <n>: Channel number, if this value is not assigned, it means all channels. Current queue names Queue Name lcd 3di_scl_in lv_scl_in enc_in enc_out scl_out_size sub_enc_out ss_enc_out Description Display buffer Dedicated scaler buffer for liveview and 3D deinterlace is enabled. Dedicated scaler buffer for liveview Input buffer for encoder Generally, it is the output of the capture. Output bitstream buffer after encoding Output buffer for scaler Generally, it is for the enc_in buffer. Output bitstream buffer after encoding sub-streams Output bitstream buffer after encoding snapshot Note: Generally, in the source code, 3di_scl_in is renamed as di_scl_in to avoid the build error. 6

13 Example enc_in_size = enc_in_count = 5 enc_in_ddr = 1 enc_in_limit_count = 8 This config indicates that the size of the encoder input (Capture a frame) is bytes, with a total of five elements, which are allocated in ddr1. When using this config runtime, the maximum count of the in-use buffer is Graph Construction xxx Queue xxx Duplicated queue xxx Entity Liveview 7

14 Record enc_in_dup is a duplicated queue from enc_in. 3DI disabled SnapShot Capture ss_enc_in ss_enc_out SnapShot Scalar SS_Encoder SS_DataOut enc_in (Main) enc_out (Main) Encoder DataOut 3DI enabled Sub1-bitstream encoder Sub1 Enc Scalar Sub1 Encoder Sub1 DataOut sub1_enc_in sub1_enc_out Sub2-bitstream encoder Sub2 Enc Scalar Sub2 Encoder Sub2 DataOut sub2_enc_in sub2_enc_out Capture ss_enc_in ss_enc_out SnapShot SnapShot Scalar SS_Encoder SS_DataOut enc_in (Main) enc_in_dup (Main) enc_out (Main) 3DI Encoder DataOut Sub1-bitstream encoder Sub1 Enc Scalar Sub1 Encoder Sub1 DataOut sub1_enc_in sub1_enc_out Sub2-bitstream encoder Sub2 Enc Scalar Sub2 Encoder Sub2 DataOut sub2_enc_in sub2_enc_out 8

15 Decode 2.5 Allocate Queue Buffer lcd: (Frame size) * (Byte per pixel) enc_in: (Frame size) * (Byte per pixel) * n No 3DI n = 1 Supports 3DI n = 1.5 enc_out: (Frame size) * (Estimative ratio) + (Num of macroblock) * 64 (Num of macroblock) (Width/16) * (Height/16) scl_in: (Frame size) * (Byte per pixel) * n No 3DI n = 1 Supports 3DI n = 1.5 Example Display resolution: NTSC/PAL (720x576) Maximum record resolution: D1 (720x576) Precondition: Use YUV422, enable 3DI, and enable scaler (YUV422 2 bytes per pixel) Queue Name Element Size Number of Element lcd enc_in enc_out

16

17 Chapter 3 API This chapter contains the following sections: 3.1 Header File for User Application 3.2 DVR_COMMON ioctl 3.3 DVR_DISP ioctl 3.4 DVR_ENC ioctl 3.5 DVR_DEC ioctl 3.6 Bit-stream Data Allocation 3.7 DVR Graph 3.8 Flow Chart 3.9 Set Dimension for Source and Destination 3.10 Set Processing Rate for Source and Destination 11

18 3.1 Header File for User Application Module Name DVR_COMMON DVR_DISP DVR_ENC DVR_DEC Include File dvr_common_api.h dvr_disp_api.h dvr_enc_api.h dvr_dec_api.h 3.2 DVR_COMMON ioctl DVR_COMMON_APPLY Issue and apply to FuncTag (Please refer to Section 3.7: DVR Graph, for the detailed information.) 3.3 DVR_DISP ioctl DVR_DISP_INITIATE This initiate VideoGraph is used by display, which is no longer used. DVR_DISP_TERMINATE This close VideoGraph is used by display, which is no longer used. DVR_DISP_GET_DISP_PARAM Issue disp_num will return with the LCD parameters. For the dual displays, disp_num can be 0 or 1. For GM8126, this value must be 0. DVR_DISP_SET_DISP_PARAM Set the display parameters by using the given disp_num. All parameters in this structure will be applied immediately after this ioctl is returned. typedef struct dvr_disp_disp_param_tag { int disp_num; int target_id; int plane_comb; - LCD number - specify the LCD target if there are more than one LCD destinations - The number of active plane for this LCD (see Ref.B for more information) 12

19 int output_system; int output_mode; dvr_disp_color_attribute color_attrib; dvr_disp_color_key transparent_color[2]; dvr_disp_vbi_info vbi_info; dvr_disp_scaler_info scl_info; DIM dim; dvr_disp_resolution res; }dvr_disp_disp_param; - LCD video output system (see Ref.A for more information) - LCD video output mode(see Ref.A for more information) - LCD color attributes - LCD transparent color(key color) - VBI information(reserved) - LCD output scaler(reserved) - Default background dimension - LCD resolution Note: The gray text indicates that it is reserved for new features, but is disused in this version. DVR_DISP_UPDATE_DISP_PARAM Set the specified display parameter by using the given disp_id and the parameter value. typedef struct dvr_disp_update_disp_param_tag { int disp_num; dvr_disp_disp_param_name param; struct val_t { int target_id; int plane_comb; int output_system; int output_mode; int display_rate; dvr_disp_color_attribute color_attrib; dvr_disp_color_key transparent_color[2]; dvr_disp_vbi_info vbi_info; dvr_disp_scaler_info scl_info; dvr_disp_resolution res; }val; }dvr_disp_update_disp_param; - LCD number - parameter name(ref. dvr_disp_disp_param_name) - specify the LCD target if there are more than one LCD destinations - The number of active plane for this LCD(see Ref.B) - LCD video output system(see Ref.A) - LCD video output mode(see Ref.A) - Specify the display rate - LCD color attributes - LCD transparent color(key color) - VBI information(reserved) - LCD output scaler(reserved) - LCD resolution Note: The gray text indicates that it is reserved for new features, but is disused in this version. 13

20 DVR_DISP_GET_PLANE_PARAM The given disp_num and plane_num will return with the plane parameters. DVR_DISP_SET_PLANE_PARAM Set the plane parameters by using the given plane_id. All parameters in this structure will be applied immediately after this ioctl is returned. typedef struct dvr_disp_plane_param_tag { int plane_id; RECT win; int data_mode; int color_mode; }dvr_disp_plane_param_st; typedef struct dvr_disp_plane_param_st_tag { int disp_num; int plane_num; dvr_disp_plane_param_st param; }dvr_disp_plane_param; - The plane ID, use this value in the later operations - The window of this plane - Video mode, possible value is DVR_VIDEIO_MODE_PROGRESSIVE or DVR_VIDEIO_MODE_INTERLACING (see Ref.A) - The color mode(see Ref.A) - The LCD number - The plane number - Plane parameter Note: Ref.A indicates GM8126_LCD_User_Guide.pdf. DVR_DISP_UPDATE_PLANE_PARAM Set the specified plane parameter by using the given plane_id and the parameter value typedef struct dvr_disp_update_plane_param_tag { int plane_id; dvr_disp_plane_param_name param; union { RECT win; int data_mode; int color_mode; }val; - The plane ID - Parameter name (use dvr_disp_plane_param_name) - The window of this plane - Video mode, possible value is DVR_VIDEIO_MODE_PROGRESSIVE or DVR_VIDEIO_MODE_INTERLACING (see Ref.A) - The color mode (see Ref.A) 14

21 }dvr_disp_update_plane_param; Note: Ref.A indicates GM8126_LCD_User_Guide.pdf. DVR_DISP_CONTROL Control what and how to display, including capture or cascade typedef struct dvr_disp_control_tag { int type; int channel; dvr_disp_ctrl_cmd command; struct { struct { int cap_path; int di_mode; int mode; int dma_order; int scale_indep; int input_system; int cap_rate; int color_mode; int is_use_scaler; DIM dim; RECT win; video_process vp_param; ScalerParam scl_param; }lv; struct { RECT win; int rate; int di_mode; int mode; int dma_order; int scale_indep; int input_system; - Control type, use "enum dvr_disp_type" - The channel number - Command, use "dvr_disp_ctrl_cmd" - Capture path - Capture's data format (see Ref.A) - Capture mode(see Ref.A) - Capture DMA order(see Ref.A) - Enlarge or keep its aspect-ratio(see Ref.A) - Capture's input system(see Ref.A) - Capture rate(see Ref.A) - Output type(see Ref.A) - Use scaler when Liveview - Desired dimension for capture - Desired ROI for display(see NoteB) - video process setting - scaler setting if it is used 15

22 int cap_rate; int color_mode; int is_use_scaler; DIM dim; video_process vp_param; ScalerParam scl_param; int cap_buf_id; - User may need to specify buffer id for capture output. Use CAP_BUF_ID(id) macro. }cas; }src_param; struct { struct { RECT win; int plane_id; }lv; struct { int path; RECT win; RECT rect0; RECT rect1; RECT swc_rect0; RECT swc_rect1; RECT bg_rect0; RECT bg_rect1; int plane_id; }cas; }dst_param; }dvr_disp_control; - Desired locations and size to be displayed - The plane for video displayed on Notes: 1. The gray text indicates that it is reserved for new features, but is disused in this version. 2. Ref.A indicates GM8126_LCD_User_Guide.pdf. 16

23 DVR_DISP_CLEAR_WIN Set the given pattern on the given region of the display buffer. This ioctl will immediately be triggered without any apply action. typedef struct dvr_disp_clear_param_tag { int plane_id; RECT win; unsigned int pattern; }dvr_disp_clear_param; - The plane for video displayed on - Desired locations and size for operation - The pattern will be used when cleaning 3.4 DVR_ENC ioctl DVR_ENC_QUERY_OUTPUT_BUFFER_SIZE Get the buffer size for the memory mapping DVR_ENC_QUERY_OUTPUT_BUFFER_SUBN_BS_OFFSET Get the buffer size for the subn-bit-stream memory mapping, where N is ranging from 1 to 8. DVR_ENC_QUERY_OUTPUT_BUFFER_SNAP_OFFSET Get the buffer size for the snapshot memory mapping DVR_ENC_QUEUE_GET_SNAP Get the bitstream data for snapshot DVR_ENC_SET_CHANNLE_PARAM Set the video parameters for encoding the main bit stream typedef struct EncParam_Ext5_tag{ unsigned int feature_enable; unsigned int target_rate_max; unsigned int reaction_delay_max; int enc_type; int MJ_quality; int watermark_enable; - for feature enable/disable. - target max bitrate - max frame count when keep at target_rate_max. - 0: ENC_TYPE_H264, 2:ENC_TYPE_MJPEG - MJPEG Quality 1(worst) ~100(best) - if 0: disable 17

24 - if 1: enable, but only insert watermark at intra-mb - if 3: enable, and insert watermark at intra/inter-mb - if others: not allowed int watermark_interval; - if 1: will be inserted watermark each frames - if N: will be inserted watermark each N frames int watermark_init_pattern; - The initial pattern for watermark int watermark_init_interval; POS roi_pos; ROI_ALL roi_all; }EncParam_Ext5; - if 1: every "watermark"ed frame with init_pattern - if N: initial with init_pattern each N "watermark"ed frame - for ROI x, y position - for update ROI all function, x, y position, width, height, enable/disable typedef struct EncParam_tag { int input_type; int frame_rate; int bit_rate; int ip_interval; int init_quant; int max_quant, min_quant; int is_use_roi; RECT ROI_win; unsigned int ext_size; void *pext_data; } EncParam; - The format of input data, use "EncoderInputFormat" - The frame rate - The bit-rate - The I-P interval frames - The initial quant value - The max/min quant value - Enable the ROI - The desired size after ROI-encoding window - for extended parameter length - for extended parameter data, please see EncParam_Ext3 typedef struct ReproduceBitStream_tag { int enabled; int out_bs; int enc_type; int is_blocked; int en_snapshot; DIM dim; EncParam enc; - enabled/disable this bit-stream -0:main-BS -0: ENC_TYPE_H264, 2:ENC_TYPE_MJPEG - Boolean value, indicate all system-call for this channel is "blocked" or "non-block" type - enabled/disable snapshot. - The resolution of encoder - Encoder parameter 18

25 ScalerParam scl; snapshot_param snap; } ReproduceBitStream; - Scaler parameter - snapshot parameter typedef struct dvr_enc_src_tag { int channel; int enc_src_type; DIM dim; int di_mode; int mode; int dma_order; int scale_indep; - The channel number - The video source, possible value is ENC_TYPE_FROM_CAPTURE, ENC_TYPE_FROM_CASCADE, ENC_TYPE_FROM_BUFFER - The resolution of resolution. - The deinterlacing mode, use "LiveviewFrameType"(see Ref.A) - The frame mode, use "LiveviewFrameMode" (see Ref.A) - The DMA order, use "LiveviewDMAOrder"(see Ref.A) - Fixed scaler aspect-ratio, use "LiveviewScalerRatio"(see Ref.A) int input_system; int color_mode; - Video system, possible value is DVR_VIDEO_SYSTEM_NTSC or DVR_VIDEO_SYSTEM_PAL(see Ref.A) - The color mode(see Ref.A) video_process vp_param; } dvr_enc_src_param; typedef struct dvr_enc_channel_param_tag { dvr_enc_src_param src; ReproduceBitStream main_bs; }dvr_enc_channel_param; -Source parameter(from capture) -Destination parameter(for encoder main-bitstream) 19

26 DVR_ENC_SET_SUB_BS_PARAM Set the video parameters for encoding the subn bitstream, where N is ranging from 1 to 8. typedef struct ReproduceBitStream_tag { int enabled; int out_bs; int enc_type; int is_blocked; - enabled/disable this bit-stream - 1:sub1-bitstream, 2:sub2-bitstream,, 8:sub8-bitstream - 0: ENC_TYPE_H264,1: ENC_TYPE_MPEG 2:ENC_TYPE_MJPEG - Boolean value, indicate all system-call for this channel is "blocked" or "non-block" type int en_snapshot; DIM dim; EncParam enc; ScalerParam scl; snapshot_param snap; } ReproduceBitStream; - enabled/disable snapshot. - The resolution of encoder - Encoder parameter - Scaler parameter - snapshot parameter DVR_ENC_QUEUE_GET Get the encoded main bitstream DVR_ENC_QUEUE _GET_SUBN_BS Get the encoded subn bitstream, where N is ranging from 1 to 8. typedef struct dvr_enc_queue_get_tag { //output dvr_bs_data bs; }dvr_enc_queue_get; - The output bit-stream structure 20

27 DVR_ENC_QUEUE_PUT Return the bitstream structure retrieved by DVR_ENC_QUEUE_GET typedef struct dvr_enc_queue_put_tag { // input dvr_bs_data bs; }dvr_enc_queue_put; - The bit-stream structure DVR_ENC_CONTROL Control the encoder state typedef struct dvr_enc_update_channel_param_tag { struct { //Capture parameter, only effect when updating main stream int di_mode; int mode; int scale_indep; int is_3di; int is_denoise; } src; int stream_enable; int frame_rate; int bit_rate; int ip_interval; DIM dim; int init_quant; int max_quant; int min_quant; unsigned int ext_size; void *pext_data; } dvr_enc_update_channel_param; - The deinterlacing mode, use "LiveviewFrameType" - The frame mode, use "LiveviewFrameMode" - Fixed scaler aspect-ratio, use "LiveviewScalerRatio" - disable/enable this bitstream - frame rate per second. - bit rate per second. - The I-P interval frames - The resolution of encoder - The initial quant value - The max quant value - The min quant value - for extended parameter length - for extended parameter data, please see EncParam_Ext5 21

28 typedef struct dvr_enc_control_tag { int command; union { int *count; int *repd_bs_num; }output; int stream; dvr_enc_update_channel_param update_parm; }dvr_enc_control; - The encoder command, use "dvr_enc_oper_cmd" - (reserved field) - (reserved field) - stream number, 0:main, 1:sub1, 2:sub2,, 8:sub8 - dynamic update parameter. DVR_ENC_RESET_INTRA Inform the encoder to generate the key frame (I frame) as soon as possible. This command will not guarantee to get the I-frame if there are P-frames left in the queue. DVR_ENC_SWAP_INTRA Set the key frame (I frame) as the first bitstream output when applying the next graph. DVR_ENC_SUB_PATH_DENOISE_CTRL This is a switch for the sub-stream de-noise function. Set 1 as enable and 0 as disable 3.5 DVR_DEC ioctl DVR_DEC_SET_CHANNEL_PARAM Set the channel video parameters for playback the record file typedef struct dvr_dec_channel_param_tag { int dec_type; int dec_dest_type; int channel; int is_blocked; int is_use_scaler; DecParam dec_param; ScalerParam scl_param; - 0: ENC_TYPE_H264, 1: ENC_TYPE_MPEG 2:ENC_TYPE_MJPEG - decode type to display - The channel number - no longer used. - Use scaler when playback - Decoder parameter - Scaler parameter 22

29 int reserved[8]; }dvr_dec_channel_param; - (reserved field) DVR_DEC_GET_CHANNEL_PARAM Get the channel parameters DVR_DEC_QUEUE_GET Get the buffer to the user space, which includes the buffer length and offset DVR_DEC_QUEUE_PUT Get the buffer from user space. Get the release buffer at the VideoGraph layer DVR_DEC_QUERY_OUTPUT_BUFFER_SIZE Get the buffer size for the memory mapping DVR_DEC_CLEAR_WIN To avoid the occurrence of the unexpected lcd image, please stop the playback and start the other playback. Please use the flow below: ioctl(dvr_fd,dvr_common_apply,&data); //Stop the current playback ioctl(dec_fd,dvr_dec_clear_win,&data); //Must after stop, and before tstart apply ioctl(dvr_fd,dvr_common_apply,&data); //Start new playback DVR_DEC_CLEAR_WIN2 To avoid the occurrence of the unexpected lcd image when updating the current playback, please use the flow below: dec_ctrl.command = DEC_UPDATE; ioctl(dec_fd, DVR_DEC_CONTROL, &dec_ctrl); ioctl(dec_fd, DVR_DEC_CLEAR_WIN2, &data); // tell VG to clear buffer after apply ioctl(dvr_fd, DVR_COMMON_APPLY, &data); 23

30 DVR_DEC_CONTROL Control the decoder state typedef struct dvr_dec_control_tag { dvr_dec_ctrl_cmd command; struct { DIM dim; RECT win; int bs_rate; int reserved[2]; }src_param; struct { int plane_id; RECT win; int is_display; int display_rate; int reserved[2]; }dst_param; }dvr_dec_control; - 0: DEC_START, 1: DEC_STOP, 2: DEC_UPDATE - The resolution of decoder - The desired size of window - bitstream frame rate - The number of active plane for this LCD - The desired size of window - Specify the display rate 3.6 Bit-stream Data Allocation The bit-stream data structure is as follows. typedef struct dvr_bs_data_tag { int timestamp; int offset; int length; //internal use void *p_job; }dvr_bs_data; 24

31 DVR_ENC The bit-stream data structure does not contain the real bit-stream. It only informs users the location of the mapped memory. Users should use DVR_ENC_QUERY_OUTPUT_BUFFER_SIZE, DVR_ENC_QUERY_OUTPUT_BUFFER_SUBn_BS_OFFSET, and DVR_ENC_QUERY_OUTPUT_BUFFER_SNAP_OFFSET to get the buffer offset size, respectively. The output bit stream is started from the offset position and its size is length. Please refer to the examples below: For example To get the main-bit-stream buffer buf = bs_buf[ch_num] + data.bs.offset buf_size = data.bs.length To get the sub1-bit-stream buffer buf = bs_buf[ch_num] + sub1_bs_buf_offset [ch_num] + data.bs.offset buf_size = data.bs.length To get the sub2-bit-stream buffer buf = bs_buf[ch_num] + sub2_bs_buf_offset [ch_num] + data.bs.offset buf_size = data.bs.length To get the snapshot bit-stream buffer buf = bs_buf[ch_num] + bs_buf_snap_offset[ch_num] + data.bs.offset buf_size = data.bs.length Grain Media defines POLLIN_MAIN_BS, POLLIN_SUB1_BS, POLLIN_SUB2_BS, POLLIN_SUB8_BS, POLLIN_SNAP_BS as the poll functions to query the bit-stream data, separately. Using this method may reduce the query time and avoid unnecessary calling of the IOCTL function. Please refer to the following examples for details. #include "dvr_enc_api.h" : struct pollfd rec_fds; dvr_enc_queue_get data; : 25

32 rec_fds.fd = enc_fd; // encorder fd rec_fds.revents = 0; rec_fds.events = POLLIN_MAIN_BS; if(enable sub1 and sub2 bitstream) rec_fds.events = (POLLIN_SUB1_BS POLLIN_SUB2_BS); if(enable sub1 and sub2 bitstream) rec_fds.events = POLLIN_SNAP_BS; ret =poll(&rec_fds, 1, 500); if((rec_fds.revents & POLLIN_MAIN_BS)){ ioctl(enc_fd, DVR_ENC_QUEUE_GET, &data); process main-bitstream data } if((rec_fds.revents & POLLIN_SUB1_BS)){ ioctl(enc_fd, DVR_ENC_QUEUE_GET_SUB1_BS, &data) process sub1-bitstream data } if((rec_fds.revents & POLLIN_SUB2_BS)){ ioctl(enc_fd, DVR_ENC_QUEUE_GET_SUB2_BS, &data) process sub2-bitstream data } : if((rec_fds.revents & POLLIN_SUB8_BS)){ ioctl(enc_fd, DVR_ENC_QUEUE_GET_SUB8_BS, &data) process sub8-bitstream data } if((rec_fds.revents & POLLIN_SNAP_BS)){ ioctl(enc_fd[ch_num], DVR_ENC_QUEUE_GET_SNAP, &data); process snapshot bitstream data } 26

33 27

34 3.7 DVR Graph DVR Graph is an encapsulated version of VideoGraph, which allows users to create and operate many different graphs, independently. Adding the properties or graphs will be operated until the dvr_graph_run() function is called. If users do not perform the DVR Graph, users can still utilize the original interface (Please refer to Chapter 3 of the VideoGraph_API document). Include file dvr_graph.h Functions Function Name dvr_graph_create dvr_graph_destroy dvr_graph_add_link dvr_graph_del_link dvr_graph_update_flow dvr_get_flow dvr_graph_apply_flow dvr_graph_set_property dvr_graph_get_property dvr_graph_apply_property dvr_graph_apply_by_tag dvr_graph_find_by_id dvr_queue_allocate dvr_queue_destroy dvr_queue_find_by_name dvr_queue_rearrange Description Create a graph Destroy the given graph Add a graph between two entities Similar to video_setgraph() Remove the graph established by dvr_graph_add_link() Similar to video_cleargraph() Update the flow between two entities Similar to video_update_flow() Absolutely the same as video_get_flow() Absolutely the same as video_apply_flow() Set the property to the given entity Similar to set_property() Get the property to the given entity Absolutely the same as get_property () Apply the properties set by dvr_graph_set_property() Apply the graph and property that matches the given tag Find the graph that matches the given ID. Create queue Similar to video_create_queue() Destroy queue Similar to video_destroy_queue() Find the queue that matches the given queue name. Rearrange queue buffer by the size and count 28

35 Function Name dvr_register_postprocess dvr_register_preprocess PROPID Description Absolutely the same as video_register_postprocess() Absolutely the same as video_register_preprocess() Absolutely the same as query_propertyid(). Define tag and apply graph Upper layer calls the functions exported by the DVR Graph to set the properties and graphs. Tag is attached to each property graph. In the DVR Graph layer, it keeps the properties and graphs at the upper layer. When users call dvr_graph_apply_by_tag(), DVR Graph will apply them to video graph. Set from upper layer DVR_DISP: Graph Tag DVR_DEC: Property Tag property Graph property Graph Property property Tag Tag DVR Graph Set to video graph after calling dvr_graph_apply_by_tag Video graph Functionality tag typedef struct FuncTag_tag{ int func : 28; int cas_ch : 4; int lv_ch; int rec_ch; int pb_ch; }FuncTag; - Functions - cascade (Not in use) - liveview (ch0 - ch3) - record (ch0 ch3) - playback (Not in use) The tag structure is defined as bitmap. Setting the bit to 1 indicates to apply this functionality. Grain Media recommends using the FN_XXX macros for better portability. 29

36 3.8 Flow Chart The module dependency is shown as follows: DVR_COMMON DVR_DISP DVR_ENC DVR_DEC DVR_COMMON must be opened when the application will be started-up. For other functionalities, such as DVR_DISP, DVR_ENC, and DVR_DEC, can be executed separately. DVR_COMMON: Start and end Start Open "dvr_common" User operations (Set property/graph ) DVR_COMMON_APPLY Close "dvr_common" End 30

37 DVR_DISP: Initialize display Start Open "dvr_disp" DVR_DISP_GET_ PLANE_PARAM DVR_DISP_INITIATE DVR_DISP_UPDATE_PLANE_PARAM DVR_DISP_GET_DISP_PARAM DVR_DISP_UPDATE_PLANE_PARAM (Param : PLANE_PARAM_APPLY ) DVR_DISP_UPDATE_DISP_PARAM Using DVR_DISP DVR_DISP_UPDATE_DISP_PARAM (Param: DISP_ PARAM_ APPLY) Close "dvr_common" End DVR_DISP: Start/Stop/Update Liveview Start DVR_DISP_CONTROL (DISP_TYPE_LIVEVIEW, ch1, DISP_START, {ch1 position} ) DVR_DISP_CONTROL (DISP_TYPE_LIVEVIEW, ch1, DISP_STOP) DVR_DISP_CONTROL (DISP_TYPE_LIVEVIEW, ch2, DISP_START, {ch2 position}) DVR_DISP_CONTROL (DISP_TYPE_LIVEVIEW, ch2, DISP_UPDATE, {ch2 new position}) Ch1 DVR_COMMON_ APPLY DVR_COMMON_ APPLY Ch2 Background Liveview is running End Ch2 Background 31

38 DVR_ENC: Start/Stop/Update flow Start main-bitstream Open /dev/dvr_enc DVR_ENC_QUERY_OUTPUT_BUFFER_SUB2 _BS_OFFSET DVR_ENC_SET_CHANNEL_PARAM DVR_ENC_QUERY_OUTPUT_BUFFER_ SNAP_OFFSET DVR_ENC_QUERY_OUTPUT_BUFFER _SIZE map memory from /dev/dvr_enc DVR_ENC_QUERY_OUTPUT_BUFFER_SUB1 _BS_OFFSET DVR_ENC_CONTROL (ENC_START ) DVR_COMMON_ APPLY Using DVR_ENC Close/dev/dvr_enc End Start sub-bitstream DVR_ENC_SET_SUB_BS_PARAM DVR_ENC_CONTROL (ENC_START) DVR_COMMON_ APPLY End 32

39 Dynamic DVR_ENC para update apply DVR_ENC_CONTROL (ENC_UPDATE) DVR_COMMON_ APPLY End DVR_ENC: Get encoded bit stream Start POLL (Bit Stream Ready) No Check Bit-Stream Enable No Check Bit-Stream Enable No checksnapshot Yes Yes Yes DVR_ENC_QUENE_GET DVR_ENC_QUENE_GET_SUB1_BS (Get the Sub1 Bit Stream) Same Handle from Sub2 ~ Sub7 DVR_ENC_QUENE_GET_SUB8_BS (Get the Dual Bit Streams) DVR_ENC_ QUEUE_GET_ SNAP DVR_ENC_QUENE_PUT DVR_ENC_QUENE_PUT DVR_ENC_QUENE_PUT DVR_ENC_QUENE_PUT Yes Continue? Yes Continue? Yes Continue? No DVR_ENC_CONTROL (ENC_STOP) No DVR_ENC_CONTROL (ENC_STOP) No DVR_ENC_CONTROL (ENC_STOP) DVR_COMMON_APPLY DVR_COMMON_APPLY DVR_COMMON_APPLY End End End 33

40 DVR_DEC: Start/End DVR_DEC: Put bit stream for decoder 34

41 3.9 Set Dimension for Source and Destination Liveview (Scaler is disabled.) Capture as A and put it on C Capture LCD A B = A C Item Precondition A B C Value dvr_disp_control.src_param.lv.is_use_scaler=false Width: dvr_disp_control.dst_param.lv.win.width Height: dvr_disp_control.dst_param.lv.win.height X: dvr_disp_control.dst_param.lv.win.x Y: dvr_disp_control.dst_param.lv.win.y Dimension: dvr_disp_disp_param.dim (read-only) Liveview (Scaler is enabled.) Capture as A, scale A as B, and put B on C Capture LCD A B C 35

42 Item Precondition A B C Value dvr_disp_control.src_param.lv.is_use_scaler=true Dimension: dvr_disp_control.src_param.lv.dim Window: dvr_disp_control.dst_param.lv.win Dimension: dvr_disp_disp_param.dim (Read only) Record (Main stream and snapshot) Capture as A, ROI as B, encode it to the bit stream Capture A Encoder B A If ROI is enabled - Bitstream of B - Snapshot of A If ROI is disabled - Bitstream of A - Snapshot of A Item Precondition A B Value Sub-stream is disabled, and sub-stream dimension is the same as the main stream. Dimension: dvr_enc_channel_param.src.dim Window: dvr_enc_channel_param.repd[0].enc.roi_win Record (Sub-stream) Capture as A (The same as the main stream), sub-stream dimension as B, ROI as C, and encode them to the bit stream Capture ( Shared with main stream) A After scaler B Encoder C B If ROI is enabled - Bitstream of C If ROI is disabled - Bitstream of B 36

43 Item Precondition A B C Value Sub-stream is enabled and sub-stream dimension is not the same as main stream. Dimension: dvr_enc_channel_param.src.dim Dimension: dvr_enc_channel_param.repd[1].dim Window: dvr_enc_channel_param.repd[1].enc.roi_win 3.10 Set Processing Rate for Source and Destination This section describes the processing rate when two entities are connected, and these rate-values are used for VideoGraph. The video system (NTSC or PAL) has different frame rates (30/25), and these values can be performed at the Capture input and LCD output. Handling the drivers will not affect VideoGraph. Liveview Item Capture rate Display rate Value dvr_disp_control.src_param.lv.cap_rate dvr_disp_update_disp_param.val.display_rate Record Item Bitstream rate (framerate) Value dvr_enc_channel_param.main_bs.enc.frame_rate Decode Item bs rate Display rate Value dec_ctrl.src_param.bs_rate dec_ctrl.dst_param.display_rate 37