diff options
Diffstat (limited to 'apps/plugins/rockboy/HACKING')
-rw-r--r-- | apps/plugins/rockboy/HACKING | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/apps/plugins/rockboy/HACKING b/apps/plugins/rockboy/HACKING index 3efd85ed9b..b0b9169ae9 100644 --- a/apps/plugins/rockboy/HACKING +++ b/apps/plugins/rockboy/HACKING | |||
@@ -364,22 +364,22 @@ called before reading or writing a sound register, and at the end of | |||
364 | each frame. | 364 | each frame. |
365 | 365 | ||
366 | The main sound module interfaces with the system-specific code through | 366 | The main sound module interfaces with the system-specific code through |
367 | one structure, pcm, and a few functions: pcm_init, pcm_close, and | 367 | one structure, pcm, and a few functions: rockboy_pcm_init, rockboy_pcm_close, and |
368 | pcm_submit. While the first two should be obvious, pcm_submit needs | 368 | rockboy_pcm_submit. While the first two should be obvious, rockboy_pcm_submit needs |
369 | some explaining. Whenever realtime sound output is operational, | 369 | some explaining. Whenever realtime sound output is operational, |
370 | pcm_submit is responsible for timing, and should not return until it | 370 | rockboy_pcm_submit is responsible for timing, and should not return until it |
371 | has successfully processed all the data in its input buffer (pcm.buf). | 371 | has successfully processed all the data in its input buffer (pcm.buf). |
372 | On *nix sound devices, this typically means just waiting for the write | 372 | On *nix sound devices, this typically means just waiting for the write |
373 | syscall to return, but on systems such as DOS where low level IO must | 373 | syscall to return, but on systems such as DOS where low level IO must |
374 | be handled in the program, pcm_submit needs to delay until the current | 374 | be handled in the program, rockboy_pcm_submit needs to delay until the current |
375 | position in the DMA buffer has advanced sufficiently to make space for | 375 | position in the DMA buffer has advanced sufficiently to make space for |
376 | the new samples, then copy them. | 376 | the new samples, then copy them. |
377 | 377 | ||
378 | For special sound output implementations like write-to-file or the | 378 | For special sound output implementations like write-to-file or the |
379 | dummy sound device, pcm_submit should write the data immediately and | 379 | dummy sound device, rockboy_pcm_submit should write the data immediately and |
380 | return 0, indicating to the caller that other methods must be used for | 380 | return 0, indicating to the caller that other methods must be used for |
381 | timing. On real sound devices that are presently functional, | 381 | timing. On real sound devices that are presently functional, |
382 | pcm_submit should return 1, regardless of whether it buffered or | 382 | rockboy_pcm_submit should return 1, regardless of whether it buffered or |
383 | actually wrote the sound data. | 383 | actually wrote the sound data. |
384 | 384 | ||
385 | And yes, for unices without OSS, we hope to add piped audio output | 385 | And yes, for unices without OSS, we hope to add piped audio output |