fix(ffmpeg): Autodetect system installed ffmpeg and allow manually setting ffmpeg path

fixes #1096

Signed-off-by: Marcel Klehr <[email protected]>

Author: marcelklehr

appinfo/routes.php

@@ -32,6 +32,7 @@
 		['name' => 'admin#platform', 'url' => '/admin/platform', 'verb' => 'GET'],
 		['name' => 'admin#musl', 'url' => '/admin/musl', 'verb' => 'GET'],
 		['name' => 'admin#nice', 'url' => '/admin/nice', 'verb' => 'GET'],
+		['name' => 'admin#ffmpeg', 'url' => '/admin/ffmpeg', 'verb' => 'GET'],
 		['name' => 'admin#nodejs', 'url' => '/admin/nodejs', 'verb' => 'GET'],
 		['name' => 'admin#libtensorflow', 'url' => '/admin/libtensorflow', 'verb' => 'GET'],
 		['name' => 'admin#wasmtensorflow', 'url' => '/admin/wasmtensorflow', 'verb' => 'GET'],

lib/BackgroundJobs/ClusterFacesJob.php

@@ -13,7 +13,6 @@
 use OCP\AppFramework\Utility\ITimeFactory;
 use OCP\BackgroundJob\IJobList;
 use OCP\BackgroundJob\QueuedJob;
-use OCP\DB\Exception;
 use Psr\Log\LoggerInterface;
 
 final class ClusterFacesJob extends QueuedJob {

lib/Classifiers/Images/ImagenetClassifier.php

@@ -12,7 +12,6 @@
 use OCA\Recognize\Service\QueueService;
 use OCA\Recognize\Service\TagManager;
 use OCP\AppFramework\Services\IAppConfig;
-use OCP\DB\Exception;
 use OCP\Files\IRootFolder;
 use OCP\IPreview;
 use OCP\ITempManager;

lib/Controller/AdminController.php

@@ -219,6 +219,24 @@ public function nodejs(): JSONResponse {
 		return new JSONResponse(['nodejs' => $version]);
 	}
 
+	public function ffmpeg(): JSONResponse {
+		try {
+			exec($this->settingsService->getSetting('ffmpeg_binary') . ' -version' . ' 2>&1', $output, $returnCode);
+		} catch (\Throwable $e) {
+			return new JSONResponse(['ffmpeg' => null]);
+		}
+
+		if ($returnCode !== 0) {
+			return new JSONResponse(['ffmpeg' => false]);
+		}
+
+		if (preg_match('/version (.*?) /', trim($output[0]), $matches) !== 1) {
+			return new JSONResponse(['ffmpeg' => false]);
+		}
+		$version = $matches[1];
+		return new JSONResponse(['ffmpeg' => $version]);
+	}
+
 	public function libtensorflow(): JSONResponse {
 		try {
 			exec($this->settingsService->getSetting('node_binary') . ' ' . __DIR__ . '/../../src/test_libtensorflow.js' . ' 2>&1', $output, $returnCode);

lib/Migration/InstallDeps.php

@@ -93,6 +93,7 @@ public function run(IOutput $output): void {
 			$this->runTfjsGpuInstall($binaryPath);
 			$this->setNodeModulesPermissions();
 			$this->setNiceBinaryPath();
+			$this->setFfmpegBinaryPath();
 		} catch (\Throwable $e) {
 			$output->warning('Failed to automatically install dependencies for recognize. Check the recognize admin panel for potential problems.');
 			$this->logger->error('Failed to automatically install dependencies for recognize. Check the recognize admin panel for potential problems.', ['exception' => $e]);
@@ -235,6 +236,22 @@ protected function runFfmpegInstall(string $nodeBinary): void {
 		}
 	}
 
+	protected function setFfmpegBinaryPath() : void {
+		/* use nice binary from settings if available */
+		if ($this->config->getAppValueString('ffmpeg_binary', '') !== '') {
+			$ffmpeg_path = $this->config->getAppValueString('ffmpeg_binary');
+		} else {
+			/* returns the path to the nice binary or false if not found */
+			$ffmpeg_path = $this->binaryFinder->findBinaryPath('ffmpeg');
+		}
+
+		if ($ffmpeg_path !== false) {
+			$this->config->setAppValueString('ffmpeg_binary', $ffmpeg_path);
+		} else {
+			$this->config->setAppValueString('ffmpeg_binary', __DIR__ . '/../../node_modules/ffmpeg-static/ffmpeg');
+		}
+	}
+
 	protected function downloadNodeBinary(string $server, string $version, string $arch, string $flavor = '') : string {
 		$name = 'node-'.$version.'-linux-'.$arch;
 		if ($flavor !== '') {

lib/Service/SettingsService.php

@@ -52,6 +52,7 @@ final class SettingsService {
 		'nice_binary' => '',
 		'nice_value' => '0',
 		'concurrency.enabled' => 'false',
+		'ffmpeg_binary' => '',
 	];
 
 	/** @var array<string,string>  */

src/components/ViewAdmin.vue

@@ -329,6 +329,23 @@
 			</p>
 			<p>{{ t('recognize', 'For Nextcloud Snap users, you need to adjust this path to point to the snap\'s "current" directory as the pre-configured path will change with each update. For example, set it to "/var/snap/nextcloud/current/nextcloud/extra-apps/recognize/bin/node" instead of "/var/snap/nextcloud/9337974/nextcloud/extra-apps/recognize/bin/node"') }}</p>
 		</NcSettingsSection>
+    <NcSettingsSection :name="t('recognize', 'FFMPEG')">
+      <p v-if="ffmpeg === undefined">
+        <span class="icon-loading-small" />&nbsp;&nbsp;&nbsp;&nbsp;{{ t('recognize', 'Checking FFMPEG') }}
+      </p>
+      <NcNoteCard v-else-if="ffmpeg === false" type="warning">
+        {{ t('recognize', 'Could not execute the ffmpeg binary. You may need to set the path to a working binary manually.') }}
+      </NcNoteCard>
+      <NcNoteCard v-else type="success">
+        {{ t('recognize', 'ffmpeg {version} binary was installed successfully.', { version: ffmpeg }) }}
+      </NcNoteCard>
+      <p>
+        {{ t('recognize', 'If the shipped ffmpeg binary doesn\'t work on your system for some reason you can set the path to a custom ffmpeg binary.') }}
+      </p>
+      <p>
+        <NcTextField :value.sync="settings['ffmpeg_binary']" @update:value="onChange" />
+      </p>
+    </NcSettingsSection>
 		<NcSettingsSection :name="t('recognize', 'Classifier process priority')">
 			<p v-if="nice === undefined">
 				<span class="icon-loading-small" />&nbsp;&nbsp;&nbsp;&nbsp;{{ t('recognize', 'Checking Nice binary') }}
@@ -400,7 +417,7 @@ import { generateUrl } from '@nextcloud/router'
 import { loadState } from '@nextcloud/initial-state'
 import humanizeDuration from 'humanize-duration'
 
-const SETTINGS = ['tensorflow.cores', 'tensorflow.gpu', 'tensorflow.purejs', 'imagenet.enabled', 'landmarks.enabled', 'faces.enabled', 'musicnn.enabled', 'movinet.enabled', 'node_binary', 'faces.status', 'imagenet.status', 'landmarks.status', 'movinet.status', 'musicnn.status', 'faces.lastFile', 'imagenet.lastFile', 'landmarks.lastFile', 'movinet.lastFile', 'musicnn.lastFile', 'faces.batchSize', 'imagenet.batchSize', 'landmarks.batchSize', 'movinet.batchSize', 'musicnn.batchSize', 'clusterFaces.status', 'clusterFaces.lastRun', 'nice_binary', 'nice_value', 'concurrency.enabled']
+const SETTINGS = ['tensorflow.cores', 'tensorflow.gpu', 'tensorflow.purejs', 'imagenet.enabled', 'landmarks.enabled', 'faces.enabled', 'musicnn.enabled', 'movinet.enabled', 'node_binary', 'ffmpeg_binary', 'faces.status', 'imagenet.status', 'landmarks.status', 'movinet.status', 'musicnn.status', 'faces.lastFile', 'imagenet.lastFile', 'landmarks.lastFile', 'movinet.lastFile', 'musicnn.lastFile', 'faces.batchSize', 'imagenet.batchSize', 'landmarks.batchSize', 'movinet.batchSize', 'musicnn.batchSize', 'clusterFaces.status', 'clusterFaces.lastRun', 'nice_binary', 'nice_value', 'concurrency.enabled']
 
 const BOOLEAN_SETTINGS = ['tensorflow.gpu', 'tensorflow.purejs', 'imagenet.enabled', 'landmarks.enabled', 'faces.enabled', 'musicnn.enabled', 'movinet.enabled', 'faces.status', 'imagenet.status', 'landmarks.status', 'movinet.status', 'musicnn.status', 'faces.lastFile', 'imagenet.lastFile', 'landmarks.lastFile', 'movinet.lastFile', 'musicnn.lastFile', 'clusterFaces.status', 'concurrency.enabled']
 
@@ -427,6 +444,7 @@ export default {
 			libtensorflow: undefined,
 			wasmtensorflow: undefined,
 			gputensorflow: undefined,
+      ffmpeg: undefined,
 			cron: undefined,
 			modelsDownloaded: null,
 			imagenetJobs: null,
@@ -470,6 +488,7 @@ export default {
 		this.getMusl()
 		this.getNice()
 		this.getNodejsStatus()
+		this.getFfmpegStatus()
 		this.getLibtensorflowStatus()
 		this.getWasmtensorflowStatus()
 		this.getGputensorflowStatus()
@@ -585,6 +604,11 @@ export default {
 			const { nodejs } = resp.data
 			this.nodejs = nodejs
 		},
+    async getFfmpegStatus() {
+      const resp = await axios.get(generateUrl('/apps/recognize/admin/ffmpeg'))
+      const { ffmpeg } = resp.data
+      this.ffmpeg = ffmpeg
+    },
 		async getLibtensorflowStatus() {
 			const resp = await axios.get(generateUrl('/apps/recognize/admin/libtensorflow'))
 			const { libtensorflow } = resp.data