nsinnovations/fusionpbx
2
0
Fork 0
mirror of https://github.com/fusionpbx/fusionpbx.git synced 2026-02-06 07:59:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation, format class, no modification. (#7629)

Browse Source
This commit is contained in:
frytimo
2025-11-19 12:48:36 -04:00
committed by GitHub
parent 0ea256fce8
commit 34821bed7e
36 changed files with 12982 additions and 11551 deletions
Download Patch File Download Diff File Expand all files Collapse all files

282
resources/classes/waveform.php
View File

@@ -2,120 +2,80 @@
/**
*
*
* @author MaximAL
* @since 2019-02-13 Added `$onePhase` parameters to get only positive waveform data and image
* @since 2018-10-22 Added `getWaveformData()` method and `$soxCommand` configuration
* @since 2016-11-21
* @date 2016-11-21
* @time 19:08
* @link http://maximals.ru
* @link http://sijeko.ru
* @link https://github.com/maximal/audio-waveform-php
* @author MaximAL
* @since 2019-02-13 Added `$onePhase` parameters to get only positive waveform data and image
* @since 2018-10-22 Added `getWaveformData()` method and `$soxCommand` configuration
* @since 2016-11-21
* @date 2016-11-21
* @time 19:08
* @link http://maximals.ru
* @link http://sijeko.ru
* @link https://github.com/maximal/audio-waveform-php
* @copyright © MaximAL, Sijeko 2016-2019
*
* @modified fusionate
* @since 2024-02-07 Added option to return image in base64 format by setting $filename to 'base64'
* @since 2024-02-08 Added `$singleAxis` parameter to combine channels (if stereo) into single axis
* @since 2024-02-08 Added `$colorA` and `$colorB` parameters to allow different colors for each channel
* @since 2024-02-08 Rename `$onePhase` parameter to `$singlePhase` and change to public static variable for class
* @since 2024-02-08 Modified singleAxis so channel 2 would display as negative waveform data when singlePhase enabled
* @modified fusionate
* @since 2024-02-07 Added option to return image in base64 format by setting $filename to 'base64'
* @since 2024-02-08 Added `$singleAxis` parameter to combine channels (if stereo) into single axis
* @since 2024-02-08 Added `$colorA` and `$colorB` parameters to allow different colors for each channel
* @since 2024-02-08 Rename `$onePhase` parameter to `$singlePhase` and change to public static variable for class
* @since 2024-02-08 Modified singleAxis so channel 2 would display as negative waveform data when singlePhase
* enabled
*
*
*/
namespace maximal\audio;
use Exception;
/**
* Waveform class allows you to get waveform data and images from audio files
*
* @package maximal\audio
*/
class Waveform
{
protected $filename;
protected $info;
protected $channels;
protected $samples;
protected $sampleRate;
protected $duration;
class Waveform {
public static $linesPerPixel = 8;
public static $samplesPerLine = 512;
public static $singlePhase; // set `true` to get positive waveform phase only, `false` to get both positive and negative waveform phases
public static $singleAxis; // combine double or single phases to use same axis
public static $singlePhase;
public static $singleAxis;
public static $color = [95, 95, 95, 0.5];
public static $colorA;
public static $colorB;
public static $backgroundColor = [245, 245, 245, 1];
public static $axisColor = [0, 0, 0, 0.1]; // set `true` to get positive waveform phase only, `false` to get both positive and negative waveform phases
public static $soxCommand = 'sox'; // combine double or single phases to use same axis
// Colors in CSS `rgba(red, green, blue, opacity)` format
public static $color = [95, 95, 95, 0.5];
public static $colorA; // color of left channel (1)
public static $colorB; // color of right channel (2)
public static $backgroundColor = [245, 245, 245, 1];
public static $axisColor = [0, 0, 0, 0.1];
protected $filename;
protected $info; // color of left channel (1)
protected $channels; // color of right channel (2)
protected $samples;
protected $sampleRate;
// SoX command: 'sox', '/usr/local/bin/sox' etc
public static $soxCommand = 'sox';
protected $duration;
public function __construct($filename)
{
/**
* Initializes a new instance of this class with the specified filename.
*
* @param string $filename The name of the file associated with this instance.
*
* @access public
*/
public function __construct($filename) {
$this->filename = $filename;
}
public function getInfo()
{
$out = null;
$ret = null;
exec(self::$soxCommand . ' --i ' . escapeshellarg($this->filename) . ' 2>&1', $out, $ret);
$str = implode('|', $out);
$match = null;
if (preg_match('/Channels?\s*\:\s*(\d+)/ui', $str, $match)) {
$this->channels = intval($match[1]);
}
$match = null;
if (preg_match('/Sample\s*Rate\s*\:\s*(\d+)/ui', $str, $match)) {
$this->sampleRate = intval($match[1]);
}
$match = null;
if (preg_match('/Duration.*[^\d](\d+)\s*samples?/ui', $str, $match)) {
$this->samples = intval($match[1]);
}
if ($this->samples && $this->sampleRate) {
$this->duration = 1.0 * $this->samples / $this->sampleRate;
}
if ($ret !== 0) {
throw new \Exception('Failed to get audio info.' . PHP_EOL . 'Error: ' . implode(PHP_EOL, $out) . PHP_EOL);
}
}
public function getSampleRate()
{
if (!$this->sampleRate) {
$this->getInfo();
}
return $this->sampleRate;
}
public function getChannels()
{
if (!$this->channels) {
$this->getInfo();
}
return $this->channels;
}
public function getSamples()
{
if (!$this->samples) {
$this->getInfo();
}
return $this->samples;
}
public function getDuration()
{
/**
* Retrieves the duration of the current media file.
*
* If the duration has not been retrieved yet, it will be fetched from the media server.
*
* @return float The duration of the media file in seconds.
*
* @access public
*/
public function getDuration() {
if (!$this->duration) {
$this->getInfo();
}
@@ -124,14 +84,15 @@ class Waveform
/**
* Get waveform from the audio file.
*
* @param string $filename Image file name
* @param int $width Width of the image file in pixels
* @param int $height Height of the image file in pixels
* @param int $width Width of the image file in pixels
* @param int $height Height of the image file in pixels
*
* @return bool Returns `true` on success or `false` on failure, when generating an image file, or a base64 string.
* @throws \Exception
*/
public function getWaveform($filename, $width, $height)
{
public function getWaveform($filename, $width, $height) {
// Calculating parameters
$needChannels = $this->getChannels() > 1 ? 2 : 1;
$data = $this->getWaveformData($width, self::$singlePhase ?? false);
@@ -159,7 +120,7 @@ class Waveform
$center1 = $center2 = $height / 2;
} else {
if (self::$singlePhase ?? false) {
$center1 = $needChannels === 2 ? $height / 2 - 1: $height - 1;
$center1 = $needChannels === 2 ? $height / 2 - 1 : $height - 1;
$center2 = $needChannels === 2 ? $height - 1 : null;
} else {
$center1 = $needChannels === 2 ? ($height / 2 - 1) / 2 : $height / 2;
@@ -218,14 +179,31 @@ class Waveform
}
}
/**
* Retrieves a collection of channels.
*
* If no channels have been loaded yet, the {@link getInfo()} method is called to load them first.
*
* @return array A collection of channel objects.
*
* @access public
*/
public function getChannels() {
if (!$this->channels) {
$this->getInfo();
}
return $this->channels;
}
/**
* Get waveform data from the audio file.
*
* @param int $width Desired width of the image file in pixels
*
* @return array
* @throws \Exception
*/
public function getWaveformData($width)
{
public function getWaveformData($width) {
// Calculating parameters
$needChannels = $this->getChannels() > 1 ? 2 : 1;
$samplesPerPixel = self::$samplesPerLine * self::$linesPerPixel;
@@ -249,7 +227,7 @@ class Waveform
$pipes = null;
$proc = proc_open($command, $outputs, $pipes);
if (!$proc) {
throw new \Exception('Failed to run `sox` command');
throw new Exception('Failed to run `sox` command');
}
$lines1 = [];
@@ -260,26 +238,26 @@ class Waveform
$channel2 = [];
foreach ($data as $index => $sample) {
if ($needChannels === 2 && $index % 2 === 0) {
$channel2 []= $sample;
$channel2 [] = $sample;
} else {
$channel1 []= $sample;
$channel1 [] = $sample;
}
}
if (self::$singlePhase ?? false) {
// Rectifying to get positive values only
$lines1 []= abs(min($channel1));
$lines1 []= abs(max($channel1));
$lines1 [] = abs(min($channel1));
$lines1 [] = abs(max($channel1));
if ($needChannels === 2) {
$lines2 []= abs(min($channel2));
$lines2 []= abs(max($channel2));
$lines2 [] = abs(min($channel2));
$lines2 [] = abs(max($channel2));
}
} else {
// Two phases
$lines1 []= min($channel1);
$lines1 []= max($channel1);
$lines1 [] = min($channel1);
$lines1 [] = max($channel1);
if ($needChannels === 2) {
$lines2 []= min($channel2);
$lines2 []= max($channel2);
$lines2 [] = min($channel2);
$lines2 [] = max($channel2);
}
}
}
@@ -288,14 +266,92 @@ class Waveform
$ret = proc_close($proc);
if ($ret !== 0) {
throw new \Exception('Failed to run `sox` command. Error:' . PHP_EOL . $err);
throw new Exception('Failed to run `sox` command. Error:' . PHP_EOL . $err);
}
return ['lines1' => $lines1, 'lines2' => $lines2];
}
public static function rgbaToColor($img, $rgba)
{
/**
* Retrieves the sample rate associated with this instance.
*
* If the sample rate has not been previously retrieved, it will be obtained
* by calling getInfo(). The sample rate is then cached for future retrieval.
*
* @return int|null The sample rate in Hz, or null if unable to retrieve the information.
*
* @access public
*/
public function getSampleRate() {
if (!$this->sampleRate) {
$this->getInfo();
}
return $this->sampleRate;
}
/**
* Retrieves information about the audio file associated with this instance.
*
* @access public
*/
public function getInfo() {
$out = null;
$ret = null;
exec(self::$soxCommand . ' --i ' . escapeshellarg($this->filename) . ' 2>&1', $out, $ret);
$str = implode('|', $out);
$match = null;
if (preg_match('/Channels?\s*\:\s*(\d+)/ui', $str, $match)) {
$this->channels = intval($match[1]);
}
$match = null;
if (preg_match('/Sample\s*Rate\s*\:\s*(\d+)/ui', $str, $match)) {
$this->sampleRate = intval($match[1]);
}
$match = null;
if (preg_match('/Duration.*[^\d](\d+)\s*samples?/ui', $str, $match)) {
$this->samples = intval($match[1]);
}
if ($this->samples && $this->sampleRate) {
$this->duration = 1.0 * $this->samples / $this->sampleRate;
}
if ($ret !== 0) {
throw new Exception('Failed to get audio info.' . PHP_EOL . 'Error: ' . implode(PHP_EOL, $out) . PHP_EOL);
}
}
/**
* Retrieves a collection of sample data.
*
* If no samples have been retrieved yet, this method will call getInfo() to populate the internal samples list.
*
* @return int The collection of sample data.
*
* @access public
*/
public function getSamples() {
if (!$this->samples) {
$this->getInfo();
}
return $this->samples;
}
/**
* Converts an RGBA color to a PHP image color with alpha channel.
*
* @param resource $img The PHP image resource to convert the color for.
* @param array $rgba An array containing the red, green, blue and alpha values of the color.
*
* @return int The allocated color index.
*
* @access public
* @static
*/
public static function rgbaToColor($img, $rgba) {
return imagecolorallocatealpha($img, $rgba[0], $rgba[1], $rgba[2], round((1 - $rgba[3]) * 127));
}
}