Merge branch 'master' into allow-positive-phase-only

Author: maximal

.gitignore

@@ -0,0 +1,6 @@
+# IDEA files
+.idea
+
+# Audio files
+*.ogg
+*.mp3

Waveform.php

@@ -3,18 +3,23 @@
  *
  *
  * @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
+ * @copyright © MaximAL, Sijeko 2016-2019
  */
 
 namespace maximal\audio;
 
+/**
+ * Waveform class allows you to get waveform data and images from audio files
+ * @package maximal\audio
+ */
 class Waveform
 {
 	protected $filename;
@@ -104,11 +109,20 @@ public function getDuration()
 		return $this->duration;
 	}
 
-	public function getWaveform($filename, $width, $height)
+	/**
+	 * Get waveform from the audio file.
+	 * @param string $filename Audio file name
+	 * @param int $width Width of the image file in pixels
+	 * @param int $height Height of the image file in pixels
+	 * @param bool $onePhase `true` to get positive values only, `false` to get both phases
+	 * @return bool Returns `true` on success or `false` on failure.
+	 * @throws \Exception
+	 */
+	public function getWaveform($filename, $width, $height, $onePhase = false)
 	{
 		// Calculating parameters
 		$needChannels = $this->getChannels() > 1 ? 2 : 1;
-		$data = $this->getWaveformData($width);
+		$data = $this->getWaveformData($width, $onePhase);
 		$lines1 = $data['lines1'];
 		$lines2 = $data['lines2'];
 
@@ -126,24 +140,37 @@ public function getWaveform($filename, $width, $height)
 		imagefill($img, 0, 0, $back);
 
 		// Center Ys
-		$center1 = $needChannels === 2 ? ($height / 2 - 1) / 2 : $height / 2;
-		$center2 = $needChannels === 2 ? $height - $center1 : null;
+		if ($onePhase) {
+			$center1 = $needChannels === 2 ? $height / 2 - 1: $height - 1;
+			$center2 = $needChannels === 2 ? $height - 1 : null;
+		} else {
+			$center1 = $needChannels === 2 ? ($height / 2 - 1) / 2 : $height / 2;
+			$center2 = $needChannels === 2 ? $height - $center1 : null;
+		}
 
 		// Drawing channel 1
 		for ($i = 0; $i < count($lines1); $i += 2) {
-			$min = $lines1[$i];
-			$max = $lines1[$i+1];
 			$x = $i / 2 / self::$linesPerPixel;
-
-			imageline($img, $x, $center1 - $min * $center1, $x, $center1 - $max * $center1, $color);
+			if ($onePhase) {
+				$max = max($lines1[$i], $lines1[$i + 1]);
+				imageline($img, $x, $center1, $x, $center1 - $max * $center1, $color);
+			} else {
+				$min = $lines1[$i];
+				$max = $lines1[$i + 1];
+				imageline($img, $x, $center1 - $min * $center1, $x, $center1 - $max * $center1, $color);
+			}
 		}
 		// Drawing channel 2
 		for ($i = 0; $i < count($lines2); $i += 2) {
-			$min = $lines2[$i];
-			$max = $lines2[$i + 1];
 			$x = $i / 2 / self::$linesPerPixel;
-
-			imageline($img, $x, $center2 - $min * $center1, $x, $center2 - $max * $center1, $color);
+			if ($onePhase) {
+				$max = max($lines2[$i], $lines2[$i + 1]);
+				imageline($img, $x, $center2, $x, $center2 - $max * $center1, $color);
+			} else {
+				$min = $lines2[$i];
+				$max = $lines2[$i + 1];
+				imageline($img, $x, $center2 - $min * $center1, $x, $center2 - $max * $center1, $color);
+			}
 		}
 
 		// Axis
@@ -155,7 +182,14 @@ public function getWaveform($filename, $width, $height)
 		return imagepng($img, $filename);
 	}
 
-	public function getWaveformData($width, $positivePhaseOnly = false)
+	/**
+	 * Get waveform data from the audio file.
+	 * @param int $width Desired width of the image file in pixels
+	 * @param bool $onePhase `true` to get positive values only, `false` to get both phases
+	 * @return array
+	 * @throws \Exception
+	 */
+	public function getWaveformData($width, $onePhase = false)
 	{
 		// Calculating parameters
 		$needChannels = $this->getChannels() > 1 ? 2 : 1;
@@ -196,15 +230,22 @@ public function getWaveformData($width, $positivePhaseOnly = false)
 					$channel1 []= $sample;
 				}
 			}
-			if (!$positivePhaseOnly) {
-                $lines1 []= min($channel1);
-            }
-			$lines1 []= max($channel1);
-			if ($needChannels === 2) {
-                if (!$positivePhaseOnly) {
-                    $lines2 []= min($channel2);
-                }
-				$lines2 []= max($channel2);
+			if ($onePhase) {
+				// Rectifying to get positive values only
+				$lines1 []= abs(min($channel1));
+				$lines1 []= abs(max($channel1));
+				if ($needChannels === 2) {
+					$lines2 []= abs(min($channel2));
+					$lines2 []= abs(max($channel2));
+				}
+			} else {
+				// Two phases
+				$lines1 []= min($channel1);
+				$lines1 []= max($channel1);
+				if ($needChannels === 2) {
+					$lines2 []= min($channel2);
+					$lines2 []= max($channel2);
+				}
 			}
 		}
 

one-phase-mono.png

@@ -48,6 +48,20 @@ $waveform = new Waveform('track.mp3');
 $success = $waveform->getWaveform('thumbnail.png', 1024, 512);
 ```
 
+### One Phase
+To get positive waveform only (i.e. one phase) pass `onePhase` parameter set to `true`:
+```php
+$waveform->getWaveform('one-phase.png', 800, 400, true);
+```
+
+Stereo source:
+
+![One phase stereo](one-phase-stereo.png)
+
+Mono source:
+
+![One phase stereo](one-phase-mono.png)
+
 
 ## Settings
 
@@ -116,6 +130,12 @@ $data = $waveform->getWaveformData($width);
 // $data['lines1'] and $data['lines2'] now have the waveform data for channels 1 and 2
 ```
 
+To get positive values only (i.e. one phase) pass `onePhase` parameter set to `true`:
+
+```php
+$data = $waveform->getWaveformData($width, true);
+```
+
 
 ## Contact the author
 

one-phase-stereo.png

@@ -33,7 +33,7 @@
 	echo 'Error: audio and thumbnail files not specified!', PHP_EOL;
 	echo 'Usage: php ', $argv[0],
 		'    <audio file>    <thumbnail file>    [<thumbnail size in pixels, default is ',
-		$width, '×', $height, '>]',
+		$width, '×', $height, '>]    [two-phase|positive, default is `two-phase`]',
 		PHP_EOL;
 	exit(1);
 }
@@ -57,6 +57,14 @@
 	}
 }
 
+// Parsing phase setting
+$onePhase = false;
+if (count($argv) > 4) {
+	if (strtolower($argv[4]) === 'positive') {
+		$onePhase = true;
+	}
+}
+
 if (!is_file($filename)) {
 	echo 'Error: file «', $filename, '» not found!', PHP_EOL;
 	exit(3);
@@ -67,7 +75,7 @@
 // Some settings
 //Waveform::$color = [255, 0, 0, 0.5];
 //Waveform::$backgroundColor = [0, 0, 0, 0];
-if (!$waveform->getWaveform($thumbnail, $width, $height)) {
+if (!$waveform->getWaveform($thumbnail, $width, $height, $onePhase)) {
 	exit(4);
 }