Skip to content

Commit

Permalink
Add blan example named "Template"
Browse files Browse the repository at this point in the history
  • Loading branch information
Guillaume Piolat committed Nov 20, 2024
1 parent 00b9c7e commit 32b5415
Show file tree
Hide file tree
Showing 14 changed files with 344 additions and 0 deletions.
65 changes: 65 additions & 0 deletions examples/template/dub.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
{
"name": "template",

"license": "public domain",
"copyright": "none",

"importPaths": [ "source" ],
"sourcePaths": [ "source" ],
"stringImportPaths": [ "gfx", "fonts", "." ],

"dflags-linux-dmd": [ "-defaultlib=libphobos2.a" ],
"dflags-osx-ldc": [ "-static" ],
"dflags-linux-ldc": [ "-link-defaultlib-shared=false" ],
"dflags-linux-x86_64-ldc": [ "-fvisibility=hidden" ],
"dflags-windows-ldc": [ "-mscrtlib=libcmt",
"-fvisibility=hidden",
"-link-defaultlib-shared=false" ],

"dependencies":
{
"dplug:gui": "~>14.7",
"dplug:flat-widgets": "~>14.7",
"dplug:vst3": "~>14.7",
"dplug:au": "~>14.7",
"dplug:clap": "~>14.7"
},

"targetType": "dynamicLibrary",

"configurations": [
{
"name": "CLAP",
"versions": [ "CLAP" ],
"lflags-osx-ldc": [
"-exported_symbols_list",
"$PACKAGE_DIR/source/module-clap.lst",
"-dead_strip"
],
"lflags-linux-ldc": [
"--version-script=$PACKAGE_DIR/source/module-clap.ver"
]
},
{
"name": "VST3",
"versions": [ "VST3" ],
"lflags-osx-ldc": [
"-exported_symbols_list",
"$PACKAGE_DIR/source/module-vst3.lst",
"-dead_strip"
],
"lflags-linux-ldc": [
"--version-script=$PACKAGE_DIR/source/module-vst3.ver"
]
},
{
"name": "AU",
"versions": [ "AU" ],
"lflags-osx-ldc": [
"-exported_symbols_list",
"$PACKAGE_DIR/source/module-au.lst",
"-dead_strip"
]
}
]
}
124 changes: 124 additions & 0 deletions examples/template/fonts/COPYRIGHT.TXT
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
Bitstream Vera Fonts Copyright

The fonts have a generous copyright, allowing derivative works (as
long as "Bitstream" or "Vera" are not in the names), and full
redistribution (so long as they are not *sold* by themselves). They
can be be bundled, redistributed and sold with any software.

The fonts are distributed under the following copyright:

Copyright
=========

Copyright (c) 2003 by Bitstream, Inc. All Rights Reserved. Bitstream
Vera is a trademark of Bitstream, Inc.

Permission is hereby granted, free of charge, to any person obtaining
a copy of the fonts accompanying this license ("Fonts") and associated
documentation files (the "Font Software"), to reproduce and distribute
the Font Software, including without limitation the rights to use,
copy, merge, publish, distribute, and/or sell copies of the Font
Software, and to permit persons to whom the Font Software is furnished
to do so, subject to the following conditions:

The above copyright and trademark notices and this permission notice
shall be included in all copies of one or more of the Font Software
typefaces.

The Font Software may be modified, altered, or added to, and in
particular the designs of glyphs or characters in the Fonts may be
modified and additional glyphs or characters may be added to the
Fonts, only if the fonts are renamed to names not containing either
the words "Bitstream" or the word "Vera".

This License becomes null and void to the extent applicable to Fonts
or Font Software that has been modified and is distributed under the
"Bitstream Vera" names.

The Font Software may be sold as part of a larger software package but
no copy of one or more of the Font Software typefaces may be sold by
itself.

THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL
BITSTREAM OR THE GNOME FOUNDATION BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL,
OR CONSEQUENTIAL DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF THE USE OR INABILITY TO USE THE FONT
SOFTWARE OR FROM OTHER DEALINGS IN THE FONT SOFTWARE.

Except as contained in this notice, the names of Gnome, the Gnome
Foundation, and Bitstream Inc., shall not be used in advertising or
otherwise to promote the sale, use or other dealings in this Font
Software without prior written authorization from the Gnome Foundation
or Bitstream Inc., respectively. For further information, contact:
fonts at gnome dot org.

Copyright FAQ
=============

1. I don't understand the resale restriction... What gives?

Bitstream is giving away these fonts, but wishes to ensure its
competitors can't just drop the fonts as is into a font sale system
and sell them as is. It seems fair that if Bitstream can't make money
from the Bitstream Vera fonts, their competitors should not be able to
do so either. You can sell the fonts as part of any software package,
however.

2. I want to package these fonts separately for distribution and
sale as part of a larger software package or system. Can I do so?

Yes. A RPM or Debian package is a "larger software package" to begin
with, and you aren't selling them independently by themselves.
See 1. above.

3. Are derivative works allowed?
Yes!

4. Can I change or add to the font(s)?
Yes, but you must change the name(s) of the font(s).

5. Under what terms are derivative works allowed?

You must change the name(s) of the fonts. This is to ensure the
quality of the fonts, both to protect Bitstream and Gnome. We want to
ensure that if an application has opened a font specifically of these
names, it gets what it expects (though of course, using fontconfig,
substitutions could still could have occurred during font
opening). You must include the Bitstream copyright. Additional
copyrights can be added, as per copyright law. Happy Font Hacking!

6. If I have improvements for Bitstream Vera, is it possible they might get
adopted in future versions?

Yes. The contract between the Gnome Foundation and Bitstream has
provisions for working with Bitstream to ensure quality additions to
the Bitstream Vera font family. Please contact us if you have such
additions. Note, that in general, we will want such additions for the
entire family, not just a single font, and that you'll have to keep
both Gnome and Jim Lyles, Vera's designer, happy! To make sense to add
glyphs to the font, they must be stylistically in keeping with Vera's
design. Vera cannot become a "ransom note" font. Jim Lyles will be
providing a document describing the design elements used in Vera, as a
guide and aid for people interested in contributing to Vera.

7. I want to sell a software package that uses these fonts: Can I do so?

Sure. Bundle the fonts with your software and sell your software
with the fonts. That is the intent of the copyright.

8. If applications have built the names "Bitstream Vera" into them,
can I override this somehow to use fonts of my choosing?

This depends on exact details of the software. Most open source
systems and software (e.g., Gnome, KDE, etc.) are now converting to
use fontconfig (see www.fontconfig.org) to handle font configuration,
selection and substitution; it has provisions for overriding font
names and subsituting alternatives. An example is provided by the
supplied local.conf file, which chooses the family Bitstream Vera for
"sans", "serif" and "monospace". Other software (e.g., the XFree86
core server) has other mechanisms for font substitution.

Binary file added examples/template/fonts/VeraBd.ttf
Binary file not shown.
Binary file added examples/template/gfx/blank.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 13 additions & 0 deletions examples/template/plugin.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"pluginName": "Template",
"publicVersion": "1.0.0",
"pluginUniqueID": "WiTe",
"pluginHomepage": "https://www.wittyaudio.com/Template",
"hasGUI": true,
"category": "effectOther",

"vendorName": "Witty Audio",
"vendorUniqueID": "Wity",
"vendorSupportEmail": "[email protected]",
"CFBundleIdentifierPrefix": "com.wittyaudio"
}
43 changes: 43 additions & 0 deletions examples/template/source/gui.d
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
module gui;

import dplug.gui;
import dplug.flatwidgets;
import dplug.client;

import main;

class TemplateGUI : FlatBackgroundGUI!("blank.png")
{
public:
nothrow:
@nogc:

MyClient _client;

this(MyClient client)
{
_client = client;
super(585, 800);
setUpdateMargin(0);

// ...
// Add widgets here with `addChild`
// ...

}

override void reflow()
{
super.reflow();

// ...
// Set position of every widget here
// ...
}

private:

// ...
// Child widgets go here
// ...
}
77 changes: 77 additions & 0 deletions examples/template/source/main.d
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
module main;

import dplug.core, dplug.client;
import gui;

mixin(pluginEntryPoints!MyClient);

final class MyClient : Client
{
public:
nothrow:
@nogc:

this()
{
}

~this()
{
}

override Parameter[] buildParameters()
{
auto params = makeVec!Parameter();

// ...
// Add parameters here
// ...

return params.releaseData();
}

override void reset(double sampleRate,
int maxFrames,
int numInputs,
int numOutputs)
{
// ...
// Add DSP initialization here
// ...
}

override void processAudio(const(float*)[] inputs,
float*[]outputs,
int frames,
TimeInfo info)
{

// ...
// Add signal processing here (DSP)
// ...

// Bypass
outputs[0][0..frames] = inputs[0][0..frames];
outputs[1][0..frames] = inputs[1][0..frames];
}

override PluginInfo buildPluginInfo()
{
// IMPORTANT change the values in plugin.json
static immutable info = parsePluginInfo(import("plugin.json"));
return info;
}

override IGraphics createGraphics()
{
return mallocNew!TemplateGUI(this);
}

override LegalIO[] buildLegalIO()
{
auto io = makeVec!LegalIO();
io ~= LegalIO(2, 2);
return io.releaseData();
}
}

2 changes: 2 additions & 0 deletions examples/template/source/module-au.lst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
_dplugAUEntryPoint
_dplugAUComponentFactoryFunction
1 change: 1 addition & 0 deletions examples/template/source/module-clap.lst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
_clap_entry
4 changes: 4 additions & 0 deletions examples/template/source/module-clap.ver
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
CLAPABI_1.0 {
global: clap_entry;
local: *;
};
2 changes: 2 additions & 0 deletions examples/template/source/module-vst2.lst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
_VSTPluginMain
_main_macho
4 changes: 4 additions & 0 deletions examples/template/source/module-vst2.ver
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
VSTABI_1.0 {
global: VSTPluginMain; main;
local: *;
};
5 changes: 5 additions & 0 deletions examples/template/source/module-vst3.lst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
_InitDll
_ExitDll
_GetPluginFactory
_bundleEntry
_bundleExit
4 changes: 4 additions & 0 deletions examples/template/source/module-vst3.ver
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
VST3ABI_1.0 {
global: GetPluginFactory; ModuleEntry; ModuleExit;
local: *;
};

0 comments on commit 32b5415

Please sign in to comment.