Browse Source

Cleanup README

Signed-off-by: falkTX <falktx@falktx.com>
tags/v1.0.0
falkTX 4 years ago
parent
commit
c27e8bea41
Signed by: falkTX <falktx@falktx.com> GPG Key ID: CDBAA37ABC74FBA0
1 changed files with 37 additions and 43 deletions
  1. +37
    -43
      README

+ 37
- 43
README View File

@@ -8,22 +8,18 @@ CONTENTS
1. INSTALLATION
---------------

Do the following to build for 32 bit Wine.
Do the following to build for 32-bit Wine.
# make clean
# make

To install (substite with the path to the 32 bit wine libs for your distro).
To install (substitute with the path to the 32-bit wine libs for your distro).
# sudo cp wineasio.dll.so /usr/lib32/wine/wineasio.dll.so

To build for 64bit Wine a shellscript has been added to modify asio.h and make
it compatible with both 32 and 64bit Wine/Linux. A separate Makefile has also
been added for 64bit.

Do the following to build for 64bit Wine.
Do the following to build for 64-bit Wine.
# make clean
# make -f Makefile64

To install (substite with the path to the 64 bit wine libs for your distro).
To install (substitute with the path to the 64 bit wine libs for your distro).
# sudo cp wineasio.dll.so /usr/lib/wine/wineasio.dll.so

Finally the dll must be registered in the wineprefix.
@@ -31,7 +27,7 @@ For both 32 and 64 bit wine do:
# regsvr32 wineasio.dll

On a 64 bit system with wine supporting both 32 and 64 applications, regsrv32
will register the 32 bit driver in a 64 bit prefix, use the following command
will register the 32-bit driver in a 64 bit prefix, use the following command
to register the 64 bit driver in a 64 bit wineprefix:

# wine64 regsvr32 wineaiso.dll
@@ -43,52 +39,50 @@ To use another prefix specify it explicitly, like:
2. GENERAL INFORMATION
----------------------

Wineasio can slave to the jack transport.

ASIO apps get notified if the jack buffersize changes.

WineASIO can slave to the jack transport.

WineASIO can change jack's buffersize if so desired. Must be enabled in the registry, see below.

The configuration of WineASIO is done with Windows registry (HKEY_CURRENT_USER\Software\Wine\WineASIO).
All these options can be overriden by an environment variable.
The key is automatically created with default values if it doesn't exist when the driver initializes.
It contains the following values:
All these options can be overridden by environment variables.
There is also a GUI for changing these settings, which WineASIO will try to launch when the ASIO "panel" is clicked.

The registry keys are automatically created with default values if they doesn't exist when the driver initializes.
Th available options are:

[Number of inputs] & [Number of outputs]
These two settings control the number of jack ports that wineasio will try to
open. Defaults are 16 in and 16 out. Environment variables are
WINEASIO_NUMBER_INPUTS and WINEASIO_NUMBER_OUTPUTS
These two settings control the number of jack ports that WineASIO will try to open.
Defaults are 16 in and 16 out. Environment variables are WINEASIO_NUMBER_INPUTS and WINEASIO_NUMBER_OUTPUTS.

[Autostart server]
Defaults to off (0), setting it to 1 enables wineasio to launch the jack
server. See the jack documentation for further details. The environment
variable is WINEASIO_AUTOSTART_SERVER, and it can be set to on or off.
Defaults to off (0), setting it to 1 enables WineASIO to launch the jack server.
See the jack documentation for further details.
The environment variable is WINEASIO_AUTOSTART_SERVER, and it can be set to on or off.

[Connect to hardware]
Defaults to on (1), makes wineasio try to connect the asio channels to the
physical I/O ports on your hardware. Setting it to 0 disables it. The
environment variable is WINEASIO_CONNECT_TO_HARDWARE, and it can be set to on
or off.
Defaults to on (1), makes WineASIO try to connect the ASIO channels to the physical I/O ports on your hardware.
Setting it to 0 disables it.
The environment variable is WINEASIO_CONNECT_TO_HARDWARE, and it can be set to on or off.

[Fixed buffersize]
Defaults to on (1) and is the old behaviour where the buffer size is controlled
by jack and wineasio has no say in the matter. When set to 0, an asio app will
be able to change the jack buffer size when calling CreateBuffers(). The
environment variable is WINEASIO_FIXED_BUFFERSIZE and it can be set to on or
off.
Defaults to on (1) which means the buffer size is controlled by jack and WineASIO has no say in the matter.
When set to 0, an ASIO app will be able to change the jack buffer size when calling CreateBuffers().
The environment variable is WINEASIO_FIXED_BUFFERSIZE and it can be set to on or off.

[Preferred buffersize]
Defaults to 1024, and is one of the sizes returned by GetBufferSize(), see the
ASIO documentation for details. Must be a power of 2. The other values
returned by the driver are hardcoded in the source, see ASIO_MINIMUM_BUFFERSIZE
which is set at 16, and ASIO_MAXIMUM_BUFFERSIZE which is set to 8192. The
environment variable is WINEASIO_PREFERRED_BUFFERSIZE. Be careful, if you set
a size that isn't supported by the backend, the jack server will most likely
shut down, might be a good idea to change ASIO_MINIMUM_BUFFERSIZE and
ASIO_MAXIMUM_BUFFERSIZE to values you know work on your system before building.
In addition there is a WINEASIO_CLIENT_NAME environment variable, that
overrides the JACK client name derrived from the program name.
Defaults to 1024, and is one of the sizes returned by GetBufferSize(), see the ASIO documentation for details.
Must be a power of 2.
The other values returned by the driver are hardcoded in the source,
see ASIO_MINIMUM_BUFFERSIZE which is set at 16, and ASIO_MAXIMUM_BUFFERSIZE which is set to 8192.
The environment variable is WINEASIO_PREFERRED_BUFFERSIZE.
Be careful, if you set a size that isn't supported by the backend, the jack server will most likely shut down,
might be a good idea to change ASIO_MINIMUM_BUFFERSIZE and ASIO_MAXIMUM_BUFFERSIZE to values you know work on your system before building.
In addition there is a WINEASIO_CLIENT_NAME environment variable, that overrides the JACK client name derrived from the program name.

3. CHANGE LOG
-------------
@@ -98,13 +92,13 @@ overrides the JACK client name derrived from the program name.
08-FEB-2020: Add custom GUI for WineASIO settings, made by PyQt (taken off Cadence project code)

0.9.2
28-OCT-2013: Add 64bit support and some small fixes
28-OCT-2013: Add 64-bit support and some small fixes

0.9.1
15-OCT-2013: Various bug fixes (JH)

0.9.0
19-FEB-2011: Nearly complete refactoring of the wineasio codebase (asio.c) (JH)
19-FEB-2011: Nearly complete refactoring of the WineASIO codebase (asio.c) (JH)

0.8.1:
05-OCT-2010: Code from Win32 callback thread moved to JACK process callback, except for bufferSwitch() call.
@@ -114,7 +108,7 @@ overrides the JACK client name derrived from the program name.
08-AUG-2010: Forward port JackWASIO changes... needs testing hard. (PLJ)

0.7.6:
27-DEC-2009: Fixes for compilation on 64bit platform. (PLJ)
27-DEC-2009: Fixes for compilation on 64-bit platform. (PLJ)

0.7.5:
29-Oct-2009: Added fork with call to qjackctl from ASIOControlPanel(). (JH)


Loading…
Cancel
Save