Add documentation about Sound Manager and Audio Manager architecture
[staging/soundmanager.git] / doc / parts / seq_startup.svg
diff --git a/doc/parts/seq_startup.svg b/doc/parts/seq_startup.svg
new file mode 100644 (file)
index 0000000..27f0ab0
--- /dev/null
@@ -0,0 +1,68 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" contentScriptType="application/ecmascript" contentStyleType="text/css" height="356px" preserveAspectRatio="none" style="width:1047px;height:356px;background:#EEEBDC;" version="1.1" viewBox="0 0 1047 356" width="1047px" zoomAndPan="magnify"><defs><filter height="300%" id="f5gmqbksvd81r" width="300%" x="-1" y="-1"><feGaussianBlur result="blurOut" stdDeviation="2.0"/><feColorMatrix in="blurOut" result="blurOut2" type="matrix" values="0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 .4 0"/><feOffset dx="4.0" dy="4.0" in="blurOut2" result="blurOut3"/><feBlend in="SourceGraphic" in2="blurOut3" mode="normal"/></filter></defs><g><rect fill="#EEEBDC" height="334.6328" style="stroke: #DEB887; stroke-width: 1.0;" width="142" x="227" y="4"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="121" x="237.5" y="16.0669">CommandPlugIn</text><rect fill="#EEEBDC" height="334.6328" style="stroke: #DEB887; stroke-width: 1.0;" width="427" x="371" y="4"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="178" x="495.5" y="16.0669">Audio Manager Daemon</text><rect fill="#EEEBDC" height="334.6328" style="stroke: #DEB887; stroke-width: 1.0;" width="128" x="800" y="4"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="103" x="812.5" y="16.0669">RoutingPlugIn</text><rect fill="#00FF00" filter="url(#f5gmqbksvd81r)" height="241.6641" style="stroke: #404040; stroke-width: 1.0;" width="10" x="589" y="93.9688"/><rect fill="#00FF00" filter="url(#f5gmqbksvd81r)" height="28" style="stroke: #404040; stroke-width: 1.0;" width="10" x="594" y="122.9688"/><rect fill="#00FF00" filter="url(#f5gmqbksvd81r)" height="28" style="stroke: #404040; stroke-width: 1.0;" width="10" x="594" y="291.5"/><rect fill="#EEEBDC" filter="url(#f5gmqbksvd81r)" height="82.3984" style="stroke: #000000; stroke-width: 2.0;" width="1023" x="13" y="173.1016"/><line style="stroke: #404040; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="60" x2="60" y1="83.9688" y2="344.6328"/><line style="stroke: #404040; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="164" x2="164" y1="83.9688" y2="344.6328"/><line style="stroke: #404040; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="298" x2="298" y1="83.9688" y2="344.6328"/><line style="stroke: #404040; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="452" x2="452" y1="83.9688" y2="344.6328"/><line style="stroke: #404040; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="594" x2="594" y1="83.9688" y2="344.6328"/><line style="stroke: #404040; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="726" x2="726" y1="83.9688" y2="344.6328"/><line style="stroke: #404040; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="864" x2="864" y1="83.9688" y2="344.6328"/><line style="stroke: #404040; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="980" x2="980" y1="83.9688" y2="344.6328"/><text fill="#000000" font-family="Yu Gothic UI" font-size="12" lengthAdjust="spacingAndGlyphs" textLength="69" x="23" y="81.1387">Application</text><ellipse cx="60.5" cy="13" fill="#FFFACD" filter="url(#f5gmqbksvd81r)" rx="8" ry="8" style="stroke: #000000; stroke-width: 2.0;"/><path d="M60.5,21 L60.5,48 M47.5,29 L73.5,29 M60.5,48 L47.5,63 M60.5,48 L73.5,63 " fill="#FFFACD" filter="url(#f5gmqbksvd81r)" style="stroke: #000000; stroke-width: 2.0;"/><rect fill="#00FF00" filter="url(#f5gmqbksvd81r)" height="27.9688" style="stroke: #000000; stroke-width: 1.5;" width="109" x="108" y="51"/><text fill="#000000" font-family="Yu Gothic UI" font-size="12" lengthAdjust="spacingAndGlyphs" textLength="95" x="115" y="69.1387">SoundManager</text><rect fill="#00FF00" filter="url(#f5gmqbksvd81r)" height="27.9688" style="stroke: #000000; stroke-width: 1.5;" width="130" x="231" y="51"/><text fill="#000000" font-family="Yu Gothic UI" font-size="12" lengthAdjust="spacingAndGlyphs" textLength="116" x="238" y="69.1387">IAmCommandSend</text><rect fill="#00FF00" filter="url(#f5gmqbksvd81r)" height="27.9688" style="stroke: #000000; stroke-width: 1.5;" width="151" x="375" y="51"/><text fill="#000000" font-family="Yu Gothic UI" font-size="12" lengthAdjust="spacingAndGlyphs" textLength="137" x="382" y="69.1387">IAmCommandReceiver</text><rect fill="#00FF00" filter="url(#f5gmqbksvd81r)" height="27.9688" style="stroke: #000000; stroke-width: 1.5;" width="104" x="540" y="51"/><text fill="#000000" font-family="Yu Gothic UI" font-size="12" lengthAdjust="spacingAndGlyphs" textLength="90" x="547" y="69.1387">AudioManager</text><rect fill="#00FF00" filter="url(#f5gmqbksvd81r)" height="27.9688" style="stroke: #000000; stroke-width: 1.5;" width="132" x="658" y="51"/><text fill="#000000" font-family="Yu Gothic UI" font-size="12" lengthAdjust="spacingAndGlyphs" textLength="118" x="665" y="69.1387">IAmRoutingReceive</text><rect fill="#00FF00" filter="url(#f5gmqbksvd81r)" height="27.9688" style="stroke: #000000; stroke-width: 1.5;" width="116" x="804" y="51"/><text fill="#000000" font-family="Yu Gothic UI" font-size="12" lengthAdjust="spacingAndGlyphs" textLength="102" x="811" y="69.1387">IAmRoutingSend</text><text fill="#000000" font-family="Yu Gothic UI" font-size="12" lengthAdjust="spacingAndGlyphs" textLength="86" x="934" y="81.1387">Audio Domain</text><ellipse cx="980" cy="13" fill="#FFFACD" filter="url(#f5gmqbksvd81r)" rx="8" ry="8" style="stroke: #000000; stroke-width: 2.0;"/><path d="M980,21 L980,48 M967,29 L993,29 M980,48 L967,63 M980,48 L993,63 " fill="#FFFACD" filter="url(#f5gmqbksvd81r)" style="stroke: #000000; stroke-width: 2.0;"/><rect fill="#00FF00" filter="url(#f5gmqbksvd81r)" height="241.6641" style="stroke: #404040; stroke-width: 1.0;" width="10" x="589" y="93.9688"/><rect fill="#00FF00" filter="url(#f5gmqbksvd81r)" height="28" style="stroke: #404040; stroke-width: 1.0;" width="10" x="594" y="122.9688"/><rect fill="#00FF00" filter="url(#f5gmqbksvd81r)" height="28" style="stroke: #404040; stroke-width: 1.0;" width="10" x="594" y="291.5"/><line style="stroke: #000000; stroke-width: 1.0;" x1="604" x2="646" y1="115.1016" y2="115.1016"/><line style="stroke: #000000; stroke-width: 1.0;" x1="646" x2="646" y1="115.1016" y2="128.1016"/><line style="stroke: #000000; stroke-width: 1.0;" x1="605" x2="646" y1="128.1016" y2="128.1016"/><polygon fill="#000000" points="615,124.1016,605,128.1016,615,132.1016,611,128.1016" style="stroke: #000000; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="58" x="611" y="110.0356">Startup()</text><rect fill="none" height="82.3984" style="stroke: #000000; stroke-width: 2.0;" width="1023" x="13" y="173.1016"/><polygon fill="#EEEEEE" points="13,173.1016,90,173.1016,90,180.1016,80,190.1016,13,190.1016,13,173.1016" style="stroke: #000000; stroke-width: 2.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="32" x="28" y="186.1685">loop</text><text fill="#000000" font-family="sans-serif" font-size="11" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="135" x="105" y="185.312">[Number of Domains]</text><rect fill="#FFFFFF" filter="url(#f5gmqbksvd81r)" height="40.2656" style="stroke: #000000; stroke-width: 2.0;" width="1005" x="20" y="200.2344"/><polygon fill="#EEEEEE" points="20,200.2344,86,200.2344,86,207.2344,76,217.2344,20,217.2344,20,200.2344" style="stroke: #000000; stroke-width: 2.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="21" x="33" y="214.3013">ref</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="76" x="486.5" y="233.3013">Registration</text><line style="stroke: #000000; stroke-width: 1.0;" x1="604" x2="646" y1="283.6328" y2="283.6328"/><line style="stroke: #000000; stroke-width: 1.0;" x1="646" x2="646" y1="283.6328" y2="296.6328"/><line style="stroke: #000000; stroke-width: 1.0;" x1="605" x2="646" y1="296.6328" y2="296.6328"/><polygon fill="#000000" points="615,292.6328,605,296.6328,615,300.6328,611,296.6328" style="stroke: #000000; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="78" x="611" y="278.5669">wait_event()</text><!--
+@startuml
+hide footbox
+
+skinparam backgroundColor #EEEBDC
+skinparam sequence {
+    ArrowColor black
+    ActorBorderColor black
+    LifeLineBorderColor #404040
+    LifeLineBackgroundColor #404040
+       
+    ParticipantBorderColor black
+    ParticipantBackgroundColor #00FF00
+    ParticipantFontName Yu Gothic UI
+    ParticipantFontSize 12
+    ParticipantFontColor black
+
+    ActorBackgroundColor #FFFACD
+    ActorFontColor black
+    ActorFontSize 12
+    ActorFontName Yu Gothic UI
+
+    BoxBorderColor #deb887
+}
+
+actor Application
+participant SoundManager
+box "CommandPlugIn" #EEEBDC
+    participant IAmCommandSend
+end box
+box "Audio Manager Daemon" #EEEBDC
+    participant IAmCommandReceiver
+    participant AudioManager
+    participant IAmRoutingReceive
+end box
+box "RoutingPlugIn" #EEEBDC
+    participant IAmRoutingSend
+end box
+actor "Audio Domain"
+
+activate AudioManager #00FF00
+AudioManager -> AudioManager: Startup()
+activate AudioManager #00FF00
+deactivate AudioManager
+
+loop Number of Domains
+||10||
+ref over Application, "Audio Domain" : Registration
+||10||
+end
+
+AudioManager -> AudioManager: wait_event()
+activate AudioManager #00FF00
+
+deactivate AudioManager
+@enduml
+
+PlantUML version 1.2017.16beta5(Unknown compile time)
+(GPL source distribution)
+Java Runtime: Java(TM) SE Runtime Environment
+JVM: Java HotSpot(TM) 64-Bit Server VM
+Java Version: 1.7.0_25-b15
+Operating System: Linux
+Default Encoding: UTF-8
+Language: en
+Country: US
+--></g></svg>
\ No newline at end of file