1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<HTML>
3<HEAD>
4<META http-equiv="content-type" content="text/html; charset=windows-1252">
5<META http-equiv="Content-Style-Type" content="text/css">
6<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 6.5.0.0 for Windows">
7<LINK rel="stylesheet" type="text/css" href="../CSS/revolution.css">
8<BASE target="main">
9<TITLE>THP API Menu</TITLE>
10</HEAD>
11<BODY>
12<H1><A name="thp">Movie (THP) API Function List</a></H1>
13
14<H2><a name="Low Level">THP Low Level APIs</a></H2>
15<TABLE border="1">
16  <TBODY>
17    <TR>
18<TD><A href="low/THPInit.html"> THPInit</A></TD>
19<TD>Initializes the THP library.</TD>
20    </TR>
21    <TR>
22<TD><A href="low/THPVideoDecode.html"> THPVideoDecode</A></TD>
23<TD>Decodes THP video data.</TD>
24    </TR>
25    <TR>
26<TD><A href="low/THPAudioDecode.html"> THPAudioDecode</A></TD>
27<TD>Decodes THP audio data.</TD>
28    </TR>
29  </TBODY>
30</TABLE>
31
32<H2><a name="Common">THP Simple Player and THP Player</a></H2>
33<TABLE border="1">
34  <TBODY>
35    <TR>
36<TD><A href="common/THPVideoInfo.html"> THPVideoInfo</A></TD>
37<TD>Structure that holds information about the THP video data.</TD>
38    </TR>
39    <TR>
40<TD><A href="common/THPAudioInfo.html"> THPAudioInfo</A></TD>
41<TD>Structure that holds information about the THP audio data.</TD>
42    </TR>
43  </TBODY>
44</TABLE>
45
46<H2><a name="Simple Player">THP Simple Player</a></H2>
47<TABLE border="1">
48  <TBODY>
49    <TR>
50<TD><A href="THPSimple/THPSimpleInit.html"> THPSimpleInit</A></TD>
51<TD>Initializes the THP simple player.</TD>
52    </TR>
53    <TR>
54<TD><A href="THPSimple/THPSimpleQuit.html"> THPSimpleQuit</A></TD>
55<TD>Quits the THP simple player.</TD>
56    </TR>
57    <TR>
58<TD><A href="THPSimple/THPSimpleOpen.html"> THPSimpleOpen</A></TD>
59<TD>Opens the THP movie data.</TD>
60    </TR>
61    <TR>
62<TD><A href="THPSimple/THPSimpleClose.html"> THPSimpleClose</A></TD>
63<TD>Closes the THP movie data.</TD>
64    </TR>
65    <TR>
66<TD><A href="THPSimple/THPSimpleCalcNeedMemory.html"> THPSimpleCalcNeedMemory</A></TD>
67<TD>Calculates the size of the work buffer that THP simple player uses.</TD>
68    </TR>
69    <TR>
70<TD><A href="THPSimple/THPSimpleSetBuffer.html"> THPSimpleSetBuffer</A></TD>
71<TD>Registers the work buffer in the THP simple player.</TD>
72    </TR>
73    <TR>
74<TD><A href="THPSimple/THPSimplePreLoad.html"> THPSimplePreLoad</A></TD>
75<TD>Preloads movie data in order to start THP movie data playback.</TD>
76    </TR>
77    <TR>
78<TD><A href="THPSimple/THPSimpleLoadStop.html"> THPSimpleLoadStop</A></TD>
79<TD>Stops preloading movie data and restores THP simple player to its initial state.</TD>
80    </TR>
81    <TR>
82<TD><A href="THPSimple/THPSimpleDecode.html"> THPSimpleDecode</A></TD>
83<TD>Decodes THP video data and THP audio data.</TD>
84    </TR>
85    <TR>
86<TD><A href="THPSimple/THPSimpleDrawCurrentFrame.html"> THPSimpleDrawCurrentFrame</A></TD>
87<TD>Renders the decoded THP video data.</TD>
88    </TR>
89    <TR>
90<TD><A href="THPSimple/THPSimpleAudioStart.html"> THPSimpleAudioStart</A></TD>
91<TD>Starts the playback of THP audio data.</TD>
92    </TR>
93    <TR>
94<TD><A href="THPSimple/THPSimpleAudioStop.html"> THPSimpleAudioStop</A></TD>
95<TD>Stops the playback of THP audio data.</TD>
96    </TR>
97    <TR>
98<TD><A href="THPSimple/THPSimpleSetVolume.html"> THPSimpleSetVolume</A></TD>
99<TD>Sets the audio playback volume.</TD>
100    </TR>
101     <TR>
102<TD><A href="THPSimple/THPSimpleGetVolume.html"> THPSimpleGetVolume</A></TD>
103<TD>Obtains the current playback volume.</TD>
104    </TR>
105    <TR>
106<TD><A href="THPSimple/THPSimpleGetVideoInfo.html"> THPSimpleGetVideoInfo</A></TD>
107<TD>Gets the information about the THP video data.</TD>
108    </TR>
109    <TR>
110<TD><A href="THPSimple/THPSimpleGetAudioInfo.html"> THPSimpleGetAudioInfo</A></TD>
111<TD>Gets information about the THP audio data.</TD>
112    </TR>
113    <TR>
114<TD><A href="THPSimple/THPSimpleGetFrameRate.html"> THPSimpleGetFrameRate</A></TD>
115<TD>Gets the frame rate of the THP movie data.</TD>
116    </TR>
117    <TR>
118<TD><A href="THPSimple/THPSimpleGetTotalFrame.html"> THPSimpleGetTotalFrame</A></TD>
119<TD>Gets the number of frames in the THP movie data.</TD>
120    </TR>
121  </TBODY>
122</TABLE>
123
124<H2><a name="Player">THP Player</a></H2>
125<TABLE border="1">
126  <TBODY>
127    <TR>
128<TD><A href="THPPlayer/THPPlayerInit.html"> THPPlayerInit</A></TD>
129<TD>Initializes the THP player.</TD>
130    </TR>
131    <TR>
132<TD><A href="THPPlayer/THPPlayerQuit.html"> THPPlayerQuit</A></TD>
133<TD>Quits the THP player.</TD>
134    </TR>
135    <TR>
136<TD><A href="THPPlayer/THPPlayerOpen.html"> THPPlayerOpen</A></TD>
137<TD>Opens the THP movie data.</TD>
138    </TR>
139    <TR>
140<TD><A href="THPPlayer/THPPlayerClose.html"> THPPlayerClose</A></TD>
141<TD>Closes the THP movie data.</TD>
142    </TR>
143    <TR>
144<TD><A href="THPPlayer/THPPlayerCalcNeedMemory.html"> THPPlayerCalcNeedMemory</A></TD>
145<TD>Calculates the size of the work buffer that the THP player uses.</TD>
146    </TR>
147    <TR>
148<TD><A href="THPPlayer/THPPlayerSetBuffer.html"> THPPlayerSetBuffer</A></TD>
149<TD>Registers the work rbuffer in the THP player.</TD>
150    </TR>
151    <TR>
152<TD><A href="THPPlayer/THPPlayerPrepare.html"> THPPlayerPrepare</A></TD>
153<TD>Specifies how to play  back the THP movie data and the starting frame.</TD>
154    </TR>
155    <TR>
156<TD><A href="THPPlayer/THPPlayerPlay.html"> THPPlayerPlay</A></TD>
157<TD>Starts THP movie data playback.</TD>
158    </TR>
159    <TR>
160<TD><A href="THPPlayer/THPPlayerStop.html"> THPPlayerStop</A></TD>
161<TD>Stops THP movie data playback.</TD>
162    </TR>
163    <TR>
164<TD><A href="THPPlayer/THPPlayerPause.html"> THPPlayerPause</A></TD>
165<TD>Pauses THP movie data playback.</TD>
166    </TR>
167    <TR>
168<TD><A href="THPPlayer/THPPlayerSkip.html"> THPPlayerSkip</A></TD>
169<TD>Advances the THP movie data playback by one frame.</TD>
170    </TR>
171    <TR>
172<TD><A href="THPPlayer/THPPlayerDrawCurrentFrame.html"> THPPlayerDrawCurrentFrame</A></TD>
173<TD>Renders the THP video data that should be currently displayed.</TD>
174    </TR>
175    <TR>
176<TD><A href="THPPlayer/THPPlayerDrawDone.html"> THPPlayerDrawDone</A></TD>
177<TD>Called instead of the <CODE>GXDrawDone</CODE> function when THP movie data is playing.</TD>
178    </TR>
179    <TR>
180<TD><A href="THPPlayer/THPPlayerSetVolume.html"> THPPlayerSetVolume</A></TD>
181<TD>Sets the audio playback volume.</TD>
182    </TR>
183     <TR>
184<TD><A href="THPPlayer/THPPlayerGetVolume.html"> THPPlayerGetVolume</A></TD>
185<TD>Obtains the current playback volume.</TD>
186    </TR>
187    <TR>
188<TD><A href="THPPlayer/THPPlayerGetVideoInfo.html"> THPPlayerGetVideoInfo</A></TD>
189<TD>Gets information about the THP video data.</TD>
190    </TR>
191    <TR>
192<TD><A href="THPPlayer/THPPlayerGetAudioInfo.html"> THPPlayerGetAudioInfo</A></TD>
193<TD>Gets information about the THP audio data.</TD>
194    </TR>
195    <TR>
196<TD><A href="THPPlayer/THPPlayerGetFrameRate.html"> THPPlayerGetFrameRate</A></TD>
197<TD>Gets the frame rate of the THP movie data.</TD>
198    </TR>
199    <TR>
200<TD><A href="THPPlayer/THPPlayerGetTotalFrame.html"> THPPlayerGetTotalFrame</A></TD>
201<TD>Gets the number of frames in the THP movie data.</TD>
202    </TR>
203    <TR>
204<TD><A href="THPPlayer/THPPlayerGetState.html"> THPPlayerGetState</A></TD>
205<TD>Displays the current status of the THP player.</TD>
206    </TR>
207  </TBODY>
208</TABLE>
209
210<H2><a name="Tool">THP Tool API</a></H2>
211<H3><a name="thpcore"><CODE>thpcore</CODE></a></H3>
212<TABLE border="1">
213  <TBODY>
214    <TR>
215<TD><A href="tools/thpcore/THPConvertJPEG2THP.html"> THPConvertJPEG2THP</A></TD>
216<TD>Converts JPEG data into THP video data.</TD>
217    </TR>
218    <TR>
219<TD><A href="tools/thpcore/THPPrintXXXX.html"> THPPrint<br>THPPrintError<br>THPPrintLog</A></TD>
220<TD>Outputs a character string.</TD>
221    </TR>
222    <TR>
223<TD><A href="tools/thpcore/THPPrintXXXXFunc.html"> THPPrintFunc<br>THPPrintErrorFunc<br>THPPrintLogFunc</A></TD>
224<TD>Registers the character string output function.</TD>
225    </TR>
226    <TR>
227<TD><A href="tools/thpcore/THPMalloc.html"> THPMalloc<br>THPFree</A></TD>
228<TD>Register the functions for allocating and freeing memory.</TD>
229    </TR>
230    <TR>
231<TD><A href="tools/thpcore/THPImageStatus.html"> THPImageStatus</A></TD>
232<TD>Structure that contains information about the THP video data.</TD>
233    </TR>
234    <TR>
235<TD><A href="tools/thpcore/THPVerboseFlag.html"> THPVerboseFlag</A></TD>
236<TD>Sets the verbose flag.</TD>
237    </TR>
238  </TBODY>
239</TABLE>
240
241<H3><a name="thpaudio"><CODE>thpaudio</CODE></a></H3>
242<TABLE border="1">
243  <TBODY>
244    <TR>
245<TD><A href="tools/thpaudio/THPAudioInit.html"> THPAudioInit</A></TD>
246<TD>Loads <CODE>dsptool.dll</CODE> and initializes the pointer for this function.</TD>
247    </TR>
248    <TR>
249<TD><A href="tools/thpaudio/THPAudioQuit.html"> THPAudioQuit</A></TD>
250<TD>Call this function when finishing THP audio data conversion.</TD>
251    </TR>
252    <TR>
253<TD><A href="tools/thpaudio/THPAudioCreateHandle.html"> THPAudioCreateHandle</A></TD>
254<TD>Reads information about the WAV file and sets the information in the <code>THPAudioHandle</code> structure.</TD>
255    </TR>
256    <TR>
257<TD><A href="tools/thpaudio/THPAudioFreeHandle.html"> THPAudioFreeHandle</A></TD>
258<TD>Releases the <code>THPAudioHandle</code> structure.</TD>
259    </TR>
260    <TR>
261<TD><A href="tools/thpaudio/THPAudioGetInfo.html"> THPAudioGetInfo</A></TD>
262<TD>Gets the number of channels and the playback frequency from the <code>THPAudioHandle</code> structure.</TD>
263    </TR>
264    <TR>
265<TD><A href="tools/thpaudio/THPAudioGetTotalSamples.html"> THPAudioGetTotalSamples</A></TD>
266<TD>Calculates the number of audio data samples required for the THP movie data.</TD>
267    </TR>
268    <TR>
269<TD><A href="tools/thpaudio/THPAudioGetFrameSize.html"> THPAudioGetFrameSize</A></TD>
270<TD>Calculates the size of THP audio data required for the specified frame of THP movie data.</TD>
271    </TR>
272    <TR>
273<TD><A href="tools/thpaudio/THPAudioGetMaxFrameSize.html"> THPAudioGetMaxFrameSize</A></TD>
274<TD>Calculates the size of the audio data for each frame of the THP movie data and returns the largest size.</TD>
275    </TR>
276    <TR>
277<TD><A href="tools/thpaudio/THPAudioGetMaxFrameSamples.html"> THPAudioGetMaxFrameSamples</A></TD>
278<TD>Calculates the number of samples in the audio data for each frame in the THP movie data and returns the maximum value.</TD>
279    </TR>
280    <TR>
281<TD><A href="tools/thpaudio/THPAudioWriteFrame.html"> THPAudioWriteFrame</A></TD>
282<TD>Encodes audio data using ADPCM.</TD>
283    </TR>
284    <TR>
285<TD><A href="tools/thpaudio/THPAudioHandle.html"> THPAudioHandle</A></TD>
286<TD>Retains the information needed for creating THP audio data.</TD>
287    </TR>
288    <TR>
289<TD><A href="tools/thpaudio/THPAudioFileInfo.html"> THPAudioFileInfo</A></TD>
290<TD>Retains the information for the original WAV data that is converted into THP audio data.</TD>
291    </TR>
292  </TBODY>
293</TABLE>
294
295<H3><a name="thputilities"><CODE>thputilities</CODE></a></H3>
296<TABLE border="1">
297  <TBODY>
298    <TR>
299<TD><A href="tools/thputilities/THPUtyConvertToUnixFmt.html"> THPUtyConvertToUnixFmt</A></TD>
300<TD>Converts a UNIX path into a DOS path.</TD>
301    </TR>
302    <TR>
303<TD><A href="tools/thputilities/THPUtyReverseEndianU16.html"> THPUtyReverseEndianU16</A></TD>
304<TD>Converts the endian of an integer value (u16).</TD>
305    </TR>
306    <TR>
307<TD><A href="tools/thputilities/THPUtyReverseEndianU32.html"> THPUtyReverseEndianU32</A></TD>
308<TD>Converts the endian of an integer value (u32).</TD>
309    </TR>
310    <TR>
311<TD><A href="tools/thputilities/THPUtyReverseEndianF32.html"> THPUtyReverseEndianF32</A></TD>
312<TD>Converts the endian of a floating point value (f32).</TD>
313    </TR>
314    <TR>
315<TD><A href="tools/thputilities/THPUtyWritePad32.html"> THPUtyWritePad32</A></TD>
316<TD>Outputs NULL to file with a 32-byte alignment.</TD>
317    </TR>
318    <TR>
319<TD><A href="tools/thputilities/THPUtyPutU32.html"> THPUtyPutU32</A></TD>
320<TD>Converts and then outputs the endian of an integer value (u32).</TD>
321    </TR>
322    <TR>
323<TD><A href="tools/thputilities/THPUtyPutF32.html"> THPUtyPutF32</A></TD>
324<TD>Converts and then outputs the endian of a floating point value (f32).</TD>
325    </TR>
326    <TR>
327<TD><A href="tools/thputilities/THPUtyHeaderInit.html"> THPUtyHeaderInit</A></TD>
328<TD>Initializes the <code>THPHeader</code> structure.</TD>
329    </TR>
330    <TR>
331<TD><A href="tools/thputilities/THPUtyWriteTHPHeader.html"> THPUtyWriteTHPHeader</A></TD>
332<TD>Outputs the <code>THPHeader</code> structure.</TD>
333    </TR>
334    <TR>
335<TD><A href="tools/thputilities/THPUtyWriteTHPFrameCompInfo.html"> THPUtyWriteTHPFrameCompInfo</A></TD>
336<TD>Outputs the <code>THPFrameCompInfo</code> structure.</TD>
337    </TR>
338    <TR>
339<TD><A href="tools/thputilities/THPUtyWriteTHPVideoInfo.html"> THPUtyWriteTHPVideoInfo</A></TD>
340<TD>Outputs the <code>THPVideoInfo</code> structure.</TD>
341    </TR>
342    <TR>
343<TD><A href="tools/thputilities/THPUtyWriteTHPAudioInfo.html"> THPUtyWriteTHPAudioInfo</A></TD>
344<TD>Outputs the <code>THPAudioInfo</code> structure.</TD>
345    </TR>
346    <TR>
347<TD><A href="tools/thputilities/THPUtyWriteTHPFrameHeader.html"> THPUtyWriteTHPFrameHeader</A></TD>
348<TD>Outputs the <code>THPFrameHeader</code>structure.</TD>
349    </TR>
350    <TR>
351<TD><A href="tools/thputilities/THPUtyWriteTHPComponentsInfo.html"> THPUtyWriteTHPComponentsInfo</A></TD>
352<TD>Outputs the <code>THPVideoInfo</code> and the <code>THPAudioInfo</code> structure.</TD>
353    </TR>
354    <TR>
355<TD><A href="tools/thputilities/THPUtyWriteTHPFileHeader.html"> THPUtyWriteTHPFileHeader</A></TD>
356<TD>Outputs the <code>THPFileHeader</code> structure.</TD>
357    </TR>
358    <TR>
359<TD><A href="tools/thputilities/THPUtyReadTHPHeader.html"> THPUtyReadTHPHeader</A></TD>
360<TD>Reads the <code>THPHeader</code> structure.</TD>
361    </TR>
362    <TR>
363<TD><A href="tools/thputilities/THPUtyReadTHPFrameCompInfo.html"> THPUtyReadTHPFrameCompInfo</A></TD>
364<TD>Reads the <code>THPFrameCompInfo</code> structure.</TD>
365    </TR>
366    <TR>
367<TD><A href="tools/thputilities/THPUtyReadTHPVideoInfo.html"> THPUtyReadTHPVideoInfo</A></TD>
368<TD>Reads the <code>THPVideoInfo</code> structure.</TD>
369    </TR>
370    <TR>
371<TD><A href="tools/thputilities/THPUtyReadTHPVideoInfoOld.html"> THPUtyReadTHPVideoInfoOld</A></TD>
372<TD>Reads the <code>THPVideoInfo</code> structure from the THP movie data (for Ver 1.0 and earlier versions).</TD>
373    </TR>
374    <TR>
375<TD><A href="tools/thputilities/THPUtyReadTHPAudioInfo.html"> THPUtyReadTHPAudioInfo</A></TD>
376<TD>Reads the <code>THPVAudioInfo</code> structure.</TD>
377    </TR>
378    <TR>
379<TD><A href="tools/thputilities/THPUtyReadTHPAudioInfoOld.html"> THPUtyReadTHPAudioInfoOld</A></TD>
380<TD>Reads the <code>THPAudioInfo</code> structure from the THP movie data (for Ver 1.0 and earlier versions).</TD>
381    </TR>
382    <TR>
383<TD><A href="tools/thputilities/THPUtyReadTHPFrameHeader.html"> THPUtyReadTHPFrameHeader</A></TD>
384<TD>Reads the <code>THPFrameHeader</code> structure.</TD>
385    </TR>
386    <TR>
387<TD><A href="tools/thputilities/THPUtyReadTHPFileHeader.html"> THPUtyReadTHPFileHeader</A></TD>
388<TD>Reads the <code>THPFileHeader</code> structure.</TD>
389    </TR>
390    <TR>
391<TD><A href="tools/thputilities/THPUtyCopyTHPFile.html"> THPUtyCopyTHPFile</A></TD>
392<TD>Copies the THP movie data.</TD>
393    </TR>
394    <TR>
395<TD><A href="tools/thputilities/THPUtyCreateTHP.html"> THPUtyCreateTHP</A></TD>
396<TD>Creates THP movie data.</TD>
397    </TR>
398    <TR>
399<TD><A href="tools/thputilities/THPUtyChangeAudioTrack.html"> THPUtyChangeAudioTrack</A></TD>
400<TD>Switches the audio track of the THP movie data.</TD>
401    </TR>
402  </TBODY>
403</TABLE>
404<hr>
405<P>CONFIDENTIAL</p>
406</BODY>
407</HTML>
408