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

源码开发语言/平台
当前位置：首页 > 源码/资料 > 多媒体 > DVD > 查看源码
AuxSubtitlesCommonPrivate.h
资源名称：tb_i86_wr_1019_1102.　[点击查看]
上传用户：super_houu
上传日期：2008-09-21
资源大小：4099k
文件大小：16k
源码类别：

DVD

开发平台：

Others

AuxSubtitlesCommonPrivate.h：源码内容
  1. /*******************************************************************
  2.  *  AuxSubtitlesCommonPrivate.h
  3.  *******************************************************************
  4.  *  Description:
  5.  *  ============
  6.  *  Private definitions for auxSubtitles.c and auxSubtitlesFormats.c
  7.  *******************************************************************
  8.  *
  9.  *
  10.  ******************************************************************/
  11. #include "Config.h" // Global Configuration - do not remove!
  13. #ifdef USE_AUX_SUBTITLES
  15. #ifndef __AUXSUBTITLESCOMMONPRIVATE_H_
  16. #define __AUXSUBTITLESCOMMONPRIVATE_H_
  18. #include "PlaycoreNav_ClipsClip_Impl.h"
  20. #define STORAGE_INTERFACE_BUFFER_SIZE 16 // size in words
  21. #define LAST_SUBTITLE_MARKER 0xffffffffUL
  22. #define SUBTITLES_SCLK_MULTIPLIER 90000UL
  23. #define SUBTITLES_SCLK_MULTIPLIER_MIL 90
  24. // Robin_0527_2004_A
  25. #if defined(SDRAM_2X16MBITS) && !defined(NEW_2X16M_MAPPING)
  26. #define SUBTITLES_MEMORY_SIZE 73728UL // 72KB
  27. #else
  28. #define SUBTITLES_MEMORY_SIZE 204800UL //200KB
  29. #endif
  30. //#define SUBTITLES_MEMORY_ADDRESS 0x90400UL
  31. //#define AUX_SUBTITLE_EARLY_DISPLAY_OFFSET 80000UL
  32. #define AUX_SUBTITLE_EARLY_DISPLAY_OFFSET 400UL
  35. #define SUBTITLE_INDEX_ENTRIES 8
  37. #ifdef SUPPORT_SAMI_SUBTITLE
  38. #define SF_NUMBER_OF_FORMATS (8+1)
  39. #else
  40. #define SF_NUMBER_OF_FORMATS (7+1)
  41. #endif
  43. #define SF_MICRODVD_PROBE_LIMIT 50
  45. #define FORMAT_NEW_LINE 'n'
  47. #define FRAME_TO_TIME(frame, scale, rate) ((((100000UL*(scale))/(rate))*(frame))/(100UL)) // Robin_0531_2004_A
  49. // typedefs
  50. // ======================================================
  51. // Commented references to this enum are throughout the AuxSubtitles code. It's not really necessary
  52. // when opening a subtitle file for use, since passing the parse function is enough. If anyone wants
  53. // to determine exact subtitle format type without using the file, uncomment these references.
  54. /* typedef enum { SF_MICRODVD, SF_SUBRIP, SF_SAMI, SF_SUBVIEWER1, SF_SUBVIEWER2, SF_UNKNOWN } SubtitlesFormatID; */
  56. /////////////////////////////////////////////////////////////////////////////////////////////
  57. // Function Type : SubtitleProbingFuncPtr
  58. // Purpose : Check if the beginning of a file is compatible with a specific format
  59. // Input Parameters : dwSubtitlesFileAddress - location of the file on disc
  60. //   dwSubtitlesFileSize  -  file size
  61. // Return type : TRUE if the file's beginning looks compatible, FALSE otherwise or on error.
  62. // Description : Functions of this type should be implemented for any subtitles format which
  63. //   uses filename extension that other formats also use. The function will
  64. //   scan a small section of the file (mostly its beginning) and attempt
  65. //   to find tokens that distinguish this format from the other formats that
  66. //   use the same extension.
  67. //   Any impelementation should consider the other recongnized types and avoid
  68. //   using identifying marks which the other formats use. When adding a new
  69. //   format it might be necessary to change or implement the probing functions
  70. //   for the existing formats, if there's a risk of confusing between the formats.
  71. /////////////////////////////////////////////////////////////////////////////////////////////
  72. typedef BOOL (*SubtitleProbingFuncPtr)(DWORD dwSubtitlesFileAddress,  DWORD dwSubtitlesFileSize);
  74. /////////////////////////////////////////////////////////////////////////////////////////////
  75. // Function Type : SubtitleParsingFuncPtr
  76. // Purpose : Parse the subtitle file according to the specific format, and store its
  77. //   contents using the proprietary format.
  78. // Input Parameters : dwSubtitlesFileAddress - location of the file on disc
  79. //   dwSubtitlesFileSize  -  file size
  80. //   dwScale, dwRate - dwScale/dwRate is the number of seconds
  81. // per video frame in the associated clip
  82. // Return type : TRUE if parsing was successful, FALSE on error.
  83. // Description : A function of this type must be implemented for every subtitle format.
  84. //   The function will read the file, extract subtitles test, timing information,
  85. //   and possibly language information and formatting information.
  86. //   It will then store this data for use during playback, using only the
  87. //   interface functions available in this file.
  88. /////////////////////////////////////////////////////////////////////////////////////////////
  89. typedef BOOL (*SubtitleParsingFuncPtr)(DWORD dwSubtitlesFileAddress, DWORD dwSubtitlesFileSize ,
  90.    DWORD dwScale, DWORD dwRate);
  93. typedef struct SubtitleFormatAttrTAG {
  94. /* SubtitlesFormatID sfFormatID; */
  95. // Robin_1003_2004_E
  96. // LPCWSTR *aFormatValidExtensions;
  97. SubtitleProbingFuncPtr  pfProbe;
  98. SubtitleParsingFuncPtr  pfParse;
  99. } SubtitleFormatAttr;
  103. typedef struct SubtitleStorageInterfaceTAG {
  104. DWORD dwCurrentStorageOffset;
  105. BYTE baBuffer[STORAGE_INTERFACE_BUFFER_SIZE];
  106. WORD wBufferPos;
  107. #ifdef _DEBUG
  108. DWORD dwByteCount;
  109. DWORD dwEntryCount;
  110. WORD  wMaxEntryLength;
  111. WORD  wCurrentEntryLength;
  112. WORD  wCurrentLineLength;
  113. WORD  wMaxLineLength;
  114. #endif // _DEBUG
  115. } SubtitleStorageInterface;
  117. typedef struct SubtitleStorageIndexEntryTAG {
  118. DWORD dwStartTime;
  119.    DWORD dwAddress;
  120. } SubtitleStorageIndexEntry;
  123. typedef struct SubtitleStorageIndexTAG {
  124. SubtitleStorageIndexEntry entry[SUBTITLE_INDEX_ENTRIES];
  125.    WORD wSubtitlesModulu;
  126.    WORD wInterval;
  127.    BYTE bIndexPosition;
  128. }  SubtitleStorageIndex;
  131. // externals
  132. extern CONST  SubtitleFormatAttr availableSubtitleFormats[SF_NUMBER_OF_FORMATS];
  133. extern  SubtitleStorageInterface* g_pSubtitleStorage;
  136. //*******************************************************************************************
  137. //  Subtitle storage interface functions
  138. //*******************************************************************************************
  140. /////////////////////////////////////////////////////////////////////////////////////////////
  141. // Function Name : subtitleStorageInitWriting
  142. // Purpose : Initializes the interface to the subtitles storage
  143. // Return type : TRUE on success, FALSE on error
  144. // Description :
  145. /////////////////////////////////////////////////////////////////////////////////////////////
  146. void subtitleStorageInitWriting(void);
  148. /////////////////////////////////////////////////////////////////////////////////////////////
  149. // Function Name : subtitleStorageMarkLastEntry
  150. // Purpose : to be used after the last subtitle was parsed.
  151. // Return type : TRUE - on success. FALSE when out of subtitle storage memory
  152. // Description : writes LAST_SUBTITLE_MARKER to the next position in the subtitle
  153. //    storage.
  154. /////////////////////////////////////////////////////////////////////////////////////////////
  155. BOOL subtitleStorageMarkLastEntry(void);
  157. /////////////////////////////////////////////////////////////////////////////////////////////
  158. // Function Name : subtitleStorageStartEntry
  159. // Purpose : Opens a new subtitle entry
  160. // Input Parameters : dwStartSCLK - Display starting time (SCLK)
  161. // Return type : TRUE - on success. FALSE when out of subtitle storage memory
  162. // Description : writes the SCLK DWORD, followed by a null byte
  163. /////////////////////////////////////////////////////////////////////////////////////////////
  164. BOOL subtitleStorageStartEntry(DWORD dwStartSCLK);
  166. /////////////////////////////////////////////////////////////////////////////////////////////
  167. // Function Name : subtitleStorageEndEntry
  168. // Purpose : Closes a subtitle entry
  169. // Input Parameters : dwEndSCLK - Display starting time (SCLK)
  170. // Return type : TRUE - on success. FALSE when out of subtitle storage memory
  171. // Description : writes a null byte, followed by the SCLK DWORD.
  172. /////////////////////////////////////////////////////////////////////////////////////////////
  173. BOOL subtitleStorageEndEntry(DWORD dwEndSCLK);
  175. /////////////////////////////////////////////////////////////////////////////////////////////
  176. // Function Name : subtitleStorageWriteByte
  177. // Purpose : Writes a byte to the subtitle storage memory
  178. // Input Parameters : b       - the byte to be stored
  179. // Return type : TRUE - on success. FALSE when out of subtitle storage memory
  180. // Description : writes the byte to the internal buffer. when full - writes the buffer
  181. //                  to the subtitle storage memory
  182. /////////////////////////////////////////////////////////////////////////////////////////////
  183. BOOL subtitleStorageWriteByte(BYTE b);
  185. /////////////////////////////////////////////////////////////////////////////////////////////
  186. // Function Name : subtitleStorageWriteDWORD
  187. // Purpose : Writes a double word to the subtitle storage memory
  188. // Input Parameters : dw       - the dword to be stored
  189. // Return type : TRUE - on success. FALSE when out of subtitle storage memory
  190. // Description : writes the word to the internal buffer, byte by byte. when
  191. //                  the internal buffer is full - writes the buffer
  192. //                  to the subtitle storage memory
  193. /////////////////////////////////////////////////////////////////////////////////////////////
  194. BOOL subtitleStorageWriteDWORD(DWORD dw);
  196. /////////////////////////////////////////////////////////////////////////////////////////////
  197. // Function Name : subtitleStorageCommitBuffer
  198. // Purpose : Internal Write the internal buffer to memory
  199. // Return type : void
  200. // Description : uses sc_SetBytes to write the buffer to subtitle memory. resets wBufferPos
  201. /////////////////////////////////////////////////////////////////////////////////////////////
  202. void subtitleStorageCommitBuffer(void);
  204. /////////////////////////////////////////////////////////////////////////////////////////////
  205. // Function Name : subtitleStorageGetSubtitle
  206. // Purpose : Get a subtitle string and the end sclk count
  207. // Output Parameters:  dwEndSCLK - The time for stopping the display of this subtitle in SCLK count
  208. // Return type : TRUE on success, FALSE if string is too long to fit in buffer
  209. // Description : Copies the subtitle string from subtitles storage memory to
  210. //                  the scratch pad. The string is copied as it was in the subtitles file,
  211. //   except for conversion of formatting symbols. Conversion to Unicode or any
  212. //                  other format the OSD module requires, is likely to be language-dependant,
  213. //                  and should be performed by the calling function if necessary.
  214. //   The time for displaying the returned subtitle should be determined beforehand,
  215. //                  and this function should be called when this time is reached. The end time is
  216. //                  returned by this function.
  217. /////////////////////////////////////////////////////////////////////////////////////////////
  218. BOOL subtitleStorageGetSubtitle(DWORD *dwEndSCLK);
  221. /////////////////////////////////////////////////////////////////////////////////////////////
  222. // Function Name : subtitleStorageGetStartTime
  223. // Purpose : Get the start SCLK count of the current subtitle
  224. // Output Parameters: dwStartSCLK - Start display time, as SCLK count
  225. // Return type : FALSE if there are no more subtitles. TRUE otherwise
  226. // Description : Reads the start SCLK count for this subtitle. If there are no more subtitle,
  227. //                  FALSE is returned, and also the value of dwStartSCLK is LAST_SUBTITLE_MARKER
  228. //   which is set to be the max possible value of the SCLK
  229. /////////////////////////////////////////////////////////////////////////////////////////////
  230. BOOL subtitleStorageGetStartTime(DWORD *dwStartSCLK);
  232. /////////////////////////////////////////////////////////////////////////////////////////////
  233. // Function Name : subtitleStorageRewind
  234. // Purpose : Set the current subtitle pointer to the previous subtitle
  235. // Input Parameters : storage - handle to a storage struct
  236. // Output Parameters: dwStartSCLK - Start display time of the previous subtitle, as SCLK count
  237. //                    dwEndSCLK - End display time of the previous subtitle, as SCLK count
  238. // Return type : FALSE if the current subtitle is already the first. TRUE otherwise.
  239. // Description : The function searches for the previous subtitle in the subtitles memory,
  240. //                    makes it the current subtitle, and returns its start and end time.
  241. //   This function is used for backwards navigation in the subtitles memory
  242. /////////////////////////////////////////////////////////////////////////////////////////////
  243. //BOOL subtitleStorageRewind(SubtitleStorageInterface *storage, DWORD *dwStartSCLK, DWORD *dwEndSCLK);
  245. /////////////////////////////////////////////////////////////////////////////////////////////
  246. // Function Name : subtitleStorageFillBuffer
  247. // Purpose : Internal function for reading from the subtitles memory in to the internal buffer
  248. // Input Parameters : storage - handle to a storage struct
  249. // Return type : void
  250. // Description : uses sc_GetBytes to write the buffer to subtitle memory. resets wBufferPos
  251. /////////////////////////////////////////////////////////////////////////////////////////////
  252. void subtitleStorageFillBuffer(void);
  254. /////////////////////////////////////////////////////////////////////////////////////////////
  255. // Function Name : subtitleStorageReadByte
  256. // Purpose : Reads a byte to the subtitle storage memory
  257. // Input Parameters : b       - place to store the byte
  258. // Return type : void
  259. // Description : Reads the byte from the internal buffer. when empty - fills the buffer
  260. /////////////////////////////////////////////////////////////////////////////////////////////
  261. void subtitleStorageReadByte(BYTE *b);
  263. /////////////////////////////////////////////////////////////////////////////////////////////
  264. // Function Name : subtitleStorageReadDWORD
  265. // Purpose : Reads a byte to the subtitle storage memory
  266. // Input Parameters : b       - place to store the DWOR
  267. // Return type : void
  268. // Description : Reads the DWORD byte by byte using subtitleStorageReadByte
  269. /////////////////////////////////////////////////////////////////////////////////////////////
  270. void subtitleStorageReadDWORD(DWORD *dw);
  272. /////////////////////////////////////////////////////////////////////////////////////////////
  273. // Function Name : subtitleStorageInitReading
  274. // Purpose : Initializes the interface to the subtitles storage
  275. // Return type : void
  276. // Description :
  277. /////////////////////////////////////////////////////////////////////////////////////////////
  278. void subtitleStorageInitReading(void);
  280. /////////////////////////////////////////////////////////////////////////////////////////////
  281. // Function Name  : subtitleStorageRewindBytes
  282. // Purpose  : Rewinds the subtitles storage pointer
  283. // Input Parameters: count   - number of bytes to rewind
  284. // Return type : FALSE when attempting to rewind beyond the start of the subtitles storage
  285. //   TRUE otherwise.
  286. // Description : Checks if the requested position is currently in the buffer, and updates
  287. //                  internal pointers if so. Otherwise, reads required data from the SDRAM
  288. /////////////////////////////////////////////////////////////////////////////////////////////
  289. BOOL subtitleStorageRewindBytes(WORD count);
  291. void updateSubtitlesIndex(DWORD dwAddress, DWORD dwStartSCLK);
  293. /////////////////////////////////////////////////////////////////////////////////////////////
  294. // Function Name  : subtitleGoToTime
  295. // Purpose  : Jump to a new time in the subtitle storage
  296. // Input parameters: dwCurrentTime - the new time
  297. // Return type :  void
  298. // Description :  After FF/FB/Goto, this function is used to set the next subtitle to be
  299. //                   the 1 right before the new time.
  300. /////////////////////////////////////////////////////////////////////////////////////////////
  301. void subtitleGoToTime(DWORD dwCurrentTime);
  303. void switchBytesInWString(LPSTR str);
  305. #endif // __AUXSUBTITLESCOMMONPRIVATE_H_
  307. #endif // USE_AUX_SUBTITLES