From ef2352f66764984f4aa4a58c21903cb09cfcffd3 Mon Sep 17 00:00:00 2001 From: litter Date: Sun, 10 Nov 2019 12:09:03 -0500 Subject: [PATCH] Add documentation --- library.properties | 4 ++-- library/SoundtrackOptical.jar | Bin 1176356 -> 1176359 bytes src/soundtrack/optical/SoundtrackOptical.java | 14 ++++++++++++++ 3 files changed, 16 insertions(+), 2 deletions(-) diff --git a/library.properties b/library.properties index 3ff3150..3f277ed 100755 --- a/library.properties +++ b/library.properties @@ -6,7 +6,7 @@ url = https://github.com/sixteenmillimeter/SoundtrackOptical categories = "Animation,Sound,Video & Vision" sentence = Framework for generating 16mm optical soundtracks from a digital audio file. paragraph = Create optical soundtracks in different styles to be used in super16 film-out -version = 2 -prettyVersion = 0.02a +version = 3 +prettyVersion = 0.03a minRevision = 2 #maxRevision = 2 diff --git a/library/SoundtrackOptical.jar b/library/SoundtrackOptical.jar index 5b4e8da45b4fbfafdc1f3c3e8dcbca64247fc412..56a987b508c6b71fb0decede6ca57f88da64808c 100644 GIT binary patch delta 3783 zcmYkEOKlB?2rqoRKa1GlCH(wF#Cs=I^OU(R6tAULabau5Rt@b0Z z;Ha4RQf+ou)xXO58aH&vdtxT27Lop4igbI>gOA z0N?=^-o0K8dx88*_Yr+nfQrl^r=*APRU__>0+egQvXL^6ER_-#8xfyfMSGMXqJF1N+F^}-m>L^4lnUD?FZ90iuR56RO@V%{Y@a{*(2iZiEB87OQ zYp)4heo*>wJ@(IcE3U%)sGK@oSu<79Kx^vsSxD1KVNu+;aH^Gu$G#%c%r=U{4d3u zX=yZCn2>ObPwW@I3a?%XVm?4Zr2Hv^2Wx@+$ zD|zfH=cC1{Oc?XMEYmN&VX&%1nzqe4S(l@$zcyS<9uQ5q#cd7-zBz5zI;OHIC=7yLz3Mk+wXNx@+A? zZq}hA_|v+Hp;_11)HjRLd4hn0m$69q*j5YUt48C$X?y#=HV{93Uu8j++Lp{SOI5vX z*A~%?st8t{8G8@a#5{2@H~u0N#f&M87@9VlFllx&&9c++ZZy7pnK9&W{DsJ$@zztT zD9qecR&>c}E4#E3ax%-(Zd%xDPFe}(V_H??8RhI|v0ibc!cC&Yja0sPmUfO#li2HH zPAxOX_UWoKY&G?@`lv@}xb* z3*1~a)o0m~ueT!+Rac8wbBZ$woaolW$bGxE^>c~8l=H=I8LaP7dEA7LnX&^LHacyO zO{Q97t%@wZdqx@}!7?mqgTYKrIr+RUi&BXa*~Zh7A@595pgJ#rSPqs zQM&qkRFwfocK66Qs!Mv#C(&n_A?TTbOasq#vjAa^UmP>~+}GwGPqr%rl)z;%WBoDc zVa%WB5I=&!GdR;>cCu%VfnWoQNlD`)WM@g?x+V;jK=+Xqe&{h7nLKc}zj4C0xOz~w zkHZ_@(C#%QR!6i-bc%1YFYH;&@POA5(TM{bK~V;T-Y55*U#yTA6BS?_lVZ)pD~XKp zOrG$@!$5C%J+X$g_J++j(E!7rJ$hnZ9pb&J(j6rLWi68BVx;*9tR|nO8v^jTCA4#jw5vL-ytj3@mfMy?Wig}*#lN#pyXRH7@nJRMV*PrCSKnXiX`ZOLt& z@KyR@;WUR@DikrRS$XkiEuo^bee8**`QfV^KQ!}?+fw7-z4t5Q(}+v8ohSv3+g9@O z*KE@?KC&k8l*?>h7-1qCuXfkxlo+}UK;t-D zM{9@lE5h6qgQI~(XSdzO1|LojY=OByEW8bLC zHu!tgC@k_k4r8K|{@ZNH*wpM+9dt)t@{wn|baR?kK?!=_3{y$w8Hkr;`_ftty8-eeC{rD&eStZZHy3 z5vga`9}zY{EKs$3Iy~r3IxaRHjgh79PpYQUJrR;i$5aD#ML%zZD33I+&?-we5c*24 zA))%p(oLRm#-cNi>x^MYwO-8!ZXbq_wulMB;pr{>y=L*Y%zU4O=(;7&L5|U}5u@_? zm0-H$nSPIY;6d3D>*#)HnR(`d^l(mIH@q4gwb!l|wbzjg5g$GXmAQw=oqpfQUG1*T z*yy;8(H@@bK{(!`%^MC6_p%Zo6|ix;ezTEl5sfNIDYo?{^x|LX;F*D38G|*$czn12 zLRC7Vn7LeUN?aFrl)x6+?p{(eYnOFX(<(M5jd#(Z7RD zzPV6NGIDXT-l!>0du&~o(+H8XX`}M|U=gD_(-bj~Vr*c11IqqsY)lL{Ygh%oq^B%E zO8g=$^NP=}q-IQV7B~2q0dM{}3-SfpZvMaq+Hgj4m|ATZho5?yO(jO~ z9zJetrN{kwraesK3TymE%UP(?Bd}kPqI{4fxhbbK=&CD=)0M-AGKWh-Q(t?78TWQ> z$#lsN_iaobE6enT**wMMTdlk=EkUI0c2}?NY?RXC2)=)BSLheE0!O?QZ70zUWey(Z zXCM>$T0Oq}-|SNFuNc(Mb&GG2pi~$){|I+iVopU5^ZTzuVv3i81j@S*#Iu$xS5<<2 z=>q?}G;xwn%7xkY0;=~C*9}RSo=0o9)bvI*%vMFftdS_*TMKkg>_>deg$qIRle#*lR@U?V4T9*TslUlNO>K`x5`u z#62aZqp}m?{gY$FYy`cfI=|T^r#*?k314q(Y{~u64M*HHJ!ex>@?eHXlPd)@_lFh0-|X>o}Ik=QlJ^{J_;Sy zJYonV6*~J^mmvSM-ljC21KOfDA1O6Cr1)DG?FmoS3pHWRQ)nTGOMSxz&55mRDd?!a zJ9)3is6D#Uob8duZL?YEMx|ftcu(t?pJhKim8&?|^af87R5vnJV*dhTE&HQ$se)#k zO|@I3i!nS3mio`Uk9Nun#biOkg1te#tbD3H{AxXpM-6^c-dy+9zhtAEX3$ME*Ryi* zo;52vq!^5tU)V=CdOD8^EZ9k^4KzVJn}y{THFKJW zgE!H1g-wn+i{Gr@%#QP0t?&f#6QZsa(fsSD@HQtI1!N=6$ zRR28S>JVEcHxK|A0s?T!7EC;m$Do*F5Rih3f|`Pcf|i1gf}Vnb;t~ZT1rr4`#bt^s z6f6|1&Bq{+`d6xJ2%OS3sP3}wL$CY)?G$kP+aQTco0QQ1XAUR2142UNSpWbTXCFjB z01ENg!vqGTVgvlAT?8V$?*HqC07{nsHDYihJ0LCK0`4*y1f@>5V8T^dFlpfu$RG(| zIj)%uvIYj?Saw0?%BN!i!PzK=CC zNS3l^Uy_m1o&UYhbMHOp{63uX;XLni-Vf(}i&k{=S9Dp84d@v-0nE(I0Bh$;)_fox zNu;_82nAvo51cc{nuW&osfT?yprr^K8Em_aK2{FUs@PdQDBI9aHc5gcu9jVXw1Ry; zkTTy+-Z&Nq_mC8d(;{@Fz=@9w&JR2HT*?Sz)-Wuv^|b6?t{>;scmaI@HLc9$4i&hf zVy^;uEB2_O$g8i_HFO49?I)Yjw#sdO=3q0ZyBg!yXn)!c@z4}DGuxki%&L=C-84IP z%vspE*?bIgz9BMMlA18Zt^ukwt&@r`p2Y&2eV4^b!%6Qj47 zrg(TQKA;^;{YZR~%7MhDpvqor4cFA0pVr`U2-nNHRiDwY;-FAY`=!fat_<`eS~bU< zryiJ_bFKSPL4V2~eCf6TLX%IvpNr#9NK!ZL-R~Y^SLD=n%ZylM!6jHy7rNpurQ7%+ z5b<}DOi-0py1)O{4e$&}Y^I%y#C0f@H1WM54_6Ld5Jskn;A%9q@?Lx6K7~twj_(B@ z7d-f}*4xYe7iOWISH;k+!!6f=YMqTe4Wyz_L-pIrj8L3dr!t) z^O#x)B19v7OGuqmqB(V?xXmQsZ3R!F`j`z5R&V(fWNZLpw)^}SSxN^0Tx0|Q{+D8o z)Kms_j5j)s0*~2ola7EH(VH|Q=g`ECp_*o!;7^EYXlzH3z)UOroM`rS3FWi`f0WbF29zU;=;nUEb- zlIo7q{PGkgJBF=IrFkP>>)TQ+)%l%rI%}AJF(y&e6jx?kQz$89i_)736z431LgIXK zbF2e~_JtaQ0*3pQy^A^vA(sot}{Hr#A}V~;Q0rqW5#a$n zEM?C74s{T8z1%}|*gL%?##{I{+pSoAhHKsEmQsj)&x7E>=%2T48IL``-P6=TPv4B= z6RIzp7_n%~aq~*mJnlj|?71}*-t(5lq^%`~LIP6^Si8{__tbidh?jzJmeiB3OC{Q1 zyd^Pka*31icdC1;aOvAe%{bw`?Leujz<8Z&!}%K)6bgAQs_3TkXeW0c>xic6e+LX9J;DdYFh9PsYfD-w>1M zl~9KE?@YwTJO1>#+m@R!NY0o-q(i0X8oIDX90H3#`FPW4KFCG4s?^}E8q4K!w!X?` zJ~PR3Tlpl(GGt!Yf)qupwgJvJE>WiC`k~vQ(8MDM?>ksAV_j;3>eu9hb4?bQcn7&) zGbUObu{K=XV~TK#4*$_UOaiGEy^>xo9i2}Vm*uY;Qu(z1lA+c_C=tjsdKTN8%5l>n zjL828EN962-afxVk3+jF``CotjRH@KEwS-Du8%i$N&WRe!m%jm zqr`_h5Y{L4*S-AU0Yryyx6RG{Cl$|JAaxtgto0PZ3yE#q*sNV%j7WL%u3lX4*K(Os zarWZV3x|RVs0k{AAuI(&X@I;gxaV`VpUwQly%&Z3JPKxn;H(?GD_Z3Ue%v+si%Hc@ zjQ&5SH9g--Yknz`|E*5MQSj<5BLM?yrONHkzVRjLf=;k4LuWXQE~&BWX~*}8i+JeU zC4u;~&bU&r(L27F3QJ9N-IpIv{2Dq%njxiePwY$I8ELb{pps3(aA3e?OWo?=H9f4>rNgd;&?_y15*;vXr=sTS z)N<~GYBjIQ5I{Eijk17iMV9+fHJ?*^hzMf8KhWy<*yw2xNO#N#R&e(0XWNYI<)Yk8mX|_e?ZDZj6W}DQ!&0OF64*ICm*U} zHj~@6tJ4BEKQ1Xh9gm*NlwYAH?Q<1fom{=MDDc{F(f)OW1|LiG9Lu=%(n0Y1iB*Re zI>Zr71anAzh&87{r?i|prgkI6*@h1(8z4@Y!|NPOnG$Qs>m>a=hxj+F2zTpcl7VY& zps$;?s8&(m2lur-;!B;^J3r(nP6n#Fd-eAMGtHV2LCJaUQacYpIJ2i~GWOk1X2nr4 zp`eI!8Vepld%XEK4D-DHxUd#f+JyU^Z@0iKD1QFg@qKJd2Pq>5r&R8VSxxJf37^r4 z5NLmyB`lSpx}ooyWmHq1_MJIAzY^iw;`ypxB0*n8s6iO}rJq!O^6WlNl%<{&W?hx7 zyffSvSr=)Z*jrZ@@MCRpFqmumE0t~~Pz7puR|%gXeYeb@Km9C86xLeA(d5ZqACicn z*e=w>@i-u(bQ1fqU5o6MXn2H^?xw%cHtO;UN^max;K%vgO-G5g7>O_&HC z*&W)7N!{o;zWKIpG{3=a0J(&YN|BH-Q)3|0wZzy4C9W^u_Y}$`A9|T6kG>7hLvCp| z-FWim#$))p&45#v_)Nc;rJZ8;Y9I#xAcOGLh8G1zjJY(7$PGwzM#oaV%FoQ&4=E7L z%SeGoyIeCqh?lZV(7&^~>D-;ylJMVxv>GeNu^$K8HHw+ZV#uf|KHl`h^E%|s61HC< z>H%G3u1s&INd1=b=7*oZD?bM5$Vhw+dbPQfG}1tDe18=-To<0AeS6!*>^-IXQnSUk5`MWeu3sUezS#CjDhmzBaMG-4TS4)C;N{TVd%(mnQg!{&h4x#(jAPeUPs zvW1J`@}3d|lIC$?NxFr{0Vd*negTK*u|>k(g3N->uYF*M-?O9ppf`|%M~Npf@=ptN zY~@UTrMmoN#+`<4j*f^*{SD@EB&pZ2>O&VN?T7>Kn2xYg)lyr?{)~#{FNm&LOWsU0 zqO~-1bD1$*CVcgV;|coXY`-H*sI0WZAnH{*xifOZb@`pA^jurBHpa&H&#M$3gqx64 zj^0A#lcwt?k&GNugL^(L;$?#1vTjGqxq~T9K|fBx7d2Eq0zHepH&S~aQaM>w?UksGdaBluSmCA*IcS3P+B z8o!~T?wEB6sog(by@AGE`R@zE(o!PWcIJDg<5jrs1c+C4+NeHkh1$tg`-VXo6*!Qc z{WEp&t~=8Jb=!1wTEQ`o4^=&>dXIs$&+dTCa@LoWmTj+@Zhx|9s5qRhd3r9j6?4k{ zPX+oNv6NyA1^`Mp{=WjHGCEYNLCt`45Yg0Bb}>xnP4!B#f4uL0AR|B98G($OhW!@DN$L5%Y>wfh=-8J6dchyK zRt$XG|8{99ax-~#+1)HwLf+x*$yAk}F>_(!^kYnrVpIngApeR~7;F~`>d9SPD={ji zbiTaE^j3~Ihm>_%u~t4b8OpwFWYowa$9$nATfx)Ka*)eQqRDgmz~)*V`Zs+P@SpeN z9vZ&L^Jp5DFbxCJ(9zJ-Fwij4FwuZ$m}$6+8M97 z1FM3NM0||?+Z^DJc3|RXIGlZq{+%tn_%6&}Nd^i4NV)pCgoFgTgnAhp0O>dZ|LG7R zqCQ6d4hskXkZ5R`{l5{9AKiti1LyGUdoWdcoH+}=(ws#dpRxxN2NvT$?7^&n!FY~+ xm>F;t@39Ya0Vd=7_F-y*QJXNp9X%~=Lo;n-14gEQZe*j)ReAtGbO%P;{R`E14=n%y diff --git a/src/soundtrack/optical/SoundtrackOptical.java b/src/soundtrack/optical/SoundtrackOptical.java index c8e8261..f447793 100755 --- a/src/soundtrack/optical/SoundtrackOptical.java +++ b/src/soundtrack/optical/SoundtrackOptical.java @@ -89,10 +89,24 @@ public class SoundtrackOptical { } } + /** + * Calls frame() every frame of parent PApplet draw() + * + * @param X {Integer} Left position of soundtrack to draw on parent renderer + * @param Y {Integer} Top position + */ public void draw (int X, int Y) { frame(X, Y, parent.frameCount); } + /** + * Draws a frame on parent PApplet window at position + * + * @param X {Integer} Left position of soundtrack to draw on parent renderer + * @param Y {Integer} Top position + * @param frameNumber {Integer} Frame of soundtrack to draw + */ + @SuppressWarnings("static-access") public void frame(int X, int Y, int frameNumber) { if (frameNumber != -1) {