[AudioEncoder] Introduce basic audio plugin to provide an attachment template and duration metadata for audio mimetype

plugins/AudioEncoder/AudioEncoder.php

@@ -0,0 +1,122 @@
+<?php
+
+declare(strict_types=1);
+// {{{ License
+// This file is part of GNU social - https://www.gnu.org/software/social
+//
+// GNU social is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// GNU social is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with GNU social.  If not, see <http://www.gnu.org/licenses/>.
+// }}}
+
+/**
+ * Audio template and metadata support via PHP-FFMpeg
+ *
+ * @package   GNUsocial
+ *
+ * @author    Diogo Peralta Cordeiro <mail@diogo.site>
+ * @copyright 2021 Free Software Foundation, Inc http://www.fsf.org
+ * @license   https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
+ *
+ * @see      http://www.gnu.org/software/social/
+ */
+
+namespace Plugin\AudioEncoder;
+
+use App\Core\Event;
+use App\Core\GSFile;
+use App\Core\Modules\Plugin;
+use App\Util\Exception\ServerException;
+use App\Util\Formatting;
+use FFMpeg\FFProbe as ffprobe;
+use SplFileInfo;
+use function App\Core\I18n\_m;
+
+class AudioEncoder extends Plugin
+{
+    public function version(): string
+    {
+        return '0.1.0';
+    }
+
+    public static function shouldHandle(string $mimetype): bool
+    {
+        return GSFile::mimetypeMajor($mimetype) === 'audio';
+    }
+
+    public function onFileMetaAvailable(array &$event_map, string $mimetype): bool
+    {
+        if (!self::shouldHandle($mimetype)) {
+            return Event::next;
+        }
+        $event_map['audio'][] = [$this, 'fileMeta'];
+        return Event::next;
+    }
+
+    /**
+     * Adds duration metadata to audios
+     *
+     * @param null|string $mimetype in/out
+     * @param null|int $width out audio duration
+     *
+     * @return bool true if metadata filled
+     */
+    public function fileMeta(SplFileInfo &$file, ?string &$mimetype, ?int &$width, ?int &$height): bool
+    {
+        // Create FFProbe instance
+        // Need to explicitly tell the drivers' location, or it won't find them
+        $ffprobe = ffprobe::create([
+            'ffmpeg.binaries' => exec('which ffmpeg'),
+            'ffprobe.binaries' => exec('which ffprobe'),
+        ]);
+
+        $metadata = $ffprobe->streams($file->getRealPath()) // extracts streams informations
+        ->audios()                      // filters audios streams
+        ->first();                      // returns the first audio stream
+        $width = (int)ceil((float)$metadata->get('duration'));
+
+        return true;
+    }
+
+    /**
+     * Generates the view for attachments of type Video
+     */
+    public function onViewAttachment(array $vars, array &$res): bool
+    {
+        if (!self::shouldHandle($vars['attachment']->getMimetype())) {
+            return Event::next;
+        }
+
+        $res[] = Formatting::twigRenderFile(
+            'audioEncoder/audioEncoderView.html.twig',
+            [
+                'attachment' => $vars['attachment'],
+                'note' => $vars['note'],
+            ],
+        );
+        return Event::stop;
+    }
+
+    /**
+     * @throws ServerException
+     */
+    public function onPluginVersion(array &$versions): bool
+    {
+        $versions[] = [
+            'name' => 'AudioEncoder',
+            'version' => self::version(),
+            'author' => 'Diogo Peralta Cordeiro',
+            'rawdescription' => _m('Use PHP-FFMpeg for some more audio support.'),
+        ];
+        return Event::next;
+    }
+}

plugins/AudioEncoder/README.md

@@ -0,0 +1,9 @@
+# Audio Encoder plugin for GNU social
+
+(c) 2021 Free Software Foundation, Inc
+
+This is the README file for GNU social's AudioEncoder plugin. It includes general information about the plugin.
+
+## About
+
+This plugin at the moment only provides the audio player template and mimetype information for audios using ffprobe.

plugins/AudioEncoder/composer.json

@@ -0,0 +1,5 @@
+{
+  "require": {
+    "php-ffmpeg/php-ffmpeg": "^0.18.0"
+  }
+}

plugins/AudioEncoder/templates/audioEncoder/audioEncoderView.html.twig

@@ -0,0 +1,9 @@
+<div>
+  <figure>
+    <audio class="u-audio" src="{{ attachment.getUrl() }}" controls>
+    </audio>
+    <figcaption><a
+          href="{{ path('attachment_show', {'id': attachment.getId()}) }}">{{ attachment.getBestTitle(note) }}</a>
+    </figcaption>
+  </figure>
+</div>