@qvac/decoder-audio 0.1.0 → 0.2.0

package/README.md

@@ -6,6 +6,7 @@ This decoder addon leverages the GStreamer pipeline for efficient, asynchronous
 
 - [Installation](#installation)  
 - [Usage](#usage)  
+  - [Supported Audio Formats](#supported-audio-formats)  
   - [1. Creating the Decoder Instance](#1-creating-the-decoder-instance)  
   - [2. Loading the Decoder](#2-loading-the-decoder)  
   - [3. Decoding Audio](#3-decoding-audio)  
@@ -56,6 +57,24 @@ npm install @tetherto/qvac-lib-decoder-audio@latest
 
 This library provides a simple workflow for decoding audio streams.
 
+### Supported Audio Formats
+
+The library exports two constants that define the supported audio formats:
+
+```javascript
+const GSTDecoder = require('@tetherto/qvac-lib-decoder-audio')
+
+// Audio formats that require decoding before processing
+console.log(GSTDecoder.FORMATS_NEEDING_DECODE)
+// ['.mp3', '.m4a', '.ogg', '.flac', '.aac', '.wav']
+
+// All supported audio formats (including raw)
+console.log(GSTDecoder.SUPPORTED_AUDIO_FORMATS)
+// ['.mp3', '.m4a', '.ogg', '.wav', '.flac', '.aac', '.raw']
+```
+
+These constants can be used to validate input file formats or to determine if a file needs decoding before processing.
+
 ### 1. Creating the Decoder Instance
 
 To get started, import the decoder addon and create an instance:

package/index.d.ts

@@ -54,4 +54,16 @@ declare class GSTDecoder extends BaseInference {
   getStatus(): Promise<any>
 }
 
+declare namespace GSTDecoder {
+  /**
+   * Audio formats that require decoding before processing
+   */
+  export const FORMATS_NEEDING_DECODE: readonly string[]
+
+  /**
+   * All supported audio formats (including raw)
+   */
+  export const SUPPORTED_AUDIO_FORMATS: readonly string[]
+}
+
 export = GSTDecoder

package/index.js

@@ -4,6 +4,7 @@ const QvacResponse = require('@qvac/response')
 const BaseInference = require('@qvac/infer-base/WeightsProvider/BaseInference')
 const { GSTDecoderInterface } = require('./gstreamer')
 const createStreamAccumulator = require('./utils/createStreamAccumulator')
+const { FORMATS_NEEDING_DECODE, SUPPORTED_AUDIO_FORMATS } = require('./constants')
 
 const END_OF_INPUT = 'end of job'
 
@@ -14,7 +15,9 @@ class GSTDecoder extends BaseInference {
   /**
    * Creates an instance of GSTDecoder.
    * @constructor
-   * @param {Object} config - environment-specific inference setup configuration
+   * @param {Object} options - Constructor options
+   * @param {Object} options.config - environment-specific inference setup configuration
+   * @param {*} [args] - Additional arguments passed to BaseInference
    */
 
   constructor ({ config, ...args }) {
@@ -100,4 +103,9 @@ class GSTDecoder extends BaseInference {
   }
 }
 
+const FFmpegDecoder = require('./lib/ffmpeg/ffmpeg-decoder')
+
 module.exports = GSTDecoder
+module.exports.FORMATS_NEEDING_DECODE = FORMATS_NEEDING_DECODE
+module.exports.SUPPORTED_AUDIO_FORMATS = SUPPORTED_AUDIO_FORMATS
+module.exports.FFmpegDecoder = FFmpegDecoder

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qvac/decoder-audio",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "",
   "license": "Apache-2.0",
   "author": "Tether",
@@ -16,7 +16,7 @@
     "lint": "standard --ignore 'addon/**'",
     "lint:fix": "standard --fix --ignore 'addon/**'",
     "test:unit:generate": "brittle -r test/unit/all.js test/unit/*.test.js",
-    "test:integration:generate": "brittle -r test/integration/all.js test/integration/*.test.js",
+    "test:integration:generate": "brittle -r test/integration/all.js test/integration/ffmpeg-decoder.test.js",
     "test:integration": "npm run test:integration:generate && bare test/integration/all.js"
   },
   "files": [
@@ -44,9 +44,14 @@
   "dependencies": {
     "@qvac/infer-base": "^0.1.0",
     "@qvac/error": "^0.1.0",
+    "@qvac/logging": "^0.1.0",
     "@qvac/response": "^0.1.0",
     "bare-assert": "^1.0.2",
-    "bare-fs": "^4.0.2"
+    "bare-channel": "^5.2.0",
+    "bare-ffmpeg": "^1.0.0-29",
+    "bare-fs": "^4.0.2",
+    "bare-path": "^3.0.0",
+    "bare-worker": "^3.2.0"
   },
   "bugs": "https://github.com/tetherto/qvac-lib-decoder-audio/issues",
   "types": "index.d.ts"

package/prebuilds/darwin-arm64/qvac__decoder-audio.bare.exports

@@ -7,7 +7,7 @@
     ],
     "current_versions": [
       {
-        "version": "0.1"
+        "version": "0.2"
       }
     ],
     "exported_symbols": [
@@ -133,7 +133,6 @@
             "_ff_aac_usac_mdst_filt_prev",
             "_ff_aac_num_swb_480",
             "_GST_CAT_QOS",
-            "_av_sha_size",
             "_g_timeout_funcs",
             "_ff_eac3_profiles",
             "_ff_tx_tab_131072_double",
@@ -1584,7 +1583,6 @@
             "_g_param_spec_get_name_quark",
             "_g_str_match_string",
             "_pcre2_substring_nametable_scan_8",
-            "_avpriv_open",
             "_av_tx_uninit",
             "_gst_codec_utils_aac_get_profile",
             "_gst_navigation_query_new_angles",
@@ -1718,7 +1716,6 @@
             "_gst_app_sink_set_buffer_list_support",
             "_g_spawn_sync",
             "_gst_video_codec_state_ref",
-            "_avpriv_tempfile",
             "_g_variant_new_object_path",
             "_gst_date_time_new_ym",
             "_g_main_context_pending",
@@ -3490,7 +3487,6 @@
             "_gst_navigation_event_parse_command",
             "_g_unix_set_fd_nonblocking",
             "_avio_rl32",
-            "_av_sha_alloc",
             "_av_opt_get_q",
             "_av_fmt_ctx_get_duration_estimation_method",
             "_g_ptr_array_sort_with_data",
@@ -4392,7 +4388,6 @@
             "_gst_event_type_flags_get_type",
             "_av_color_transfer_name",
             "_gst_navigation_query_set_commandsv",
-            "_avpriv_fopen_utf8",
             "_gst_debug_category_free",
             "_av_iamf_audio_element_get_class",
             "_av_dirname",
@@ -4653,14 +4648,13 @@
             "_g_rename",
             "__gst_plugin_loader_client_run",
             "_ff_sbrdsp_init",
-            "_av_sha_update",
             "_avio_get_str16le",
+            "_ff_inlink_queued_samples",
             "_ff_set_common_samplerates2",
             "_ff_thread_report_progress",
             "_g_ptr_array_extend",
-            "_ff_inlink_queued_samples",
-            "_gst_tag_list_get_string",
             "_g_clear_handle_id",
+            "_gst_tag_list_get_string",
             "_g_parse_debug_string",
             "_g_slist_delete_link",
             "_g_type_plugin_complete_type_info",
@@ -5039,7 +5033,6 @@
             "_g_variant_type_new",
             "_ff_read_string_to_bprint_overwrite",
             "_g_bookmark_file_new",
-            "_av_sha_final",
             "__vorbis_block_ripcord",
             "_gst_navigation_event_new_mouse_scroll",
             "_gst_codec_utils_h264_get_level_idc",
@@ -6208,7 +6201,6 @@
             "_avfilter_graph_segment_free",
             "_vorbis_synthesis_init",
             "_av_buffersrc_parameters_set",
-            "_av_sha_init",
             "_ff_progress_frame_replace",
             "_av_buffersink_get_color_range",
             "_av_color_space_name",

package/prebuilds/darwin-x64/qvac__decoder-audio.bare.exports

@@ -7,7 +7,7 @@
     ],
     "current_versions": [
       {
-        "version": "0.1"
+        "version": "0.2"
       }
     ],
     "exported_symbols": [
@@ -133,7 +133,6 @@
             "_ff_aac_usac_mdst_filt_prev",
             "_ff_aac_num_swb_480",
             "_GST_CAT_QOS",
-            "_av_sha_size",
             "_g_timeout_funcs",
             "_ff_eac3_profiles",
             "_ff_tx_tab_131072_double",
@@ -1582,7 +1581,6 @@
             "_g_param_spec_get_name_quark",
             "_g_str_match_string",
             "_pcre2_substring_nametable_scan_8",
-            "_avpriv_open",
             "_av_tx_uninit",
             "_gst_codec_utils_aac_get_profile",
             "_gst_navigation_query_new_angles",
@@ -1716,7 +1714,6 @@
             "_gst_app_sink_set_buffer_list_support",
             "_g_spawn_sync",
             "_gst_video_codec_state_ref",
-            "_avpriv_tempfile",
             "_g_variant_new_object_path",
             "_gst_date_time_new_ym",
             "_g_main_context_pending",
@@ -3480,7 +3477,6 @@
             "_gst_navigation_event_parse_command",
             "_g_unix_set_fd_nonblocking",
             "_avio_rl32",
-            "_av_sha_alloc",
             "_av_opt_get_q",
             "_av_fmt_ctx_get_duration_estimation_method",
             "_g_ptr_array_sort_with_data",
@@ -3685,9 +3681,9 @@
             "_g_variant_dup_bytestring",
             "_gst_pad_probe_info_get_buffer",
             "_g_type_check_instance",
+            "_g_test_init",
             "_gst_base_sink_get_sync",
             "_gst_audio_resampler_resample",
-            "_g_test_init",
             "_gst_clock_single_shot_id_reinit",
             "_g_thread_unref",
             "_drft_init",
@@ -4374,7 +4370,6 @@
             "_gst_event_type_flags_get_type",
             "_av_color_transfer_name",
             "_gst_navigation_query_set_commandsv",
-            "_avpriv_fopen_utf8",
             "_gst_debug_category_free",
             "_av_iamf_audio_element_get_class",
             "_av_dirname",
@@ -4634,14 +4629,13 @@
             "_g_rename",
             "__gst_plugin_loader_client_run",
             "_ff_sbrdsp_init",
-            "_av_sha_update",
             "_avio_get_str16le",
+            "_ff_inlink_queued_samples",
             "_ff_set_common_samplerates2",
             "_ff_thread_report_progress",
             "_g_ptr_array_extend",
-            "_ff_inlink_queued_samples",
-            "_gst_tag_list_get_string",
             "_g_clear_handle_id",
+            "_gst_tag_list_get_string",
             "_g_parse_debug_string",
             "_g_slist_delete_link",
             "_g_type_plugin_complete_type_info",
@@ -5017,7 +5011,6 @@
             "_g_variant_type_new",
             "_ff_read_string_to_bprint_overwrite",
             "_g_bookmark_file_new",
-            "_av_sha_final",
             "__vorbis_block_ripcord",
             "_gst_navigation_event_new_mouse_scroll",
             "_gst_codec_utils_h264_get_level_idc",
@@ -6178,7 +6171,6 @@
             "_avfilter_graph_segment_free",
             "_vorbis_synthesis_init",
             "_av_buffersrc_parameters_set",
-            "_av_sha_init",
             "_ff_progress_frame_replace",
             "_av_buffersink_get_color_range",
             "_av_color_space_name",

package/prebuilds/ios-arm64/qvac__decoder-audio.bare.exports

@@ -7,7 +7,7 @@
     ],
     "current_versions": [
       {
-        "version": "0.1"
+        "version": "0.2"
       }
     ],
     "exported_symbols": [
@@ -133,7 +133,6 @@
             "_ff_aac_usac_mdst_filt_prev",
             "_ff_aac_num_swb_480",
             "_GST_CAT_QOS",
-            "_av_sha_size",
             "_g_timeout_funcs",
             "_ff_eac3_profiles",
             "_ff_tx_tab_131072_double",
@@ -1584,7 +1583,6 @@
             "_g_param_spec_get_name_quark",
             "_g_str_match_string",
             "_pcre2_substring_nametable_scan_8",
-            "_avpriv_open",
             "_av_tx_uninit",
             "_gst_codec_utils_aac_get_profile",
             "_gst_navigation_query_new_angles",
@@ -1718,7 +1716,6 @@
             "_gst_app_sink_set_buffer_list_support",
             "_g_spawn_sync",
             "_gst_video_codec_state_ref",
-            "_avpriv_tempfile",
             "_g_variant_new_object_path",
             "_gst_date_time_new_ym",
             "_g_main_context_pending",
@@ -3490,7 +3487,6 @@
             "_gst_navigation_event_parse_command",
             "_g_unix_set_fd_nonblocking",
             "_avio_rl32",
-            "_av_sha_alloc",
             "_av_opt_get_q",
             "_av_fmt_ctx_get_duration_estimation_method",
             "_g_ptr_array_sort_with_data",
@@ -4392,7 +4388,6 @@
             "_gst_event_type_flags_get_type",
             "_av_color_transfer_name",
             "_gst_navigation_query_set_commandsv",
-            "_avpriv_fopen_utf8",
             "_gst_debug_category_free",
             "_av_iamf_audio_element_get_class",
             "_av_dirname",
@@ -4653,14 +4648,13 @@
             "_g_rename",
             "__gst_plugin_loader_client_run",
             "_ff_sbrdsp_init",
-            "_av_sha_update",
             "_avio_get_str16le",
+            "_ff_inlink_queued_samples",
             "_ff_set_common_samplerates2",
             "_ff_thread_report_progress",
             "_g_ptr_array_extend",
-            "_ff_inlink_queued_samples",
-            "_gst_tag_list_get_string",
             "_g_clear_handle_id",
+            "_gst_tag_list_get_string",
             "_g_parse_debug_string",
             "_g_slist_delete_link",
             "_g_type_plugin_complete_type_info",
@@ -5039,7 +5033,6 @@
             "_g_variant_type_new",
             "_ff_read_string_to_bprint_overwrite",
             "_g_bookmark_file_new",
-            "_av_sha_final",
             "__vorbis_block_ripcord",
             "_gst_navigation_event_new_mouse_scroll",
             "_gst_codec_utils_h264_get_level_idc",
@@ -6208,7 +6201,6 @@
             "_avfilter_graph_segment_free",
             "_vorbis_synthesis_init",
             "_av_buffersrc_parameters_set",
-            "_av_sha_init",
             "_ff_progress_frame_replace",
             "_av_buffersink_get_color_range",
             "_av_color_space_name",

package/prebuilds/ios-arm64-simulator/qvac__decoder-audio.bare.exports

@@ -7,7 +7,7 @@
     ],
     "current_versions": [
       {
-        "version": "0.1"
+        "version": "0.2"
       }
     ],
     "exported_symbols": [
@@ -133,7 +133,6 @@
             "_ff_aac_usac_mdst_filt_prev",
             "_ff_aac_num_swb_480",
             "_GST_CAT_QOS",
-            "_av_sha_size",
             "_g_timeout_funcs",
             "_ff_eac3_profiles",
             "_ff_tx_tab_131072_double",
@@ -1584,7 +1583,6 @@
             "_g_param_spec_get_name_quark",
             "_g_str_match_string",
             "_pcre2_substring_nametable_scan_8",
-            "_avpriv_open",
             "_av_tx_uninit",
             "_gst_codec_utils_aac_get_profile",
             "_gst_navigation_query_new_angles",
@@ -1718,7 +1716,6 @@
             "_gst_app_sink_set_buffer_list_support",
             "_g_spawn_sync",
             "_gst_video_codec_state_ref",
-            "_avpriv_tempfile",
             "_g_variant_new_object_path",
             "_gst_date_time_new_ym",
             "_g_main_context_pending",
@@ -3490,7 +3487,6 @@
             "_gst_navigation_event_parse_command",
             "_g_unix_set_fd_nonblocking",
             "_avio_rl32",
-            "_av_sha_alloc",
             "_av_opt_get_q",
             "_av_fmt_ctx_get_duration_estimation_method",
             "_g_ptr_array_sort_with_data",
@@ -4392,7 +4388,6 @@
             "_gst_event_type_flags_get_type",
             "_av_color_transfer_name",
             "_gst_navigation_query_set_commandsv",
-            "_avpriv_fopen_utf8",
             "_gst_debug_category_free",
             "_av_iamf_audio_element_get_class",
             "_av_dirname",
@@ -4653,14 +4648,13 @@
             "_g_rename",
             "__gst_plugin_loader_client_run",
             "_ff_sbrdsp_init",
-            "_av_sha_update",
             "_avio_get_str16le",
+            "_ff_inlink_queued_samples",
             "_ff_set_common_samplerates2",
             "_ff_thread_report_progress",
             "_g_ptr_array_extend",
-            "_ff_inlink_queued_samples",
-            "_gst_tag_list_get_string",
             "_g_clear_handle_id",
+            "_gst_tag_list_get_string",
             "_g_parse_debug_string",
             "_g_slist_delete_link",
             "_g_type_plugin_complete_type_info",
@@ -5039,7 +5033,6 @@
             "_g_variant_type_new",
             "_ff_read_string_to_bprint_overwrite",
             "_g_bookmark_file_new",
-            "_av_sha_final",
             "__vorbis_block_ripcord",
             "_gst_navigation_event_new_mouse_scroll",
             "_gst_codec_utils_h264_get_level_idc",
@@ -6208,7 +6201,6 @@
             "_avfilter_graph_segment_free",
             "_vorbis_synthesis_init",
             "_av_buffersrc_parameters_set",
-            "_av_sha_init",
             "_ff_progress_frame_replace",
             "_av_buffersink_get_color_range",
             "_av_color_space_name",

package/prebuilds/ios-x64-simulator/qvac__decoder-audio.bare.exports

@@ -7,7 +7,7 @@
     ],
     "current_versions": [
       {
-        "version": "0.1"
+        "version": "0.2"
       }
     ],
     "exported_symbols": [
@@ -134,7 +134,6 @@
             "_ff_aac_usac_mdst_filt_prev",
             "_ff_aac_num_swb_480",
             "_GST_CAT_QOS",
-            "_av_sha_size",
             "_g_timeout_funcs",
             "_ff_eac3_profiles",
             "_ff_tx_tab_131072_double",
@@ -1584,7 +1583,6 @@
             "_g_param_spec_get_name_quark",
             "_g_str_match_string",
             "_pcre2_substring_nametable_scan_8",
-            "_avpriv_open",
             "_av_tx_uninit",
             "_gst_codec_utils_aac_get_profile",
             "_gst_navigation_query_new_angles",
@@ -1718,7 +1716,6 @@
             "_gst_app_sink_set_buffer_list_support",
             "_g_spawn_sync",
             "_gst_video_codec_state_ref",
-            "_avpriv_tempfile",
             "_g_variant_new_object_path",
             "_gst_date_time_new_ym",
             "_g_main_context_pending",
@@ -3486,7 +3483,6 @@
             "_gst_navigation_event_parse_command",
             "_g_unix_set_fd_nonblocking",
             "_avio_rl32",
-            "_av_sha_alloc",
             "_av_opt_get_q",
             "_av_fmt_ctx_get_duration_estimation_method",
             "_g_ptr_array_sort_with_data",
@@ -4381,7 +4377,6 @@
             "_gst_event_type_flags_get_type",
             "_av_color_transfer_name",
             "_gst_navigation_query_set_commandsv",
-            "_avpriv_fopen_utf8",
             "_gst_debug_category_free",
             "_av_iamf_audio_element_get_class",
             "_av_dirname",
@@ -4641,14 +4636,13 @@
             "_g_rename",
             "__gst_plugin_loader_client_run",
             "_ff_sbrdsp_init",
-            "_av_sha_update",
             "_avio_get_str16le",
+            "_ff_inlink_queued_samples",
             "_ff_set_common_samplerates2",
             "_ff_thread_report_progress",
             "_g_ptr_array_extend",
-            "_ff_inlink_queued_samples",
-            "_gst_tag_list_get_string",
             "_g_clear_handle_id",
+            "_gst_tag_list_get_string",
             "_g_parse_debug_string",
             "_g_slist_delete_link",
             "_g_type_plugin_complete_type_info",
@@ -5024,7 +5018,6 @@
             "_g_variant_type_new",
             "_ff_read_string_to_bprint_overwrite",
             "_g_bookmark_file_new",
-            "_av_sha_final",
             "__vorbis_block_ripcord",
             "_gst_navigation_event_new_mouse_scroll",
             "_gst_codec_utils_h264_get_level_idc",
@@ -6188,7 +6181,6 @@
             "_avfilter_graph_segment_free",
             "_vorbis_synthesis_init",
             "_av_buffersrc_parameters_set",
-            "_av_sha_init",
             "_ff_progress_frame_replace",
             "_av_buffersink_get_color_range",
             "_av_color_space_name",