summaryrefslogtreecommitdiff
path: root/lib/libsndio/sio_open.3
AgeCommit message (Collapse)Author
2020-11-29Clarify what sio_start() does exactlyAlexandre Ratchov
Suggested by Erico Nogueira <ericonr@disroot.org>, help from and ok jmc@, schwarze@
2020-11-20* Add SIO_BPS() to NAME and SYNOPSIS where it is missing.Ingo Schwarze
* Use .Fn rather than .Dv for macros taking arguments. * Actually say what SIO_LE_NATIVE means. * Add closely related APIs to SEE ALSO. * Add missing HISTORY and AUTHORS sections. OK ratchov@
2020-06-20basic macro cleanup: .Fo for long .Fn lines, .Fa for struct fields,Ingo Schwarze
avoid \*(Gt and \*(Lt, .Dv NULL, .Cm for pledge promises
2020-04-21move mixerctl and audioctl man pages to section 8, as these workTheo de Raadt
against root-only device nodes.
2019-01-18Sayt that using capabilities to negociate audio parameters (ie usingAlexandre Ratchov
sio_getcap() function) is not recomended. From Paul Swanson <psw at protonmail.com>, ok jmc
2018-07-28Move libsndio session cookie in its own $HOME/.sndio/ directory toAlexandre Ratchov
make libsndio easier to use with unveil(2). "make sense" deraadt
2017-01-03Tweak RETURN VALUES section. Move description of sio_pollfd() andMartin Natano
sio_nfds() return values there and add a paragraph about sio_eof(). ok jmc ratchov
2016-02-11Document how to use sndio in pledged programs.Tim van der Molen
Input and OK jmc@ ratchov@ semarie@
2016-01-07Move sndiod man page to section 8.Alexandre Ratchov
suggested by deraadt, fixes from jmc, ok millert
2015-09-14Remove useless quoting from .Fo and .Fn function names, to preventIngo Schwarze
development of a cargo cult in case people look at existing files for examples. This achieves a consistent .Fo and .Fn quoting style across the whole tree.
2014-12-02Kill the only instance of .Lb in our tree. It is better to not useIngo Schwarze
it at all, not even occasionally, because there is no sustainable way (and even less any portable way) to maintain the list of library names. Besides, without such a list, even the formatting looks bad. OK jmc@ bentley@
2014-03-05say this is the "sndio" api, as we have other audio/midi apis,Alexandre Ratchov
makes "man -k" happier. ok jmc, schwarze
2014-01-22clean up macro usage;Ingo Schwarze
tweak and ok ratchov@, ok jmc@
2013-12-23- clarify that sio_close() stops the device first, thenAlexandre Ratchov
frees the handle and not the opposite - clarify that sio_close() and sio_stop() dont discard samples in the play buffer. suggested by Reimar Doeffinger <Reimar.Doeffinger at gmx.de> ok jmc@
2013-12-22- replaces "audio stream" by "audio device", as sndio is a deviceAlexandre Ratchov
abstraction - remove useless statements. ok jmc@
2013-07-04remove FILES sections because it's incomplete, wrong and doesn't giveAlexandre Ratchov
any useful information
2013-07-04shorten lines in literal blocks to avoid word wrapingAlexandre Ratchov
2013-06-05use fancy .In macro for includes. from Jan Klemkow. ok jmc schwarzeTed Unangst
2013-04-06explain what "default" means in sndio.7 rather than {sio,mio}_open.3,Alexandre Ratchov
with tweaks from jmc
2012-05-23Make the "default" string a valid device name that has the same effectAlexandre Ratchov
as NULL has. This will (hopefully) simplify ports where the user passes the device string.
2012-04-11Use "unsigned int" rather than "unsigned". No object change.Alexandre Ratchov
suggested by deraadt@
2011-12-24formatting errors, found using freebsd's "igor";Jason McIntyre
2011-12-09mention sndiod rather than aucat when talking about the serverAlexandre Ratchov
2011-10-17Remove midicat since aucat can now be used instead of midicatAlexandre Ratchov
with almost the same syntax (roughly an extra -M option). Thru boxes are created with aucat, and corresponding MIDI port names have the "aucat" prefix instead of "midithru". The old device name will still work some time for backward compatibility. ok deraadt
2011-10-04some tweaks, from Tim van der MolenJason McIntyre
2011-04-16Make aucat audio and midi backends share the same code to communicateAlexandre Ratchov
with the server. As we're at it use the same protocol for midi and audio. Now, both audio and midi code use the same SNDIO_DEBUG environment variable to turn on/off DPRINTF's.
2010-11-06tweak previous;Jason McIntyre
2010-11-06make sio_onvol(3) return a integer exposing whether a volume knobAlexandre Ratchov
is available for the stream. As we're at it, remove macros and functions that are neither used nor documented.
2010-04-26once sio_start() has been called, stream parameters cannot beJacob Meuser
changed until after sio_stop() is called ok ratchov@, jmc@
2010-04-06aucat (server):Alexandre Ratchov
- make the ``-m mode'' option per subdevice, allowing subdevices to be play-only or rec-only even if the server is full-duplex - add ``monitoring'' mode (with ``-m mon''). This is a record-only stream from which played streams can be recorded (kind of ``record what you hear''). - allow MIDI devices to be subscribed to the controlling MIDI port of the server, ie what midicat does (with -f option), but using the -q option. - add flow control to the protocol, and serialize clock ticks (sio_onmove() calls) and data chunks. This should fix certain full-duplex programs, broken with ``magic'' block/buffer size combinations. - enable 3 block latency which is the minimum theoretical. Make -z and -b options correspond to device parameters. - make sio_getcap(3) the same for aucat and sun backends, ie return whatever is supported (``everything'' in the aucat case, since everything is actulally supported). aucat (player): - enable ``-m mode'' option to select between monitoring and recording when ``-o file'' is used. - plug MIDI code to non-server codepath. The MIDI control device is specified with the ``-q device'' option, as in server mode. - impliment lseek()'ing within files (controlled through MIDI). Necessary to use aucat with a MIDI sequencer. midicat (thrubox): - rename ``-f'' flag to ``-q'', so it has the same name as in aucat (-f is still working) ok jakemsr@, tweaks from jmc@
2009-12-30explain what sio_close() drains play buffers as if sio_close() wasAlexandre Ratchov
called. Since sio_onmove() callback doesn't return negative deltas anymore, slightly simplify related paragraphs. siggested by espie@, ok jakemsr@
2009-07-25use const qualifier in libsndio, making it slightly more consistentAlexandre Ratchov
with open(2) and write(2) syscalls. from Thomas Pfaff, jakemsr is fine with it
2009-07-25Currently midi capable programs can control midi hardware, butAlexandre Ratchov
cannot cooperate with other programs. The aim of this change is to allow any program to send midi data to other programs as they were midi hardware. For instance, this change should solve the longstanding problem of using a midi sequencer with software synthesizers. More precisely: - new midicat(1) utility (actually hardlink to aucat(1)). it creates software midi thru boxes, allowing programs to send midi messages to other programs as they were midi(4) hardware. - new midi api in libsndio (see mio_open(3)), to access midi(4) devices and midicat(1) sockets in a uniform way. - new device naming scheme <service>:<unit>[.<option>], common to audio and midi. - new sndio(7) manual describing concepts and naming The current audio device naming still works, but people having scripts or configuration files containing device names could read the sndio(7) man page and slowly start updating device names. discussed with jakemsr@ and deraadt@, help form jmc@
2009-05-15describe sio_getcap(), sio_pollfd() and sio_setvol() retrurn valuesAlexandre Ratchov
spotted by Philipp Schafft
2009-02-04update the default socket paths, to reflect recent aucat changesAlexandre Ratchov
2009-02-04explain that it's ok if we get a slightly different rate thanAlexandre Ratchov
the one we asked for, from Thomas Pfaff <tpfaff(at)tp76.info> with tweaks from jmc@
2009-01-21fix bugs section: clarify that sio_start() and sio_stop() shouldAlexandre Ratchov
not be used if blocking is not desirable.
2009-01-21explain what ``frame'' does meanAlexandre Ratchov
from Thomas Pfaff <tpfaff(at)tp76.info>, thanks! ok jmc
2009-01-12replace s/routine/function/, as other manuals doAlexandre Ratchov
from Thomas Pfaff <tpfaff(at)tp76.info>, thanks! ok jmc@
2009-01-08oops, i messed up tim's patch; correction from Tim van der MolenJason McIntyre
2009-01-08a little macro cleanup; from Tim van der MolenJason McIntyre
2008-12-17stop using stderr in the library, wrap all diagnostic fprintfsAlexandre Ratchov
so they are visible only when the DEBUG macro is #defined and SIO_DEBUG env. variable is set. requested by many, discussed with jakemsr
2008-12-17tweak previous;Jason McIntyre
2008-12-17add a writable ``appbufsz'' field to the sa_par structure, containingAlexandre Ratchov
the program-part of the buffer size, ie the part that is subject to underruns. Useful for apps like cdio(1) that don't have their own rings, or to apps that have a minimum ring size constraint. Setting the ``bufsz'' parameter becomes deprecated. ok jakemsr
2008-11-17occures -> occurs;Jason McIntyre
2008-11-16document that sio_revents() can return POLLHUPAlexandre Ratchov
2008-11-11tweak previous;Jason McIntyre
2008-11-11expose a volume knob in the sndio API: add sio_setvol(3) andAlexandre Ratchov
sio_onvol(3) functions. The audio(4) backend tries to use the inputs.dac, outputs.dac, outputs.output and outputs.master controls (in this order). Add a sample file in regress/lib/libsndio/vol/vol.c
2008-11-09typos; ok ratchov@ jmc@Christian Weisgerber
2008-11-07expose the block size in the sndio API by making par->round writableAlexandre Ratchov
and thus remove the ugly rate <-> block-size table from sio_setpar(3). Handle the block size negociation in aucat(1), since it has few constrains the code is overally simpler. ok jakemsr@, major crank suggested by deraadt@