Foobar2000:Development:Overview - Revision history

DEATH at 10:52, 8 September 2023

2023-09-08T10:52:08Z

← Older revision		Revision as of 10:52, 8 September 2023
Line 9:		Line 9:
	Each component has a single exported DLL function, <code>foobar2000_get_interface()</code>, called on startup to initialize and discover entrypoint services of your component. This function is generated automatically by the foobar2000_component_client module. Do not implement it yourself.		Each component has a single exported DLL function, <code>foobar2000_get_interface()</code>, called on startup to initialize and discover entrypoint services of your component. This function is generated automatically by the foobar2000_component_client module. Do not implement it yourself.

	foobar2000 components are made using [https://www.foobar2000.org/SDK foobar2000 SDK] and [https://visualstudio.microsoft.com Microsoft Visual Studio].		foobar2000 components are made using [https://www.foobar2000.org/SDK foobar2000 SDK] and [https://visualstudio.microsoft.com Microsoft Visual Studio] or [https://developer.apple.com/xcode Xcode].

	See also: [[Foobar2000:Development:Visual_Studio_Compatibility\|Visual Studio Compatibility]], [[Foobar2000:Development:SDK Contents\|SDK Contents]].		See also: [[Foobar2000:Development:Visual_Studio_Compatibility\|Visual Studio Compatibility]], [[Foobar2000:Development:SDK Contents\|SDK Contents]].
Line 41:		Line 41:
	The components site now accepts such components and detects supported CPU architectures by listing zip contents.		The components site now accepts such components and detects supported CPU architectures by listing zip contents.

	=== ARM support ===		=== Windows ARM support ===
	foobar2000 for ARM is built in ARM64EC (Emulation Compatible) mode.		foobar2000 for ARM is built in ARM64EC (Emulation Compatible) mode.

DEATH: Mac OS info

2023-09-07T12:09:54Z

Mac OS info

← Older revision		Revision as of 12:09, 7 September 2023
Line 3:		Line 3:
	== What is a component ==		== What is a component ==

	A foobar2000 component is a Windows Dynamic Link Library (DLL) extending the functionality of the foobar2000 application.		A foobar2000 component is a Windows Dynamic Link Library (DLL), or a Mac OS bundle with "component" extension, extending the functionality of the foobar2000 application.

	A foobar2000 component implements one or more entrypoint services and interacts with services provided by foobar2000 core or other components.		A foobar2000 component implements one or more entrypoint services and interacts with services provided by foobar2000 core or other components.
Line 17:		Line 17:
	Components are delivered to the user in form of fb2k-component file.		Components are delivered to the user in form of fb2k-component file.

	~~This is simply~~ a renamed zip of ~~your~~ DLL.		In old 32-bit foobar2000, this was originally a renamed zip of a component DLL.

	~~If your~~ component ~~requires additional files, include them in the zip; foobar2000 will extract them to the folder containing your DLL upon installation~~.		In modern foobar2000, fb2k-component archive can contain multiple subdiretories with payloads for different processor architectures or operating systems.

	=== Different ~~CPU~~ architectures ===		If your component requires additional files, include them in the zip; foobar2000 will extract them to the folder containing your component DLL upon installation.

			=== Different architectures ===
	Delivering as straightforward zip-of-a-DLL still works, but that leaves it up to the user to download the correct binary.		Delivering as straightforward zip-of-a-DLL still works, but that leaves it up to the user to download the correct binary.

Line 32:		Line 34:
	x64\foo_sample.dll <= for x64 and arm64ec		x64\foo_sample.dll <= for x64 and arm64ec
	arm64ec\foo_sample.dll <= arm64ec foobar2000 will prefer this over x64 if provided		arm64ec\foo_sample.dll <= arm64ec foobar2000 will prefer this over x64 if provided
			mac\foo_sample.component <= Mac OS bundle
	</pre>		</pre>

	Components packaged this way will let foobar2000 choose the right ~~DLL~~ to load.		Components packaged this way will let foobar2000 choose the right thing to load.

	The components site now accepts such components and detects supported CPU architectures by listing zip contents.		The components site now accepts such components and detects supported CPU architectures by listing zip contents.

DEATH: Added foobar2000 for ARM link

2023-03-23T13:57:51Z

Added foobar2000 for ARM link

← Older revision		Revision as of 13:57, 23 March 2023
Line 44:		Line 44:

	For non-performance-critical components, emulation of verified working x64 code is more than good enough, likely better than running untested ARM64 code if the developer has no means to test it.		For non-performance-critical components, emulation of verified working x64 code is more than good enough, likely better than running untested ARM64 code if the developer has no means to test it.

			See also: [[Foobar2000:Foobar2000 for ARM]]

	== Getting a component listed on foobar2000.org/components ==		== Getting a component listed on foobar2000.org/components ==

DEATH: ARM info

2023-03-23T13:08:32Z

ARM info

← Older revision		Revision as of 13:08, 23 March 2023
Line 30:		Line 30:
	<pre>		<pre>
	foo_sample.dll <= this is for legacy x86 foobar2000		foo_sample.dll <= this is for legacy x86 foobar2000
	x64\foo_sample.dll		x64\foo_sample.dll <= for x64 and arm64ec
	~~arm64~~\foo_sample.dll		arm64ec\foo_sample.dll <= arm64ec foobar2000 will prefer this over x64 if provided
	</pre>		</pre>

Line 37:		Line 37:

	The components site now accepts such components and detects supported CPU architectures by listing zip contents.		The components site now accepts such components and detects supported CPU architectures by listing zip contents.

			=== ARM support ===
			foobar2000 for ARM is built in ARM64EC (Emulation Compatible) mode.

			Because ARM64 Windows is still a niche platform, we cannot expect every developer to compile and test ARM64 components. foobar2000 for ARM64 is capable of seamlessly loading x64 components and transparently running them side by side with native components.

			For non-performance-critical components, emulation of verified working x64 code is more than good enough, likely better than running untested ARM64 code if the developer has no means to test it.

	== Getting a component listed on foobar2000.org/components ==		== Getting a component listed on foobar2000.org/components ==

DEATH: /* What is a component */

2022-08-26T07:05:48Z

What is a component

← Older revision		Revision as of 07:05, 26 August 2022
Line 7:		Line 7:
	A foobar2000 component implements one or more entrypoint services and interacts with services provided by foobar2000 core or other components.		A foobar2000 component implements one or more entrypoint services and interacts with services provided by foobar2000 core or other components.

	Each component has a single exported DLL function, <code>foobar2000_get_interface()</code>, called on startup to initialize and discover entrypoint services your component. This function is generated automatically by the foobar2000_component_client module. Do not implement it yourself.		Each component has a single exported DLL function, <code>foobar2000_get_interface()</code>, called on startup to initialize and discover entrypoint services of your component. This function is generated automatically by the foobar2000_component_client module. Do not implement it yourself.

	foobar2000 components are made using [https://www.foobar2000.org/SDK foobar2000 SDK] and [https://visualstudio.microsoft.com Microsoft Visual Studio].		foobar2000 components are made using [https://www.foobar2000.org/SDK foobar2000 SDK] and [https://visualstudio.microsoft.com Microsoft Visual Studio].

DEATH: /* Packaging a component */

2022-08-25T19:35:53Z

Packaging a component

← Older revision		Revision as of 19:35, 25 August 2022
Line 20:		Line 20:

	If your component requires additional files, include them in the zip; foobar2000 will extract them to the folder containing your DLL upon installation.		If your component requires additional files, include them in the zip; foobar2000 will extract them to the folder containing your DLL upon installation.

			=== Different CPU architectures ===
			Delivering as straightforward zip-of-a-DLL still works, but that leaves it up to the user to download the correct binary.

			To support multiple CPU architectures with one package, put files meant for legacy x86 foobar2000 in top level and create subdirectories named after the architectures, with files that are specialized for those architectures.

			For an example, x64 foobar2000 will extract whole component archive, then overwrite files in root with those in x64 subfolder:

			<pre>
			foo_sample.dll <= this is for legacy x86 foobar2000
			x64\foo_sample.dll
			arm64\foo_sample.dll
			</pre>

			Components packaged this way will let foobar2000 choose the right DLL to load.

			The components site now accepts such components and detects supported CPU architectures by listing zip contents.

	== Getting a component listed on foobar2000.org/components ==		== Getting a component listed on foobar2000.org/components ==

DEATH at 13:46, 22 June 2022

2022-06-22T13:46:22Z

← Older revision		Revision as of 13:46, 22 June 2022
Line 9:		Line 9:
	Each component has a single exported DLL function, <code>foobar2000_get_interface()</code>, called on startup to initialize and discover entrypoint services your component. This function is generated automatically by the foobar2000_component_client module. Do not implement it yourself.		Each component has a single exported DLL function, <code>foobar2000_get_interface()</code>, called on startup to initialize and discover entrypoint services your component. This function is generated automatically by the foobar2000_component_client module. Do not implement it yourself.

	foobar2000 components are made using [https://www.foobar2000.org/SDK foobar2000 SDK] and [https://visualstudio.microsoft.com Microsoft Visual Studio]. See also: [[Foobar2000:Development:Visual_Studio_Compatibility\|Visual Studio Compatibility]].		foobar2000 components are made using [https://www.foobar2000.org/SDK foobar2000 SDK] and [https://visualstudio.microsoft.com Microsoft Visual Studio].

			See also: [[Foobar2000:Development:Visual_Studio_Compatibility\|Visual Studio Compatibility]], [[Foobar2000:Development:SDK Contents\|SDK Contents]].

	== Packaging a component ==		== Packaging a component ==
Line 29:		Line 31:
	* [[Foobar2000:Development:Exceptions\|Exceptions]]		* [[Foobar2000:Development:Exceptions\|Exceptions]]
	* [[Foobar2000:Development:Global Callbacks\|Global Callbacks: tracking foobar2000 lifetime events]]		* [[Foobar2000:Development:Global Callbacks\|Global Callbacks: tracking foobar2000 lifetime events]]
			* [[Foobar2000:Development:SDK Contents\|SDK Contents]]
	* [[Foobar2000:Development:Services\|Services]]		* [[Foobar2000:Development:Services\|Services]]
	* [[Foobar2000:Development:Storing Configuration\|Storing Configuration]]		* [[Foobar2000:Development:Storing Configuration\|Storing Configuration]]
	* [[Foobar2000:Development:Threads\|Threads]]		* [[Foobar2000:Development:Threads\|Threads]]
	* [[Foobar2000:Development:Visual_Studio_Compatibility\|Visual Studio Compatibility]]		* [[Foobar2000:Development:Visual_Studio_Compatibility\|Visual Studio Compatibility]]

DEATH at 13:22, 22 June 2022

2022-06-22T13:22:34Z

← Older revision		Revision as of 13:22, 22 June 2022
Line 8:		Line 8:

	Each component has a single exported DLL function, <code>foobar2000_get_interface()</code>, called on startup to initialize and discover entrypoint services your component. This function is generated automatically by the foobar2000_component_client module. Do not implement it yourself.		Each component has a single exported DLL function, <code>foobar2000_get_interface()</code>, called on startup to initialize and discover entrypoint services your component. This function is generated automatically by the foobar2000_component_client module. Do not implement it yourself.

			foobar2000 components are made using [https://www.foobar2000.org/SDK foobar2000 SDK] and [https://visualstudio.microsoft.com Microsoft Visual Studio]. See also: [[Foobar2000:Development:Visual_Studio_Compatibility\|Visual Studio Compatibility]].

	== Packaging a component ==		== Packaging a component ==
Line 30:		Line 32:
	* [[Foobar2000:Development:Storing Configuration\|Storing Configuration]]		* [[Foobar2000:Development:Storing Configuration\|Storing Configuration]]
	* [[Foobar2000:Development:Threads\|Threads]]		* [[Foobar2000:Development:Threads\|Threads]]
			* [[Foobar2000:Development:Visual_Studio_Compatibility\|Visual Studio Compatibility]]

DEATH at 12:21, 22 June 2022

2022-06-22T12:21:28Z

@@ Line 20: / Line 20: @@
 Register a forum account and contact [https://hydrogenaud.io/index.php?action=profile;u=84 Peter] with info about your component.
 == Further reading ==
@@ Line 101: / Line 25: @@
 * [[Foobar2000:Development:Auto Pointers|Auto Pointers]]
 * [[Foobar2000:Development:Debugging|Debugging]]
 * [[Foobar2000:Development:Global Callbacks|Global Callbacks: tracking foobar2000 lifetime events]]
 * [[Foobar2000:Development:Threads|Threads]]

DEATH at 12:18, 22 June 2022

2022-06-22T12:18:17Z

@@ Line 86: / Line 86: @@
 Implementations of global callback services such as <code>playlist_callback</code>, <code>playback_callback</code> or <code>library_callback</code> must not throw unhandled exceptions; behaviors in case they do are undefined (app termination is to be expected).
 == Storing configuration ==
@@ Line 128: / Line 97: @@
 It is encouraged to create your own configuration files in foobar2000 profile for more complex data to allow easy import / export / backup.
-== Tracking foobar2000 lifetime events ==
+== Further reading ==
-See: [[Foobar2000:Development:Global Callbacks|Global Callbacks]]