summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJaromil <jaromil@dyne.org>2017-03-24 18:27:03 (GMT)
committer Jaromil <jaromil@dyne.org>2017-03-24 18:27:03 (GMT)
commit6b177c41510c1ec2b0360bd46879bcd5a1d91831 (patch)
treeda1c30987cd0d6191da9bc4c144697dcd407054e
parent79239c58e582b1cc9200901fcce0a5a616c75b7c (diff)
release documentation updatesHEADmaster
-rw-r--r--AUTHORS4
-rw-r--r--ChangeLog7
-rw-r--r--INSTALL49
-rw-r--r--INSTALL.md44
-rw-r--r--README.md (renamed from README)119
5 files changed, 87 insertions, 136 deletions
diff --git a/AUTHORS b/AUTHORS
index 4a871b3..7f64214 100644
--- a/AUTHORS
+++ b/AUTHORS
@@ -4,7 +4,9 @@ hosted by BEK - Bergen Senter for Elektronisk Kunst
Developers who contributed, in alphabetic order:
+Akito Iwakura
Albert Frisch
+Brian Matherly
Burkhard Plaum
Carlo E. Prelz
Dan Dennedy
@@ -13,6 +15,7 @@ Filippo Giunchedi
Gabriel Finch
Georg Seidel
Hedde Bosman
+IOhannes M. Zmölnig
Janne Liljeblad
Jean-Sebastien Senecal
Joshua M. Doe
@@ -23,6 +26,7 @@ Martin Bayer
Mathieu Guindon
Phillip Promesberger
Richard Spindler
+Samuel Mimram
Simon A. Eugster
Stefano Sabatini
Steinar H. Gunderson
diff --git a/ChangeLog b/ChangeLog
index 34d0137..043d182 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,12 @@
*** See also the Changes @section in include/frei0r.h or git log
+1.6.0 - 24 March 2017
+
+ This release contains new filters and some bugfixes to parameters
+ and building environment, documentation is updated accordingly.
+ New filters (2): bgsubtract0r, glitch0r
+ Updated filter (1): Distort0r now mode and velocity.
+
1.5.0 - 2 April 2016
This release fixes several major bugs in existing plugins and adds
diff --git a/INSTALL b/INSTALL
deleted file mode 100644
index 0dd4c99..0000000
--- a/INSTALL
+++ /dev/null
@@ -1,49 +0,0 @@
-Installation Instructions
-*************************
-
-Frei0r can be built using either Autoconf or CMake.
-
-The choice is open, CMake is mandatory only on Windowz.
-
-The presence of optional libraries on the system will trigger compilation
-of extra plugins. These libraries are:
-
- + [Gavl] ( required for scale0tilt and vectorscope filters )
- [Gavl]: http://gmerlin.sourceforge.net
-
- + [OpenCV] (required for facebl0r filter )
- [OpenCV]: http://opencvlibrary.sourceforge.net
-
- + [Cairo] (required for cairo- filters and mixers )
- [Cairo]: http://cairographics.org
-
-= Autoconf build
-
-./configure
-make
-
-= CMake build
-
-cmake .
-make
-
-
-= Install
-
-Default prefix is /usr/local
-Target directory is frei0r-1
-
-Hence a default install will put the plugins into /usr/local/lib/frei0r-1
-unless the prefix path is specified. Most applications will look into that
-directory on GNU/Linux, or it should be possible to configure where to
-look for frei0r plugins.
-
-When using Apple/OSX, the dlopen() mechanism (in FFMpeg for instance)
-will look for .dylib extensions and not the .so that frei0r plugins
-have by default. To fix this problem one can rename the plugins simply so:
-
-for file in /usr/local/lib/frei0r-1/*.so ; do
- cp $file "${file%.*}.dylib"
-done
-
-
diff --git a/INSTALL.md b/INSTALL.md
new file mode 100644
index 0000000..5eca51c
--- /dev/null
+++ b/INSTALL.md
@@ -0,0 +1,44 @@
+# Installation Instructions
+
+Frei0r can be built using either Autoconf or CMake.
+
+The choice is open, CMake is mandatory only on Windowz.
+
+The presence of optional libraries on the system will trigger compilation
+of extra plugins. These libraries are:
+
+ + [Gavl](http://gmerlin.sourceforge.net) required for scale0tilt and vectorscope filters
+
+ + [OpenCV](http://opencvlibrary.sourceforge.net) required for facebl0r filter
+
+ + [Cairo](http://cairographics.org) required for cairo- filters and mixers
+
+## Autoconf build
+
+```
+./configure
+make
+```
+
+## CMake build
+
+```
+cmake .
+make
+```
+
+## Proceed with install
+
+Default prefix is `/usr/local`, target directory is `frei0r-1`
+
+A default `make install` as root will put the plugins into `/usr/local/lib/frei0r-1` unless the prefix path is specified. Most applications will look into that directory on GNU/Linux, or it should be possible to configure where to look for frei0r plugins.
+
+When using Apple/OSX, the `dlopen()` mechanism (in FFMpeg for instance) will look for `.dylib` extensions and not the `.so` that frei0r plugins have by default. To fix this problem one can rename the plugins simply so:
+
+```
+for file in /usr/local/lib/frei0r-1/*.so ; do
+ cp $file "${file%.*}.dylib"
+done
+```
+
+
diff --git a/README b/README.md
index bba11a5..f2c3e90 100644
--- a/README
+++ b/README.md
@@ -1,4 +1,4 @@
-
+```
___________ ._________
\_ _____/______ ____ |__\ _ \_______
| __) \_ __ \_/ __ \| / /_\ \_ __ \
@@ -6,19 +6,14 @@
\___ / |__| \___ >__|\_____ /__|
\/ \/ \/
- Minimalistic plugin API for video effects v1.5
+```
+Minimalistic plugin API for video effects v1.6
by the Piksel Developers Union
- Updated info on http://frei0r.dyne.org
-
+ Updated info on https://frei0r.dyne.org
-Introduction
-~~~~~~~~~~~~~
-
-
-What frei0r is
-===============
+# What frei0r is
Frei0r is a minimalistic plugin API for video effects.
@@ -30,8 +25,7 @@ It's our hope that this way these simple effects can be shared between
many applications, avoiding their reimplementation by different
projects.
-What frei0r is not
-===================
+## What frei0r is not
Frei0r is not meant as a competing standard to more ambitious efforts
that try to satisfy the needs of many different applications and more
@@ -45,8 +39,7 @@ Eventually the frei0r API can be wrapped by higher level APIs
expanding its functionalities
(for instance as GStreamer, MLT, FFmpeg and others do).
-Current status
-===============
+## Current status
Developers are sporadically contributing and we are happy if more
people like to get involved, so let us know about your creations! Code
@@ -54,8 +47,7 @@ and patches are well accepted, get in touch with us on the
mailinglist (see the section Communication below).
-History
-========
+## History
Frei0r has been around since 2004, born from yearly brainstormings
held at the Piksel conference with the participation of various free
@@ -86,50 +78,31 @@ Wikipedia page about frei0r: http://en.wikipedia.org/wiki/Frei0r
[Shotcut]: https://www.shotcut.org/
-Download
-~~~~~~~~~
+# Downloads
-Source code
-============
+## Source code
Stable frei0r releases are packaged periodically and distributed on
https://files.dyne.org/frei0r
-Frei0r sourcecode is released under the terms of the GNU General
-Public License and, eventually other compatible Free Software
-licenses.
-
-The latest source for frei0r plugins can be attained using our
-revisioning system *GIT*
-
- git clone git://code.dyne.org/frei0r.git
+Frei0r sourcecode is released under the terms of the GNU General Public License and, eventually other compatible Free Software licenses.
-A repository is also maintained on GitHub:
+The latest source for frei0r plugins can be attained using git on https://github.com/dyne/frei0r
- https://github.com/dyne/frei0r
+Make sure to get in touch with our mailinglist if you like to contribute.
+## Build dependencies
-Make sure to get in touch with our mailinglist if you like to
-contribute.
+Frei0r can be built on GNU/Linux, M$/Windows and Apple/OSX platforms, possibly in even more environments like embedded devices.
-Build dependencies
--------------------
+For details see the [INSTALL](/INSTALL) file.
-Frei0r can be built on GNU/Linux, M$/Windows and Apple/OSX platforms,
-possibly in even more environments like embedded devices.
+### GNU / Linux
-For details see the INSTALL file, short and to the point.
+Binary packages are mantained on various distributions, but they may not be completely up to date with latest release.
-GNU / Linux
-============
-
-Binary packages are mantained on various distributions.
-
-For an overview see http://oswatershed.org/pkg/frei0r-plugins
-
-Apple / OSX
-============
+### Apple / OSX
MacPorts provides packages for OSX:
[MacPorts]: http://www.macports.org
@@ -142,34 +115,20 @@ directly and to include frei0r within their bundle.
-Microsoft / Windows
-====================
-
-Pre-compiled binaries are often provided by third-parties
-
-We encourage MS/Win application distributors to compile the plugins
-directly and to include frei0r within their bundle.
+### Microsoft / Windows
+Pre-compiled binaries are often provided by third-parties, but they may not to be up to date.
-Documentation
-~~~~~~~~~~~~~~
-If you are new to frei0r (but not to programming) the best thing is
-probably to have a look at the [frei0r header], which is quite simple
-and well documented, or the doxygen code documentation in doc/
+We encourage MS/Win application distributors to compile the plugins directly and to include frei0r within their bundle.
-API explanation
-================
+# Documentation
-While the main source of documentation for the frei0r API is the
-header, the sourcecode is well commented so you can study its full
-[doxyfied documentation] online.
-[doxyfied documentation]: http://frei0r.dyne.org/codedoc/html
+If you are new to frei0r (but not to programming) the best thing is probably to have a look at the [frei0r header](/include/frei0r.h), which is quite simple and well documented. The [doxyfied documentation](http://frei0r.dyne.org/codedoc/html) is also available for browsing on-line.
-C++ Filter example
-===================
+## C++ Filter example
A simple skeleton for a frei0r video filter looks like this:
@@ -217,32 +176,18 @@ A simple skeleton for a frei0r video filter looks like this:
```
-Communication
-~~~~~~~~~~~~~~
-
-You can get in touch with our developer community, send your new
-effects and share your intentions with us.
-
-We have a free mailinglist open to [subscription] and we provide
-[public archives] of the discussions there that are also searchable
-and indexed online.
+## Communication
-For bug reporting the mailinglist is preferred, but is also possible
-to use an [issue tracker].
+You can get in touch with our developer community, send your new effects and share your intentions with us.
+We have a free mailinglist open to [subscription](https://mailinglists.dyne.org/cgi-bin/mailman/listinfo/frei0r) and we provide [public archives](http://lists.dyne.org/lurker/list/frei0r.en.html) of the discussions there that are also searchable and indexed online.
-[subscribe]: https://mailinglists.dyne.org/cgi-bin/mailman/listinfo/frei0r
-[public archives]: http://lists.dyne.org/lurker/list/frei0r.en.html
-[issue tracker]: https://github.com/dyne/frei0r/issues
+For bug reporting the mailinglist is preferred, but is also possible to use an [issue tracker](https://github.com/dyne/frei0r/issues).
-Acknowledgments
-~~~~~~~~~~~~~~~~
+## Acknowledgments
-Frei0r is the result of a collective effort in coordination with
-several software developers meeting to find a common standard for
-video effect plugins to be used among their applications.
+Frei0r is the result of a collective effort in coordination with several software developers meeting to find a common standard for video effect plugins to be used among their applications.
-For a full list of contributors and the project history, see the file
-AUTHORS, the ChangeLog and the project web page http://frei0r.dyne.org
+For a full list of contributors and the project history, see the file [AUTHORS](/AUTHORS), the [ChangeLog](/ChangeLog) and the project web page: https://frei0r.dyne.org