Go to most recent revision | Details | Last modification | View Log | RSS feed
| Rev | Author | Line No. | Line |
|---|---|---|---|
| 5131 | clevermous | 1 | |
| 2 | > |
||
| 3 | > |
||
| 4 | >SDL_AudioSpec |
||
| 5 | > |
||
| 6 | NAME="GENERATOR" |
||
| 7 | CONTENT="Modular DocBook HTML Stylesheet Version 1.64 |
||
| 8 | "> |
||
| 9 | REL="HOME" |
||
| 10 | TITLE="SDL Library Documentation" |
||
| 11 | HREF="index.html"> |
||
| 12 | REL="UP" |
||
| 13 | TITLE="Audio" |
||
| 14 | HREF="audio.html"> |
||
| 15 | REL="PREVIOUS" |
||
| 16 | TITLE="Audio" |
||
| 17 | HREF="audio.html"> |
||
| 18 | REL="NEXT" |
||
| 19 | TITLE="SDL_OpenAudio" |
||
| 20 | HREF="sdlopenaudio.html"> |
||
| 21 | > |
||
| 22 | CLASS="REFENTRY" |
||
| 23 | BGCOLOR="#FFF8DC" |
||
| 24 | TEXT="#000000" |
||
| 25 | LINK="#0000ee" |
||
| 26 | VLINK="#551a8b" |
||
| 27 | ALINK="#ff0000" |
||
| 28 | > |
||
| 29 | CLASS="NAVHEADER" |
||
| 30 | > |
||
| 31 | WIDTH="100%" |
||
| 32 | BORDER="0" |
||
| 33 | CELLPADDING="0" |
||
| 34 | CELLSPACING="0" |
||
| 35 | > |
||
| 36 | > |
||
| 37 | COLSPAN="3" |
||
| 38 | ALIGN="center" |
||
| 39 | >SDL Library Documentation |
||
| 40 | > |
||
| 41 | > |
||
| 42 | > |
||
| 43 | WIDTH="10%" |
||
| 44 | ALIGN="left" |
||
| 45 | VALIGN="bottom" |
||
| 46 | > |
||
| 47 | HREF="audio.html" |
||
| 48 | >Prev |
||
| 49 | > |
||
| 50 | > |
||
| 51 | WIDTH="80%" |
||
| 52 | ALIGN="center" |
||
| 53 | VALIGN="bottom" |
||
| 54 | > |
||
| 55 | > |
||
| 56 | WIDTH="10%" |
||
| 57 | ALIGN="right" |
||
| 58 | VALIGN="bottom" |
||
| 59 | > |
||
| 60 | HREF="sdlopenaudio.html" |
||
| 61 | >Next |
||
| 62 | > |
||
| 63 | > |
||
| 64 | > |
||
| 65 | > |
||
| 66 | ALIGN="LEFT" |
||
| 67 | WIDTH="100%"> |
||
| 68 | > |
||
| 69 | > |
||
| 70 | NAME="SDLAUDIOSPEC" |
||
| 71 | >SDL_AudioSpec |
||
| 72 | > |
||
| 73 | > |
||
| 74 | CLASS="REFNAMEDIV" |
||
| 75 | > |
||
| 76 | NAME="AEN5960" |
||
| 77 | > |
||
| 78 | > |
||
| 79 | >Name |
||
| 80 | >SDL_AudioSpec -- Audio Specification Structure |
||
| 81 | > |
||
| 82 | CLASS="REFSECT1" |
||
| 83 | > |
||
| 84 | NAME="AEN5963" |
||
| 85 | > |
||
| 86 | > |
||
| 87 | >Structure Definition |
||
| 88 | > |
||
| 89 | CLASS="PROGRAMLISTING" |
||
| 90 | >typedef struct{ |
||
| 91 | int freq; |
||
| 92 | Uint16 format; |
||
| 93 | Uint8 channels; |
||
| 94 | Uint8 silence; |
||
| 95 | Uint16 samples; |
||
| 96 | Uint32 size; |
||
| 97 | void (*callback)(void *userdata, Uint8 *stream, int len); |
||
| 98 | void *userdata; |
||
| 99 | } SDL_AudioSpec; |
||
| 100 | > |
||
| 101 | > |
||
| 102 | CLASS="REFSECT1" |
||
| 103 | > |
||
| 104 | NAME="AEN5966" |
||
| 105 | > |
||
| 106 | > |
||
| 107 | >Structure Data |
||
| 108 | > |
||
| 109 | CLASS="INFORMALTABLE" |
||
| 110 | > |
||
| 111 | NAME="AEN5968" |
||
| 112 | > |
||
| 113 | > |
||
| 114 | > |
||
| 115 | > |
||
| 116 | BORDER="0" |
||
| 117 | CLASS="CALSTABLE" |
||
| 118 | > |
||
| 119 | > |
||
| 120 | > |
||
| 121 | ALIGN="LEFT" |
||
| 122 | VALIGN="TOP" |
||
| 123 | > |
||
| 124 | CLASS="STRUCTFIELD" |
||
| 125 | > |
||
| 126 | >freq |
||
| 127 | > |
||
| 128 | > |
||
| 129 | > |
||
| 130 | ALIGN="LEFT" |
||
| 131 | VALIGN="TOP" |
||
| 132 | >Audio frequency in samples per second |
||
| 133 | > |
||
| 134 | > |
||
| 135 | > |
||
| 136 | ALIGN="LEFT" |
||
| 137 | VALIGN="TOP" |
||
| 138 | > |
||
| 139 | CLASS="STRUCTFIELD" |
||
| 140 | > |
||
| 141 | >format |
||
| 142 | > |
||
| 143 | > |
||
| 144 | > |
||
| 145 | ALIGN="LEFT" |
||
| 146 | VALIGN="TOP" |
||
| 147 | >Audio data format |
||
| 148 | > |
||
| 149 | > |
||
| 150 | > |
||
| 151 | ALIGN="LEFT" |
||
| 152 | VALIGN="TOP" |
||
| 153 | > |
||
| 154 | CLASS="STRUCTFIELD" |
||
| 155 | > |
||
| 156 | >channels |
||
| 157 | > |
||
| 158 | > |
||
| 159 | > |
||
| 160 | ALIGN="LEFT" |
||
| 161 | VALIGN="TOP" |
||
| 162 | >Number of channels: 1 mono, 2 stereo |
||
| 163 | > |
||
| 164 | > |
||
| 165 | > |
||
| 166 | ALIGN="LEFT" |
||
| 167 | VALIGN="TOP" |
||
| 168 | > |
||
| 169 | CLASS="STRUCTFIELD" |
||
| 170 | > |
||
| 171 | >silence |
||
| 172 | > |
||
| 173 | > |
||
| 174 | > |
||
| 175 | ALIGN="LEFT" |
||
| 176 | VALIGN="TOP" |
||
| 177 | >Audio buffer silence value (calculated) |
||
| 178 | > |
||
| 179 | > |
||
| 180 | > |
||
| 181 | ALIGN="LEFT" |
||
| 182 | VALIGN="TOP" |
||
| 183 | > |
||
| 184 | CLASS="STRUCTFIELD" |
||
| 185 | > |
||
| 186 | >samples |
||
| 187 | > |
||
| 188 | > |
||
| 189 | > |
||
| 190 | ALIGN="LEFT" |
||
| 191 | VALIGN="TOP" |
||
| 192 | >Audio buffer size in samples |
||
| 193 | > |
||
| 194 | > |
||
| 195 | > |
||
| 196 | ALIGN="LEFT" |
||
| 197 | VALIGN="TOP" |
||
| 198 | > |
||
| 199 | CLASS="STRUCTFIELD" |
||
| 200 | > |
||
| 201 | >size |
||
| 202 | > |
||
| 203 | > |
||
| 204 | > |
||
| 205 | ALIGN="LEFT" |
||
| 206 | VALIGN="TOP" |
||
| 207 | >Audio buffer size in bytes (calculated) |
||
| 208 | > |
||
| 209 | > |
||
| 210 | > |
||
| 211 | ALIGN="LEFT" |
||
| 212 | VALIGN="TOP" |
||
| 213 | > |
||
| 214 | CLASS="STRUCTFIELD" |
||
| 215 | > |
||
| 216 | >callback(..) |
||
| 217 | > |
||
| 218 | > |
||
| 219 | > |
||
| 220 | ALIGN="LEFT" |
||
| 221 | VALIGN="TOP" |
||
| 222 | >Callback function for filling the audio buffer |
||
| 223 | > |
||
| 224 | > |
||
| 225 | > |
||
| 226 | ALIGN="LEFT" |
||
| 227 | VALIGN="TOP" |
||
| 228 | > |
||
| 229 | CLASS="STRUCTFIELD" |
||
| 230 | > |
||
| 231 | >userdata |
||
| 232 | > |
||
| 233 | > |
||
| 234 | > |
||
| 235 | ALIGN="LEFT" |
||
| 236 | VALIGN="TOP" |
||
| 237 | >Pointer the user data which is passed to the callback function |
||
| 238 | > |
||
| 239 | > |
||
| 240 | > |
||
| 241 | > |
||
| 242 | > |
||
| 243 | > |
||
| 244 | > |
||
| 245 | > |
||
| 246 | CLASS="REFSECT1" |
||
| 247 | > |
||
| 248 | NAME="AEN6003" |
||
| 249 | > |
||
| 250 | > |
||
| 251 | >Description |
||
| 252 | > |
||
| 253 | >The |
||
| 254 | CLASS="STRUCTNAME" |
||
| 255 | >SDL_AudioSpec |
||
| 256 | > structure is used to describe the format of some audio data. This structure is used by |
||
| 257 | HREF="sdlopenaudio.html" |
||
| 258 | > |
||
| 259 | CLASS="FUNCTION" |
||
| 260 | >SDL_OpenAudio |
||
| 261 | > |
||
| 262 | > and |
||
| 263 | HREF="sdlloadwav.html" |
||
| 264 | > |
||
| 265 | CLASS="FUNCTION" |
||
| 266 | >SDL_LoadWAV |
||
| 267 | > |
||
| 268 | >. While all fields are used by |
||
| 269 | CLASS="FUNCTION" |
||
| 270 | >SDL_OpenAudio |
||
| 271 | > only |
||
| 272 | CLASS="STRUCTFIELD" |
||
| 273 | > |
||
| 274 | >freq |
||
| 275 | > |
||
| 276 | >, |
||
| 277 | CLASS="STRUCTFIELD" |
||
| 278 | > |
||
| 279 | >format |
||
| 280 | > |
||
| 281 | >, |
||
| 282 | CLASS="STRUCTFIELD" |
||
| 283 | > |
||
| 284 | >samples |
||
| 285 | > |
||
| 286 | > and |
||
| 287 | CLASS="STRUCTFIELD" |
||
| 288 | > |
||
| 289 | >channels |
||
| 290 | > |
||
| 291 | > are used by |
||
| 292 | CLASS="FUNCTION" |
||
| 293 | >SDL_LoadWAV |
||
| 294 | >. We will detail these common members here. |
||
| 295 | > |
||
| 296 | CLASS="INFORMALTABLE" |
||
| 297 | > |
||
| 298 | NAME="AEN6017" |
||
| 299 | > |
||
| 300 | > |
||
| 301 | > |
||
| 302 | > |
||
| 303 | BORDER="0" |
||
| 304 | CLASS="CALSTABLE" |
||
| 305 | > |
||
| 306 | > |
||
| 307 | > |
||
| 308 | ALIGN="LEFT" |
||
| 309 | VALIGN="TOP" |
||
| 310 | > |
||
| 311 | CLASS="STRUCTFIELD" |
||
| 312 | > |
||
| 313 | >freq |
||
| 314 | > |
||
| 315 | > |
||
| 316 | > |
||
| 317 | ALIGN="LEFT" |
||
| 318 | VALIGN="TOP" |
||
| 319 | > |
||
| 320 | >The number of samples sent to the sound device every second. Common values are 11025, 22050 and 44100. The higher the better. |
||
| 321 | > |
||
| 322 | > |
||
| 323 | > |
||
| 324 | > |
||
| 325 | ALIGN="LEFT" |
||
| 326 | VALIGN="TOP" |
||
| 327 | > |
||
| 328 | CLASS="STRUCTFIELD" |
||
| 329 | > |
||
| 330 | >format |
||
| 331 | > |
||
| 332 | > |
||
| 333 | > |
||
| 334 | ALIGN="LEFT" |
||
| 335 | VALIGN="TOP" |
||
| 336 | > |
||
| 337 | >Specifies the size and type of each sample element |
||
| 338 | |||
| 339 | > |
||
| 340 | > |
||
| 341 | CLASS="VARIABLELIST" |
||
| 342 | > |
||
| 343 | > |
||
| 344 | > |
||
| 345 | CLASS="LITERAL" |
||
| 346 | >AUDIO_U8 |
||
| 347 | > |
||
| 348 | > |
||
| 349 | > |
||
| 350 | >Unsigned 8-bit samples |
||
| 351 | > |
||
| 352 | > |
||
| 353 | > |
||
| 354 | CLASS="LITERAL" |
||
| 355 | >AUDIO_S8 |
||
| 356 | > |
||
| 357 | > |
||
| 358 | > |
||
| 359 | >Signed 8-bit samples |
||
| 360 | > |
||
| 361 | > |
||
| 362 | > |
||
| 363 | CLASS="LITERAL" |
||
| 364 | >AUDIO_U16 |
||
| 365 | > or |
||
| 366 | CLASS="LITERAL" |
||
| 367 | >AUDIO_U16LSB |
||
| 368 | > |
||
| 369 | > |
||
| 370 | > |
||
| 371 | >Unsigned 16-bit little-endian samples |
||
| 372 | > |
||
| 373 | > |
||
| 374 | > |
||
| 375 | CLASS="LITERAL" |
||
| 376 | >AUDIO_S16 |
||
| 377 | > or |
||
| 378 | CLASS="LITERAL" |
||
| 379 | >AUDIO_S16LSB |
||
| 380 | > |
||
| 381 | > |
||
| 382 | > |
||
| 383 | >Signed 16-bit little-endian samples |
||
| 384 | > |
||
| 385 | > |
||
| 386 | > |
||
| 387 | CLASS="LITERAL" |
||
| 388 | >AUDIO_U16MSB |
||
| 389 | > |
||
| 390 | > |
||
| 391 | > |
||
| 392 | >Unsigned 16-bit big-endian samples |
||
| 393 | > |
||
| 394 | > |
||
| 395 | > |
||
| 396 | CLASS="LITERAL" |
||
| 397 | >AUDIO_S16MSB |
||
| 398 | > |
||
| 399 | > |
||
| 400 | > |
||
| 401 | >Signed 16-bit big-endian samples |
||
| 402 | > |
||
| 403 | > |
||
| 404 | > |
||
| 405 | CLASS="LITERAL" |
||
| 406 | >AUDIO_U16SYS |
||
| 407 | > |
||
| 408 | > |
||
| 409 | > |
||
| 410 | >Either |
||
| 411 | CLASS="LITERAL" |
||
| 412 | >AUDIO_U16LSB |
||
| 413 | > or |
||
| 414 | CLASS="LITERAL" |
||
| 415 | >AUDIO_U16MSB |
||
| 416 | > depending on you systems endianness |
||
| 417 | > |
||
| 418 | > |
||
| 419 | > |
||
| 420 | CLASS="LITERAL" |
||
| 421 | >AUDIO_S16SYS |
||
| 422 | > |
||
| 423 | > |
||
| 424 | > |
||
| 425 | >Either |
||
| 426 | CLASS="LITERAL" |
||
| 427 | >AUDIO_S16LSB |
||
| 428 | > or |
||
| 429 | CLASS="LITERAL" |
||
| 430 | >AUDIO_S16MSB |
||
| 431 | > depending on you systems endianness |
||
| 432 | > |
||
| 433 | > |
||
| 434 | > |
||
| 435 | > |
||
| 436 | > |
||
| 437 | > |
||
| 438 | > |
||
| 439 | > |
||
| 440 | ALIGN="LEFT" |
||
| 441 | VALIGN="TOP" |
||
| 442 | > |
||
| 443 | CLASS="STRUCTFIELD" |
||
| 444 | > |
||
| 445 | >channels |
||
| 446 | > |
||
| 447 | > |
||
| 448 | > |
||
| 449 | ALIGN="LEFT" |
||
| 450 | VALIGN="TOP" |
||
| 451 | >The number of seperate sound channels. 1 is mono (single channel), 2 is stereo (dual channel). |
||
| 452 | > |
||
| 453 | > |
||
| 454 | > |
||
| 455 | ALIGN="LEFT" |
||
| 456 | VALIGN="TOP" |
||
| 457 | > |
||
| 458 | CLASS="STRUCTFIELD" |
||
| 459 | > |
||
| 460 | >samples |
||
| 461 | > |
||
| 462 | > |
||
| 463 | > |
||
| 464 | ALIGN="LEFT" |
||
| 465 | VALIGN="TOP" |
||
| 466 | >When used with |
||
| 467 | HREF="sdlopenaudio.html" |
||
| 468 | > |
||
| 469 | CLASS="FUNCTION" |
||
| 470 | >SDL_OpenAudio |
||
| 471 | > |
||
| 472 | > this refers to the size of the audio buffer in samples. A sample a chunk of audio data of the size specified in |
||
| 473 | CLASS="PARAMETER" |
||
| 474 | > |
||
| 475 | >format |
||
| 476 | > |
||
| 477 | > mulitplied by the number of channels. When the |
||
| 478 | CLASS="STRUCTNAME" |
||
| 479 | >SDL_AudioSpec |
||
| 480 | > is used with |
||
| 481 | HREF="sdlloadwav.html" |
||
| 482 | > |
||
| 483 | CLASS="FUNCTION" |
||
| 484 | >SDL_LoadWAV |
||
| 485 | > |
||
| 486 | > |
||
| 487 | CLASS="STRUCTFIELD" |
||
| 488 | > |
||
| 489 | >samples |
||
| 490 | > |
||
| 491 | > is set to 4096. |
||
| 492 | > |
||
| 493 | > |
||
| 494 | > |
||
| 495 | > |
||
| 496 | > |
||
| 497 | > |
||
| 498 | > |
||
| 499 | > |
||
| 500 | CLASS="REFSECT1" |
||
| 501 | > |
||
| 502 | NAME="AEN6092" |
||
| 503 | > |
||
| 504 | > |
||
| 505 | >See Also |
||
| 506 | > |
||
| 507 | > |
||
| 508 | HREF="sdlopenaudio.html" |
||
| 509 | > |
||
| 510 | CLASS="FUNCTION" |
||
| 511 | >SDL_OpenAudio |
||
| 512 | > |
||
| 513 | >, |
||
| 514 | |||
| 515 | HREF="sdlloadwav.html" |
||
| 516 | > |
||
| 517 | CLASS="FUNCTION" |
||
| 518 | >SDL_LoadWAV |
||
| 519 | > |
||
| 520 | > |
||
| 521 | > |
||
| 522 | > |
||
| 523 | CLASS="NAVFOOTER" |
||
| 524 | > |
||
| 525 | ALIGN="LEFT" |
||
| 526 | WIDTH="100%"> |
||
| 527 | WIDTH="100%" |
||
| 528 | BORDER="0" |
||
| 529 | CELLPADDING="0" |
||
| 530 | CELLSPACING="0" |
||
| 531 | > |
||
| 532 | > |
||
| 533 | WIDTH="33%" |
||
| 534 | ALIGN="left" |
||
| 535 | VALIGN="top" |
||
| 536 | > |
||
| 537 | HREF="audio.html" |
||
| 538 | >Prev |
||
| 539 | > |
||
| 540 | > |
||
| 541 | WIDTH="34%" |
||
| 542 | ALIGN="center" |
||
| 543 | VALIGN="top" |
||
| 544 | > |
||
| 545 | HREF="index.html" |
||
| 546 | >Home |
||
| 547 | > |
||
| 548 | > |
||
| 549 | WIDTH="33%" |
||
| 550 | ALIGN="right" |
||
| 551 | VALIGN="top" |
||
| 552 | > |
||
| 553 | HREF="sdlopenaudio.html" |
||
| 554 | >Next |
||
| 555 | > |
||
| 556 | > |
||
| 557 | > |
||
| 558 | > |
||
| 559 | WIDTH="33%" |
||
| 560 | ALIGN="left" |
||
| 561 | VALIGN="top" |
||
| 562 | >Audio |
||
| 563 | > |
||
| 564 | WIDTH="34%" |
||
| 565 | ALIGN="center" |
||
| 566 | VALIGN="top" |
||
| 567 | > |
||
| 568 | HREF="audio.html" |
||
| 569 | >Up |
||
| 570 | > |
||
| 571 | > |
||
| 572 | WIDTH="33%" |
||
| 573 | ALIGN="right" |
||
| 574 | VALIGN="top" |
||
| 575 | >SDL_OpenAudio |
||
| 576 | > |
||
| 577 | > |
||
| 578 | > |
||
| 579 | > |
||
| 580 | > |
||
| 581 | > |