summaryrefslogtreecommitdiff
path: root/apps/plugins/rockboy/HACKING
diff options
context:
space:
mode:
authorRafaël Carré <rafael.carre@gmail.com>2010-05-27 12:00:23 +0000
committerRafaël Carré <rafael.carre@gmail.com>2010-05-27 12:00:23 +0000
commitb36e721aa66e20595eb4441edaaddac76f8d5147 (patch)
tree09bf0d917cb6d04714ef9c21c26ee9f1a2a3d4d1 /apps/plugins/rockboy/HACKING
parentb0146de64cdcd581f4d179262d2361622c8de096 (diff)
downloadrockbox-b36e721aa66e20595eb4441edaaddac76f8d5147.tar.gz
rockbox-b36e721aa66e20595eb4441edaaddac76f8d5147.zip
rockboy: rename pcm_*() functions to avoid namespace clash with rockbox
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@26327 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'apps/plugins/rockboy/HACKING')
-rw-r--r--apps/plugins/rockboy/HACKING12
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
364each frame. 364each frame.
365 365
366The main sound module interfaces with the system-specific code through 366The main sound module interfaces with the system-specific code through
367one structure, pcm, and a few functions: pcm_init, pcm_close, and 367one structure, pcm, and a few functions: rockboy_pcm_init, rockboy_pcm_close, and
368pcm_submit. While the first two should be obvious, pcm_submit needs 368rockboy_pcm_submit. While the first two should be obvious, rockboy_pcm_submit needs
369some explaining. Whenever realtime sound output is operational, 369some explaining. Whenever realtime sound output is operational,
370pcm_submit is responsible for timing, and should not return until it 370rockboy_pcm_submit is responsible for timing, and should not return until it
371has successfully processed all the data in its input buffer (pcm.buf). 371has successfully processed all the data in its input buffer (pcm.buf).
372On *nix sound devices, this typically means just waiting for the write 372On *nix sound devices, this typically means just waiting for the write
373syscall to return, but on systems such as DOS where low level IO must 373syscall to return, but on systems such as DOS where low level IO must
374be handled in the program, pcm_submit needs to delay until the current 374be handled in the program, rockboy_pcm_submit needs to delay until the current
375position in the DMA buffer has advanced sufficiently to make space for 375position in the DMA buffer has advanced sufficiently to make space for
376the new samples, then copy them. 376the new samples, then copy them.
377 377
378For special sound output implementations like write-to-file or the 378For special sound output implementations like write-to-file or the
379dummy sound device, pcm_submit should write the data immediately and 379dummy sound device, rockboy_pcm_submit should write the data immediately and
380return 0, indicating to the caller that other methods must be used for 380return 0, indicating to the caller that other methods must be used for
381timing. On real sound devices that are presently functional, 381timing. On real sound devices that are presently functional,
382pcm_submit should return 1, regardless of whether it buffered or 382rockboy_pcm_submit should return 1, regardless of whether it buffered or
383actually wrote the sound data. 383actually wrote the sound data.
384 384
385And yes, for unices without OSS, we hope to add piped audio output 385And yes, for unices without OSS, we hope to add piped audio output