Skip to content

[video_player_avfoundation] Adds Swift Package Manager compatibility #6675

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 8, 2024
Merged

[video_player_avfoundation] Adds Swift Package Manager compatibility #6675

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions packages/video_player/video_player_avfoundation/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
## 2.6.0

* Adds Swift Package Manager compatibility.

## 2.5.7

* Adds frame availability checks on iOS.
Expand Down
10 changes: 5 additions & 5 deletions packages/video_player/video_player_avfoundation/darwin/video_player_avfoundation.podspec
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@ Downloaded by pub (not CocoaPods).
s.author = { 'Flutter Dev Team' => 'flutter-dev@googlegroups.com' }
s.source = { :http => 'https://github.com/flutter/packages/tree/main/packages/video_player/video_player_avfoundation' }
s.documentation_url = 'https://pub.dev/packages/video_player'
s.source_files = 'Classes/*'
s.ios.source_files = 'Classes/ios/*'
s.osx.source_files = 'Classes/macos/*'
s.public_header_files = 'Classes/**/*.h'
s.source_files = 'video_player_avfoundation/Sources/video_player_avfoundation/**/*.{h,m}'
s.ios.source_files = 'video_player_avfoundation/Sources/video_player_avfoundation_ios/*'
s.osx.source_files = 'video_player_avfoundation/Sources/video_player_avfoundation_macos/*'
s.public_header_files = 'video_player_avfoundation/Sources/video_player_avfoundation/include/**/*.h'
s.ios.dependency 'Flutter'
s.osx.dependency 'FlutterMacOS'
s.ios.deployment_target = '12.0'
s.osx.deployment_target = '10.14'
s.pod_target_xcconfig = { 'DEFINES_MODULE' => 'YES' }
s.resource_bundles = {'video_player_avfoundation_privacy' => ['Resources/PrivacyInfo.xcprivacy']}
s.resource_bundles = {'video_player_avfoundation_privacy' => ['video_player_avfoundation/Sources/video_player_avfoundation/Resources/PrivacyInfo.xcprivacy']}
end
46 changes: 46 additions & 0 deletions ...ges/video_player/video_player_avfoundation/darwin/video_player_avfoundation/Package.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
// swift-tools-version: 5.9

// Copyright 2013 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import PackageDescription

let package = Package(
name: "video_player_avfoundation",
platforms: [
.iOS("12.0"),
.macOS("10.14"),
],
products: [
.library(name: "video-player-avfoundation", targets: ["video_player_avfoundation"])
],
dependencies: [],
targets: [
.target(
name: "video_player_avfoundation",
dependencies: [
.target(name: "video_player_avfoundation_ios", condition: .when(platforms: [.iOS])),
.target(name: "video_player_avfoundation_macos", condition: .when(platforms: [.macOS])),
],
resources: [
.process("Resources")
],
cSettings: [
.headerSearchPath("include/video_player_avfoundation")
]
),
.target(
Copy link
Contributor Author

@vashworth vashworth May 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment from previous PR by @stuartmorgan:
Interesting, so SPM doesn't allow source filtering without making separate targets?

Copy link
Contributor Author

@vashworth vashworth May 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct, it doesn't allow you to conditionalize by platform very much, only target dependencies, CSettings, CXXSettings, SwiftSettings, and LinkerSettings.

Sources can only be nil or an array of strings

name: "video_player_avfoundation_ios",
cSettings: [
.headerSearchPath("../video_player_avfoundation/include/video_player_avfoundation")
]
),
.target(
name: "video_player_avfoundation_macos",
cSettings: [
.headerSearchPath("../video_player_avfoundation/include/video_player_avfoundation")
]
),
]
)
0 ...dation/darwin/Classes/AVAssetTrackUtils.m → ...o_player_avfoundation/AVAssetTrackUtils.m
View file
Open in desktop
File renamed without changes.
6 changes: 3 additions & 3 deletions ...ion/darwin/Classes/FVPVideoPlayerPlugin.m → ...layer_avfoundation/FVPVideoPlayerPlugin.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@
#import <AVFoundation/AVFoundation.h>
#import <GLKit/GLKit.h>

#import "AVAssetTrackUtils.h"
#import "FVPDisplayLink.h"
#import "messages.g.h"
#import "./include/video_player_avfoundation/AVAssetTrackUtils.h"
#import "./include/video_player_avfoundation/FVPDisplayLink.h"
#import "./include/video_player_avfoundation/messages.g.h"
Copy link
Contributor Author

@vashworth vashworth May 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment from previous PR by @stuartmorgan:
Do we know why include paths aren't taking care of this?

Copy link
Contributor Author

@vashworth vashworth May 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So for most of the headers, include paths is sufficient. However, messages.g.h is a problem when there's multiple plugins that also have a messages.g.h. Seems like it can't resolve which to use. More explanation here: flutter/flutter#147587 (comment)

So I decided to change all of them to relative paths to keep it uniform

Copy link
Collaborator

@stuartmorgan-g stuartmorgan-g May 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a little surprised the compilation doesn't scope the search to just the module. Maybe it's the way we have to make all the headers public to make our unit tests work?

We could consider using a different naming convention for Obj-C out from Pigeon in our repo to give them unique names to avoid this, but relative paths are fine too.


#if !__has_feature(objc_arc)
#error Code Requires ARC.
Expand Down
0 ...on/darwin/Resources/PrivacyInfo.xcprivacy → ...oundation/Resources/PrivacyInfo.xcprivacy
View file
Open in desktop
File renamed without changes.
0 ...dation/darwin/Classes/AVAssetTrackUtils.h → ...o_player_avfoundation/AVAssetTrackUtils.h
View file
Open in desktop
File renamed without changes.
0 ...oundation/darwin/Classes/FVPDisplayLink.h → ...ideo_player_avfoundation/FVPDisplayLink.h
View file
Open in desktop
File renamed without changes.
0 ...ion/darwin/Classes/FVPVideoPlayerPlugin.h → ...layer_avfoundation/FVPVideoPlayerPlugin.h
View file
Open in desktop
File renamed without changes.
0 ...arwin/Classes/FVPVideoPlayerPlugin_Test.h → ..._avfoundation/FVPVideoPlayerPlugin_Test.h
View file
Open in desktop
File renamed without changes.
0 ..._avfoundation/darwin/Classes/messages.g.h → ...de/video_player_avfoundation/messages.g.h
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion ..._avfoundation/darwin/Classes/messages.g.m → ...es/video_player_avfoundation/messages.g.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
// Autogenerated from Pigeon (v18.0.0), do not edit directly.
// See also: https://pub.dev/packages/pigeon

#import "messages.g.h"
#import "./include/video_player_avfoundation/messages.g.h"
Copy link
Contributor Author

@vashworth vashworth May 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I changed this manually. This will get overwritten by pigeon until flutter/flutter#147587 is fixed.


#if TARGET_OS_OSX
#import <FlutterMacOS/FlutterMacOS.h>
Expand Down
2 changes: 1 addition & 1 deletion ...ation/darwin/Classes/ios/FVPDisplayLink.m → ..._player_avfoundation_ios/FVPDisplayLink.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#import "../FVPDisplayLink.h"
#import "../video_player_avfoundation/include/video_player_avfoundation/FVPDisplayLink.h"

#import <Foundation/Foundation.h>
#import <QuartzCore/QuartzCore.h>
Expand Down
Empty file added ...n/darwin/video_player_avfoundation/Sources/video_player_avfoundation_ios/include/.gitkeep
View file
Open in desktop
Empty file.
2 changes: 1 addition & 1 deletion ...ion/darwin/Classes/macos/FVPDisplayLink.m → ...layer_avfoundation_macos/FVPDisplayLink.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#import "../FVPDisplayLink.h"
#import "../video_player_avfoundation/include/video_player_avfoundation/FVPDisplayLink.h"

#import <CoreVideo/CoreVideo.h>
#import <Foundation/Foundation.h>
Expand Down
Empty file added ...darwin/video_player_avfoundation/Sources/video_player_avfoundation_macos/include/.gitkeep
View file
Open in desktop
Empty file.
1 change: 0 additions & 1 deletion packages/video_player/video_player_avfoundation/example/ios/Podfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ target 'Runner' do
flutter_install_all_ios_pods File.dirname(File.realpath(__FILE__))
target 'RunnerTests' do
inherit! :search_paths
pod 'OCMock', '3.9.1'
end
end

Expand Down
27 changes: 27 additions & 0 deletions packages/video_player/video_player_avfoundation/example/ios/Runner.xcodeproj/project.pbxproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
/* Begin PBXBuildFile section */
1498D2341E8E89220040F4C2 /* GeneratedPluginRegistrant.m in Sources */ = {isa = PBXBuildFile; fileRef = 1498D2331E8E89220040F4C2 /* GeneratedPluginRegistrant.m */; };
3B3967161E833CAA004F5970 /* AppFrameworkInfo.plist in Resources */ = {isa = PBXBuildFile; fileRef = 3B3967151E833CAA004F5970 /* AppFrameworkInfo.plist */; };
78CF8D742BC5CEA80051231B /* OCMock in Frameworks */ = {isa = PBXBuildFile; productRef = 78CF8D732BC5CEA80051231B /* OCMock */; };
Copy link
Contributor Author

@vashworth vashworth May 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: pbxproj file does not contain Swift Package Manager migration changes so that it will continue to build with stable. Migration will happen on the fly.

978B8F6F1D3862AE00F588F7 /* AppDelegate.m in Sources */ = {isa = PBXBuildFile; fileRef = 7AFFD8EE1D35381100E5BB4D /* AppDelegate.m */; };
97C146F31CF9000F007C117D /* main.m in Sources */ = {isa = PBXBuildFile; fileRef = 97C146F21CF9000F007C117D /* main.m */; };
97C146FC1CF9000F007C117D /* Main.storyboard in Resources */ = {isa = PBXBuildFile; fileRef = 97C146FA1CF9000F007C117D /* Main.storyboard */; };
Expand Down Expand Up @@ -99,6 +100,7 @@
isa = PBXFrameworksBuildPhase;
buildActionMask = 2147483647;
files = (
78CF8D742BC5CEA80051231B /* OCMock in Frameworks */,
D182ECB59C06DBC7E2D5D913 /* libPods-RunnerTests.a in Frameworks */,
);
runOnlyForDeploymentPostprocessing = 0;
Expand Down Expand Up @@ -260,6 +262,9 @@
F7151F4026603ECA0028CB91 /* PBXTargetDependency */,
);
name = RunnerTests;
packageProductDependencies = (
78CF8D732BC5CEA80051231B /* OCMock */,
);
productName = RunnerTests;
productReference = F7151F3A26603ECA0028CB91 /* RunnerTests.xctest */;
productType = "com.apple.product-type.bundle.unit-test";
Expand Down Expand Up @@ -297,6 +302,9 @@
Base,
);
mainGroup = 97C146E51CF9000F007C117D;
packageReferences = (
78CF8D722BC5CEA80051231B /* XCRemoteSwiftPackageReference "ocmock" */,
);
productRefGroup = 97C146EF1CF9000F007C117D /* Products */;
projectDirPath = "";
projectRoot = "";
Expand Down Expand Up @@ -758,6 +766,25 @@
defaultConfigurationName = Release;
};
/* End XCConfigurationList section */

/* Begin XCRemoteSwiftPackageReference section */
78CF8D722BC5CEA80051231B /* XCRemoteSwiftPackageReference "ocmock" */ = {
isa = XCRemoteSwiftPackageReference;
repositoryURL = "https://github.com/erikdoe/ocmock";
requirement = {
kind = revision;
revision = ef21a2ece3ee092f8ed175417718bdd9b8eb7c9a;
};
};
/* End XCRemoteSwiftPackageReference section */

/* Begin XCSwiftPackageProductDependency section */
78CF8D732BC5CEA80051231B /* OCMock */ = {
isa = XCSwiftPackageProductDependency;
package = 78CF8D722BC5CEA80051231B /* XCRemoteSwiftPackageReference "ocmock" */;
productName = OCMock;
};
/* End XCSwiftPackageProductDependency section */
};
rootObject = 97C146E61CF9000F007C117D /* Project object */;
}
13 changes: 13 additions & 0 deletions ...on/example/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 13 additions & 0 deletions ..._player_avfoundation/example/ios/Runner.xcworkspace/xcshareddata/swiftpm/Package.resolved
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion packages/video_player/video_player_avfoundation/example/macos/Podfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ target 'Runner' do
flutter_install_all_macos_pods File.dirname(File.realpath(__FILE__))
target 'RunnerTests' do
inherit! :search_paths
pod 'OCMock', '3.9.1'
end
end

Expand Down
27 changes: 27 additions & 0 deletions ...ges/video_player/video_player_avfoundation/example/macos/Runner.xcodeproj/project.pbxproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
33CC10F32044A3C60003C045 /* Assets.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = 33CC10F22044A3C60003C045 /* Assets.xcassets */; };
33CC10F62044A3C60003C045 /* MainMenu.xib in Resources */ = {isa = PBXBuildFile; fileRef = 33CC10F42044A3C60003C045 /* MainMenu.xib */; };
33CC11132044BFA00003C045 /* MainFlutterWindow.swift in Sources */ = {isa = PBXBuildFile; fileRef = 33CC11122044BFA00003C045 /* MainFlutterWindow.swift */; };
78CF8D772BC5D0140051231B /* OCMock in Frameworks */ = {isa = PBXBuildFile; productRef = 78CF8D762BC5D0140051231B /* OCMock */; };
C000184E56E3386C22EF683A /* Pods_Runner.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = CC60543320154AF9A465D416 /* Pods_Runner.framework */; };
/* End PBXBuildFile section */

Expand Down Expand Up @@ -95,6 +96,7 @@
isa = PBXFrameworksBuildPhase;
buildActionMask = 2147483647;
files = (
78CF8D772BC5D0140051231B /* OCMock in Frameworks */,
18AD5E2A5B24DAFCF3749529 /* Pods_RunnerTests.framework in Frameworks */,
);
runOnlyForDeploymentPostprocessing = 0;
Expand Down Expand Up @@ -226,6 +228,9 @@
331C80DA294CF71000263BE5 /* PBXTargetDependency */,
);
name = RunnerTests;
packageProductDependencies = (
78CF8D762BC5D0140051231B /* OCMock */,
);
productName = RunnerTests;
productReference = 331C80D5294CF71000263BE5 /* RunnerTests.xctest */;
productType = "com.apple.product-type.bundle.unit-test";
Expand Down Expand Up @@ -292,6 +297,9 @@
Base,
);
mainGroup = 33CC10E42044A3C60003C045;
packageReferences = (
78CF8D752BC5D0140051231B /* XCRemoteSwiftPackageReference "ocmock" */,
);
productRefGroup = 33CC10EE2044A3C60003C045 /* Products */;
projectDirPath = "";
projectRoot = "";
Expand Down Expand Up @@ -808,6 +816,25 @@
defaultConfigurationName = Release;
};
/* End XCConfigurationList section */

/* Begin XCRemoteSwiftPackageReference section */
78CF8D752BC5D0140051231B /* XCRemoteSwiftPackageReference "ocmock" */ = {
isa = XCRemoteSwiftPackageReference;
repositoryURL = "https://github.com/erikdoe/ocmock";
requirement = {
kind = revision;
revision = ef21a2ece3ee092f8ed175417718bdd9b8eb7c9a;
};
};
/* End XCRemoteSwiftPackageReference section */

/* Begin XCSwiftPackageProductDependency section */
78CF8D762BC5D0140051231B /* OCMock */ = {
isa = XCSwiftPackageProductDependency;
package = 78CF8D752BC5D0140051231B /* XCRemoteSwiftPackageReference "ocmock" */;
productName = OCMock;
};
/* End XCSwiftPackageProductDependency section */
};
rootObject = 33CC10E52044A3C60003C045 /* Project object */;
}
13 changes: 13 additions & 0 deletions .../example/macos/Runner.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 13 additions & 0 deletions ...layer_avfoundation/example/macos/Runner.xcworkspace/xcshareddata/swiftpm/Package.resolved
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion packages/video_player/video_player_avfoundation/example/macos/Runner/AppDelegate.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
import Cocoa
import FlutterMacOS

@NSApplicationMain
@main
Copy link
Contributor Author

@vashworth vashworth May 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@NSApplicationMain was deprecated, tool migrated it: flutter/flutter#146848

class AppDelegate: FlutterAppDelegate {
override func applicationShouldTerminateAfterLastWindowClosed(_ sender: NSApplication) -> Bool {
return true
Expand Down
7 changes: 5 additions & 2 deletions packages/video_player/video_player_avfoundation/pigeons/messages.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,13 @@ import 'package:pigeon/pigeon.dart';
@ConfigurePigeon(PigeonOptions(
dartOut: 'lib/src/messages.g.dart',
dartTestOut: 'test/test_api.g.dart',
objcHeaderOut: 'darwin/Classes/messages.g.h',
objcSourceOut: 'darwin/Classes/messages.g.m',
objcHeaderOut:
'darwin/video_player_avfoundation/Sources/video_player_avfoundation/include/video_player_avfoundation/messages.g.h',
objcSourceOut:
'darwin/video_player_avfoundation/Sources/video_player_avfoundation/messages.g.m',
objcOptions: ObjcOptions(
prefix: 'FVP',
headerIncludePath: './include/video_player_avfoundation/messages.g.h',
),
copyrightHeader: 'pigeons/copyright.txt',
))
Expand Down
2 changes: 1 addition & 1 deletion packages/video_player/video_player_avfoundation/pubspec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: video_player_avfoundation
description: iOS and macOS implementation of the video_player plugin.
repository: https://github.com/flutter/packages/tree/main/packages/video_player/video_player_avfoundation
issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+video_player%22
version: 2.5.7
version: 2.6.0
Copy link
Contributor Author

@vashworth vashworth May 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment from previous PR by @stuartmorgan:
Optional: I would probably make this a minor bump, since it's more of a new feature than a fix.

Copy link
Contributor Author

@vashworth vashworth May 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I changed it to a minor bump


environment:
sdk: ^3.2.3
Expand Down