开通博客赚积分
发布资源赚积分
分类

源码开发语言/平台
当前位置：首页 > 源码/资料 > 多媒体 > DVD > 查看源码
zivaDS.h
资源名称：dvd-munitions.tar.gz　[点击查看]
上传用户：aoeyumen
上传日期：2007-01-06
资源大小：3329k
文件大小：30k
源码类别：

DVD

开发平台：

Unix_Linux

zivaDS.h：源码内容
  1. /*
  2.   **********************************************************************
  3.   *
  4.   *     Copyright 1999, 2000 Creative Labs, Inc.
  5.   *
  6.   **********************************************************************
  7.   *
  8.   *     Date                 Author               Summary of changes
  9.   *     ----                 ------               ------------------
  10.   *     October 20, 1999     Andrew de Quincey    Rewrote and extended
  11.   *                          Lucien Murray-Pitts  original incomplete 
  12.   *                                               driver.
  13.   *
  14.   *     April 18, 1999       Andrew Veliath       Original Driver
  15.   *                                               implementation
  16.   *
  17.   **********************************************************************
  18.   *
  19.   *     This program is free software; you can redistribute it and/or
  20.   *     modify it under the terms of the GNU General Public License as
  21.   *     published by the Free Software Foundation; either version 2 of
  22.   *     the License, or (at your option) any later version.
  23.   *
  24.   *     This program is distributed in the hope that it will be useful,
  25.   *     but WITHOUT ANY WARRANTY; without even the implied warranty of
  26.   *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  27.   *     GNU General Public License for more details.
  28.   *
  29.   *     You should have received a copy of the GNU General Public
  30.   *     License along with this program; if not, write to the Free
  31.   *     Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139,
  32.   *     USA.
  33.   *
  34.   **********************************************************************
  35.   */
  37. /**
  38.  *
  39.  * Driver for the C-Cube Ziva-DS MPEG decoder chip
  40.  *
  41.  */
  44. #ifndef __ZIVADS_H__
  45. #define __ZIVADS_H__
  47. #include <linux/types.h>
  49. // *******************************************************************
  50. // useful defines
  52. // Full name of the chip
  53. #define ZIVADS_FULLNAME              "C-Cube Ziva-DS Mpeg Decoder"
  55. // Log name of the driver
  56. #define ZIVADS_LOGNAME "ZIVADS"
  60. // *******************************************************************
  61. // DRAM location names
  63. #define ZIVADS_AC3_ACMOD_CMIXLEV 0x418
  64. #define ZIVADS_AC3_BSI_FRAME 0x40c
  65. #define ZIVADS_AC3_BSI_IS_BEING_READ 0x404
  66. #define ZIVADS_AC3_BSI_VALID 0x408
  67. #define ZIVADS_AC3_BSID_BSMOD 0x414
  68. #define ZIVADS_AC3_C_LEVEL 0x130
  69. #define ZIVADS_AC3_CENTER_DELAY 0x144
  70. #define ZIVADS_AC3_COMPR_LANGCOD 0x424
  71. #define ZIVADS_AC3_DIALNORM_COMPR2 0x42c
  72. #define ZIVADS_AC3_FRAME_NUMBER 0x400
  73. #define ZIVADS_AC3_FSCOD_FRMSIZECOD 0x410
  74. #define ZIVADS_AC3_HIGH_CUT 0x11c
  75. #define ZIVADS_AC3_L_LEVEL 0x12c
  76. #define ZIVADS_AC3_LANGCOD2_MIXLEV2 0x430
  77. #define ZIVADS_AC3_LFE_OUTPUT_ENABLE 0x124
  78. #define ZIVADS_AC3_LFEON_DIALNORM 0x420
  79. #define ZIVADS_AC3_LOW_BOOST 0x118
  80. #define ZIVADS_AC3_MIXLEV_ROOMTYP 0x428
  81. #define ZIVADS_AC3_OPERATIONAL_MODE 0x114
  82. #define ZIVADS_AC3_ORIGBS_TIMECOD1 0x438
  83. #define ZIVADS_AC3_OUTPUT_MODE 0x110
  84. #define ZIVADS_AC3_PCM_SCALE_FACTOR 0x120
  85. #define ZIVADS_AC3_R_LEVEL 0x134
  86. #define ZIVADS_AC3_ROOMTYP2_COPYRIGHTB 0x434
  87. #define ZIVADS_AC3_SL_LEVEL 0x138
  88. #define ZIVADS_AC3_SR_LEVEL 0x13c
  89. #define ZIVADS_AC3_SURMIXLEV_DSURMOD 0x41c
  90. #define ZIVADS_AC3_SURROUND_DELAY 0x148
  91. #define ZIVADS_AC3_TIMECOD2 0x43c
  92. #define ZIVADS_AC3_VOICE_SELECT 0x128
  93. #define ZIVADS_AEE_INT_SRC 0x2c0
  94. #define ZIVADS_AOR_INT_SRC 0x2bc
  95. #define ZIVADS_ASPECT_RATIO 0x3b8
  96. #define ZIVADS_ASPECT_RATIO_MODE 0x84
  97. #define ZIVADS_AUDIO_ATTENUATION 0xf4
  98. #define ZIVADS_AUDIO_CLOCK_SELECTION 0xec
  99. #define ZIVADS_AUDIO_CONFIG 0xe0
  100. #define ZIVADS_AUDIO_DAC_MODE 0xe8
  101. #define ZIVADS_AUDIO_EMPTINESS 0x2cc
  102. #define ZIVADS_AUDIO_TYPE 0x3f0
  103. #define ZIVADS_AUTOPAAUSE_ENABLE 0x1d4
  104. #define ZIVADS_AV_SYNC_MODE 0x1b0
  105. #define ZIVADS_BACKGROUND_COLOR 0x9c
  106. #define ZIVADS_BIT_RATE 0x3c0
  107. #define ZIVADS_BITSTREAM_SOURCE 0x1a4
  108. #define ZIVADS_BITSTREAM_TYPE 0x1a0
  109. #define ZIVADS_BORDER_COLOR 0x98
  110. #define ZIVADS_BUFF_INT_SRC 0x2b4
  111. #define ZIVADS_CD_MODE 0x1ac
  112. #define ZIVADS_COMMAND 0x40
  113. #define ZIVADS_CURR_PIC_DISPLAYED 0x2d0
  114. #define ZIVADS_DATE_TIME 0x324
  115. #define ZIVADS_DISP_SIZE_H_V 0x3cc
  116. #define ZIVADS_DISPLAY_ASPECT_RATIO 0x80
  117. #define ZIVADS_DRAM_INFO 0x68
  118. #define ZIVADS_DSI_BUFFER_END 0x22c
  119. #define ZIVADS_DSI_BUFFER_START 0x228
  120. #define ZIVADS_DUMP_DATA_BUFFER_END 0x284
  121. #define ZIVADS_DUMP_DATA_BUFFER_START 0x280
  122. #define ZIVADS_ERR_ASPECT_RATIO_INFO 0xc0
  123. #define ZIVADS_ERR_CONCEALMENT_LEVEL 0xb4
  124. #define ZIVADS_ERR_FRAME_RATE_CODE 0xc4
  125. #define ZIVADS_ERR_HORIZONTAL_SIZE 0xb8
  126. #define ZIVADS_ERR_INT_SRC 0x2c4
  127. #define ZIVADS_ERR_VERTICAL_SIZE 0xbc
  128. #define ZIVADS_EXTENDED_VERSION 0x334
  129. #define ZIVADS_FRAME_RATE 0x3bc
  130. #define ZIVADS_GOP_FLAGS 0x3d4
  131. #define ZIVADS_H_SIZE 0x3b0
  132. #define ZIVADS_HLI_INT_SRC 0x2b0
  133. #define ZIVADS_IC_TYPE 0xb0
  134. #define ZIVADS_IEC_958_DELAY 0xf0
  135. #define ZIVADS_INT_MASK 0x200
  136. #define ZIVADS_INT_STATUS 0x2ac
  137. #define ZIVADS_LPCM_AUDIO_DYN_RANGE_CTRL 0x418
  138. #define ZIVADS_LPCM_AUDIO_EMPHASIS_FLAG 0x400
  139. #define ZIVADS_LPCM_AUDIO_FRAME_NUMBER 0x408
  140. #define ZIVADS_LPCM_AUDIO_MUTE_FLAG 0x404
  141. #define ZIVADS_LPCM_AUDIO_NUM_AUDIO_CHANS 0x414
  142. #define ZIVADS_LPCM_AUDIO_SAMPLING_FREQ 0x410
  143. #define ZIVADS_LPCM_AUDIO_QUANT_WORD_LEN 0x40c
  144. #define ZIVADS_MEMORY_MAP 0x21c
  145. #define ZIVADS_MPEG_AUDIO_HEADER1 0x400
  146. #define ZIVADS_MPEG_AUDIO_HEADER2 0x404
  147. #define ZIVADS_MRC_ID 0x2a4
  148. #define ZIVADS_MRC_PIC_PTS 0x2f0
  149. #define ZIVADS_MRC_PIC_STC 0x2f4
  150. #define ZIVADS_MRC_STATUS 0x2a8
  151. #define ZIVADS_N_AUD_DECODED 0x2f8
  152. #define ZIVADS_N_AUD_ERRORS 0x320
  153. #define ZIVADS_N_SYS_ERRORS 0x318
  154. #define ZIVADS_N_VID_ERRORS 0x31c
  155. #define ZIVADS_NEW_AUDIO_CONFIG 0x468
  156. #define ZIVADS_NEW_AUDIO_MODE 0x460
  157. #define ZIVADS_NEW_SUBPICTURE_PALETTE 0x464
  158. #define ZIVADS_NEXT_PIC_DISPLAYED 0x2d4
  159. #define ZIVADS_NEXT_SECTOR_ADDR 0x314
  160. #define ZIVADS_NUM_DECODED 0x2e4
  161. #define ZIVADS_NUM_REPEATED 0x2ec
  162. #define ZIVADS_NUM_SKIPPED 0x2e8
  163. #define ZIVADS_OSD_BUFFER_END 0x244
  164. #define ZIVADS_OSD_BUFFER_IDLE_START 0x248
  165. #define ZIVADS_OSD_BUFFER_START 0x240
  166. #define ZIVADS_OSD_EVEN_FIELD 0xa0
  167. #define ZIVADS_OSD_ODD_FIELD 0xa4
  168. #define ZIVADS_OSD_VALID 0x2e0
  169. #define ZIVADS_PACKET_LEN 0x3a4
  170. #define ZIVADS_PAN_SCAN_HORIZONTAL_OFFSET 0x8c
  171. #define ZIVADS_PAN_SCAN_SOURCE 0x88
  172. #define ZIVADS_PARAMETER_1 0x44
  173. #define ZIVADS_PARAMETER_2 0x48
  174. #define ZIVADS_PARAMETER_3 0x4c
  175. #define ZIVADS_PARAMETER_4 0x50
  176. #define ZIVADS_PARAMETER_5 0x54
  177. #define ZIVADS_PARAMETER_6 0x58
  178. #define ZIVADS_PCI_BUFFER_END 0x224
  179. #define ZIVADS_PCI_BUFFER_START 0x220
  180. #define ZIVADS_PES_HEADER 0x3a8
  181. #define ZIVADS_PIC_HEADER 0x3e4
  182. #define ZIVADS_PIC_TYPE 0x3dc
  183. #define ZIVADS_PIC1_PAN_SCAN 0x348
  184. #define ZIVADS_PIC1_PICTURE_START 0x340
  185. #define ZIVADS_PIC1_PTS 0x344
  186. #define ZIVADS_PIC1_TREF_PTYPE_FLGS 0x358
  187. #define ZIVADS_PIC1_USER_DATA 0x34c
  188. #define ZIVADS_PIC2_PAN_SCAN 0x368
  189. #define ZIVADS_PIC2_PICTURE_BUFFER_START 0x360
  190. #define ZIVADS_PIC2_PTS 0x364
  191. #define ZIVADS_PIC2_TREF_PTYP_FLGS 0x378
  192. #define ZIVADS_PIC2_USER_DATA 0x36c
  193. #define ZIVADS_PIC3_BUFFER_START 0x380
  194. #define ZIVADS_PIC3_PAN_SCAN 0x388
  195. #define ZIVADS_PIC3_PTS 0x384
  196. #define ZIVADS_PIC3_TREF_PTYP_FLGS 0x398
  197. #define ZIVADS_PIC3_USER_DATA 0x38c
  198. #define ZIVADS_PROC_STATE 0x2a0
  199. #define ZIVADS_RDY_S_THRESHOLD_LOW 0x208
  200. #define ZIVADS_ROM_INFO 0x60
  201. #define ZIVADS_SD_MODE 0x1a8
  202. #define ZIVADS_SE_STATUS 0x444
  203. #define ZIVADS_SEQ_FLAGS 0x3c8
  204. #define ZIVADS_STATUS_ADDRESS 0x5c
  205. #define ZIVADS_STREAM_ID 0x3a0
  206. #define ZIVADS_SUBPICTURE_PALETTE_END 0x28c
  207. #define ZIVADS_SUBPICTURE_PALETTE_START 0x288
  208. #define ZIVADS_TEMP_REF 0x2d8
  209. #define ZIVADS_TIME_CODE 0x3d0
  210. #define ZIVADS_TOP_BORDER 0x94
  211. #define ZIVADS_UCODE_MEMORY 0x6c
  212. #define ZIVADS_UND_INT_SRC 0x2b8
  213. #define ZIVADS_USER_DATA_BUFFER_END 0x274
  214. #define ZIVADS_USER_DATA_BUFFER_START 0x270
  215. #define ZIVADS_USER_DATA_READ 0x278
  216. #define ZIVADS_USER_DATA_WRITE 0x27c
  217. #define ZIVADS_V_SIZE   0x3b4
  218. #define ZIVADS_VBV_DELAY   0x3e0
  219. #define ZIVADS_SIZE   0x3c4
  220. #define ZIVADS_VERSION      0x330
  221. #define ZIVADS_VIDEO_EMPTINESS   0x2c8
  222. #define ZIVADS_VIDEO_FIELD   0x2d8
  223. #define ZIVADS_VIDEO_MODE   0x7c
  224. #define ZIVADS_VIDEO_PTS_REPEAT_INTERVAL  0x1bc
  225. #define ZIVADS_VIDEO_PTS_SKIP_INTERVAL   0x1b8
  226. #define ZIVADS_CSS_START                  0x480
  227. #define ZIVADS_CSS_UNKNOWN0               0xAC
  228. #define ZIVADS_ENABLE_SUBPICTURE   0x474
  229. #define ZIVADS_SOURCE_ASPECT_RATIO        0xC8
  230. #define ZIVADS_SOURCE_TV_FORMAT           0x1E0
  233. // *******************************************************************
  234. // offsets from [ZIVADS_CSS_START]
  236. #define ZIVADS_CSSOFFSET_COMMAND          0x00
  237. #define ZIVADS_CSSOFFSET_STATUS           0x04
  238. #define ZIVADS_CSSOFFSET_SENDCHALLENGEKEY 0x54
  239. #define ZIVADS_CSSOFFSET_GETCHALLENGEKEY  0x2C
  240. #define ZIVADS_CSSOFFSET_SENDRESPONSEKEY  0x68
  241. #define ZIVADS_CSSOFFSET_GETRESPONSEKEY   0x7C
  242. #define ZIVADS_CSSOFFSET_SENDTITLEKEY     0x90
  245. // *******************************************************************
  246. // Memory area names & numbers
  248. #define ZIVADS_MEMAREA_DRAM         0
  249. #define ZIVADS_MEMAREA_ROM 1
  250. #define ZIVADS_MEMAREA_IBUS 2
  252. // *******************************************************************
  253. // Register names
  255. #define ZIVADS_REGCONTROL 7
  256. #define ZIVADS_REGADDRESS 4
  257. #define ZIVADS_REGDATA 0
  259. // *******************************************************************
  260. // Ziva commands
  262. #define ZIVADS_CMD_ABORT 0x8120
  263. #define ZIVADS_CMD_PAUSE 0x12A
  264. #define ZIVADS_CMD_SETFILL 0x532
  265. #define ZIVADS_CMD_SLOWFORWARDS 0x235
  266. #define ZIVADS_CMD_BACKWARDS 0x33B
  267. #define ZIVADS_CMD_SCAN 0x32F
  268. #define ZIVADS_CMD_SINGLESTEP 0x134
  269. #define ZIVADS_CMD_RESUME 0x12e
  270. #define ZIVADS_CMD_PLAY 0x42b
  271. #define ZIVADS_CMD_SELECTSTREAM 0x231
  272. #define ZIVADS_CMD_RESET 0x802D
  273. #define ZIVADS_CMD_NEWPLAYMODE 0x28
  274. #define ZIVADS_CMD_HIGHLIGHT 0x326
  277. // *******************************************************************
  278. // misc defines 
  280. // CSS hardware supported
  281. #define ZIVADS_TYPE_1 1
  282. #define ZIVADS_TYPE_3 3
  283. #define ZIVADS_TYPE_4 4
  285. // CSS decryption modes supported
  286. #define ZIVADS_CSSDECRMODE_OFF 0
  287. #define ZIVADS_CSSDECRMODE_ON  1
  289. // subpicture modes
  290. #define ZIVADS_SUBPICTURE_OFF 0
  291. #define ZIVADS_SUBPICTURE_ON 1
  293. // aspect ratios
  294. #define ZIVADS_ASPECTRATIO_4_3 0
  295. #define ZIVADS_ASPECTRATIO_16_9 1
  297. // slow rates
  298. #define ZIVADS_SLOWRATE_2x 0
  299. #define ZIVADS_SLOWRATE_3x 1
  300. #define ZIVADS_SLOWRATE_4x 2
  301. #define ZIVADS_SLOWRATE_5x 3
  302. #define ZIVADS_SLOWRATE_6x 4
  304. // bitstreams possibly present in files
  305. #define ZIVADS_STREAM_VIDEO       0
  306. #define ZIVADS_STREAM_SUBPICTURE  1
  307. #define ZIVADS_STREAM_AUDIO_AC3   2
  308. #define ZIVADS_STREAM_AUDIO_MPEG  3
  309. #define ZIVADS_STREAM_AUDIO_LPCM  4
  310. #define ZIVADS_STREAM_AUDIO_5     5
  312. // bitstream types
  313. #define ZIVADS_BITSTREAM_TYPE_MPEG_VOB       0
  314. #define ZIVADS_BITSTREAM_TYPE_CDROM_VCD      1
  315. #define ZIVADS_BITSTREAM_TYPE_MPEG_VCD       2
  316. #define ZIVADS_BITSTREAM_TYPE_CDDA           3
  317. #define ZIVADS_BITSTREAM_TYPE_4              4
  319. // TV formats
  320. #define ZIVADS_TVFORMAT_NTSC     0
  321. #define ZIVADS_TVFORMAT_PAL      1
  323. // video frequencies
  324. #define ZIVADS_SRC_VIDEO_FREQ_30 0
  325. #define ZIVADS_SRC_VIDEO_FREQ_25 1
  327. // aspect ratio modes
  328. #define ZIVADS_ASPECTRATIOMODE_NORMAL    0
  329. #define ZIVADS_ASPECTRATIOMODE_PAN_SCAN  1
  330. #define ZIVADS_ASPECTRATIOMODE_LETTERBOX 2
  332. // play types
  333. #define ZIVADS_PLAYTYPE_NORMAL 0
  334. #define ZIVADS_PLAYTYPE_STILLSTOP 1
  336. // iec-958 output types
  337. #define ZIVADS_IEC958_DECODED    0
  338. #define ZIVADS_IEC958_ENCODED    1
  340. // AC3 modes
  341. #define ZIVADS_AC3MODE_LR_STEREO          0
  342. #define ZIVADS_AC3MODE_LR_STEREO_PROLOGIC 1
  343. #define ZIVADS_AC3MODE_LR_MONOR           2
  345. // AC3 voice configuration (for karaoke)
  346. #define ZIVADS_AC3VOICE_NONE        0
  347. #define ZIVADS_AC3VOICE_V1V2        1
  349. // highlight actions
  350. #define ZIVADS_BUTTONACTION_SELECT    0
  351. #define ZIVADS_BUTTONACTION_UNHIGHLIGHT 1
  352. #define ZIVADS_BUTTONACTION_ACTIVATE 2
  353. #define ZIVADS_BUTTONACTION_ACTIVATE_SELECTED 3
  355. // special buttons
  356. #define ZIVADS_BUTTON_NONE    0
  357. #define ZIVADS_BUTTON_UP     64
  358. #define ZIVADS_BUTTON_DOWN   65
  359. #define ZIVADS_BUTTON_LEFT   66
  360. #define ZIVADS_BUTTON_RIGHT  67
  362. // audio clock frequencies
  363. #define ZIVADS_CLKFREQ256 0
  364. #define ZIVADS_CLKFREQ384 1
  367. // *******************************************************************
  368. // Structures
  370. typedef struct _zivaDS_ops_t zivaDS_ops_t;
  371. typedef struct _zivaDS_t zivaDS_t;
  373. // generic driver structure
  374. struct _zivaDS_t {
  376.   zivaDS_ops_t* ops;
  377.   void* data;
  379.   // type of Ziva chip
  380.   int zivaDSType;
  382.   // interrupt status
  383.   int intEnabledFlag;
  384. };
  386. // lowlevel access operations
  387. struct _zivaDS_ops_t {
  389.   char name[32];
  390.   int (*get_reg) (zivaDS_t* instance, int reg);
  391.   int (*set_reg) (zivaDS_t* instance, int reg, int val);
  392.   int (*get_mem) (zivaDS_t* instance, int addr);
  393.   int (*set_mem) (zivaDS_t* instance, int addr, int val);
  394.   int (*enable_int) (zivaDS_t* instance, int flag);
  395. };
  398. // to hold flags during CSS operations
  399. typedef struct {
  400.   
  401.   unsigned int flag1;
  402.   unsigned int flag2;
  403. } zivaDS_cssFlags_t;
  406. // to hold ziva interrupt src
  407. typedef struct {
  408.   
  409.   unsigned int HLI_int_src;
  410.   unsigned int BUF_int_src;
  411.   unsigned int UND_int_src;
  412.   unsigned int AOR_int_src;
  413.   unsigned int AEE_int_src;
  414.   unsigned int ERR_int_src;
  416. } zivaDS_int_src_t;
  417.   
  419. // *******************************************************************
  420. // function declarations
  422. // ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  423. // Driver maintenance functions
  427. /**
  428.  *
  429.  * Create new ZivaDS driver instance
  430.  *
  431.  * @param ops Lowlevel operations to talk to chip
  432.  * @param data Any extra data for said functions
  433.  *
  434.  * @return The new instance (or NULL on error)
  435.  *
  436.  */
  438. extern zivaDS_t* zivaDS_new(zivaDS_ops_t* ops, void* data);
  441. /**
  442.  *
  443.  * Destroy an Anp82 driver instance
  444.  *
  445.  * @param instance The instance to destroy
  446.  *
  447.  */
  449. extern void zivaDS_free(zivaDS_t* instance);
  452. // ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  453. // High level convenience functions
  457. /**
  458.  *
  459.  * This detects the Ziva chip. You can't just reset the thing, because
  460.  * you need the firmware uploaded first (I think)... 
  461.  *
  462.  * @return 0 on success, <0 on failure
  463.  *
  464.  */
  466. extern int zivaDS_detect(zivaDS_t* instance);
  469. /**
  470.  *
  471.  * Get the CSS flags from the ziva and store them in supplied structure
  472.  *
  473.  * @param instance Ziva instance to use
  474.  * @param flags Where to store the flags
  475.  *
  476.  */
  478. extern void zivaDS_get_css_flags(zivaDS_t* instance, zivaDS_cssFlags_t* flags);
  482. /**
  483.  *
  484.  * Restore the CSS flags to the ziva from the supplied structure
  485.  *
  486.  * @param instance Ziva instance to use
  487.  * @param flags Where to store the flags
  488.  *
  489.  */
  491. extern void zivaDS_restore_css_flags(zivaDS_t* instance, zivaDS_cssFlags_t* flags);
  495. /**
  496.  *
  497.  * Set the CSS mode... used for the tc6807af functions
  498.  * You call this with mode=1 before doing anything with the tc6807af, and then with
  499.  * mode=0 after you have finished.
  500.  *
  501.  * @param instance Ziva instance to use
  502.  * @param mode Mode to set (0 or 1).
  503.  *
  504.  */
  506. extern void zivaDS_set_css_mode(zivaDS_t* instance, int mode);
  510. /**
  511.  *
  512.  * Enable/disable subpicture
  513.  *
  514.  * @param instance instance to use
  515.  * @param flag one of ZIVADS_SUBPICTURE_OFF, ZIVADS_SUBPICTURE_ON
  516.  *
  517.  * @return 0 on success, <0 on failure
  518.  *
  519.  */
  521. extern int zivaDS_enable_subpicture(zivaDS_t* instance, int flag);
  525. /**
  526.  *
  527.  * Abort playback
  528.  *
  529.  * @param instance zivaDS instance to use
  530.  *
  531.  * @return 0 on success, <0 on failure
  532.  *
  533.  */
  535. extern int zivaDS_abort(zivaDS_t* instance);
  540. /**
  541.  *
  542.  * Set the output aspect ratio
  543.  *
  544.  * @param instance zivaDS instance to use
  545.  * @param buffer instance of dxr2_oneArg_t. 
  546.  *               arg is one of ZIVADS_ASPECTRATIO_4_3 or ZIVADS_ASPECTRATIO_16_9
  547.  *
  548.  * @return 0 on success, <0 on failure
  549.  *
  550.  */
  552. extern int zivaDS_set_output_aspect_ratio(zivaDS_t* instance, int ratio);
  556. /**
  557.  *
  558.  * Set source aspect ratio
  559.  *
  560.  * @param instance ZivaDS instance
  561.  * @param ratio one of ZIVADS_ASPECTRATIO_4_3, ZIVADS_ASPECTRATIO_16_9
  562.  *
  563.  * @return 0 on success, <0 on failure
  564.  *
  565.  */
  567. extern int zivaDS_set_source_aspect_ratio(zivaDS_t* instance, int ratio);
  571. /**
  572.  *
  573.  * Set audio volume
  574.  *
  575.  * @param instance ZivaDS instance to use
  576.  * @param volume Volume to to (0-19), 0 =min, 19=max
  577.  *
  578.  * @return 0 on success, <0 on failure
  579.  *
  580.  */
  582. extern int zivaDS_set_audio_volume(zivaDS_t* instance, int volume);
  586. /**
  587.  *
  588.  * Pause playback
  589.  *
  590.  * @param instance ZivaDS instance
  591.  *
  592.  * @return 0 on success, <0 on failure
  593.  *
  594.  */
  596. extern int zivaDS_pause(zivaDS_t* instance);
  600. /**
  601.  *
  602.  * Clear video
  603.  *
  604.  * @param instance ZivaDS instance
  605.  *
  606.  * @return 0 on success, <0 on failure
  607.  *
  608.  */
  610. extern int zivaDS_clear_video(zivaDS_t* instance);
  615. /**
  616.  *
  617.  * Slow forwards
  618.  *
  619.  * @param instance ZivaDS instance
  620.  * @param rate Rate of play (one of ZIVADS_SLOWRATE_2x, ZIVADS_SLOWRATE_3x
  621.  *                           ZIVADS_SLOWRATE_4x, ZIVADS_SLOWRATE_5x, ZIVADS_SLOWRATE_6x)
  622.  *
  623.  * @return 0 on success, <0 on failure
  624.  *
  625.  */
  627. extern int zivaDS_slow_forwards(zivaDS_t* instance, int rate);
  631. /**
  632.  *
  633.  * Slow backwards
  634.  *
  635.  * @param instance ZivaDS instance
  636.  * @param rate Rate of play (one of ZIVADS_SLOWRATE_2x, ZIVADS_SLOWRATE_3x
  637.  *                           ZIVADS_SLOWRATE_4x, ZIVADS_SLOWRATE_5x, ZIVADS_SLOWRATE_6x)
  638.  *
  639.  * @return 0 on success, <0 on failure
  640.  *
  641.  */
  643. extern int zivaDS_slow_backwards(zivaDS_t* instance, int rate);
  647. /**
  648.  * 
  649.  * Set aspect ratio mode
  650.  *
  651.  * @param instance ZivaDS instance to use
  652.  * @param mode Aspect ratio mode (one of ZIVADS_ASPECTRATIOMODE_NORMAL,
  653.  *                                ZIVADS_ASPECTRATIOMODE_PAN_SCAN,
  654.  *                                ZIVADS_ASPECTRATIOMODE_LETTERBOX)
  655.  *
  656.  * @return 0 on success, <0 on failure
  657.  *
  658.  */
  660. extern int zivaDS_set_aspect_ratio_mode(zivaDS_t* instance, int mode);
  663. /**
  664.  * UNSURE
  665.  * Scan (fastforward/fastbackward)
  666.  *
  667.  * @param instance ZivaDS instance to use
  668.  * @param scanOp ???
  669.  * @param scanParam ???
  670.  *
  671.  * @return 0 on success, <0 on failure
  672.  *
  673.  */
  675. extern int zivaDS_scan_mode(zivaDS_t* instance, int arg1, int arg2);
  678. /**
  679.  * 
  680.  * Single Step
  681.  *
  682.  * @param instance ZivaDS instance to use
  683.  *
  684.  * @return 0 on success, <0 on failure
  685.  *
  686.  */
  688. extern int zivaDS_single_step(zivaDS_t* instance);
  692. /**
  693.  * 
  694.  * Reverse play
  695.  *
  696.  * @param instance ZivaDS instance to use
  697.  *
  698.  * @return 0 on success, <0 on failure
  699.  *
  700.  */
  702. extern int zivaDS_reverse_play(zivaDS_t* instance);
  706. /**
  707.  * 
  708.  * Set subpicture palettes
  709.  *
  710.  * @param instance ZivaDS instance to use
  711.  * @param palette (16x32bit palette entries)
  712.  *
  713.  * @return 0 on success, <0 on failure
  714.  *
  715.  */
  717. extern int zivaDS_set_subpicture_palettes(zivaDS_t* instance, unsigned int palettes[]);
  720. /**
  721.  *
  722.  * Initialise the ziva
  723.  *
  724.  * @param instance instance to use
  725.  * @param uCode ucode data to upload
  726.  *
  727.  * @return 0 on success, <0 on failure
  728.  *
  729.  */
  731. extern int zivaDS_init(zivaDS_t* instance, char* uCode);
  735. /**
  736.  *
  737.  * Resume play (e.g. if the device is paused)
  738.  *
  739.  * @param instance instance to use
  740.  *
  741.  * @return 0 on success, <0 on failure
  742.  *
  743.  */
  745. extern int zivaDS_resume(zivaDS_t* instance);
  749. /**
  750.  *
  751.  * Start play (e.g. if the device is stopped)
  752.  *
  753.  * @param instance instance to use
  754.  * @param playType ZIVADS_PLAYTYPE_NORMAL, ZIVADS_PLAYTYPE_STILLSTOP
  755.  *
  756.  * @return 0 on success, <0 on failure
  757.  *
  758.  */
  760. extern int zivaDS_play(zivaDS_t* instance, int arg);
  765. /**
  766.  *
  767.  * Select stream
  768.  *
  769.  * @param streamType Type of stream. One of ZIVADS_STREAM_VIDEO, ZIVADS_STREAM_SUBPICTURE,
  770.  *                   ZIVADS_STREAM_AUDIO_AC3, ZIVADS_STREAM_AUDIO_MPEG1, ZIVADS_STREAM_AUDIO_LPCM,
  771.  *                   ZIVADS_STREAM_AUDIO4
  772.  * @param streamNumber Stream of that type to select
  773.  *
  774.  * @return 0 on success, <0 on failure
  775.  *
  776.  */
  778. extern int zivaDS_select_stream(zivaDS_t* instance, 
  779. int streamType, int streamNumber);
  781. /**
  782.  *
  783.  * Reset the Ziva
  784.  *
  785.  * @param instance instance to use
  786.  *
  787.  * @return 0 on success, <0 on failure
  788.  *
  789.  */
  791. extern int zivaDS_reset(zivaDS_t* instance);
  795. /**
  796.  *
  797.  * Performs a new play mode command on the ziva
  798.  *
  799.  * @param instance instance to use
  800.  *
  801.  * @return 0 on success, <0 on failure
  802.  *
  803.  */
  805. extern int zivaDS_new_play_mode(zivaDS_t* instance);
  809. /**
  810.  *
  811.  * Sets the bitstream type
  812.  *
  813.  * @param instance instance to use
  814.  * @param type Bitstream type, one of ZIVADS_BITSTREAM_TYPE_MPEG_VOB,
  815.  * ZIVADS_BITSTREAM_TYPE_CDROM_VCD, ZIVADS_BITSTREAM_TYPE_MPEG_VCD, 
  816.  * ZIVADS_BITSTREAM_TYPE_CDDA, ZIVADS_BITSTREAM_TYPE_4
  817.  *
  818.  * @return 0 on success, <0 on failure
  819.  *
  820.  */
  822. extern int zivaDS_set_bitstream_type(zivaDS_t* instance, int type);
  826. /**
  827.  *
  828.  * Sets the source video frequency
  829.  *
  830.  * @param instance instance to use
  831.  * @param freq ZIVADS_SRC_VIDEO_FREQ_30, ZIVADS_SRC_VIDEO_FREQ_25
  832.  *
  833.  * @return 0 on success, <0 on failure
  834.  *
  835.  */
  837. extern int zivaDS_set_source_video_frequency(zivaDS_t* instance, int format);
  841. /**
  842.  *
  843.  * Setup audio DAC.
  844.  *
  845.  * @param instance ZivaDS instance to use
  846.  * @param dacMode Current Audio DAC mode
  847.  *
  848.  * @return 0 on success, <0 on failure
  849.  *
  850.  */
  852. extern int zivaDS_setup_audio_dac(zivaDS_t* instance, int dacMode);
  856. /**
  857.  *
  858.  * Get the most significant 32 bits of the STC value
  859.  * this is the System time..
  860.  *
  861.  * @param instance instance to use
  862.  *
  863.  * @return Value on success, <0 on failure
  864.  *
  865.  */
  867. extern int zivaDS_get_mrc_pic_stc(zivaDS_t* instance);
  871. /**
  872.  * 
  873.  * Get the most significant 32 bits of the PTS value
  874.  * this is the presentation time..
  875.  *
  876.  * @param instance instance to use
  877.  *
  878.  * @return Value on success, <0 on failure
  879.  *
  880.  */
  882. extern int zivaDS_get_mrc_pic_pts(zivaDS_t* instance);
  886. /**
  887.  * 
  888.  * Sets the IEC-958 output mode (either decoded AC3, or encoded AC3)
  889.  *
  890.  * @param instance instance to use
  891.  * @param flag (ZIVADS_IEC958_DECODED, ZIVADS_IEC958_ENCODED)
  892.  *
  893.  * @return 0 on success, <0 on failure
  894.  *
  895.  */
  897. extern int zivaDS_set_iec958_output_mode(zivaDS_t* instance, int flag);
  902. /**
  903.  * 
  904.  * Set the AC3 mode... probably for Karaoke... Mmmmm... how useful ;)
  905.  *
  906.  * @param instance instance to use
  907.  * @param dacMode Current Audio DAC mode
  908.  * @param param One of ZIVADS_AC3MODE_LR_STEREO, 
  909.  *                     ZIVADS_AC3MODE_LR_STEREO_PROLOGIC,
  910.  *                     ZIVADS_AC3MODE_LR_MONOR
  911.  *
  912.  * @return 0 on success, <0 on failure
  913.  *
  914.  */
  916. extern int zivaDS_set_AC3_mode(zivaDS_t* instance, 
  917.        int currentDacMode,
  918.        int param);
  922. /**
  923.  * 
  924.  * Selects AC3 voice, either to NONE, or V1V2. This is for karaoke
  925.  *
  926.  * @param instance instance to use
  927.  * @param voice Voice to select (ZIVADS_AC3VOICE_NONE, ZIVADS_AC3VOICE_V1V2)
  928.  *
  929.  * @return 0 on success, <0 on failure
  930.  *
  931.  */
  933. extern int zivaDS_select_AC3_voice(zivaDS_t* instance, int voice);
  936. /**
  937.  *
  938.  * Set the audio attenuation
  939.  *
  940.  * @param instance instance to use
  941.  * @param attenuation The attenuation
  942.  *
  943.  * @return 0 on success, <0 on failure
  944.  *
  945.  */
  947. extern int zivaDS_set_audio_attenuation(zivaDS_t* instance, int attenuation);
  951. /**
  952.  *
  953.  * Highlights a button
  954.  *
  955.  * @param instance zivaDS instance
  956.  * @param button Index of button to highlight (1-36), or ZIVADS_BUTTON_NONE,
  957.  *     ZIVADS_BUTTON_UP, ZIVADS_BUTTON_DOWN, ZIVADS_BUTTON_LEFT, 
  958.  *     ZIVADS_BUTTON_RIGHT
  959.  * @param action to perform on button:
  960.  *     ZIVADS_BUTTONACTION_SELECT, ZIVADS_BUTTONACTION_UNHIGHLIGHT,
  961.  *     ZIVADS_BUTTONACTION_ACTIVATE, ZIVADS_BUTTONACTION_ACTIVATE_SELECTED
  962.  *
  963.  * @return 0 on success, <0 on failure
  964.  *
  965.  */
  967. extern int zivaDS_highlight(zivaDS_t* instance, int buttonIndex, int colour);
  970. /**
  971.  *
  972.  * Waits for the current HLI interrupt to finish??
  973.  *
  974.  * @param instance zivaDS instance
  975.  *
  976.  * @return 0 on success, <0 on failure
  977.  *
  978.  */
  980. extern int zivaDS_wait_for_HLI_int(zivaDS_t* instance);
  984. /**
  985.  *
  986.  * Sets the ziva Audio clock frequency
  987.  *
  988.  * @param instance ZivaDS instance
  989.  * @param freq Frequency to set (ZIVADS_CLKFRE256 or ZIVADS_CLKFREQ384)
  990.  *
  991.  */
  993. extern int zivaDS_set_audio_clock_frequency(zivaDS_t* instance, int freq);
  996. // ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  997. // CSS functions
  1000. /**
  1001.  *
  1002.  * Sets the CSS decryption mode
  1003.  *
  1004.  * @param instance Ziva instance to use
  1005.  * @param mode CSS mode one of ZIVADS_CSSDECRMODE_ON,ZIVADS_CSSDECRMODE_OFF
  1006.  *
  1007.  * @return 0 on success, <0 on failure
  1008.  *
  1009.  */
  1011. extern int zivaDS_set_decryption_mode(zivaDS_t* instance, int mode);
  1014. /**
  1015.  *
  1016.  * Send the challenge key to the Ziva
  1017.  *
  1018.  * @param instance Ziva instance to use
  1019.  * @param key 10 byte char array containing the key
  1020.  *
  1021.  * @return 0 on success, <0 on failure
  1022.  *
  1023.  */
  1025. extern int zivaDS_send_challenge_key(zivaDS_t* instance, char* key);
  1028. /**
  1029.  *
  1030.  * Get the challenge key from the Ziva
  1031.  *
  1032.  * @param instance Instance of the Ziva to use
  1033.  * @param key 10 byte char array to put the key in
  1034.  *
  1035.  * @return 0 on success, <0 on failure
  1036.  *
  1037.  */
  1039. extern int zivaDS_get_challenge_key(zivaDS_t* instance, char* key);
  1042. /**
  1043.  *
  1044.  * Send the response key to the Ziva
  1045.  *
  1046.  * @param instance Instance of the Ziva to use
  1047.  * @param key 5 byte char array containing the key
  1048.  *
  1049.  * @return 0 on success, <0 on failure
  1050.  *
  1051.  */
  1053. extern int zivaDS_send_response_key(zivaDS_t* instance, char* key);
  1056. /**
  1057.  *
  1058.  * Get the challenge key from the Ziva
  1059.  *
  1060.  * @param instance Instance of the Ziva to use
  1061.  * @param key 5 byte char array to put the key in
  1062.  *
  1063.  * @return 0 on success, <0 on failure
  1064.  *
  1065.  */
  1067. extern int zivaDS_get_response_key(zivaDS_t* instance, char* key);
  1070. /**
  1071.  *
  1072.  * Part 1 of send disc key (setup)
  1073.  *
  1074.  * @param instance Instance of the Ziva to use
  1075.  *
  1076.  * @return 0 on success, or <0 on failure
  1077.  *
  1078.  */
  1080. extern int zivaDS_send_disc_key_part1(zivaDS_t* instance);
  1083. /**
  1084.  *
  1085.  * Part 2 of send disc key (finalise)
  1086.  *
  1087.  * @param instance Instance of the Ziva to use
  1088.  *
  1089.  * @return 0 on success, or <0 on failure
  1090.  *
  1091.  */
  1093. extern int zivaDS_send_disc_key_part2(zivaDS_t* instance);
  1096. /**
  1097.  *
  1098.  * Send the disc title key
  1099.  *
  1100.  * @param instance Instance of the Ziva to use
  1101.  * @param key 6 byte char array containing the key to send
  1102.  *
  1103.  * @return 0 on success, <0 on failure
  1104.  *
  1105.  */
  1107. extern int zivaDS_send_title_key(zivaDS_t* instance, char* key);
  1110. // ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  1111. // Low level functions
  1114. /**
  1115.  *
  1116.  * Get register from the zivaDS
  1117.  *
  1118.  * @param instance Instance of the zivaDS to use
  1119.  * @param reg Register to retrieve
  1120.  *
  1121.  * @return The register's value, or <0 on failure
  1122.  *
  1123.  */
  1125. extern int zivaDS_get_reg(zivaDS_t* instance, int reg);
  1128. /**
  1129.  *
  1130.  * Set register on the ZivaDS
  1131.  *
  1132.  * @param instance Instance of the ZivaDS to use
  1133.  * @param reg Register to retrieve
  1134.  * @param val Value to set
  1135.  *
  1136.  */
  1138. extern void zivaDS_set_reg(zivaDS_t* instance, int reg, int val);
  1141. /**
  1142.  *
  1143.  * Get specified bitmask of a register from ZivaDS
  1144.  *
  1145.  * @param instance Instance of the ZivaDS to use
  1146.  * @param reg Register to retrieve
  1147.  * @param bitmask Bitmask of bits to retrive from that register
  1148.  *
  1149.  * @return The register bitvalues, or <0 on failure
  1150.  *
  1151.  */
  1153. extern int zivaDS_get_bits(zivaDS_t* instance, int reg, int bitmask);
  1156. /**
  1157.  *
  1158.  * Set specified bits of a register on ZivaDS
  1159.  *
  1160.  * @param instance Instance of the ZivaDS to use
  1161.  * @param reg Register to retrieve
  1162.  * @param bitmask Bitmask of bits to set from that register
  1163.  * @param valuemask Values of the bits in the bitmask
  1164.  *
  1165.  */
  1167. extern void zivaDS_set_bits(zivaDS_t* instance, int reg, int bitmask, 
  1168.     int valuemask);
  1171. /**
  1172.  *
  1173.  * Read from a ZivaDS memory location
  1174.  *
  1175.  * @param instance Instance of Ziva DS to read from
  1176.  * @param addr Address to read from in that memory area
  1177.  *
  1178.  * @return Memory Value
  1179.  *
  1180.  */
  1182. extern int zivaDS_get_mem(zivaDS_t* instance, int addr);
  1185. /**
  1186.  *
  1187.  * Write to a ZivaDS memory location
  1188.  *
  1189.  * @param instance Instance of Ziva DS to read from
  1190.  * @param addr Address to write to in that memory area
  1191.  * @param val Value to write
  1192.  *
  1193.  */
  1195. extern void zivaDS_set_mem(zivaDS_t* instance, int addr, int val);
  1199. /**
  1200.  *
  1201.  * Issues a command to the Ziva chip
  1202.  *
  1203.  * @param instance Instance of the ZivaDS to use
  1204.  * @param command Ziva command to send
  1205.  * @param arg0 Argument 0 for command
  1206.  * @param arg1 Argument 1 for command
  1207.  * @param arg2 Argument 2 for command
  1208.  * @param arg3 Argument 3 for command
  1209.  * @param arg4 Argument 4 for command
  1210.  * @param arg5 Argument 5 for command
  1211.  * @param intMask Ziva Int Mask to set (0 for don't bother)
  1212.  * @param statusToWaitFor Ziva Status to wait for (0 for don't bother)
  1213.  *
  1214.  * @return 0 on success, <0 on failure
  1215.  *
  1216.  */
  1218. extern int zivaDS_command(zivaDS_t* instance,
  1219.   int command,
  1220.   int arg0, int arg1, int arg2, int arg3, int arg4, int arg5,
  1221.   int intMask, int statusToWaitFor);
  1226. /**
  1227.  *
  1228.  * Determines whether the ziva Int is currently enabled
  1229.  *
  1230.  * @param instance zivaDS instance
  1231.  *
  1232.  * @return 0 => int NOT enabled, 1 => int enabled
  1233.  *
  1234.  */
  1236. extern int zivaDS_is_int_enabled(zivaDS_t* instance);
  1239. /**
  1240.  *
  1241.  * Enable/disable ziva interrupt
  1242.  *
  1243.  * @param instance zivaDS instance
  1244.  * @param flag 0=> disable, 1=> enable
  1245.  *
  1246.  * @return 0 on success, <0 on failure
  1247.  *
  1248.  */
  1250. extern int zivaDS_enable_int(zivaDS_t* instance, int flag);
  1255. /**
  1256.  *
  1257.  * Get ziva int status
  1258.  *
  1259.  * @param instance zivaDS instance
  1260.  * @param itnSrcBuf buffer to hold intsrcs
  1261.  * 
  1262.  * @return int status bitmap from ziva
  1263.  *
  1264.  */
  1266. extern int zivaDS_get_int_status(zivaDS_t* instance, zivaDS_int_src_t* intSrcBuf);
  1269. /**
  1270.  *
  1271.  * Checks if the ziva is ZIVADS_TYPE_1 or not (i.e. doesn't have onboard CSS)
  1272.  *
  1273.  * @param instance zivaDS instance
  1274.  *
  1275.  * @return 0 => NOT ZIVADS_TYPE_1, 1=> it IS ZIVADS_TYPE_1
  1276.  *
  1277.  */
  1279. extern int zivaDS_check_type_1(zivaDS_t* instance);
  1282. #endif