Refactor plugin to work with video files also

Author: Josh5

README.md

@@ -1,4 +1,4 @@
-# Transcode Audio Files
+# Transcode Audio
 Plugin for [Unmanic](https://github.com/Unmanic)
 
 ---

changelog.md

@@ -1,4 +1,7 @@
 
+**<span style="color:#56adda">0.0.4</span>**
+- Rebrand the plugin as Transcode Audio and add support for transcoding audio streams in video/media files while copying non-audio streams and preserving the source container
+
 **<span style="color:#56adda">0.0.3</span>**
 - Add smart output target to Basic mode so matching audio codecs can be re-encoded when they are significantly above the recommended bitrate window
 

description.md

@@ -1,6 +1,11 @@
 
 ---
 
+Transcode Audio is designed to transcode audio streams in media files.
+
+It supports both audio-only source files and video/media containers. When processing a video/media file, the
+plugin transcodes only the audio streams and copies all non-audio streams through to the output unchanged.
+
 ##### Links:
 
 - [Support](https://unmanic.app/discord)
@@ -22,8 +27,10 @@ For information on the available encoder settings:
 ##### Additional Information:
 
 :::note
-The output file extension will always be determined by the selected audio encoder. 
-For example, selecting an MP3 encoder will always produce a *XXXX.mp3* file, and selecting an AAC encoder will always produce a *XXXX.m4a* file.
+For audio-only files, the output file extension is determined by the selected audio encoder.
+For example, selecting an MP3 encoder will produce a *XXXX.mp3* file, and selecting an AAC encoder will produce a *XXXX.m4a* file.
+
+For video/media files, the plugin preserves the original container and only transcodes the audio streams.
 :::
 
 :::note
@@ -43,10 +50,10 @@ ffmpeg \
     -hide_banner \
     -loglevel info \
     <CUSTOM MAIN OPTIONS HERE> \
-    -i /path/to/input/audio.wav \
+    -i /path/to/input/media.file \
     <CUSTOM ADVANCED OPTIONS HERE> \
     -map 0:0 -c:a:0 <CUSTOM AUDIO OPTIONS HERE> \
-    -y /path/to/output/audio.mp3 
+    -y /path/to/output/media.file
 ```
 :::
 
@@ -57,5 +64,5 @@ Enabling the *"Force transcoding ..."* option will force a transcode of the audi
 
 A file will only be forced to be transcoded once. It will then be flagged in a local `.unmanic` file to prevent it being added to the pending tasks list in a loop.
 
-However, a file previously flagged to be ignored by this will still be transcoded to apply any matching smart filters such as scaling, stripping data streams, etc.
+However, a file previously flagged to be ignored by this will still be transcoded to apply any matching audio filter changes.
 :::

info.json

@@ -3,14 +3,14 @@
     "compatibility": [
         2
     ],
-    "description": "Transcode the audio streams of a audio file",
+    "description": "Transcode audio streams in audio and video media files",
     "icon": "https://raw.githubusercontent.com/Unmanic/plugin.audio_transcoder/master/icon.png",
     "id": "audio_transcoder",
-    "name": "Transcode Audio Files",
+    "name": "Transcode Audio",
     "priorities": {
         "on_library_management_file_test": 10,
         "on_worker_process": 1
     },
     "tags": "audio,ffmpeg",
-    "version": "0.0.3"
+    "version": "0.0.4"
 }

lib/plugin_stream_mapper.py

@@ -37,6 +37,7 @@ def __init__(self, worker_log=None):
         self.worker_log = worker_log if isinstance(worker_log, list) else None
         self.abspath = None
         self.settings = None
+        self.media_file_mode = 'audio_file'
         self.complex_audio_filters = {}
         self.forced_encode = False
         self.execution_stage = False
@@ -48,10 +49,12 @@ def set_default_values(self, settings, abspath, probe):
         self.set_probe(probe)
         self.set_input_file(abspath)
         self.settings = settings
+        self.media_file_mode = tools.get_media_file_mode(abspath) or 'audio_file'
         tools.append_worker_log(
             self.worker_log,
-            "Stream mapper configured (mode='{}', encoder='{}')".format(
+            "Stream mapper configured (mode='{}', media_mode='{}', encoder='{}')".format(
                 self.settings.get_setting('mode'),
+                self.media_file_mode,
                 self.settings.get_setting('audio_encoder'),
             )
         )
@@ -279,6 +282,10 @@ def custom_stream_mapping(self, stream_info: dict, stream_id: int):
         }
 
     def set_output_file(self, path):
+        if self.media_file_mode == 'video_file':
+            self.output_file = os.path.abspath(path)
+            return self.output_file
+
         encoder_name = self.settings.get_setting('audio_encoder')
         encoder = tools.available_encoders(settings=self.settings, probe=self.probe).get(encoder_name)
         container_extension = encoder.get_output_file_extension(encoder_name)

lib/tools.py

@@ -21,6 +21,8 @@
         If not, see <https://www.gnu.org/licenses/>.
 
 """
+import mimetypes
+
 from audio_transcoder.lib.encoders.aac import AacEncoder
 from audio_transcoder.lib.encoders.lame import LameEncoder
 
@@ -59,3 +61,16 @@ def join_filtergraph(filter_id, filter_args, stream_id):
         filtergraph += '[{}]'.format(filter_id)
         count += 1
     return filter_id, filtergraph
+
+
+def get_media_file_mode(path: str):
+    file_type = mimetypes.guess_type(path)[0]
+    if not file_type:
+        return None
+
+    file_type_category = file_type.split('/')[0]
+    if file_type_category == 'video':
+        return 'video_file'
+    if file_type_category == 'audio':
+        return 'audio_file'
+    return None

plugin.py

@@ -128,7 +128,7 @@ def on_library_management_file_test(data, task_data_store=None, file_metadata=No
     settings = Settings(library_id=data.get('library_id'), apply_default_fallbacks=False)
     abspath = data.get('path')
 
-    probe = Probe.init_probe(data, logger, allowed_mimetypes=['audio'])
+    probe = Probe.init_probe(data, logger, allowed_mimetypes=['audio', 'video'])
     if not probe or not probe.file(abspath):
         return
 
@@ -156,7 +156,7 @@ def on_worker_process(data, task_data_store=None, file_metadata=None):
     abspath = data.get('file_in')
 
     tools.append_worker_log(worker_log, "Probing file: {}".format(abspath))
-    probe = Probe(logger, allowed_mimetypes=['audio'])
+    probe = Probe(logger, allowed_mimetypes=['audio', 'video'])
     if not probe.file(abspath):
         tools.append_worker_log(worker_log, "Probe failed - skipping file")
         return