Merge branch 'main' into flac-channel-order

Author: sbooth

.github/workflows/clang-format-check.yml

@@ -0,0 +1,38 @@
+name: cpp-linter
+on:
+  push:
+    branches: [ "main" ]
+    paths: 
+      - 'Sources/CSFBAudioEngine/**.h'
+      - 'Sources/CSFBAudioEngine/**.hpp'
+      - 'Sources/CSFBAudioEngine/**.m'
+      - 'Sources/CSFBAudioEngine/**.mm'
+  pull_request:
+    branches: [ "main" ]
+    paths: 
+      - 'Sources/CSFBAudioEngine/**.h'
+      - 'Sources/CSFBAudioEngine/**.hpp'
+      - 'Sources/CSFBAudioEngine/**.m'
+      - 'Sources/CSFBAudioEngine/**.mm'
+permissions:
+  contents: read
+  pull-requests: write
+jobs:
+  cpp-linter:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6
+      - name: cpp-linter
+        uses: cpp-linter/cpp-linter-action@v2
+        id: linter
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          style: 'file'
+          tidy-checks: '-*'
+          thread-comments: ${{ github.event_name == 'pull_request' && 'update' }}
+          format-review: true
+      - name: Fail fast?!
+        if: steps.linter.outputs.checks-failed > 0
+        run: exit 1

.github/workflows/cpp-linter.yml

@@ -32,18 +32,18 @@ let package = Package(
 
         // Standalone dependencies from source
         .package(url: "https://github.com/sbooth/CDUMB", from: "2.0.3"),
-        .package(url: "https://github.com/sbooth/CXXMonkeysAudio", from: "11.82.0"),
+        .package(url: "https://github.com/sbooth/CXXMonkeysAudio", from: "12.13.0"),
         .package(url: "https://github.com/sbooth/CXXTagLib", from: "2.1.1"),
 
         // Standalone dependencies not easily packaged using SPM
-        .package(url: "https://github.com/sbooth/wavpack-binary-xcframework", .upToNextMinor(from: "0.1.2")),
+        .package(url: "https://github.com/sbooth/wavpack-binary-xcframework", .upToNextMinor(from: "0.2.0")),
 
         // Xiph ecosystem
         .package(url: "https://github.com/sbooth/ogg-binary-xcframework", .upToNextMinor(from: "0.1.3")),
         // flac-binary-xcframework requires ogg-binary-xcframework
         .package(url: "https://github.com/sbooth/flac-binary-xcframework", .upToNextMinor(from: "0.2.0")),
         // opus-binary-xcframework requires ogg-binary-xcframework
-        .package(url: "https://github.com/sbooth/opus-binary-xcframework", .upToNextMinor(from: "0.2.2")),
+        .package(url: "https://github.com/sbooth/opus-binary-xcframework", .upToNextMinor(from: "0.3.0")),
         // vorbis-binary-xcframework requires ogg-binary-xcframework
         .package(url: "https://github.com/sbooth/vorbis-binary-xcframework", .upToNextMinor(from: "0.1.2")),
         // libspeex does not depend on libogg
@@ -53,7 +53,7 @@ let package = Package(
         .package(url: "https://github.com/sbooth/lame-binary-xcframework", .upToNextMinor(from: "0.1.2")),
         // Technically only the musepack *encoder* is LGPL'd but for now the decoder and encoder are packaged together
         .package(url: "https://github.com/sbooth/mpc-binary-xcframework", .upToNextMinor(from: "0.1.2")),
-        .package(url: "https://github.com/sbooth/mpg123-binary-xcframework", .upToNextMinor(from: "0.3.0")),
+        .package(url: "https://github.com/sbooth/mpg123-binary-xcframework", .upToNextMinor(from: "0.3.1")),
         // sndfile-binary-xcframework requires ogg-binary-xcframework, flac-binary-xcframework, opus-binary-xcframework, and vorbis-binary-xcframework
         .package(url: "https://github.com/sbooth/sndfile-binary-xcframework", .upToNextMinor(from: "0.1.2")),
         .package(url: "https://github.com/sbooth/tta-cpp-binary-xcframework", .upToNextMinor(from: "0.1.2")),

Package.resolved

@@ -72,8 +72,8 @@ The output file's format is inferred from the file extension.
 More complex conversions are supported including writing to `Data` instead of files:
 
 ~~~swift
-let output = OutputSource.makeForData()
-let encoder = try AudioEncoder(outputSource: output, encoderName: .coreAudio)
+let output = OutputTarget.makeForData()
+let encoder = try AudioEncoder(outputTarget: output, encoderName: .coreAudio)
 encoder.settings = [
     .coreAudioFileTypeID: kAudioFileM4AType,
     .coreAudioFormatID: kAudioFormatMPEG4AAC,
@@ -114,9 +114,9 @@ Three special decoder subclasses that decorate an underlying audio decoder insta
 
 ## Encoding
 
-[Audio encoders](Sources/CSFBAudioEngine/Encoders/) in SFBAudioEngine process input data and convert it to their output format. Audio encoders write data to an [SFBOutputSource](Sources/CSFBAudioEngine/include/SFBOutputSource.h) which may refer to a file, buffer, or data.
+[Audio encoders](Sources/CSFBAudioEngine/SFBAudioEngine/Encoders/) in SFBAudioEngine process input data and convert it to their output format. Audio encoders write data to an [SFBOutputTarget](Sources/CSFBAudioEngine/include/SFBAudioEngine/SFBOutputTarget.h) which may refer to a file, buffer, or data.
 
-All audio encoders in SFBAudioEngine implement the [SFBAudioEncoding](Sources/CSFBAudioEngine/include/SFBAudioEncoding.h) protocol. PCM-consuming encoders additionally implement [SFBPCMEncoding](Sources/CSFBAudioEngine/include/SFBPCMEncoding.h). Currently there are no encoders consuming DSD in SFBAudioEngine.
+All audio encoders in SFBAudioEngine implement the [SFBAudioEncoding](Sources/CSFBAudioEngine/include/SFBAudioEncoding.h) protocol. PCM-consuming encoders additionally implement [SFBPCMEncoding](Sources/CSFBAudioEngine/include/SFBAudioEngine/SFBPCMEncoding.h). Currently there are no encoders consuming DSD in SFBAudioEngine.
 
 Encoders don't support arbitrary input formats. The processing format used by an encoder is derived from a desired format combined with the encoder's settings.
 

Package.swift

@@ -313,10 +313,11 @@ - (BOOL)openReturningError:(NSError **)error {
     AVAudioChannelLayout *channelLayout = nil;
 
     if (_channelMask != 0) {
-        if (__builtin_popcount(_channelMask) == _streamInfo.channels) {
+        if (static_cast<uint32_t>(__builtin_popcount(_channelMask)) == _streamInfo.channels) {
             channelLayout = channelLayoutFromWAVEMask(_channelMask);
         } else {
-            os_log_error(gSFBAudioDecoderLog, "Ignoring invalid channel mask 0x%x (%d channels) for %u-channel stream", _channelMask, __builtin_popcount(_channelMask), _streamInfo.channels);
+            os_log_error(gSFBAudioDecoderLog, "Ignoring invalid channel mask 0x%x (%d channels) for %u-channel stream",
+                         _channelMask, __builtin_popcount(_channelMask), _streamInfo.channels);
         }
     }
 
@@ -618,14 +619,16 @@ - (void)handleFLACMetadata:(const FLAC__StreamDecoder *)decoder metadata:(const
             const char *prefix = "WAVEFORMATEXTENSIBLE_CHANNEL_MASK=";
             constexpr auto prefixLength = 34;
             constexpr auto minValidLength = prefixLength + 2 + 1 /* '0xN' */;
-            if (comment.length >= minValidLength && comment.entry[0] == prefix[0] && memcmp(comment.entry, prefix, prefixLength) == 0) {
+            if (comment.length >= minValidLength && comment.entry[0] == prefix[0] &&
+                memcmp(comment.entry, prefix, prefixLength) == 0) {
                 if (_channelMask != 0) {
                     os_log_debug(gSFBAudioDecoderLog, "Multiple WAVEFORMATEXTENSIBLE_CHANNEL_MASK Vorbis comments");
                 }
                 const char *value = reinterpret_cast<const char *>(comment.entry) + prefixLength;
                 _channelMask = static_cast<uint32_t>(std::strtoul(value, nullptr, 16));
                 if (_channelMask == 0 || _channelMask > 0x3FFFF) {
-                    os_log_error(gSFBAudioDecoderLog, "Invalid value \"%{public}s\" for WAVEFORMATEXTENSIBLE_CHANNEL_MASK", value);
+                    os_log_error(gSFBAudioDecoderLog,
+                                 "Invalid value \"%{public}s\" for WAVEFORMATEXTENSIBLE_CHANNEL_MASK", value);
                     _channelMask = 0;
                 }
             }

README.md

@@ -238,9 +238,9 @@ - (BOOL)openReturningError:(NSError **)error {
 
         AudioChannelLayoutTag tag = 0;
         UInt32 propertySize = sizeof(tag);
-        OSStatus result = AudioFormatGetProperty(kAudioFormatProperty_TagForChannelLayout, sizeof(layout), &layout,
+        OSStatus status = AudioFormatGetProperty(kAudioFormatProperty_TagForChannelLayout, sizeof layout, &layout,
                                                  &propertySize, &tag);
-        if (result == noErr) {
+        if (status == noErr) {
             channelLayout = [[AVAudioChannelLayout alloc] initWithLayoutTag:tag];
         } else {
             channelLayout = [AVAudioChannelLayout layoutWithLayout:&layout];

Sources/CSFBAudioEngine/Decoders/SFBFLACDecoder.mm

@@ -15,7 +15,7 @@ extern os_log_t gSFBAudioEncoderLog;
 
 @interface SFBAudioEncoder () {
   @package
-    SFBOutputSource *_outputSource;
+    SFBOutputTarget *_outputTarget;
     AVAudioFormat *_sourceFormat;
     AVAudioFormat *_processingFormat;
     AVAudioFormat *_outputFormat;

Sources/CSFBAudioEngine/Decoders/SFBWavPackDecoder.m

@@ -29,7 +29,7 @@ @interface SFBAudioEncoderSubclassInfo : NSObject
 
 @implementation SFBAudioEncoder
 
-@synthesize outputSource = _outputSource;
+@synthesize outputTarget = _outputTarget;
 @synthesize sourceFormat = _sourceFormat;
 @synthesize processingFormat = _processingFormat;
 @synthesize outputFormat = _outputFormat;
@@ -126,27 +126,27 @@ - (instancetype)initWithURL:(NSURL *)url error:(NSError **)error {
 - (instancetype)initWithURL:(NSURL *)url mimeType:(NSString *)mimeType error:(NSError **)error {
     NSParameterAssert(url != nil);
 
-    SFBOutputSource *outputSource = [SFBOutputSource outputSourceForURL:url error:error];
-    if (!outputSource) {
+    SFBOutputTarget *outputTarget = [SFBOutputTarget outputTargetForURL:url error:error];
+    if (!outputTarget) {
         return nil;
     }
-    return [self initWithOutputSource:outputSource mimeType:mimeType error:error];
+    return [self initWithOutputTarget:outputTarget mimeType:mimeType error:error];
 }
 
-- (instancetype)initWithOutputSource:(SFBOutputSource *)outputSource {
-    return [self initWithOutputSource:outputSource mimeType:nil error:nil];
+- (instancetype)initWithOutputTarget:(SFBOutputTarget *)outputTarget {
+    return [self initWithOutputTarget:outputTarget mimeType:nil error:nil];
 }
 
-- (instancetype)initWithOutputSource:(SFBOutputSource *)outputSource error:(NSError **)error {
-    return [self initWithOutputSource:outputSource mimeType:nil error:error];
+- (instancetype)initWithOutputTarget:(SFBOutputTarget *)outputTarget error:(NSError **)error {
+    return [self initWithOutputTarget:outputTarget mimeType:nil error:error];
 }
 
-- (instancetype)initWithOutputSource:(SFBOutputSource *)outputSource
+- (instancetype)initWithOutputTarget:(SFBOutputTarget *)outputTarget
                             mimeType:(NSString *)mimeType
                                error:(NSError **)error {
-    NSParameterAssert(outputSource != nil);
+    NSParameterAssert(outputTarget != nil);
 
-    NSString *lowercaseExtension = outputSource.url.pathExtension.lowercaseString;
+    NSString *lowercaseExtension = outputTarget.url.pathExtension.lowercaseString;
     NSString *lowercaseMIMEType = mimeType.lowercaseString;
 
     int score = 10;
@@ -177,20 +177,20 @@ - (instancetype)initWithOutputSource:(SFBOutputSource *)outputSource
     }
 
     if (!subclass) {
-        os_log_debug(gSFBAudioEncoderLog, "Unable to determine content type for %{public}@", outputSource);
+        os_log_debug(gSFBAudioEncoderLog, "Unable to determine content type for %{public}@", outputTarget);
         if (error) {
             NSMutableDictionary *userInfo = [NSMutableDictionary
                     dictionaryWithObject:
                             NSLocalizedString(@"The file's extension may be missing or may not match the file's type.",
                                               @"")
                                   forKey:NSLocalizedRecoverySuggestionErrorKey];
 
-            if (outputSource.url) {
+            if (outputTarget.url) {
                 userInfo[NSLocalizedDescriptionKey] = [NSString
                         localizedStringWithFormat:NSLocalizedString(
                                                           @"The type of the file “%@” could not be determined.", @""),
-                                                  SFBLocalizedNameForURL(outputSource.url)];
-                userInfo[NSURLErrorKey] = outputSource.url;
+                                                  SFBLocalizedNameForURL(outputTarget.url)];
+                userInfo[NSURLErrorKey] = outputTarget.url;
             } else {
                 userInfo[NSLocalizedDescriptionKey] =
                         NSLocalizedString(@"The type of the file could not be determined.", @"");
@@ -204,7 +204,7 @@ - (instancetype)initWithOutputSource:(SFBOutputSource *)outputSource
     }
 
     if ((self = [[subclass alloc] init])) {
-        _outputSource = outputSource;
+        _outputTarget = outputTarget;
         os_log_debug(gSFBAudioEncoderLog, "Created %{public}@ based on score of %i", self, score);
     }
 
@@ -218,21 +218,21 @@ - (instancetype)initWithURL:(NSURL *)url encoderName:(SFBAudioEncoderName)encode
 - (instancetype)initWithURL:(NSURL *)url encoderName:(SFBAudioEncoderName)encoderName error:(NSError **)error {
     NSParameterAssert(url != nil);
 
-    SFBOutputSource *outputSource = [SFBOutputSource outputSourceForURL:url error:error];
-    if (!outputSource) {
+    SFBOutputTarget *outputTarget = [SFBOutputTarget outputTargetForURL:url error:error];
+    if (!outputTarget) {
         return nil;
     }
-    return [self initWithOutputSource:outputSource encoderName:encoderName error:error];
+    return [self initWithOutputTarget:outputTarget encoderName:encoderName error:error];
 }
 
-- (instancetype)initWithOutputSource:(SFBOutputSource *)outputSource encoderName:(SFBAudioEncoderName)encoderName {
-    return [self initWithOutputSource:outputSource encoderName:encoderName error:nil];
+- (instancetype)initWithOutputTarget:(SFBOutputTarget *)outputTarget encoderName:(SFBAudioEncoderName)encoderName {
+    return [self initWithOutputTarget:outputTarget encoderName:encoderName error:nil];
 }
 
-- (instancetype)initWithOutputSource:(SFBOutputSource *)outputSource
+- (instancetype)initWithOutputTarget:(SFBOutputTarget *)outputTarget
                          encoderName:(SFBAudioEncoderName)encoderName
                                error:(NSError **)error {
-    NSParameterAssert(outputSource != nil);
+    NSParameterAssert(outputTarget != nil);
 
     Class subclass = nil;
     for (SFBAudioEncoderSubclassInfo *subclassInfo in _registeredSubclasses) {
@@ -254,7 +254,7 @@ - (instancetype)initWithOutputSource:(SFBOutputSource *)outputSource
     }
 
     if ((self = [[subclass alloc] init])) {
-        _outputSource = outputSource;
+        _outputTarget = outputTarget;
     }
 
     return self;
@@ -302,8 +302,8 @@ - (BOOL)setSourceFormat:(AVAudioFormat *)sourceFormat error:(NSError **)error {
 }
 
 - (BOOL)openReturningError:(NSError **)error {
-    if (!_outputSource.isOpen) {
-        return [_outputSource openReturningError:error];
+    if (!_outputTarget.isOpen) {
+        return [_outputTarget openReturningError:error];
     }
     return YES;
 }
@@ -313,8 +313,8 @@ - (BOOL)closeReturningError:(NSError **)error {
     _processingFormat = nil;
     _outputFormat = nil;
     _settings = nil;
-    if (_outputSource.isOpen) {
-        return [_outputSource closeReturningError:error];
+    if (_outputTarget.isOpen) {
+        return [_outputTarget closeReturningError:error];
     }
     return YES;
 }