tune the preloads a bit
[sdl_omap.git] / docs / html / sdlcd.html
CommitLineData
e14743d1 1<HTML
2><HEAD
3><TITLE
4>SDL_CD</TITLE
5><META
6NAME="GENERATOR"
7CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
8"><LINK
9REL="HOME"
10TITLE="SDL Library Documentation"
11HREF="index.html"><LINK
12REL="UP"
13TITLE="CD-ROM"
14HREF="cdrom.html"><LINK
15REL="PREVIOUS"
16TITLE="SDL_CDClose"
17HREF="sdlcdclose.html"><LINK
18REL="NEXT"
19TITLE="SDL_CDtrack"
20HREF="sdlcdtrack.html"></HEAD
21><BODY
22CLASS="REFENTRY"
23BGCOLOR="#FFF8DC"
24TEXT="#000000"
25LINK="#0000ee"
26VLINK="#551a8b"
27ALINK="#ff0000"
28><DIV
29CLASS="NAVHEADER"
30><TABLE
31SUMMARY="Header navigation table"
32WIDTH="100%"
33BORDER="0"
34CELLPADDING="0"
35CELLSPACING="0"
36><TR
37><TH
38COLSPAN="3"
39ALIGN="center"
40>SDL Library Documentation</TH
41></TR
42><TR
43><TD
44WIDTH="10%"
45ALIGN="left"
46VALIGN="bottom"
47><A
48HREF="sdlcdclose.html"
49ACCESSKEY="P"
50>Prev</A
51></TD
52><TD
53WIDTH="80%"
54ALIGN="center"
55VALIGN="bottom"
56></TD
57><TD
58WIDTH="10%"
59ALIGN="right"
60VALIGN="bottom"
61><A
62HREF="sdlcdtrack.html"
63ACCESSKEY="N"
64>Next</A
65></TD
66></TR
67></TABLE
68><HR
69ALIGN="LEFT"
70WIDTH="100%"></DIV
71><H1
72><A
73NAME="SDLCD"
74></A
75>SDL_CD</H1
76><DIV
77CLASS="REFNAMEDIV"
78><A
79NAME="AEN7566"
80></A
81><H2
82>Name</H2
83>SDL_CD&nbsp;--&nbsp;CDROM Drive Information</DIV
84><DIV
85CLASS="REFSECT1"
86><A
87NAME="AEN7569"
88></A
89><H2
90>Structure Definition</H2
91><PRE
92CLASS="PROGRAMLISTING"
93>typedef struct{
94 int id;
95 CDstatus status;
96 int numtracks;
97 int cur_track;
98 int cur_frame;
99 SDL_CDtrack track[SDL_MAX_TRACKS+1];
100} SDL_CD;</PRE
101></DIV
102><DIV
103CLASS="REFSECT1"
104><A
105NAME="AEN7572"
106></A
107><H2
108>Structure Data</H2
109><DIV
110CLASS="INFORMALTABLE"
111><A
112NAME="AEN7574"
113></A
114><P
115></P
116><TABLE
117BORDER="0"
118CLASS="CALSTABLE"
119><TBODY
120><TR
121><TD
122ALIGN="LEFT"
123VALIGN="TOP"
124><TT
125CLASS="STRUCTFIELD"
126><I
127>id</I
128></TT
129></TD
130><TD
131ALIGN="LEFT"
132VALIGN="TOP"
133>Private drive identifier</TD
134></TR
135><TR
136><TD
137ALIGN="LEFT"
138VALIGN="TOP"
139><TT
140CLASS="STRUCTFIELD"
141><I
142>status</I
143></TT
144></TD
145><TD
146ALIGN="LEFT"
147VALIGN="TOP"
148>Drive <A
149HREF="sdlcdstatus.html"
150>status</A
151></TD
152></TR
153><TR
154><TD
155ALIGN="LEFT"
156VALIGN="TOP"
157><TT
158CLASS="STRUCTFIELD"
159><I
160>numtracks</I
161></TT
162></TD
163><TD
164ALIGN="LEFT"
165VALIGN="TOP"
166>Number of tracks on the CD</TD
167></TR
168><TR
169><TD
170ALIGN="LEFT"
171VALIGN="TOP"
172><TT
173CLASS="STRUCTFIELD"
174><I
175>cur_track</I
176></TT
177></TD
178><TD
179ALIGN="LEFT"
180VALIGN="TOP"
181>Current track</TD
182></TR
183><TR
184><TD
185ALIGN="LEFT"
186VALIGN="TOP"
187><TT
188CLASS="STRUCTFIELD"
189><I
190>cur_frame</I
191></TT
192></TD
193><TD
194ALIGN="LEFT"
195VALIGN="TOP"
196>Current frame offset within the track</TD
197></TR
198><TR
199><TD
200ALIGN="LEFT"
201VALIGN="TOP"
202><TT
203CLASS="STRUCTFIELD"
204><I
205>track</I
206></TT
207>[SDL_MAX_TRACKS+1]</TD
208><TD
209ALIGN="LEFT"
210VALIGN="TOP"
211>Array of track descriptions. (see <A
212HREF="sdlcdtrack.html"
213><SPAN
214CLASS="STRUCTNAME"
215>SDL_CDtrack</SPAN
216></A
217>)</TD
218></TR
219></TBODY
220></TABLE
221><P
222></P
223></DIV
224></DIV
225><DIV
226CLASS="REFSECT1"
227><A
228NAME="AEN7604"
229></A
230><H2
231>Description</H2
232><P
233>An <SPAN
234CLASS="STRUCTNAME"
235>SDL_CD</SPAN
236> structure is returned by <A
237HREF="sdlcdopen.html"
238><TT
239CLASS="FUNCTION"
240>SDL_CDOpen</TT
241></A
242>. It represents an opened CDROM device and stores information on the layout of the tracks on the disc.</P
243><P
244>A frame is the base data unit of a CD. <TT
245CLASS="LITERAL"
246>CD_FPS</TT
247> frames is equal to 1 second of music. SDL provides two macros for converting between time and frames: <TT
248CLASS="LITERAL"
249>FRAMES_TO_MSF(f, M,S,F)</TT
250> and <TT
251CLASS="LITERAL"
252>MSF_TO_FRAMES</TT
253>.</P
254></DIV
255><DIV
256CLASS="REFSECT1"
257><A
258NAME="AEN7614"
259></A
260><H2
261>Examples</H2
262><PRE
263CLASS="PROGRAMLISTING"
264>int min, sec, frame;
265int frame_offset;
266
267FRAMES_TO_MSF(cdrom-&#62;cur_frame, &#38;min, &#38;sec, &#38;frame);
268printf("Current Position: %d minutes, %d seconds, %d frames\n", min, sec, frame);
269
270frame_offset=MSF_TO_FRAMES(min, sec, frame);</PRE
271></DIV
272><DIV
273CLASS="REFSECT1"
274><A
275NAME="AEN7617"
276></A
277><H2
278>See Also</H2
279><P
280><A
281HREF="sdlcdopen.html"
282><TT
283CLASS="FUNCTION"
284>SDL_CDOpen</TT
285></A
286>,
287<A
288HREF="sdlcdtrack.html"
289><SPAN
290CLASS="STRUCTNAME"
291>SDL_CDtrack</SPAN
292></A
293></P
294></DIV
295><DIV
296CLASS="NAVFOOTER"
297><HR
298ALIGN="LEFT"
299WIDTH="100%"><TABLE
300SUMMARY="Footer navigation table"
301WIDTH="100%"
302BORDER="0"
303CELLPADDING="0"
304CELLSPACING="0"
305><TR
306><TD
307WIDTH="33%"
308ALIGN="left"
309VALIGN="top"
310><A
311HREF="sdlcdclose.html"
312ACCESSKEY="P"
313>Prev</A
314></TD
315><TD
316WIDTH="34%"
317ALIGN="center"
318VALIGN="top"
319><A
320HREF="index.html"
321ACCESSKEY="H"
322>Home</A
323></TD
324><TD
325WIDTH="33%"
326ALIGN="right"
327VALIGN="top"
328><A
329HREF="sdlcdtrack.html"
330ACCESSKEY="N"
331>Next</A
332></TD
333></TR
334><TR
335><TD
336WIDTH="33%"
337ALIGN="left"
338VALIGN="top"
339>SDL_CDClose</TD
340><TD
341WIDTH="34%"
342ALIGN="center"
343VALIGN="top"
344><A
345HREF="cdrom.html"
346ACCESSKEY="U"
347>Up</A
348></TD
349><TD
350WIDTH="33%"
351ALIGN="right"
352VALIGN="top"
353>SDL_CDtrack</TD
354></TR
355></TABLE
356></DIV
357></BODY
358></HTML
359>