From 4eaa1e7dffa96b20be6282c0b2ccc7253794fd5b Mon Sep 17 00:00:00 2001 From: AutumnSky1010 <66455966+AutumnSky1010@users.noreply.github.com> Date: Fri, 6 Dec 2024 15:11:14 +0900 Subject: [PATCH 1/6] :bug: Fix a bug of volume --- src/SoundMaker/Sounds/WaveTypes/TriangleWave.cs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/SoundMaker/Sounds/WaveTypes/TriangleWave.cs b/src/SoundMaker/Sounds/WaveTypes/TriangleWave.cs index cded92f..a145d90 100644 --- a/src/SoundMaker/Sounds/WaveTypes/TriangleWave.cs +++ b/src/SoundMaker/Sounds/WaveTypes/TriangleWave.cs @@ -54,8 +54,8 @@ private List GenerateUnitWave(SoundFormat format, int volume, double hert if (halfCount % 2 != 0) { - result[quarterCount] = short.MaxValue; - result[halfCount + quarterCount + midOffsetFromHalfCount] = short.MinValue; + result[quarterCount] = (short)(short.MaxValue * volumeMagnification); + result[halfCount + quarterCount + midOffsetFromHalfCount] = (short)(short.MinValue * volumeMagnification); } return result.ToList(); From 1457f4066d811a66b1d349abfd3aeb15d12ac80d Mon Sep 17 00:00:00 2001 From: AutumnSky1010 <66455966+AutumnSky1010@users.noreply.github.com> Date: Sat, 7 Dec 2024 13:22:14 +0900 Subject: [PATCH 2/6] :+1: Delete the memo --- ...\233\264\345\261\245\346\255\264\343\203\241\343\203\242.txt" | 1 - 1 file changed, 1 deletion(-) delete mode 100644 "\345\244\211\346\233\264\345\261\245\346\255\264\343\203\241\343\203\242.txt" diff --git "a/\345\244\211\346\233\264\345\261\245\346\255\264\343\203\241\343\203\242.txt" "b/\345\244\211\346\233\264\345\261\245\346\255\264\343\203\241\343\203\242.txt" deleted file mode 100644 index 5f28270..0000000 --- "a/\345\244\211\346\233\264\345\261\245\346\255\264\343\203\241\343\203\242.txt" +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file From db4f055a5d59fcf4292376cb5246d05c2b69e10c Mon Sep 17 00:00:00 2001 From: AutumnSky1010 <66455966+AutumnSky1010@users.noreply.github.com> Date: Sat, 7 Dec 2024 13:26:15 +0900 Subject: [PATCH 3/6] :book: Write index --- docs/images/SoundMakerCover.png | Bin 0 -> 13580 bytes docs/images/favicon.png | Bin 0 -> 318 bytes docs/index.md | 60 +++++++++++++++++++++++++++++--- 3 files changed, 56 insertions(+), 4 deletions(-) create mode 100644 docs/images/SoundMakerCover.png create mode 100644 docs/images/favicon.png diff --git a/docs/images/SoundMakerCover.png b/docs/images/SoundMakerCover.png new file mode 100644 index 0000000000000000000000000000000000000000..4847b4085e9b7c566ecf49b5a30bab9550152ac0 GIT binary patch literal 13580 zcmb7r1zeO{*Y6-lkq|u6Ac6-_8tIZaB3&Ylz=(9nDBYnVN;eK2lF})SDBU65-Oa#I zbN2wpbKduR-|yZ#KYu3LFRoazjS?@ly!o>KFuqv3LCn z7|B?4bb&x_5z?Yc0Q$7}(>MFSZdRXOJvut1AI9SnL_}`E1RaKse1qdO1aqh8L1y(&#*zbSO%1-fB=Ns;?4}Psr1iPE^GZ9M zs{{G?I9=X9VPhj2TKbuJHKX3#wlg3oPVn{2H|9%`V zdn~JEk|_~VFQ2pwggNnP_JtVHAZEE=vizKS$(y3x;mOWh4J2FjLppm8;?~5E@Sks^ z!2Cq|g3Zk0Jd#K?vMq@;2fzZ^k1j`LbU)2&j`?USHQM%}ca>ljSK?R8$C(f z+7IF7@MR)wrTM+(J{y}NttwzI>K+ZLTw|zB6ZQa`n^FFy(-W~+On_#=nL~U^i8$?c zfGjCEQ^t_pRH|Y zR@Ndn6Ff?|WM*sV-D*!qYpZP*J6Zk!8+HWhddSmnWZkd3`PH=eAh~CPMen5YSm~sJ zFaG3gHa(PEuheolfN$cH1R2;4?4}DFb{*v>G7O04?H|gjxKx;8J?FpLosKT-U;&i^ z#zgZEU^ooBWdDl^oYHW-!wbkoAVKa(SQ8286wD(*?g>@)Gfxr+uVMQ0mzi|r+Ry{S zNn=n@&6V+C!PUmf%F5kcL}qq*d0Cr#a!FRZWX)G-Z2PGuRY?Z(hV)R({#Ra6J|P~S zh^+>p^UwGeAWw0k{Z4;NH;33A{5$-IahtA-b>A>$C>*#=qB=!OK07^__JdlV%~-H) zY_4xu3X5>=j^T!R94xh@u;0%rYM0t4q@q-E$d);r*>oSQgjFo3#Y+g|UcU*{CxhP> z5*$V=6?n2gh&u8*rk3t?Y)S4!trJq79TQ}C2r^mc+h-ipijQMc*1DQ6B%m4y&er25 zrH9Vio4Ryd#!JwKO$>L95i|e61_m&x+P97cG4h|>dkPLN%=}**NLI4hC;=dr@8e&@ z%KD*=rZ|rHuMwv2oaCI(^Zo$(Y;nSRQkkM@s`HlKds5V|&MJb?n>~g1IC8 zq8tJV`KLRFhq?~#w7Ca#=2b5mQloSVt>;^>{stHuE(KhR=apqM+ml8Y^|5>-vw8$- z+v_cA0eae|Lio{_KT6krc=Kdq^W3?b0I5ECY9jS=I5gKtuHsf{o1V6pNrJ<^iX26oz+Y~crZn^pjfSx$RFH07y@wp9^&gj6^vanx zG)uBY^1tG6g~ot2JQKduYtT%M4eh27Lcbn(v*Pf7Bs?2Qf(9T6GLKo`NG+`q*G?*5NJLu_o1;il(pxE)|Z(WO=YJ2=Ry7e*hG zNOsMSNi4U$;{1e{&N7KX+(9!Qngdcd{ zQnYq%M)dG4fzhqjwL>MS)11dio5?NS+J)pZN;W8o!vH5X@Iy4DzMQHbgrp{>=EJz4 z7@q84>ri^Kx|Ydy9;+?wukM-)Mkt?}>HMNhw#jPkLop$|Huy=K7_tRu-K z>3uKRI6{#Gm=`(3rN1gYqL%LTFL-4Q#3z=RFDC`-7MB4_>}{ahCgpBuclVEg$@9u9 zDInQTgnv2wC&UVV93=Ai;5D6he?=G>czzE%y|kCWY)GrP@_Q!bsJq-{p5UQhbU+jV zgE&2_A}a7eL_{F!^L7i@_DYZ3#9%GMv|sIdJ#GgX?rUC`i){f@%O7>e-FQu@#(rtb zFHD9ak3!GoSQNPht3DRShPomP=W(y!073!%{kVmsb*}$#t*J-F-LX*hOck2YgPAJsQ<|aHLMy~g8X1|)c!hPw@u5&1N{HIt{<0KVo!{co+~hLiF-swo?9gQdpfThh&6OxOVlGg&K8?$N;gx1 zp{EOg4HfP+wnfpiw90pNqNZ9@pcAK$>ZQ+?M~G4TouiTXcyyKt-c8gVC%Kgyg0H5; z>c}Sg(-dN?s`m$adV0FOAjKKp*!H%zdjrp4&63W*StBETL z)u*~4XMg4>W@vctVr3WJHkb2Jj%=dz>dr&H$Xe?#M8rYAd2DWGy~$^aCmsQwr075Q0Y?{ zA0Kx+bsP5Xk9MvW5fE_NnQNKzv9-77t)SF>tzoZ>5nk86)_yqTI6$}tKK=cwSwLid z9FC3Y>>waN++U>$`Xl)0S#ce#Y!2tyJ&?mD2?`T6m6a|{fmA{c8xMUrVhKT(SLv`h zvA?d{LZDS-+_5i|JNfms0a$&GX5H@Ydi*w4yf6sFU8mz+He}qTaS7Lw#C_~HC*oE@ zZI`x^fV-xHp(qk03kOT{W23!08)x;zGp#B-#(6_aIS z))(6Zw!}oVZCUKiGTOIbryAn#4g35WRd}?$=uzR&mHdvq#>#g5Xn&ENrozU!BbsNl z^kobjF4OC1*sx~c(^VyikPU4#NwcVylPZJNKG3HltyzDmtE-Dm35;fyp5?I$Lzr9_ z^aM_j1CN&3b8y>xyt_)Uaa6CdDSJ3WeYzwy7?cYYvt4YjoH)%bu^8kHQ-F%P?1aE3 zklx~0@ru2U%A27vs2-^^q!dh%tYv4ut+KKbmm`Ga?t7b5`Nb=$D*B5Bs$TO>x4b(v z8h{Ll@XL8x{cFv{C76;JG#*>E~jFOOZf!gjtj0*G#f zty#5R7aN_Yb;jUob#-+nFVC|o$L$|Ke)zH1d^!o<-rfe;x@zBH|6c!(!^iaslMEG) z+$%hHfMYl$jz4qE_0Od~ZHBqcEyRRbbrVYT_i`C zB_t#ySf8wgP1el$>>&_VAk9yUv66Lf4pS0w>JmP9cra$uLV%IM5By9$-^=D9LnWoyyvJ7<^3?F8nVcEKRA-P3c@5F3B8Wr6MYWYYa8TMXSRIWP3}4Yt$bm z{>6K^b9J)hOy7B~LZnkm2nf{9n(rDw7|)X23N<@edbyX{;KZpXRbeeiwo=_pM7*Q+cy5~@~D=mIKd0-4!#LhYo#-N5hnSZz!K z*@e>3*|18`=`{73etjdUu5C|F*+hl&{)&2vkjX$m?(tBQ2%@)*o!)FLgO9CptuR|$ zaFONem5k`@1l7|Kebq=MQnd9gwA)+isdN}W-TF=dUR!|(^&;??IRVOtPbKYz#}Wt} zCX3TCYJZaIur~@pXX(1z!3P_!D7h{HR}=rDK3>ISOGLh#iJfTP+j){p^x3FgjIGt< zEpYA-F^s>{Q1J7nCz^fNm)qyyD)*HXl$3n%=K=z$MMZ?wzGi5vz_``%ay5&L6?Viy zDoPn3X@B?I+}vEIN_tvaS}1id@CJi}CWcS%6;Q=`vcUD9TI}m%J&o(14H7M|7|g}Q zB6tVZx>hUk{UERl|-#TQL723YbGtDizJ%bthVz@6+Ll64pt+32vu0Pcq9I8 z{;yzeQ-b3|wdZEUrOX5mT@pWeL^K875pv!$tuTnL-KqV7WhAnjr&qm#7=_guukrw8 zE4QAH=CODRg=&v^@sED_1h4&+zy?fr@#=}dp8Y|n$9#lF?z1SQkEgH;;^8Y4=C55wvOb$Yb~@CYt}pv?3K*`< zM?q^gYmO0XGDq(!2f{O%aoG|C1b$YsKub?5Eb`ipbhRV*D~as=i4l1_+1bbQhugDi zHNUn|oQ^kaUcy8WOuYNltau>enixhzwu-F1U?veFudp@lk%&Ksb{ZPg6q_L8qydf` zaO?Ub<@f%K9vYvZq6`d}Mclq$U(&NOYNdy-**;}lgBnE$rFNSqVe&hGxv318-H85L z*_3=;t)V&`=9i7uZTYz@H*~cqyw_#DA|&;>7POrrlktM%Zk--sK4zgkyofw8HxioJy&ET zD<#`dzUNZb>KeBdC%ad@y^%hqh1S4guXdxg3)3rjMPa_LK%;NA{9>rAe&y5WU}OH} z>NWQ|*W*Td#@5C*#w$e+q7rby>nqO+Yf#hT-=lIxMQv%6O-yns+j{e_mb>rP4fq}1 z;yvpWzmGaVZ6WXD#{uW$xWAPyvd<_1AJ95|1}M^6e@$J}j4SfldpjeurPf{sOAVZC zZk!m7!Bz%eBBKfIqT$%+XbK@=62V|zUSZwM%)uk)fMQNlTRZMsq@^pbZC2WU3@vZd z1vDKuniw0C+|({7+OLptA~P^+A=Bb&Y}VFq($vSKWz`+d(%kS&en7?gZVhmuvM}GP zgeJj;(XtVTQWLJ~>R*y5zu5bxKECFh-h`h5+|j&8r?jRv-lyJP#WdEHdOLe~sJ^rS^F)i6CwRv*RmWsGs|J6VcR zDfB8sB=9^nHJ_EreUmeKOyw07;~&~_Rt9VL5j*fu1ax+GW>1>By1Lq1@j4wZXD)AS zY^cg~O5y5~J2VDJ(gx~w_!-$-*}J+vRMSvYROF=y$o4U^GRWrkh$t#50&t#iL7I=b`!#$AUJp?fWw!JWqeu zt+&)wh!KmhvV_>!u_BYMafit`UFn?isW-T}wP!~mAtBk5OUxie^}@soE!*7Km~cNu zJhLjNFZ!U}|41Xy-`}#<{kRdA*O*i-*c|Q3yoF> za)u>{=lL6DcQugxUGXE8CY#gWeN?C-zLPO$*Pp57QtP5Zf?VesDPiqrIlYX1?H<4? z1FLYdW+E!*E}hcz)p_+Nuo!MT;*ye*>Unx`A{G6zTtUS4Xc3hJ*?^{1<$9^=`oYHd zF8f(S?O3gchvas# zgQFTqp<^ISny7XOqqg4vsezgRlU9EYyEj=Wz!wT$1Ok~JL_?jwl}(psGddXcXltlD zLBd%K1b$O5^q&`N>L`dIQs);BhNPsOM5sFF?CnS=N+Ixp#mUDf;3BJ zZ$OB=movg~Mst7=Uq#0H`OhcLco8G^p3xYXMJ(&=D5r6#r%gDp2{7nBk8nBa9U2+} zoKcDsjQG60wkEG+yE7tptuQd_2iqOps;}u>wnW8m>lO1@9_v?@{RJXi`nn!OZLMh@zh@}3tMJhKXVK;j4aRbo;tVCXBpN(hE-Y7_gN zqe0&qA_E{-^#z$y>+LOoLHko=@ec!m49Dl*!lxw7n%YK!QLf=;{t=l6adP;rq?$TH zWgvxZwe63t*MoO5S(cGJ$RDUEB6h8QWn$)?WEM?XFiX0pwI zmB4zLBEevWtzGITCckWN|M`@BgY5jlRuU0y_6PZ2wU(foUb6hpf_bS*jBUp&2s{qI z^Nri8EQw8+T3T9mO$Y;cUt>pnAXnGrdjOx_c{W#_CO^xXU=va>Cn+Tb`?~$U#A4u{ zs9}RIh;avqd0QGawK*fz2NtcT>b`AGxNHJwJZgRPv%_3-NQzWY>8s}ma-pqMcDLn= zEU+s%p7mL&4tP-u0XYQ)1vxomleE=c10=&58S`36p?A;#E?&DVxhI16A^LM$(3h{k zVR8cIaXfl_u&LzU417FqwSkI=1bK7k*4CDbLyg1kLPruNhWkcy$fCpgNW@C0>T8e$ z3RurcXNd#wd?$1AxF7LywCH2Tl6JFZ12IAyj*?o%5pl~TiqK?;djs=-#H_vA8++~1 z-KH4-RC?eI&QGP!rQU2=lAE8dGE^u1rFBJi#?-NT3>uVJ7VFnw(*^|fQSpk^ap*0{IKs8+4=}$2N(14d_?H>*E#A zeKb4;;Qo+sjS<`m0?0q8Uv9Vt;vPz7z= z&ndh@K3WOed`s}~Q`Kqd`sk#?=rIuKQ1HTG0KZJ4PA5t88Mun^6Sv!eX>3CG0+{~< zD9uwNOVrtE<-yu;nFDM`Jh$Q~t0RUlDuto%Q6p2{%I=WGiGy-TIKl(#<&I&>ydc^cX^Ls~Sy z%(&jM|7pp)2!hqc#W3zWLc*mWyQoFR)PizPt9>r@Se~MZ@xu+ejp`FI|aR)cxVKMVG=L*75ATn=bAL z0?*c0NF}t$U6LAnHD@(Y>$HjJs^;ND-~!|vCy`vM5&-6^0l!)n#5gp+p-23|2;6j? zV^PhWzv6EZKR=$4AgQUs?|z(ToEXjFxC+2PUYz>Es*L!za$q2LYEH&mn=R$Kg^z3S8nhF&t2eKC8nLc?GgP;Bd^%SH59UkCnloJL0Zu zGOJTwZ^0CF)O8-(mA)J;1sb)MJhN|I>Bi{$M=H6e$B?eW`2N&ef_t!9aNEJs*+=Pq zaV2m|X;ddbSEi<>I`}4ISAwyqUAL6Z=9FC5TKYj0vsty*gM^Qk zQb3ghI9G9T@sj9wz~H=ON#C3X=;l$YM$OJ%pVED^vGJc{XNb&E(bw+vq|l0~HiWEJ%njRE#3tm>74jb1&lHHgTiPIMp&>16#? zYVzcrN6>>ZMRkJ$)Y7xG&p*1Od2c^DVKIfpnxB;1Vw$zkJ?f#$=iB6MVSlOPe6yxS z9`rm-&S7jKv%vkU+vSTq#(L}CK5j|IhhbCXV&3geiN@a6y9One(6cDnumTcvhIbKS zGsPDS7@xhcH&X4dV-jf`dGoh_D;BQh0D5dTA6#Hu?wqP)5{7l*!wQOVgmy_wnQwtz!9WOJ_x}9zl&bfUhSfxsQ{N~b zz(vE2{pS(OZz4hOl&5_7*H@9hlQZAYl^O8oC^YuJ%=zcpJ6Q=s@nfGYgbxxqyY0SOUe&o8F%cEb*&I5n0n zk0sVh_R9=8bDubWTYm&PvjBj@dB}zKv^Hjc>MPaed(GdE{4G%zUW1dTwL~4@D-E(< z))Y%!tu&h!AC5?McqctIkQ6W*q-6kGU@<|Lc5%K*aX}Kz|E?05!bnKbLJ2~poDD|J z?!J~kFQTsD<FhMBCjD|BeM$cdk4XME{ha zEz(r3B!ff{G~;+){kV%v8r~qND+h6x0yDV(%uh|u)86O^7~T>1zcp{5mGZm+Qm^U1 zbrhM3Djcf<3~U`#rcG5=(Dif|ztbtaV#YpFP=g&ni$|z4SfqOc6q*sAna~U@=TBhg z-Qa|D3h#nmtM1No8Dh=yMze3LCgv66LJ%aZ!y8_y8tSZfsFEv;}=Vh%rm$eG0GIUS8fLeI+UXVt6&E-aS z=>HqcnsXcUQ?cff z3S79CBm;M@(^#pmM=g8|T=M3pU>4)aauK134mes6Z~C)i{1WMiNT@5@;-2+t?*D@q5(j0 zvc-KI)o{i}f57|h!WSne@#)Ljd)6klpCJ-(2H(#9M^a+b;9aWvl53e)SUCKWL5)fe zEkz8i8Z2Osp0by1FMl`Cphy2_>#eDH{0Gp!QC$0Vx$Q=GWON#UX%cfT{T=Aa>yBgz z1$!USRg@riK(``+;$yb+mQz^bm%X1T>oR4vGGGdaz^?IEokPT;S(S+!g;Z*Q*8G~g(;KmZRKK9 zK+GFdj~C(vA8wbpH4)qv3TyD2bZjV`94jrX)LY33F;^}&V_HcdpppVDPPP;BOCb7( zw9@7!%fEJqLLX9BS3`*5t&V4@nK0qQUU5<3xCXz2{YF#+&)e~R7QM;`U;*QM+9?!( zxKDUf^SVg(~YZmq)*cl<*nZMSssB6J!xgmtFjukdu>wX2?6iD(w51Coq)@aWo-|7w79R$0Cl=*;LI7(2iq zdV>Sh?g`H&XNU?JW)G|Z@eg&0A|#%e$p^@bkk1lm7L%!(K0 zMXrT#VN+5&r&^pg`jO;h)03%cFn=F79We9N#&E7GB;@hrd@_SGKsns^_I`ZHi)1p zlJsY)u!rl)x2DjuqwivitN)83SQRpQfWv|xj40K^6qq469d=o7PVe*nJMDy|6; z2H)iZ&Y&)D8XeUGQ_=b)-0X<;4)|`$XLQk;RSX)QX_(aufFxCUTN4?9su{QqkxsvT zkrnU)lnDI3DaPo_sc@_=b{E+POz`3Ur7<$)dyRc3=xN^I@zGIq%Rn1<1!){SP)~p- zY$?^ECt1?OL3i2LIywdx506d&Vlg7(dwhIM$g5Xu3Mx}3*v6pW*3-ZL&S^_Zl7VK1 zNxb{fwA3AVd^BigFg|H0NFh*25D5kS(>lii7V2Y;$U^U{*RR^GMJ&TyHxCICDCCCR zx3fB`zm(Bg0wmM5g+6MJfR1$rY*|&|wxFlY)X5FX&dL0{`m;VBCtC?;!vwXcDUdn> zI9pP~j=A-TdR}0M`yy7J>nRLW!%;0tXDO%^aq4z%I>&b#E_k@(=#z}lkNCu`h}E9_Q7xi>y6K;gm&54T-pcFG%?d&ZPs zx+ZtN{XE4Ug}QDxz#9Rlo-me3-EpF`#Vd~nI74h~Y+Rf|ucNc`$}VaHg=`$GjkZ(0 z`NN6U0@W7ecCuoTD>qcrGrnYHYl3#vVs@%lsq%m^Fc_@95p+4(bmT@Ubr@3Ide`e< zEMm2{cW_@9ojBDA82)<~s}u8O+yhCB{iUc*%pJyDw%3Ds+P;Ca)&Gyb56R#?SOTI4 zdI2w_?6!paeGiKr@n!NkGztIe+g-bFoxvXlM#OFwup7dX)W78D3A=*+llS<)adJF- zI5s&6L&q7{|G=jbOR{T>+jQ!3;k6vPDR{H_v650(b96|zGPtj*x<2hgjZcMsnb`c$ z5{Q~0|2@+C4>$j>f2Q(pe|}To!w!xInfuE({2~l`^nbTt|JludxM&TAWYGL;$23jg wAAAqaU)6CLJ-)y-0`GwAnEb~-r`bYbpu(^JPCrxTj($o;Lh*6#qvvn_4=rRIj{pDw literal 0 HcmV?d00001 diff --git a/docs/images/favicon.png b/docs/images/favicon.png new file mode 100644 index 0000000000000000000000000000000000000000..c6c3dda5cfd74001fa85792aa0ae0858316416cc GIT binary patch literal 318 zcmeAS@N?(olHy`uVBq!ia0vp^3LwnE1|*BCs=fdz&H|6fVg?4jBOuH;Rhv&5DEPtC z#W5tJ_35;Sg3Ss%tqZSf?&@84xpG%u-euDl^Rsq-5b98=u)VMEKjHht77vc_aFaOw zOj{ksps44U5~5t>wHY$}6c*e+%i$0b_51^?PEd*iE{0?Ykmu!gsOBNe&l( zW<6pEdArqp1zX!pWrk}puhK3_d>40Na4zp-@Voe*!QGs|zNvr+)JM2zzgd3MwYwH93 O&fw|l=d#Wzp$Py%h=C;l literal 0 HcmV?d00001 diff --git a/docs/index.md b/docs/index.md index f9859f8..6208bf9 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,10 +2,62 @@ _layout: landing --- -# This is the **HOMEPAGE**. -Refer to [Markdown](http://daringfireball.net/projects/markdown/) for how to write markdown files. +![cover](./images/SoundMakerCover.png) +[![Pipeline](https://github.com/AutumnSky1010/SoundMaker/actions/workflows/build.yml/badge.svg)](https://github.com/AutumnSky1010/SoundMaker/actions/workflows/build.yml) -## Quick Start Notes: +# SoundMakerとは +SoundMakerは、.NET上で動作する音を生成するライブラリです。 -1. Add images to the *images* folder if the file is referencing an image. \ No newline at end of file +## 特徴 +### 「音程がC4の四分音符」というように音楽の知識で音を生成できます +```cs +// 音符 +new Note(Scale.C, 5, LengthType.Eighth, isDotted: true); +// 休符 +new Rest(LengthType.Quarter); +// タイ +new Tie(new Note(Scale.D, 5, LengthType.Eighth), LengthType.Eighth); +// 連符 +new Tuplet([new Note(Scale.D, 5, LengthType.Eighth), new Note(Scale.D, 5, LengthType.Eighth)], LengthType.Quarter); +``` + +### 周波数を指定しても音を生成できます +```cs +var triangleWave = new TriangleWave(); +int hertz = 800; +int length = (int)format.SamplingFrequency * 5; +int volume = 50; +short[] waveShorts = triangleWave.GenerateWave(format, length, volume, hertz); +``` + +### リニアPCMのWAVを出力することができます +```cs +var builder = FormatBuilder.Create() + .WithFrequency(48000) + .WithBitDepth(16) + .WithChannelCount(2); + +var sound = new SoundWaveChunk(/* 音声波形バイト列 */); +var waveFileFormat = builder.ToFormatChunk(); +var writer = new WaveWriter(waveFileFormat, sound); +string filePath = "sample.wav"; +writer.Write(filePath); +``` + +ストリームへ書き込むことも可能です。 +```cs +writer.Write(stream); +``` + +### 楽譜記述フォーマットを提供 +簡単な楽譜記述フォーマットのシリアライズ・デシリアライズ機能を提供しています。 +``` +// コメントアウト +// 付点四分音符(音階はC#4) +C#4, 4. +// 休符 +rest, 4. +// タイ と 三連符(4分音符を三等分している) +tie(C4, 4, 4, 4); tup(4, C4, C4, C4) +``` \ No newline at end of file From fb5b88f1ec5032cc5f39bd1921f4c2d66f744650 Mon Sep 17 00:00:00 2001 From: AutumnSky1010 <66455966+AutumnSky1010@users.noreply.github.com> Date: Sat, 7 Dec 2024 13:26:49 +0900 Subject: [PATCH 4/6] :book: Write for starter --- docs/markdowns/getting-started.md | 1 - docs/markdowns/start/format.md | 43 +++++++++++ docs/markdowns/start/gen/channel-base-api.md | 50 +++++++++++++ docs/markdowns/start/gen/frequency.md | 29 ++++++++ docs/markdowns/start/gen/track-base-api.md | 70 ++++++++++++++++++ docs/markdowns/start/getting-started.md | 75 ++++++++++++++++++++ docs/markdowns/start/wav.md | 67 +++++++++++++++++ 7 files changed, 334 insertions(+), 1 deletion(-) delete mode 100644 docs/markdowns/getting-started.md create mode 100644 docs/markdowns/start/format.md create mode 100644 docs/markdowns/start/gen/channel-base-api.md create mode 100644 docs/markdowns/start/gen/frequency.md create mode 100644 docs/markdowns/start/gen/track-base-api.md create mode 100644 docs/markdowns/start/getting-started.md create mode 100644 docs/markdowns/start/wav.md diff --git a/docs/markdowns/getting-started.md b/docs/markdowns/getting-started.md deleted file mode 100644 index 8b3a794..0000000 --- a/docs/markdowns/getting-started.md +++ /dev/null @@ -1 +0,0 @@ -# Getting Started \ No newline at end of file diff --git a/docs/markdowns/start/format.md b/docs/markdowns/start/format.md new file mode 100644 index 0000000..832cb85 --- /dev/null +++ b/docs/markdowns/start/format.md @@ -0,0 +1,43 @@ +# 利用できるフォーマットについて + +SoundMakerでは、以下の形式のWAV出力に対応しています。 + +### 出力形式 + +**サンプリング周波数** +- 48000Hz +- 44100Hz + +**量子化ビット数** +- 16bit +- 8bit + +**チャンネル数** +- Stereo 2ch +- Monaural 1ch + +## FormatBuilderの使い方 + +SoundMakerでは、簡単にフォーマットデータを扱うためのビルダクラスを提供しています。 + +### コード例 +```cs +var builder = FormatBuilder.Create() + .WithFrequency(48000) + .WithBitDepth(16) + .WithChannelCount(2); + +// 音声波形生成用フォーマット +var soundFormat = builder.ToSoundFormat(); +// WAV出力用フォーマット +var waveFileFormat = builder.ToFormatChunk(); +``` + +### 詳細な説明 + +- **サンプリング周波数の設定**: `.WithFrequency(48000)` で、サンプリング周波数を48000Hzに設定します。 +- **量子化ビット数の設定**: `.WithBitDepth(16)` で、量子化ビット数を16bitに設定します。 +- **チャンネル数の設定**: `.WithChannelCount(2)` で、ステレオ（2ch）に設定します。 +- **フォーマットの取得**: + - `soundFormat`: `.ToSoundFormat()` メソッドを使用して、音声波形生成用のフォーマットを取得します。 + - `waveFileFormat`: `.ToFormatChunk()` メソッドを使用して、WAV出力用のフォーマットを取得します。 \ No newline at end of file diff --git a/docs/markdowns/start/gen/channel-base-api.md b/docs/markdowns/start/gen/channel-base-api.md new file mode 100644 index 0000000..1687e18 --- /dev/null +++ b/docs/markdowns/start/gen/channel-base-api.md @@ -0,0 +1,50 @@ +# チャンネルベースAPIでの音声生成 + +サウンドチャンネルに音符や休符を挿入することで音声を生成する方法を説明します。 + +### 概要 +この方法では、複数の音のチャンネルを作成し、それらをミキシングしてステレオ音声を生成します。 + +### コード例 +```cs +private static StereoWave MakeStereoWave(SoundFormat format) +{ + // 一分間の四分音符の個数 + int tempo = 100; + // まず、音のチャンネルを作成する必要がある。 + // 現段階では矩形波、三角波、疑似三角波、ロービットノイズに対応している。 + var rightChannel = new SquareSoundChannel(tempo, format, SquareWaveRatio.Point25, PanType.Right) + { + // ISoundComponentを実装したクラスのオブジェクトをチャンネルに追加していく。 + // 現段階では普通の音符、休符、タイ、連符を使うことができる。 + new Note(Scale.C, 5, LengthType.Eighth, isDotted: true), + new Tie(new Note(Scale.D, 5, LengthType.Eighth), LengthType.Eighth), + new Tuplet(GetComponents(), LengthType.Quarter) + }; + var rightChannel2 = new SquareSoundChannel(tempo, format, SquareWaveRatio.Point125, PanType.Right) + { + new Note(Scale.C, 4, LengthType.Eighth, isDotted: true), + new Note(Scale.D, 4, LengthType.Quarter), + new Rest(LengthType.Quarter) + }; + var leftChannel = new TriangleSoundChannel(tempo, format, PanType.Left) + { + new Note(Scale.C, 3, LengthType.Eighth, isDotted: true), + new Note(Scale.D, 3, LengthType.Quarter), + new Rest(LengthType.Quarter) + }; + var channels = new List() { rightChannel, rightChannel2, leftChannel }; + // ミックスは'StereoMixer'クラスで行う。 + return new StereoMixer(channels).Mix(); +} +``` + +### 詳細な説明 + +- **テンポ設定**: `tempo` は1分間に演奏される四分音符の数を示しています。ここでは100に設定されています。 +- **チャンネルの作成**: + - `rightChannel`: 矩形波のサウンドチャンネル。右パンに設定されています。ドット付き八分音符、タイ、連符が含まれています。 + - `rightChannel2`: 矩形波の別チャンネル。異なる周波数（`SquareWaveRatio.Point125`）で設定されています。 + - `leftChannel`: 三角波のサウンドチャンネル。左パンに設定されています。 +- **ISoundComponent** を実装したクラスのオブジェクト（`Note`、`Tie`、`Tuplet`、`Rest`など）をチャンネルに追加しています。 +- **ミキシング**: 最後に、これらのチャンネルを `StereoMixer` クラスでミックスし、ステレオ音声を生成します。 diff --git a/docs/markdowns/start/gen/frequency.md b/docs/markdowns/start/gen/frequency.md new file mode 100644 index 0000000..884c5e6 --- /dev/null +++ b/docs/markdowns/start/gen/frequency.md @@ -0,0 +1,29 @@ +# 周波数を指定し、音声波形を生成する + +周波数を直接指定して音波を生成する方法です。以下のプログラムでは、800Hzの三角波を5秒間生成します。 + +### 概要 +指定された周波数の音波を生成するためのコードです。指定秒数分の配列の長さは `サンプリング周波数 * 秒数` で求められます。 + +### コード例 +```cs +private static StereoWave MakeStereoWave(SoundFormat format) +{ + var triangleWave = new TriangleWave(); + int hertz = 800; + int length = (int)format.SamplingFrequency * 5; + int volume = 50; + + var waveShorts = triangleWave.GenerateWave(format, length, volume, hertz); + return new StereoWave(waveShorts, waveShorts); +} +``` + +### 詳細な説明 + +- **三角波の作成**: `TriangleWave` クラスのインスタンスを作成します。 +- **周波数の設定**: `hertz` は生成する音波の周波数を指定します。ここでは800Hzに設定されています。 +- **配列の長さの計算**: `length` は `サンプリング周波数 * 秒数` で計算されます。ここでは5秒間の音波を生成するため、 `format.SamplingFrequency * 5` となります。 +- **音量の設定**: `volume` で音量を指定します。ここでは50に設定されています(0 <= volume <= 100)。 +- **音波の生成**: `triangleWave.GenerateWave` メソッドを使って、指定された周波数と音量で音波を生成します。 +- **ステレオ音波の作成**: 最後に、生成された音波データを使って `StereoWave` のインスタンスを作成します。 \ No newline at end of file diff --git a/docs/markdowns/start/gen/track-base-api.md b/docs/markdowns/start/gen/track-base-api.md new file mode 100644 index 0000000..a5a8f2e --- /dev/null +++ b/docs/markdowns/start/gen/track-base-api.md @@ -0,0 +1,70 @@ +# トラックベースAPIでの音声生成 (ver 3.0.0以降) + +チャンネルベースAPIと異なり、開始時間をミリ秒で指定でき、パンも数値の範囲で指定できるため、細かな調整が可能です。 + +### 概要 +この方法では、複数のトラックを作成し、それらをミキシングしてステレオ音声を生成します。各トラックの開始時間をミリ秒単位で指定でき、パン（左右の音の配置）も調整可能です。 + +### コード例 +```cs +private static StereoWave MakeStereoWave(SoundFormat format) +{ + // 一分間の四分音符の個数 + int tempo = 100; + var trackBaseSound = new TrackBaseSound(format, tempo); + + var track1Components = new ISoundComponent[] + { + // ISoundComponentを実装したクラスのオブジェクトの配列を定義する。上から順に演奏される。 + // 現段階では普通の音符、休符、タイ、連符を使うことができる。 + new Note(Scale.C, 5, LengthType.Eighth, isDotted: true), + new Tie(new Note(Scale.D, 5, LengthType.Eighth), LengthType.Eighth), + new Tuplet(GetComponents(), LengthType.Quarter) + }; + + var track2Components = new ISoundComponent[] + { + new Note(Scale.C, 4, LengthType.Eighth, isDotted: true), + new Note(Scale.D, 4, LengthType.Quarter), + new Rest(LengthType.Quarter) + }; + var track3Components = new ISoundComponent[] + { + new Note(Scale.C, 3, LengthType.Eighth, isDotted: true), + new Note(Scale.D, 3, LengthType.Quarter), + new Rest(LengthType.Quarter) + }; + + // トラックを作成する + var track1 = trackBaseSound.CreateTrack(startMilliSecond: 0, new SquareWave(SquareWaveRatio.Point25)); + track1.Import(track1Components); + // パンを-1から1の範囲で指定できます。1は左、-1は右です。 + // 上限、下限値をオーバーした場合は上限・下限値に丸められることに注意してください。 + track1.Pan = -1; + + var track2 = trackBaseSound.CreateTrack(0, new SquareWave(SquareWaveRatio.Point125)); + track2.Import(track2Components); + track2.Pan = -1; + + var track3 = trackBaseSound.CreateTrack(0, new TriangleWave()); + track3.Import(track3Components); + track3.Pan = 1; + + // ステレオ波を生成する + return trackBaseSound.GenerateStereoWave(); +} +``` + +### 詳細な説明 + +- **テンポ設定**: `tempo` は1分間に演奏される四分音符の数を示しています。ここでは100に設定されています。 +- **トラックの作成**: + - `track1`: 矩形波のトラック。パンは右（`Pan = -1`）に設定されています。 + - コンポーネント: ドット付き八分音符、タイ、連符。 + - `track2`: 矩形波の別トラック。パンは右（`Pan = -1`）に設定されています。 + - コンポーネント: ドット付き八分音符、四分音符、休符。 + - `track3`: 三角波のトラック。パンは左（`Pan = 1`）に設定されています。 + - コンポーネント: ドット付き八分音符、四分音符、休符。 +- **開始時間の指定**: 各トラックの開始時間をミリ秒単位で指定できます。例えば、`track1` の開始時間は `startMilliSecond: 0` です。 +- **パンの設定**: パンを -1 から 1 の範囲で指定でき、1 は左、-1 は右を示します。上限、下限値をオーバーした場合は自動的に丸められます。 +- **音波の生成**: `trackBaseSound.GenerateStereoWave` メソッドを使って、すべてのトラックをミックスし、ステレオ音波を生成します。 \ No newline at end of file diff --git a/docs/markdowns/start/getting-started.md b/docs/markdowns/start/getting-started.md new file mode 100644 index 0000000..45981a1 --- /dev/null +++ b/docs/markdowns/start/getting-started.md @@ -0,0 +1,75 @@ +# 最初のコード +```CSharp +using SoundMaker; +using SoundMaker.Sounds; +using SoundMaker.Sounds.Score; +using SoundMaker.Sounds.SoundChannels; +using SoundMaker.WaveFile; + +namespace YourNamespace; +public static class YourClass +{ + private static void Main() + { + // サウンドの形式を作成する。 + var builder = FormatBuilder.Create() + .WithFrequency(48000) + .WithBitDepth(16) + .WithChannelCount(2); + + var soundFormat = builder.ToSoundFormat(); + StereoWave wave = MakeStereoWave(soundFormat); + + // ファイルに書き込む。 + var sound = new SoundWaveChunk(wave.GetBytes(soundFormat.BitRate)); + var waveFileFormat = builder.ToFormatChunk(); + var writer = new WaveWriter(waveFileFormat, sound); + string filePath = "sample.wav"; + writer.Write(filePath); + } + + private static StereoWave MakeStereoWave(SoundFormat format) + { + // 一分間の四分音符の個数 + int tempo = 100; + // まず、音のチャンネルを作成する必要がある。 + // 現段階では矩形波、三角波、疑似三角波、ロービットノイズに対応している。 + var rightChannel = new SquareSoundChannel(tempo, format, SquareWaveRatio.Point25, PanType.Right) + { + // ISoundComponentを実装したクラスのオブジェクトをチャンネルに追加していく。 + // 現段階では普通の音符、休符、タイ、連符を使うことができる。 + new Note(Scale.C, 5, LengthType.Eighth, isDotted: true), + new Tie(new Note(Scale.D, 5, LengthType.Eighth), LengthType.Eighth), + new Tuplet(GetComponents(), LengthType.Quarter) + }; + var rightChannel2 = new SquareSoundChannel(tempo, format, SquareWaveRatio.Point125, PanType.Right) + { + new Note(Scale.C, 4, LengthType.Eighth, isDotted: true), + new Note(Scale.D, 4, LengthType.Quarter), + new Rest(LengthType.Quarter) + }; + var leftChannel = new TriangleSoundChannel(tempo, format, PanType.Left) + { + new Note(Scale.C, 3, LengthType.Eighth, isDotted: true), + new Note(Scale.D, 3, LengthType.Quarter), + new Rest(LengthType.Quarter) + }; + + var channels = new List() { rightChannel, rightChannel2, leftChannel }; + // ミックスは'StereoMixer'クラスで行う。 + return new StereoMixer(channels).Mix(); + } + + private static IReadOnlyList GetComponents() + { + return new List() + { + new Note(Scale.E, 5, LengthType.Eighth), + new Note(Scale.F, 5, LengthType.Eighth), + new Note(Scale.G, 5, LengthType.Eighth), + }; + } +} +``` + +今後の説明でもこのサンプルコードを利用します。 \ No newline at end of file diff --git a/docs/markdowns/start/wav.md b/docs/markdowns/start/wav.md new file mode 100644 index 0000000..7fc8e44 --- /dev/null +++ b/docs/markdowns/start/wav.md @@ -0,0 +1,67 @@ +# WAV出力 + +SoundMakerではWAV形式(リニアPCM)で音声を出力できます。 + +### ファイルに出力する + +以下のコード例では、サウンドの形式を作成し、波形をファイルに出力する方法を示しています。 + +#### コード例 +```cs +// サウンドの形式を作成する。 +var builder = FormatBuilder.Create() + .WithFrequency(48000) + .WithBitDepth(16) + .WithChannelCount(2); +var waveFileFormat = builder.ToFormatChunk(); + +// 波形のバイト列 +var wave = new byte[10]; + +var sound = new SoundWaveChunk(wave); +var writer = new WaveWriter(waveFileFormat, sound); +var filePath = "sample.wav"; +writer.Write(filePath); +``` + +#### 詳細な説明 + +1. **サウンド形式の作成**: `FormatBuilder` を使用してサウンドの形式を設定します。 + - `.WithFrequency(48000)`: サンプリング周波数を48000Hzに設定。 + - `.WithBitDepth(16)`: 量子化ビット数を16bitに設定。 + - `.WithChannelCount(2)`: チャンネル数をステレオ（2ch）に設定。 +2. **フォーマットの取得**: `ToFormatChunk` メソッドを使って、WAV出力用のフォーマットを取得します。 +3. **波形の作成**: `SoundWaveChunk` クラスのインスタンスを作成し、波形データ（バイト列）を渡します。 +4. **ファイルへの書き込み**: `WaveWriter` クラスを使用して、フォーマットと波形データを指定し、ファイルに出力します。 + +### ストリームに出力する + +以下のコード例では、サウンドの形式を作成し、波形をメモリストリームに出力する方法を示しています。 + +#### コード例 +```cs +// サウンドの形式を作成する。 +var builder = FormatBuilder.Create() + .WithFrequency(48000) + .WithBitDepth(16) + .WithChannelCount(2); +var waveFileFormat = builder.ToFormatChunk(); + +// 波形のバイト列 +var wave = new byte[10]; + +var sound = new SoundWaveChunk(wave); +var writer = new WaveWriter(waveFileFormat, sound); +var memoryStream = new MemoryStream(); +writer.Write(memoryStream); +``` + +#### 詳細な説明 + +1. **サウンド形式の作成**: `FormatBuilder` を使用してサウンドの形式を設定します。 + - `.WithFrequency(48000)`: サンプリング周波数を48000Hzに設定。 + - `.WithBitDepth(16)`: 量子化ビット数を16bitに設定。 + - `.WithChannelCount(2)`: チャンネル数をステレオ（2ch）に設定。 +2. **フォーマットの取得**: `ToFormatChunk` メソッドを使って、WAV出力用のフォーマットを取得します。 +3. **波形の作成**: `SoundWaveChunk` クラスのインスタンスを作成し、波形データ（バイト列）を渡します。 +4. **ストリームへの書き込み**: `WaveWriter` クラスを使用して、フォーマットと波形データを指定し、メモリストリームに出力します。 \ No newline at end of file From 427e76e574612489e90858e8eaa014b4e2b9fe23 Mon Sep 17 00:00:00 2001 From: AutumnSky1010 <66455966+AutumnSky1010@users.noreply.github.com> Date: Sat, 7 Dec 2024 13:29:22 +0900 Subject: [PATCH 5/6] :book: Describe the documentation for smsc --- docs/markdowns/smsc/serializer.md | 55 +++++++++++++++++++++++++ docs/markdowns/smsc/what-is-the-smsc.md | 21 ++++++++++ 2 files changed, 76 insertions(+) create mode 100644 docs/markdowns/smsc/serializer.md create mode 100644 docs/markdowns/smsc/what-is-the-smsc.md diff --git a/docs/markdowns/smsc/serializer.md b/docs/markdowns/smsc/serializer.md new file mode 100644 index 0000000..cc2be21 --- /dev/null +++ b/docs/markdowns/smsc/serializer.md @@ -0,0 +1,55 @@ +# SMSCシリアライズ・デシリアライズ + +SMSCデータをシリアライズおよびデシリアライズする方法を示します。 + +### シリアライズ + +以下のコード例では、サウンドコンポーネントをSMSC形式にシリアライズする方法を示しています。 + +#### コード例 +```cs +// using SoundMaker.ScoreData.SMSC; +// using SoundMaker.Sounds.Score; +var components = new List() +{ + new Note(Scale.E, 5, LengthType.Eighth), + new Note(Scale.F, 5, LengthType.Eighth), + new Note(Scale.G, 5, LengthType.Eighth), +}; +var smsc = SMSCFormat.Serialize(components); +Console.WriteLine(smsc); +``` + +#### 詳細な説明 + +1. **サウンドコンポーネントの作成**: `ISoundComponent` を実装したクラス（例：`Note`）のオブジェクトをリストに追加します。 + - `new Note(Scale.E, 5, LengthType.Eighth)`: 音階E、5オクターブ、長さは八分音符の音を作成。 + - 同様に、音階FおよびGの音符も追加します。 +2. **シリアライズ**: `SMSCFormat.Serialize` メソッドを使用して、サウンドコンポーネントのリストをSMSC形式にシリアライズします。 +3. **出力**: シリアライズされたSMSCデータをコンソールに出力します。 + +### デシリアライズ + +以下のコード例では、SMSC形式のデータをサウンドコンポーネントにデシリアライズする方法を示しています。 + +#### コード例 +```cs +// using SoundMaker.ScoreData.SMSC; +// using SoundMaker.Sounds.Score; +var smsc = "C4, 4"; +var result = SMSCFormat.Read(smsc); +if (result.TryGetValue(out IReadOnlyList components)) +{ +} +else +{ +} +``` + +#### 詳細な説明 + +1. **SMSCデータの読み込み**: シリアライズされたSMSC形式の文字列を用意します。例：`"C4, 4"`。 +2. **デシリアライズ**: `SMSCFormat.Read` メソッドを使用して、SMSC形式のデータをサウンドコンポーネントにデシリアライズします。 +3. **結果の確認**: + - `result.TryGetValue(out IReadOnlyList components)`: デシリアライズに成功した場合、サウンドコンポーネントのリストを取得します。 + - デシリアライズに失敗した場合の処理も含めます。 diff --git a/docs/markdowns/smsc/what-is-the-smsc.md b/docs/markdowns/smsc/what-is-the-smsc.md new file mode 100644 index 0000000..5f28f6d --- /dev/null +++ b/docs/markdowns/smsc/what-is-the-smsc.md @@ -0,0 +1,21 @@ +# SMSCフォーマットとは？ +## 概要 +簡単にSoundMaker用の楽譜を記述するためのフォーマットです。詳細な情報は設定できませんが、簡単に記述できます。 +チャンネルやトラックの完全なデータを永続化する目的では利用できないことに注意してください。 + +## 例 +``` +// コメントアウト +// 付点四分音符(音階はC#4) +C#4, 4. +// 休符 +rest, 4. +// タイ と 三連符(4分音符を三等分している) +tie(C4, 4, 4, 4); tup(4, C4, C4, C4) +``` + +## 仕様 +[BNF(バッカス・ナウア記法)](https://github.com/AutumnSky1010/SoundMaker/blob/master/src/SoundMaker/ScoreData/SMSC/SMSC.bnf) + +## 今後の展望 +音量やエフェクトなどを指定できるように仕様を拡張する可能性があります。 \ No newline at end of file From a8dd5ab319ca5e92429f8df013d7e008a2d53435 Mon Sep 17 00:00:00 2001 From: AutumnSky1010 <66455966+AutumnSky1010@users.noreply.github.com> Date: Sat, 7 Dec 2024 13:30:19 +0900 Subject: [PATCH 6/6] :book: Fine tuning --- docs/HowToUseDocFX.md | 7 +++++++ docs/docfx.json | 7 +++++-- docs/markdowns/introduction.md | 3 ++- docs/markdowns/migrate-to-ver-3.md | 28 ++++++++++++++++++++++++++++ docs/markdowns/toc.yml | 27 ++++++++++++++++++++++++--- docs/toc.yml | 4 ++-- 6 files changed, 68 insertions(+), 8 deletions(-) create mode 100644 docs/HowToUseDocFX.md create mode 100644 docs/markdowns/migrate-to-ver-3.md diff --git a/docs/HowToUseDocFX.md b/docs/HowToUseDocFX.md new file mode 100644 index 0000000..969f8d0 --- /dev/null +++ b/docs/HowToUseDocFX.md @@ -0,0 +1,7 @@ +# ローカル環境でドキュメントをプレビューする方法 +リポジトリルートで、 +``` +docfx docs\docfx.json --serve +``` + +を実行する。 \ No newline at end of file diff --git a/docs/docfx.json b/docs/docfx.json index 32d9edc..ffb2fcd 100644 --- a/docs/docfx.json +++ b/docs/docfx.json @@ -36,9 +36,12 @@ "modern" ], "globalMetadata": { - "_appName": "SoundMaker API Reference", - "_appTitle": "SoundMaker API Reference", + "_appName": "SoundMaker Documentation", + "_appTitle": "SoundMaker Documentation", + "_appFooter": "SoundMaker © 2022-2024", "_enableSearch": true, + "_appLogoPath": "images/favicon.png", + "_appFaviconPath": "images/favicon.png", "pdf": false } } diff --git a/docs/markdowns/introduction.md b/docs/markdowns/introduction.md index f6ecaa6..0bc605a 100644 --- a/docs/markdowns/introduction.md +++ b/docs/markdowns/introduction.md @@ -1 +1,2 @@ -# Introduction \ No newline at end of file +# イントロダクション +ここではSoundMakerの使用例をプログラムを示しながら紹介します。 \ No newline at end of file diff --git a/docs/markdowns/migrate-to-ver-3.md b/docs/markdowns/migrate-to-ver-3.md new file mode 100644 index 0000000..042eec7 --- /dev/null +++ b/docs/markdowns/migrate-to-ver-3.md @@ -0,0 +1,28 @@ +# Ver 3.0.0への移行ガイド + +SoundMaker Ver 3.0.0への移行に関して、以下のガイドラインに従ってください。メジャーバージョンアップにより、破壊的変更が含まれていますのでご注意ください。 + +## .NET 7以前を利用している場合は.NET 8以降へアップデートする +.NET 6のサポート終了に伴い、SoundMakerも.NET 8へ移行しました。.NET 8へのアップデートは以下の手順で行います： +1. **.NET SDKのインストール**: 最新の.NET 8 SDKを[公式サイト](https://dotnet.microsoft.com/download/dotnet/8.0)からダウンロードしてインストールします。 +2. **プロジェクトファイルの更新**: 各プロジェクトの`TargetFramework`を`.NET 8`に更新します。例えば、`.csproj`ファイルで以下のように変更します： + ```xml + net8.0 + ``` +3. **依存関係の更新**: `.NET 8`に対応するライブラリやパッケージのバージョンを確認し、必要に応じてアップデートします。 + +## ushort[]型からshort[]型を利用するように変更する +音声波形は符号付き整数を利用することが一般的なので、Ver 3.0.0では`ushort`型から`short`型に変更しました。以下の手順で対応します： +**コードの修正**: `ushort[]`型を使用している箇所をすべて`short[]`型に変更します。例えば、 +```csharp +// 旧コード +ushort[] sample = [32767]; + +// 新コード +short[] sample = [32767]; +``` + +## 廃止機能を利用しない +Ver 3.0.0以前に`Obsolete`属性がついたメソッドやプロパティは削除されました。これに対応するためには、以下の手順を行います： +1. **コードのチェック**: `Obsolete`属性が付与されたメソッドやプロパティを使用している箇所を確認します。これらはコンパイラ警告として表示されることが多いです。 +2. **代替機能の利用**: `Obsolete`となった機能の代替となるメソッドやプロパティを使用します。削除された機能に関する詳細は、削除を行ったプルリクエストを参照してください：[削除を行ったプルリクエスト](https://github.com/AutumnSky1010/SoundMaker/pull/29/files) diff --git a/docs/markdowns/toc.yml b/docs/markdowns/toc.yml index d7e9ea8..5191b2f 100644 --- a/docs/markdowns/toc.yml +++ b/docs/markdowns/toc.yml @@ -1,4 +1,25 @@ -- name: Introduction +- name: イントロダクション href: introduction.md -- name: Getting Started - href: getting-started.md \ No newline at end of file +- name: 基本的な使い方 + items: + - name: 最初のコード + href: start/getting-started.md + - name: 利用できるフォーマット + href: start/format.md + - name: 周波数を指定し、音声波形を生成する + href: start/gen/frequency.md + - name: 音楽知識から波形を生成する + items: + - name: チャンネルベースAPI + href: start/gen/channel-base-api.md + - name: トラックベースAPI + href: start/gen/track-base-api.md + - name: WAV出力 + href: start/wav.md +- name: Ver 3.0.0への移行 + href: migrate-to-ver-3.md +- name: SMSCフォーマット + items: + - name: SMSCフォーマットとは？ + href: smsc/what-is-the-smsc.md + - name: SMSCシリアライズ・デシリアライズ \ No newline at end of file diff --git a/docs/toc.yml b/docs/toc.yml index 096f523..aa29dec 100644 --- a/docs/toc.yml +++ b/docs/toc.yml @@ -1,4 +1,4 @@ -- name: Docs +- name: ドキュメント href: markdowns/ -- name: API +- name: APIリファレンス href: api/ \ No newline at end of file