CW Cyrix's Git Repository Mirror
Browse code

Added README file.

Naram Qashat authored on 2013/05/09 01:25:49
Showing 1 changed files
README.txt
History View file @ 1173161
1 1 
new file mode 100644
... ... 
@@ -0,0 +1,101 @@
1 
+in_ncsf - NCSF Winamp Plugin
2 
+By Naram Qashat (CyberBotX) [cyberbotx@cyberbotx.com]
3 
+
4 
+(If you need to email me, please include NCSF in the subject line.)
5 
+
6 
+Special thanks to fincs for FeOS Sound System, as well as the DeSmuME
7 
+team for their open-source Nintendo DS emulator.
8 
+
9 
+Version History
10 
+---------------
11 
+  v1.0 - 2013-03-25 - Initial Version
12 
+  v1.1 - 2013-04-02 - Fixed crash upon seeking backwards (also causes crash
13 
+                      in XMPlay on stopping).
14 
+                    - Added version number to the plugin description.
15 
+                    - Added 3 more interpolation options: B-spline, Hermite,
16 
+                      and Optimal.
17 
+  v1.2 - 2013-04-07 - Fixed crash if Winamp tries to access a file that no
18 
+                      longer exists, reported by Caitsith2.
19 
+                    - Utilized the SSEQ's volume from the INFO section.
20 
+                    - Minor optimizations.
21 
+  v1.3 - 2013-04-10 - Added more interpolation methods, cleanup of interpolation
22 
+                      code, and stopped using slope to determine points outside
23 
+                      the sample in an attempt to prevent clipping or popping.
24 
+                    - Made it so certain changes in the configuration dialog
25 
+                      will apply immediately after clicking OK.
26 
+                    - Minor optimizations.
27 
+  v1.4 - 2013-04-12 - Removed the Optimal, Lagrange, and Hermite interpolations,
28 
+                      added in 2nd-order Osculating interpolation.
29 
+                    - Changed handling of start/end of SWAV data to use the
30 
+                      closest data point instead of only the current one.
31 
+  v1.5 - 2013-04-18 - Implemented circular interpolation buffer to fix
32 
+                      interpolation, thanks to kode54 for the code.
33 
+  v1.6 - 2013-04-23 - Added Lanczos (Sinc) interpolation. Also modified Cosine
34 
+                      interpolation to use a lookup table instead.
35 
+  v1.7 - 2013-04-26 - Fixed Lanczos interpolation a bit (thanks to kode54), also
36 
+                      allowed the plugin to handle 32-bit samples.
37 
+v1.7.1 - 2013-04-26 - Minor update to scale the phase offset, thanks to kode54.
38 
+  v1.8 - 2013-05-07 - Replaced Lanczos window for Sinc with the Hann window.
39 
+                    - Added a ring buffer designed to work with SWAVs, replaces
40 
+                      kode54's implementation (still have to give him big thanks
41 
+                      for the original implementation).
42 
+                    - Corrected clamping issue which caused some clipping-like
43 
+                      effects.
44 
+
45 
+This is a Winamp plugin to play NCSF files. NCSF is a PSF-style music format that
46 
+uses SDAT files from Nintendo DS ROMs as it's "program".
47 
+
48 
+Contains:
49 
+*    in_ncsf.dll - The NCSF Winamp plugin
50 
+* zlib DLL v1.25 - Required by the plugin
51 
+
52 
+To allow Winamp to use the plugin, place in_ncsf.dll into your Winamp plugins
53 
+directory and zlib1.dll into your Winamp directory (NOTE: NOT the plugins
54 
+directory). Once this has been done, start Winamp and you should be able to
55 
+play NCSF files.
56 
+
57 
+If you wish to download from GitHub, you may do so from:
58 
+
59 
+http://github.com/CyberBotX/in_xsf
60 
+
61 
+This contains not only the above NCSF plugin, but also plugins for SNSF, GSF,
62 
+and 2SF. While the latter 3 are similar to existing plugins for those formats,
63 
+my versions utilize the same xSF framework that the NCSF plugin uses. In
64 
+addition, all plugins are much more modified than the versions they originate
65 
+from.
66 
+
67 
+You may need the Microsoft Visual C++ 2010 Runtime, if you do not already have
68 
+it installed. You can obtain it here:
69 
+
70 
+http://www.microsoft.com/en-us/download/details.aspx?id=5555
71 
+
72 
+(NOTE: You will usually not require this runtime if you have Visual Studio installed,
73 
+or if you plan on installing Visual Studio. But you will need it if you do not have
74 
+Visual Studio installed.)
75 
+
76 
+If you wish to compile the plugin yourself, you can do so with Microsoft Visual
77 
+Studio. You must use version 2010 or later. If you do not have Microsoft Visual
78 
+Studio, you can obtain the Express version of Microsoft Visual C++ from Microsoft, at:
79 
+
80 
+http://www.microsoft.com/visualstudio/eng/downloads
81 
+
82 
+You may use any Express version that is 2010 or later. Once you have Visual Studio
83 
+installed, you need to open the SDATStuff.sln file. If using a version of Visual
84 
+Studio later than 2010, you may be asked to upgrade the solution.
85 
+
86 
+Of note, the utilities will not compile out of the box immediately. First, you need the
87 
+Winamp SDK. This is not included with the plugin's source code.  You can obtain the SDK
88 
+from here:
89 
+
90 
+http://download.nullsoft.com/winamp/plugin-dev/WA5.55_SDK.exe
91 
+
92 
+The zlib library is also required. zlib can be obtained from here:
93 
+
94 
+http://www.zlib.net/
95 
+
96 
+You need to download the "compiled DLL" version.
97 
+
98 
+Once you have this, you need to modify the values of zlibRootDir and WinampSDKDir in
99 
+src\in_xsf_framework\common.props. Just replace ZLIBFIXME with the directory to which
100 
+you extracted zlib to, and replace WINAMPSDKFIXME with the directory to which you
101 
+installed the SDK to. Once this has been done, you can compile the solution.