From d86400262f810a540170b97ec5b0362711560c29 Mon Sep 17 00:00:00 2001 From: Takashi Sakamoto Date: Tue, 24 May 2022 19:23:08 +0900 Subject: doc: update documentation to obsolete function support of ALSA HwDep cdev All of HinawaSnd* object classes and structures are supported by libhitaki instead. Let's obsolete current implementations. Signed-off-by: Takashi Sakamoto --- doc/overview.md | 18 +- doc/overview.png | Bin 55869 -> 40484 bytes doc/overview.svg | 1415 ++++++++++++++++-------------------------------------- 3 files changed, 416 insertions(+), 1017 deletions(-) diff --git a/doc/overview.md b/doc/overview.md index 0eee706..7c19b8a 100644 --- a/doc/overview.md +++ b/doc/overview.md @@ -1,18 +1,18 @@ Title: Overview -This library gives some objects for abstraction to operate system resources in two Linux -subsystems; FireWire subsystem and Sound subsystem. +This library gives some objects for abstraction to operate system resources in Linux FireWire +subsystem. This library mainly supports operations for asynchronous communication to nodes on +IEEE 1394 bus. -This library mainly supports operations for asynchronous communication to nodes on IEEE 1394 bus. -Additionally, this library supports some model-specific operations for Audio and Music units on -IEEE 1394 bus, supported by drivers in ALSA firewire stack. +This library originally supported some model-specific operations for Audio and Music units on +IEEE 1394 bus, assisted by drivers in ALSA firewire stack as well, however the support has already +been migrated to [libhitaki](https://github.com/alsa-project/libhitaki) library nowadays and +obsoleted since v2.5 release. ![Overview of libhinawa](overview.png) -This library expects userspace applications to use GMainContext to run event dispatcher with -GSource from HinawaFwNode and HinawaSndUnit. Additionally this library launches a thread for event -notifier which emits GObject signal and execute any handler on this thread so that the handler can -wait for events from the dispatcher. +This library expects userspace applications to use [struct@GLib.MainContext] to run event +dispatcher with [struct@GLib.Source] from [class@FwNode]. libhinawa supports gobject introspection, thus this library is available with gobject introspection bindings of each language such as Python, Ruby and so on. When using this mechanism, please refer diff --git a/doc/overview.png b/doc/overview.png index 77597cd..22f9c6d 100644 Binary files a/doc/overview.png and b/doc/overview.png differ diff --git a/doc/overview.svg b/doc/overview.svg index f1b5956..8b8a624 100644 --- a/doc/overview.svg +++ b/doc/overview.svg @@ -2,19 +2,22 @@ + inkscape:version="1.1.2 (0a00cf5339, 2022-02-04)" + sodipodi:docname="overview.svg" + inkscape:export-filename="/home/mocchi/git/libhinawa/doc/overview.png" + inkscape:export-xdpi="90" + inkscape:export-ydpi="90" + xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" + xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" + xmlns="http://www.w3.org/2000/svg" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" + xmlns:cc="http://creativecommons.org/ns#" + xmlns:dc="http://purl.org/dc/elements/1.1/"> @@ -44,26 +47,10 @@ - - - + d="M 0,0 5,-5 -12.5,0 5,5 Z" + style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1pt;stroke-opacity:1" + transform="matrix(0.4,0,0,0.4,4,0)" /> + d="M 0,0 5,-5 -12.5,0 5,5 Z" + style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1pt;stroke-opacity:1" + transform="matrix(-0.4,0,0,-0.4,-4,0)" /> + d="M 0,0 5,-5 -12.5,0 5,5 Z" + style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1pt;stroke-opacity:1" + transform="matrix(0.4,0,0,0.4,4,0)" /> + d="M 0,0 5,-5 -12.5,0 5,5 Z" + style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1pt;stroke-opacity:1" + transform="matrix(0.4,0,0,0.4,4,0)" /> + d="M 0,0 5,-5 -12.5,0 5,5 Z" + style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1pt;stroke-opacity:1" + transform="matrix(0.4,0,0,0.4,4,0)" /> + d="M 0,0 5,-5 -12.5,0 5,5 Z" + style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1pt;stroke-opacity:1" + transform="matrix(-0.4,0,0,-0.4,-4,0)" /> + d="M 0,0 5,-5 -12.5,0 5,5 Z" + style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1pt;stroke-opacity:1" + transform="matrix(0.4,0,0,0.4,4,0)" /> + d="M 0,0 5,-5 -12.5,0 5,5 Z" + style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1pt;stroke-opacity:1" + transform="matrix(0.4,0,0,0.4,4,0)" /> + d="M 0,0 5,-5 -12.5,0 5,5 Z" + style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1pt;stroke-opacity:1" + transform="matrix(0.4,0,0,0.4,4,0)" /> + d="M 0,0 5,-5 -12.5,0 5,5 Z" + style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1pt;stroke-opacity:1" + transform="matrix(0.4,0,0,0.4,4,0)" /> + d="M 0,0 5,-5 -12.5,0 5,5 Z" + style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1pt;stroke-opacity:1" + transform="matrix(0.4,0,0,0.4,4,0)" /> + d="M 0,0 5,-5 -12.5,0 5,5 Z" + style="fill-rule:evenodd;stroke:#000000;stroke-width:1pt" + transform="matrix(0.4,0,0,0.4,4,0)" /> + style="overflow:visible"> + d="M 0,0 5,-5 -12.5,0 5,5 Z" + style="fill-rule:evenodd;stroke:#000000;stroke-width:1pt" + transform="matrix(-0.4,0,0,-0.4,-4,0)" /> + style="overflow:visible"> + style="fill-rule:evenodd;stroke-width:0.625;stroke-linejoin:round" + d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z" + transform="matrix(-1.1,0,0,-1.1,-1.1,0)" /> @@ -310,7 +297,7 @@ @@ -324,7 +311,7 @@ @@ -338,7 +325,7 @@ @@ -352,7 +339,7 @@ @@ -366,7 +353,7 @@ @@ -380,7 +367,7 @@ @@ -394,7 +381,7 @@ @@ -408,42 +395,10 @@ - - - - - - @@ -468,7 +423,7 @@ @@ -483,7 +438,7 @@ @@ -498,7 +453,7 @@ @@ -514,7 +469,7 @@ inkscape:connector-curvature="0" id="path4637-9" d="M 0,0 5,-5 -12.5,0 5,5 Z" - style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1.00000003pt;stroke-opacity:1" + style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1pt;stroke-opacity:1" transform="matrix(-0.4,0,0,-0.4,-4,0)" /> + + + + + + @@ -583,11 +565,11 @@ borderopacity="1.0" inkscape:pageopacity="1" inkscape:pageshadow="2" - inkscape:zoom="2.0000001" - inkscape:cx="350.39851" - inkscape:cy="541.86443" + inkscape:zoom="2.8284271" + inkscape:cx="279.83751" + inkscape:cy="309.18244" inkscape:document-units="px" - inkscape:current-layer="layer1" + inkscape:current-layer="layer6" showgrid="true" showguides="false" inkscape:guide-bbox="true" @@ -605,12 +587,14 @@ inkscape:snap-object-midpoints="false" inkscape:snap-page="true" inkscape:window-width="2560" - inkscape:window-height="1016" + inkscape:window-height="1376" inkscape:window-x="0" inkscape:window-y="27" inkscape:window-maximized="1" inkscape:snap-to-guides="false" - inkscape:snap-text-baseline="true"> + inkscape:snap-text-baseline="true" + inkscape:pagecheckerboard="0" + units="px"> image/svg+xml - + + + @@ -653,457 +653,246 @@ transform="translate(0,-308.2677)" style="display:inline;opacity:1"> pfds callback callback callback + ioctl() ioctl() + pfds pfds + read() read() + callback callback + transact transaction + transact write() read() callback transact transaction + ioctl() ioctl() + libhinawa libhinawa + queue queue queue + signal transact queue signal +     +   call-back ioctl() poll()   + poll() signal enqueue + style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:12px;line-height:1.25;font-family:'Times New Roman';-inkscape-font-specification:'Times New Roman, Normal';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-feature-settings:normal;text-align:start;writing-mode:lr-tb;text-anchor:start;stroke-width:0.747445">poll() + - - - - - - - - FwReq FwReq + FwResp FwResp + FwNode FwNodeSource SndUnitSource SndUnit FwNode + FwFcp SndDice /dev/snd/hwC%u FwFcp + /dev/fw%u /dev/fw%u + Application SndTscm SndDg00x SndEfw  Application + GMainContext GThread GMainContext + Linux firewireLinux firewiresubsystem subsystem + Linux soundsubsystem + inkscape:export-ydpi="90" + inkscape:export-filename="/home/mocchi/git/libhinawa/doc/overview.png">GSource (FwNodeSource) + - - - - - - - - - - - - - - - - - - - - -- cgit 1.2.3-korg