hsc3-process (empty) → 0.0.0
raw patch · 11 files changed
+941/−0 lines, 11 filesdep +ConfigFiledep +basedep +containerssetup-changed
Dependencies added: ConfigFile, base, containers, data-accessor, data-accessor-template, hosc, mtl, process, template-haskell
Files
- LICENSE +339/−0
- Setup.hs +4/−0
- Sound/SC3/Server/Process.hs +132/−0
- Sound/SC3/Server/Process/Accessor.hs +10/−0
- Sound/SC3/Server/Process/CommandLine.hs +91/−0
- Sound/SC3/Server/Process/ConfigFile.hs +139/−0
- Sound/SC3/Server/Process/Options.hs +155/−0
- examples/config.hs +14/−0
- examples/scsynth.cfg +6/−0
- examples/sine.hs +13/−0
- hsc3-process.cabal +38/−0
+ LICENSE view
@@ -0,0 +1,339 @@+ GNU GENERAL PUBLIC LICENSE+ Version 2, June 1991++ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA+ Everyone is permitted to copy and distribute verbatim copies+ of this license document, but changing it is not allowed.++ Preamble++ The licenses for most software are designed to take away your+freedom to share and change it. By contrast, the GNU General Public+License is intended to guarantee your freedom to share and change free+software--to make sure the software is free for all its users. This+General Public License applies to most of the Free Software+Foundation's software and to any other program whose authors commit to+using it. (Some other Free Software Foundation software is covered by+the GNU Lesser General Public License instead.) You can apply it to+your programs, too.++ When we speak of free software, we are referring to freedom, not+price. Our General Public Licenses are designed to make sure that you+have the freedom to distribute copies of free software (and charge for+this service if you wish), that you receive source code or can get it+if you want it, that you can change the software or use pieces of it+in new free programs; and that you know you can do these things.++ To protect your rights, we need to make restrictions that forbid+anyone to deny you these rights or to ask you to surrender the rights.+These restrictions translate to certain responsibilities for you if you+distribute copies of the software, or if you modify it.++ For example, if you distribute copies of such a program, whether+gratis or for a fee, you must give the recipients all the rights that+you have. You must make sure that they, too, receive or can get the+source code. And you must show them these terms so they know their+rights.++ We protect your rights with two steps: (1) copyright the software, and+(2) offer you this license which gives you legal permission to copy,+distribute and/or modify the software.++ Also, for each author's protection and ours, we want to make certain+that everyone understands that there is no warranty for this free+software. If the software is modified by someone else and passed on, we+want its recipients to know that what they have is not the original, so+that any problems introduced by others will not reflect on the original+authors' reputations.++ Finally, any free program is threatened constantly by software+patents. We wish to avoid the danger that redistributors of a free+program will individually obtain patent licenses, in effect making the+program proprietary. To prevent this, we have made it clear that any+patent must be licensed for everyone's free use or not licensed at all.++ The precise terms and conditions for copying, distribution and+modification follow.++ GNU GENERAL PUBLIC LICENSE+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION++ 0. This License applies to any program or other work which contains+a notice placed by the copyright holder saying it may be distributed+under the terms of this General Public License. The "Program", below,+refers to any such program or work, and a "work based on the Program"+means either the Program or any derivative work under copyright law:+that is to say, a work containing the Program or a portion of it,+either verbatim or with modifications and/or translated into another+language. (Hereinafter, translation is included without limitation in+the term "modification".) Each licensee is addressed as "you".++Activities other than copying, distribution and modification are not+covered by this License; they are outside its scope. The act of+running the Program is not restricted, and the output from the Program+is covered only if its contents constitute a work based on the+Program (independent of having been made by running the Program).+Whether that is true depends on what the Program does.++ 1. You may copy and distribute verbatim copies of the Program's+source code as you receive it, in any medium, provided that you+conspicuously and appropriately publish on each copy an appropriate+copyright notice and disclaimer of warranty; keep intact all the+notices that refer to this License and to the absence of any warranty;+and give any other recipients of the Program a copy of this License+along with the Program.++You may charge a fee for the physical act of transferring a copy, and+you may at your option offer warranty protection in exchange for a fee.++ 2. You may modify your copy or copies of the Program or any portion+of it, thus forming a work based on the Program, and copy and+distribute such modifications or work under the terms of Section 1+above, provided that you also meet all of these conditions:++ a) You must cause the modified files to carry prominent notices+ stating that you changed the files and the date of any change.++ b) You must cause any work that you distribute or publish, that in+ whole or in part contains or is derived from the Program or any+ part thereof, to be licensed as a whole at no charge to all third+ parties under the terms of this License.++ c) If the modified program normally reads commands interactively+ when run, you must cause it, when started running for such+ interactive use in the most ordinary way, to print or display an+ announcement including an appropriate copyright notice and a+ notice that there is no warranty (or else, saying that you provide+ a warranty) and that users may redistribute the program under+ these conditions, and telling the user how to view a copy of this+ License. (Exception: if the Program itself is interactive but+ does not normally print such an announcement, your work based on+ the Program is not required to print an announcement.)++These requirements apply to the modified work as a whole. If+identifiable sections of that work are not derived from the Program,+and can be reasonably considered independent and separate works in+themselves, then this License, and its terms, do not apply to those+sections when you distribute them as separate works. But when you+distribute the same sections as part of a whole which is a work based+on the Program, the distribution of the whole must be on the terms of+this License, whose permissions for other licensees extend to the+entire whole, and thus to each and every part regardless of who wrote it.++Thus, it is not the intent of this section to claim rights or contest+your rights to work written entirely by you; rather, the intent is to+exercise the right to control the distribution of derivative or+collective works based on the Program.++In addition, mere aggregation of another work not based on the Program+with the Program (or with a work based on the Program) on a volume of+a storage or distribution medium does not bring the other work under+the scope of this License.++ 3. You may copy and distribute the Program (or a work based on it,+under Section 2) in object code or executable form under the terms of+Sections 1 and 2 above provided that you also do one of the following:++ a) Accompany it with the complete corresponding machine-readable+ source code, which must be distributed under the terms of Sections+ 1 and 2 above on a medium customarily used for software interchange; or,++ b) Accompany it with a written offer, valid for at least three+ years, to give any third party, for a charge no more than your+ cost of physically performing source distribution, a complete+ machine-readable copy of the corresponding source code, to be+ distributed under the terms of Sections 1 and 2 above on a medium+ customarily used for software interchange; or,++ c) Accompany it with the information you received as to the offer+ to distribute corresponding source code. (This alternative is+ allowed only for noncommercial distribution and only if you+ received the program in object code or executable form with such+ an offer, in accord with Subsection b above.)++The source code for a work means the preferred form of the work for+making modifications to it. For an executable work, complete source+code means all the source code for all modules it contains, plus any+associated interface definition files, plus the scripts used to+control compilation and installation of the executable. However, as a+special exception, the source code distributed need not include+anything that is normally distributed (in either source or binary+form) with the major components (compiler, kernel, and so on) of the+operating system on which the executable runs, unless that component+itself accompanies the executable.++If distribution of executable or object code is made by offering+access to copy from a designated place, then offering equivalent+access to copy the source code from the same place counts as+distribution of the source code, even though third parties are not+compelled to copy the source along with the object code.++ 4. You may not copy, modify, sublicense, or distribute the Program+except as expressly provided under this License. Any attempt+otherwise to copy, modify, sublicense or distribute the Program is+void, and will automatically terminate your rights under this License.+However, parties who have received copies, or rights, from you under+this License will not have their licenses terminated so long as such+parties remain in full compliance.++ 5. You are not required to accept this License, since you have not+signed it. However, nothing else grants you permission to modify or+distribute the Program or its derivative works. These actions are+prohibited by law if you do not accept this License. Therefore, by+modifying or distributing the Program (or any work based on the+Program), you indicate your acceptance of this License to do so, and+all its terms and conditions for copying, distributing or modifying+the Program or works based on it.++ 6. Each time you redistribute the Program (or any work based on the+Program), the recipient automatically receives a license from the+original licensor to copy, distribute or modify the Program subject to+these terms and conditions. You may not impose any further+restrictions on the recipients' exercise of the rights granted herein.+You are not responsible for enforcing compliance by third parties to+this License.++ 7. If, as a consequence of a court judgment or allegation of patent+infringement or for any other reason (not limited to patent issues),+conditions are imposed on you (whether by court order, agreement or+otherwise) that contradict the conditions of this License, they do not+excuse you from the conditions of this License. If you cannot+distribute so as to satisfy simultaneously your obligations under this+License and any other pertinent obligations, then as a consequence you+may not distribute the Program at all. For example, if a patent+license would not permit royalty-free redistribution of the Program by+all those who receive copies directly or indirectly through you, then+the only way you could satisfy both it and this License would be to+refrain entirely from distribution of the Program.++If any portion of this section is held invalid or unenforceable under+any particular circumstance, the balance of the section is intended to+apply and the section as a whole is intended to apply in other+circumstances.++It is not the purpose of this section to induce you to infringe any+patents or other property right claims or to contest validity of any+such claims; this section has the sole purpose of protecting the+integrity of the free software distribution system, which is+implemented by public license practices. Many people have made+generous contributions to the wide range of software distributed+through that system in reliance on consistent application of that+system; it is up to the author/donor to decide if he or she is willing+to distribute software through any other system and a licensee cannot+impose that choice.++This section is intended to make thoroughly clear what is believed to+be a consequence of the rest of this License.++ 8. If the distribution and/or use of the Program is restricted in+certain countries either by patents or by copyrighted interfaces, the+original copyright holder who places the Program under this License+may add an explicit geographical distribution limitation excluding+those countries, so that distribution is permitted only in or among+countries not thus excluded. In such case, this License incorporates+the limitation as if written in the body of this License.++ 9. The Free Software Foundation may publish revised and/or new versions+of the General Public License from time to time. Such new versions will+be similar in spirit to the present version, but may differ in detail to+address new problems or concerns.++Each version is given a distinguishing version number. If the Program+specifies a version number of this License which applies to it and "any+later version", you have the option of following the terms and conditions+either of that version or of any later version published by the Free+Software Foundation. If the Program does not specify a version number of+this License, you may choose any version ever published by the Free Software+Foundation.++ 10. If you wish to incorporate parts of the Program into other free+programs whose distribution conditions are different, write to the author+to ask for permission. For software which is copyrighted by the Free+Software Foundation, write to the Free Software Foundation; we sometimes+make exceptions for this. Our decision will be guided by the two goals+of preserving the free status of all derivatives of our free software and+of promoting the sharing and reuse of software generally.++ NO WARRANTY++ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,+REPAIR OR CORRECTION.++ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE+POSSIBILITY OF SUCH DAMAGES.++ END OF TERMS AND CONDITIONS++ How to Apply These Terms to Your New Programs++ If you develop a new program, and you want it to be of the greatest+possible use to the public, the best way to achieve this is to make it+free software which everyone can redistribute and change under these terms.++ To do so, attach the following notices to the program. It is safest+to attach them to the start of each source file to most effectively+convey the exclusion of warranty; and each file should have at least+the "copyright" line and a pointer to where the full notice is found.++ <one line to give the program's name and a brief idea of what it does.>+ Copyright (C) <year> <name of author>++ This program is free software; you can redistribute it and/or modify+ it under the terms of the GNU General Public License as published by+ the Free Software Foundation; either version 2 of the License, or+ (at your option) any later version.++ This program is distributed in the hope that it will be useful,+ but WITHOUT ANY WARRANTY; without even the implied warranty of+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the+ GNU General Public License for more details.++ You should have received a copy of the GNU General Public License along+ with this program; if not, write to the Free Software Foundation, Inc.,+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.++Also add information on how to contact you by electronic and paper mail.++If the program is interactive, make it output a short notice like this+when it starts in an interactive mode:++ Gnomovision version 69, Copyright (C) year name of author+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.+ This is free software, and you are welcome to redistribute it+ under certain conditions; type `show c' for details.++The hypothetical commands `show w' and `show c' should show the appropriate+parts of the General Public License. Of course, the commands you use may+be called something other than `show w' and `show c'; they could even be+mouse-clicks or menu items--whatever suits your program.++You should also get your employer (if you work as a programmer) or your+school, if any, to sign a "copyright disclaimer" for the program, if+necessary. Here is a sample; alter the names:++ Yoyodyne, Inc., hereby disclaims all copyright interest in the program+ `Gnomovision' (which makes passes at compilers) written by James Hacker.++ <signature of Ty Coon>, 1 April 1989+ Ty Coon, President of Vice++This General Public License does not permit incorporating your program into+proprietary programs. If your program is a subroutine library, you may+consider it more useful to permit linking proprietary applications with the+library. If this is what you want to do, use the GNU Lesser General+Public License instead of this License.
+ Setup.hs view
@@ -0,0 +1,4 @@+#!/usr/bin/env runhaskell++import Distribution.Simple+main = defaultMain
+ Sound/SC3/Server/Process.hs view
@@ -0,0 +1,132 @@+-- | This module includes utilities for spawning an external scsynth process,+-- either for realtime or non-realtime execution.+module Sound.SC3.Server.Process (+ module Sound.SC3.Server.Process.Options,+ commandLine,+ EventHandler(..),+ _onBoot,+ _onPutString,+ _onPutError,+ defaultEventHandler,+ withSynth,+ withNRT+) where++import Sound.OpenSoundControl (Transport, TCP, UDP, openTCP, openUDP)+import Control.Concurrent (forkIO)+import Control.Monad (unless)+import Prelude hiding (catch)+import Data.List (isPrefixOf)++import Sound.SC3.Server.Process.Accessor (deriveAccessors)+import Sound.SC3.Server.Process.Options+import Sound.SC3.Server.Process.CommandLine++import System.Exit (ExitCode)+import System.IO (Handle, hGetLine, hIsEOF, hPutStrLn, stderr, stdout)+import System.Process (runInteractiveProcess, waitForProcess)++-- | Helper class for polymorphic opening of network connections.+class OpenTransport t where+ openTransport :: RTOptions -> String -> IO t++-- | Check wether a network port is within the valid range (0, 65535]+checkPort :: String -> Int -> Int+checkPort tag p | p <= 0 || p > 65535 = error ("Invalid " ++ tag ++ " port " ++ show p)+checkPort _ p = p++instance OpenTransport (UDP) where+ openTransport options server = openUDP server (checkPort "UDP" $ udpPortNumber options)++instance OpenTransport (TCP) where+ openTransport options server = openTCP server (checkPort "TCP" $ tcpPortNumber options)++-- ====================================================================+-- * Event handler++-- | Event handler for handling I/O with external @scsynth@ processes,+-- parameterized by the I/O handle used for sending OSC commands to the+-- server.+data EventHandler t = EventHandler {+ onPutString :: String -> IO (), -- ^ Handle one line of normal output+ onPutError :: String -> IO (), -- ^ Handle one line of error output+ onBoot :: t -> IO () -- ^ Executed with the OSC handle after the server has booted+}++$(deriveAccessors ''EventHandler)++-- | Default event handler, writing to stdout and stderr, respectively.+defaultEventHandler :: EventHandler t+defaultEventHandler = EventHandler {+ onPutString = hPutStrLn stdout,+ onPutError = hPutStrLn stderr,+ onBoot = const (return ())+}++-- ====================================================================+-- Process helpers++pipeOutput :: (String -> IO ()) -> Handle -> IO ()+pipeOutput f h = hIsEOF h >>= flip unless (hGetLine h >>= f >> pipeOutput f h)++-- ====================================================================+-- * Realtime scsynth execution++-- | Execute a realtime instance of @scsynth@ with 'Transport' t and return+-- 'ExitCode' when the process exists.+--+-- /NOTE/: When compiling executables with GHC, the @-threaded@ option should be+-- passed, otherwise the I\/O handlers will not work correctly.+withSynth :: (Transport t, OpenTransport t) =>+ ServerOptions+ -> RTOptions+ -> EventHandler t+ -> IO ExitCode+withSynth serverOptions rtOptions handler = do+ print (exe, args)+ (_, hOut, hErr, hProc) <- runInteractiveProcess exe args Nothing Nothing+ forkIO $ putStdout0 hOut+ forkIO $ putStderr hErr+ waitForProcess hProc+ where+ (exe:args) = commandLine serverOptions rtOptions+ putStdout0 h = do+ eof <- hIsEOF h+ unless eof $ do+ l <- hGetLine h+ if isPrefixOf "SuperCollider 3 server ready.." l+ then do+ onPutString handler l+ fd <- openTransport rtOptions "127.0.0.1"+ forkIO $ onBoot handler fd+ -- Spawn more efficient output handler+ forkIO $ putStdout h+ return ()+ else do+ onPutString handler l+ putStdout0 h -- recurse+ putStdout = pipeOutput (onPutString handler)+ putStderr = pipeOutput (onPutError handler)+ +-- ====================================================================+-- * Non-Realtime scsynth execution++-- | Execute a non-realtime instance of @scsynth@ and return 'ExitCode' when+-- the process exists.+withNRT ::+ ServerOptions+ -> NRTOptions+ -> EventHandler Handle+ -> IO ExitCode+withNRT serverOptions nrtOptions handler = do+ (hIn, hOut, hErr, hProc) <- runInteractiveProcess exe args Nothing Nothing+ forkIO $ putStdout hOut+ forkIO $ putStderr hErr+ forkIO $ onBoot handler hIn+ waitForProcess hProc+ where+ (exe:args) = commandLine serverOptions nrtOptions { commandFilePath = Nothing }+ putStdout = pipeOutput (onPutString handler)+ putStderr = pipeOutput (onPutString handler)++-- EOF
+ Sound/SC3/Server/Process/Accessor.hs view
@@ -0,0 +1,10 @@+module Sound.SC3.Server.Process.Accessor (+ deriveAccessors+) where++import qualified Data.Accessor.Template as Accessor+import Language.Haskell.TH (Dec, Name, Q)++-- | Derive accessors with a leading @_@.+deriveAccessors :: Name -> Q [Dec]+deriveAccessors = flip Accessor.nameDeriveAccessors (Just . ("_"++))
+ Sound/SC3/Server/Process/CommandLine.hs view
@@ -0,0 +1,91 @@+module Sound.SC3.Server.Process.CommandLine (+ CommandLine(..),+ commandLine+) where++import Data.Accessor+import Data.Maybe (fromMaybe)+import Sound.SC3.Server.Process.Options++-- ====================================================================+-- scsynth commandline options++class CommandLine a where+ argumentList :: a -> [String]++-- | Convert a value to an option string.+class Show a => Option a where+ showOption :: a -> String++instance Option (String) where+ showOption = id++instance Option (Int) where+ showOption = show++instance Option (Bool) where+ showOption = showOption . fromEnum++instance Option a => Option (Maybe a) where+ showOption Nothing = ""+ showOption (Just a) = showOption a++instance Option (Verbosity) where+ showOption = showOption . fromEnum++mkOption :: (Eq b, Option b, Show b) => a -> a -> String -> Accessor a b -> [String]+mkOption defaultOptions options optName accessor =+ if value == defaultValue+ then []+ else [optName, showOption value]+ where+ defaultValue = defaultOptions ^. accessor+ value = options ^. accessor++instance CommandLine (ServerOptions) where+ argumentList options = concat [ + o "-c" _numberOfControlBusChannels+ , o "-a" _numberOfAudioBusChannels+ , o "-i" _numberOfInputBusChannels+ , o "-o" _numberOfOutputBusChannels+ , o "-z" _blockSize+ , o "-b" _numberOfSampleBuffers+ , o "-n" _maxNumberOfNodes+ , o "-d" _maxNumberOfSynthDefs+ , o "-w" _numberOfWireBuffers+ , o "-r" _numberOfRandomSeeds+ , o "-D" _loadSynthDefs+ , o "-v" _verbosity ]+ where+ o :: (Eq b, Option b, Show b) => String -> Accessor ServerOptions b -> [String]+ o = mkOption defaultServerOptions options++instance CommandLine (RTOptions) where+ argumentList options = concat [+ o "-u" _udpPortNumber+ , o "-t" _tcpPortNumber+ , o "-R" _useZeroconf+ , o "-H" _hardwareDeviceName+ , o "-Z" _hardwareBufferSize+ , o "-S" _hardwareSampleRate+ , o "-l" _maxNumberOfLogins+ , o "-p" _sessionPassword+ , o "-I" _inputStreamsEnabled+ , o "-O" _outputStreamsEnabled ]+ where+ o :: (Eq b, Option b, Show b) => String -> Accessor RTOptions b -> [String]+ o = mkOption defaultRTOptions options++instance CommandLine (NRTOptions) where+ argumentList options =+ "-N" : map ($ options) [+ fromMaybe "_" . commandFilePath+ , fromMaybe "_" . inputFilePath+ , outputFilePath+ , showOption . outputSampleRate+ , outputHeaderFormat+ , outputSampleFormat ]++-- | Construct the scsynth command line from 'ServerOptions' and either 'RTOptions' or 'NRTOptions'.+commandLine :: (CommandLine a) => ServerOptions -> a -> [String]+commandLine serverOptions options = (serverProgram serverOptions : argumentList serverOptions) ++ argumentList options
+ Sound/SC3/Server/Process/ConfigFile.hs view
@@ -0,0 +1,139 @@+-- | Read server options from configuraton file.+module Sound.SC3.Server.Process.ConfigFile (+ fromAssocs,+ toAssocs+) where+ +import Control.Monad.Error (MonadError)+import Control.Monad.State (State, evalState, execState)+import Data.Accessor+import Sound.OpenSoundControl (TCP, UDP)+import Sound.SC3.Server.Process.Options+import Data.ConfigFile (CPError, OptionSpec)+import Data.Map (Map)+import qualified Data.Map as Map++readMaybe :: (Read a) => String -> Maybe a+readMaybe s = case reads s of+ [(a, "")] -> return a+ _ -> fail ("Could not read " ++ (show s))++-- TODO: Add parse error handling+set :: (Read b) => Map OptionSpec String -> OptionSpec -> Accessor a b -> State a ()+set opts name accessor = do+ case Map.lookup name opts of+ Nothing -> return ()+ Just str -> case readMaybe str of+ Nothing -> return ()+ Just value -> putA accessor value++get :: (Show b) => OptionSpec -> Accessor a b -> State a (OptionSpec, String)+get name accessor = do+ value <- getA accessor+ return (name, show value)++-- | Get 'ServerOptions' from an option 'Map'.+-- Uninitialized fields are taken from 'defaultServerOptions'.+getServerOptions :: Map OptionSpec String -> ServerOptions+getServerOptions m = flip execState defaultServerOptions $ do+ set m "serverProgram" _serverProgram+ set m "numberOfControlBusChannels" _numberOfControlBusChannels+ set m "numberOfAudioBusChannels" _numberOfAudioBusChannels+ set m "numberOfInputBusChannels" _numberOfInputBusChannels+ set m "numberOfOutputBusChannels" _numberOfOutputBusChannels+ set m "blockSize" _blockSize+ set m "numberOfSampleBuffers" _numberOfSampleBuffers+ set m "maxNumberOfNodes" _maxNumberOfNodes+ set m "maxNumberOfSynthDefs" _maxNumberOfSynthDefs+ set m "realtimeMemorySize" _realtimeMemorySize+ set m "numberOfWireBuffers" _numberOfWireBuffers+ set m "numberOfRandomSeeds" _numberOfRandomSeeds+ set m "loadSynthDefs" _loadSynthDefs+ set m "verbosity" _verbosity++-- | Get 'RTOptions' from an option 'Map'.+-- Uninitialized fields are taken from 'defaultRTOptions'.+getRTOptions :: Map OptionSpec String -> RTOptions+getRTOptions m = flip execState defaultRTOptions $ do+ set m "udpPortNumber" _udpPortNumber+ set m "tcpPortNumber" _tcpPortNumber+ set m "useZeroconf" _useZeroconf+ set m "maxNumberOfLogins" _maxNumberOfLogins+ set m "sessionPassword" _sessionPassword+ set m "hardwareDeviceName" _hardwareDeviceName+ set m "hardwareBufferSize" _hardwareBufferSize+ set m "hardwareSampleRate" _hardwareSampleRate+ set m "inputStreamsEnabled" _inputStreamsEnabled+ set m "outputStreamsEnabled" _outputStreamsEnabled++-- | Get 'NRTOptions' from an option 'Map'.+-- Uninitialized fields are taken from 'defaultNRTOptions'.+getNRTOptions :: Map OptionSpec String -> NRTOptions+getNRTOptions m = flip execState defaultNRTOptions $ do+ set m "commandFilePath" _commandFilePath+ set m "inputFilePath" _inputFilePath+ set m "outputFilePath" _outputFilePath+ set m "outputSampleRate" _outputSampleRate+ set m "outputHeaderFormat" _outputHeaderFormat+ set m "outputSampleFormat" _outputSampleFormat++-- | Read server options, realtime options and non-relatime options from an+-- association list.+--+-- TODO: Add error handling.+fromAssocs :: MonadError CPError m => [(OptionSpec, String)] -> m (ServerOptions, RTOptions, NRTOptions)+fromAssocs opts = return (getServerOptions m, getRTOptions m, getNRTOptions m)+ where m = Map.fromList opts++-- | Convert 'ServerOptions' to association list.+assocsServerOptions :: ServerOptions -> [(OptionSpec, String)]+assocsServerOptions options = flip evalState options $ sequence [+ get "serverProgram" _serverProgram+ , get "numberOfControlBusChannels" _numberOfControlBusChannels+ , get "numberOfAudioBusChannels" _numberOfAudioBusChannels+ , get "numberOfInputBusChannels" _numberOfInputBusChannels+ , get "numberOfOutputBusChannels" _numberOfOutputBusChannels+ , get "blockSize" _blockSize+ , get "numberOfSampleBuffers" _numberOfSampleBuffers+ , get "maxNumberOfNodes" _maxNumberOfNodes+ , get "maxNumberOfSynthDefs" _maxNumberOfSynthDefs+ , get "realtimeMemorySize" _realtimeMemorySize+ , get "numberOfWireBuffers" _numberOfWireBuffers+ , get "numberOfRandomSeeds" _numberOfRandomSeeds+ , get "loadSynthDefs" _loadSynthDefs+ , get "verbosity" _verbosity+ ]++-- | Convert 'RTOptions' to association list.+assocsRTOptions :: RTOptions -> [(OptionSpec, String)]+assocsRTOptions options = flip evalState options $ sequence [+ get "udpPortNumber" _udpPortNumber+ , get "tcpPortNumber" _tcpPortNumber+ , get "useZeroconf" _useZeroconf+ , get "maxNumberOfLogins" _maxNumberOfLogins+ , get "sessionPassword" _sessionPassword+ , get "hardwareDeviceName" _hardwareDeviceName+ , get "hardwareBufferSize" _hardwareBufferSize+ , get "hardwareSampleRate" _hardwareSampleRate+ , get "inputStreamsEnabled" _inputStreamsEnabled+ , get "outputStreamsEnabled" _outputStreamsEnabled+ ]++-- | Convert 'NRTOptions' to association list.+assocsNRTOptions :: NRTOptions -> [(OptionSpec, String)]+assocsNRTOptions options = flip evalState options $ sequence [+ get "commandFilePath" _commandFilePath+ , get "inputFilePath" _inputFilePath+ , get "outputFilePath" _outputFilePath+ , get "outputSampleRate" _outputSampleRate+ , get "outputHeaderFormat" _outputHeaderFormat+ , get "outputSampleFormat" _outputSampleFormat+ ]++-- | Convert server options and optionally realtime options and non-realtime+-- options to an association list.+toAssocs :: ServerOptions -> Maybe RTOptions -> Maybe NRTOptions -> [(OptionSpec, String)]+toAssocs serverOptions rtOptions nrtOptions =+ assocsServerOptions serverOptions+ ++ maybe [] assocsRTOptions rtOptions+ ++ maybe [] assocsNRTOptions nrtOptions
+ Sound/SC3/Server/Process/Options.hs view
@@ -0,0 +1,155 @@+module Sound.SC3.Server.Process.Options where++import Data.Accessor (Accessor)+import Sound.SC3.Server.Process.Accessor (deriveAccessors)++-- | Used with the 'verbosity' field in 'ServerOptions'.+data Verbosity =+ Silent+ | Quiet+ | Normal+ | Verbose+ | VeryVerbose+ | ExtremelyVerbose+ deriving (Eq, Read, Show)++-- 'Enum' instance for 'Verbosity' for conversion to a commandline option.+instance Enum (Verbosity) where+ fromEnum Silent = -2+ fromEnum Quiet = -1+ fromEnum Normal = 0+ fromEnum Verbose = 1+ fromEnum VeryVerbose = 2+ fromEnum ExtremelyVerbose = 4++ toEnum (-1) = Quiet+ toEnum 0 = Normal+ toEnum 1 = Verbose+ toEnum 2 = VeryVerbose+ toEnum x | x >= 4 = ExtremelyVerbose+ toEnum _ = Silent++-- ====================================================================+-- * Server options++-- | Specify general server options used both in realtime and non-realtime+-- mode.+data ServerOptions = ServerOptions {+ serverProgram :: FilePath, -- ^ Path to the @scsynth@ program+ numberOfControlBusChannels :: Int, -- ^ Number of allocated control bus channels+ numberOfAudioBusChannels :: Int, -- ^ Number of allocated audio bus channels+ numberOfInputBusChannels :: Int, -- ^ Number of physical input channels+ numberOfOutputBusChannels :: Int, -- ^ Number of physical output channels+ blockSize :: Int, -- ^ Synthesis block size+ numberOfSampleBuffers :: Int, -- ^ Number of allocated sample buffers+ maxNumberOfNodes :: Int, -- ^ Maximum number of synthesis nodes+ maxNumberOfSynthDefs :: Int, -- ^ Maximum number of synth definitions+ realtimeMemorySize :: Int, -- ^ Realtime memory size in bytes+ numberOfWireBuffers :: Int, -- ^ Number of unit generator connection buffers+ numberOfRandomSeeds :: Int, -- ^ Number of random number generator seeds+ loadSynthDefs :: Bool, -- ^ If 'True', load synth definitions from /synthdefs/ directory on startup+ verbosity :: Verbosity -- ^ 'Verbosity' level+} deriving (Eq, Show)++-- | Default server options.+defaultServerOptions :: ServerOptions+defaultServerOptions = ServerOptions {+ serverProgram = "scsynth",+ numberOfControlBusChannels = 4096,+ numberOfAudioBusChannels = 128,+ numberOfInputBusChannels = 8,+ numberOfOutputBusChannels = 8,+ blockSize = 64,+ numberOfSampleBuffers = 1024,+ maxNumberOfNodes = 1024,+ maxNumberOfSynthDefs = 1024,+ realtimeMemorySize = 8192,+ numberOfWireBuffers = 64,+ numberOfRandomSeeds = 64,+ loadSynthDefs = True,+ verbosity = Normal+}++$(deriveAccessors ''ServerOptions)++{-# DEPRECATED realTimeMemorySize "Use `realtimeMemorySize' instead" #-}+realTimeMemorySize :: ServerOptions -> Int+realTimeMemorySize = realtimeMemorySize++{-# DEPRECATED _realTimeMemorySize "Use `_realtimeMemorySize' instead" #-}+_realTimeMemorySize :: Accessor ServerOptions Int+_realTimeMemorySize = _realtimeMemorySize++-- ====================================================================+-- * Realtime options++-- | Realtime server options, parameterized by the OpenSoundControl+-- 'Transport' to be used.+data RTOptions = RTOptions {+ -- Network control+ udpPortNumber :: Int, -- ^ UDP port number (one of 'udpPortNumber' and 'tcpPortNumber' must be non-zero)+ tcpPortNumber :: Int, -- ^ TCP port number (one of 'udpPortNumber' and 'tcpPortNumber' must be non-zero)+ useZeroconf :: Bool, -- ^ If 'True', publish scsynth service through Zeroconf+ maxNumberOfLogins :: Int, -- ^ Max number of supported logins if 'sessionPassword' is set+ sessionPassword :: Maybe String, -- ^ Session password+ -- Audio device control+ hardwareDeviceName :: Maybe String, -- ^ Hardware device name (JACK client:server name on Linux)+ hardwareBufferSize :: Int, -- ^ Hardware buffer size (no effect with JACK)+ hardwareSampleRate :: Int, -- ^ Hardware buffer size (no effect with JACK)+ inputStreamsEnabled :: Maybe Int, -- ^ Enabled input streams (CoreAudio only)+ outputStreamsEnabled :: Maybe Int -- ^ Enabled output streams (CoreAudio only)+} deriving (Eq, Show)++-- | Default realtime server options.+defaultRTOptions :: RTOptions+defaultRTOptions = RTOptions {+ -- Network control+ udpPortNumber = 0,+ tcpPortNumber = 0,+ useZeroconf = False,+ maxNumberOfLogins = 16,+ sessionPassword = Nothing,+ -- Audio device control+ hardwareDeviceName = Nothing,+ hardwareBufferSize = 0,+ hardwareSampleRate = 0,+ inputStreamsEnabled = Nothing,+ outputStreamsEnabled = Nothing+}++$(deriveAccessors ''RTOptions)++-- | Default realtime server options (UDP transport).+defaultRTOptionsUDP :: RTOptions+defaultRTOptionsUDP = defaultRTOptions { udpPortNumber = 57110 }++-- | Default realtime server options (TCP transport).+defaultRTOptionsTCP :: RTOptions+defaultRTOptionsTCP = defaultRTOptions { tcpPortNumber = 57110 }++-- ====================================================================+-- * Non-Realtime options++-- | Non-realtime server options.+data NRTOptions = NRTOptions {+ commandFilePath :: Maybe FilePath, -- ^ Path to OSC command file ('Nothing' for stdin)+ inputFilePath :: Maybe FilePath, -- ^ Path to input sound file ('Nothing' for no audio input)+ outputFilePath :: FilePath, -- ^ Path to output sound file+ outputSampleRate :: Int, -- ^ Output sound file sample rate+ outputHeaderFormat :: String, -- ^ Output sound file header format+ outputSampleFormat :: String -- ^ Output sound file sample format+} deriving (Eq, Show)++-- | Default non-realtime server options.+defaultNRTOptions :: NRTOptions+defaultNRTOptions = NRTOptions {+ commandFilePath = Nothing,+ inputFilePath = Nothing,+ outputFilePath = "output.wav",+ outputSampleRate = 44100,+ outputHeaderFormat = "wav",+ outputSampleFormat = "int16"+}++$(deriveAccessors ''NRTOptions)+
+ examples/config.hs view
@@ -0,0 +1,14 @@+import Sound.SC3.Server.Process.ConfigFile (fromAssocs)+import Data.ConfigFile+import System.Environment (getArgs)+import Control.Monad (join)+import Control.Monad.Error (ErrorT(..), liftIO)++main :: IO ()+main = do+ [file] <- getArgs+ runErrorT $ do+ cp <- join (liftIO (readfile emptyCP file))+ (serverOpts, rtOpts, nrtOpts) <- items cp "scsynth" >>= fromAssocs+ liftIO $ print serverOpts >> print rtOpts >> print nrtOpts+ return ()
+ examples/scsynth.cfg view
@@ -0,0 +1,6 @@+[scsynth]++useZeroConf = False+realtimeMemorySize = 64000+verbosity = Verbose+outputStreamsEnabled = Just 4
+ examples/sine.hs view
@@ -0,0 +1,13 @@+import Sound.OpenSoundControl (UDP)+import Sound.SC3+import Sound.SC3.Server.Process+import Data.Accessor++scmain :: UDP -> IO ()+scmain _ = return ()++main :: IO () +main = do+ putStrLn "fuck"+ withSynth defaultServerOptions defaultRTOptionsUDP ((onBoot^=scmain) defaultEventHandler)+ return ()
+ hsc3-process.cabal view
@@ -0,0 +1,38 @@+name: hsc3-process+version: 0.0.0+synopsis: Create and control scsynth processes+description: Create and control scsynth processes.+license: GPL+license-file: LICENSE+category: Sound+copyright: Copyright (c) Stefan Kersten 2008+author: Stefan Kersten+maintainer: Stefan Kersten+stability: provisional+homepage: http://code.haskell.org/~StefanKersten/code/hsc3-process+tested-with: GHC == 6.10.1+build-type: Simple+cabal-version: >= 1.2++extra-source-files: examples/config.hs+ examples/scsynth.cfg+ examples/sine.hs++library+ exposed-modules: Sound.SC3.Server.Process+ Sound.SC3.Server.Process.ConfigFile+ Sound.SC3.Server.Process.Options+ other-modules: Sound.SC3.Server.Process.Accessor,+ Sound.SC3.Server.Process.CommandLine++ extensions: FlexibleContexts, TemplateHaskell, TypeSynonymInstances+ + build-depends: base >= 3,+ ConfigFile,+ containers == 0.2.*,+ data-accessor == 0.1.*,+ data-accessor-template == 0.1.*,+ hosc == 0.6.*,+ mtl == 1.1.*,+ process == 1.0.*,+ template-haskell == 2.3.*