https://github.com/emmt/ysox
YSoX is a Yorick audio plug-in using the SoX library.
https://github.com/emmt/ysox
Last synced: about 1 year ago
JSON representation
YSoX is a Yorick audio plug-in using the SoX library.
- Host: GitHub
- URL: https://github.com/emmt/ysox
- Owner: emmt
- License: other
- Created: 2015-05-15T10:33:18.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2022-11-03T12:47:34.000Z (over 3 years ago)
- Last Synced: 2025-01-29T05:41:22.821Z (over 1 year ago)
- Language: C
- Size: 28.3 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
YSoX
====
YSoX is a [Yorick](http://github.com/LLNL/yorick/) plug-in for endocing/decoding
audio thanks to the [SoX library](http://sox.sourceforge.net/).
Installation
------------
In short, building and installing the plug-in can be as quick as:
````{.sh}
cd $BUILD_DIR
$SRC_DIR/configure
make
make install
````
where `$BUILD_DIR` is the build directory (at your convenience) and
`$SRC_DIR` is the source directory of the plug-in code. The build and
source directories can be the same in which case, call `./configure` to
configure for building.
If the plug-in has been properly installed, it is sufficient to use any
function of YSoX to automatically load the plug-in. You may force the
loading of the plug-in by something like:
````{.sh}
#include "sox.i"
````
or
````{.sh}
require, "sox.i";
````
in your code.
More detailled installation explanations are given below.
1. You must have Yorick and the SoX library installed on your machine.
2. Unpack the plug-in code somewhere.
3. Configure for compilation. There are two possibilities:
For an **in-place build**, go to the source directory, say `$SRC_DIR`, of
the plug-in code and run the configuration script:
````{.sh}
cd $SRC_DIR
./configure
````
To see the configuration options, type:
````{.sh}
./configure --help
````
To compile in a **different build directory**, say `$BUILD_DIR`, create the
build directory, go to the build directory and run the configuration
script:
````{.sh}
mkdir -p $BUILD_DIR
cd $BUILD_DIR
$SRC_DIR/configure
````
where `$SRC_DIR` is the path to the source directory of the plug-in code.
To see the configuration options, type:
````{.sh}
$SRC_DIR/configure --help
````
4. Compile the code:
````{.sh}
make clean
make
````
5. Install the plug-in in Yorick directories:
````{.sh}
make install
````
License
-------
**YSoX** is open source sofware released under the [MIT license](LICENSE.md).
To temporarily suspend **SIGFPE** (floating-point error) signals, the
`switch_fpemask()` function is based on `ygl_fpemask()` borrowed from
[Yorick-GL](https://github.com/LLNL/yorick-gl) plug-in written by Dave
Munro. For this piece of code, the following applies:
> Copyright (c) 2012, David H. Munro.
> All rights reserved.
> This file is part of yorick (http://yorick.sourceforge.net).
> Read the accompanying LICENSE file for details.