/usr/share/frei0r/html/index.html is in frei0r-plugins-doc 1.6.1-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>frei0r: frei0r - a minimalistic plugin API for video effects</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">frei0r
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('index.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">frei0r - a minimalistic plugin API for video effects </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><h1><a class="anchor" id="sec_intro"></a>
Introduction</h1>
<p>This is frei0r - a minimalistic plugin API for video effects.</p>
<p>The main emphasis is on simplicity - there are many different applications that use video effects, and they all have different requirements regarding their internal plugin API. And that's why frei0r does not try to be a one-in-all general video plugin API, but instead an API for the most common video effects: simple filters, sources and mixers that can be controlled by parameters.</p>
<p>It's our hope that this way these simple effects can be shared between many applications, avoiding their reimplementation by different projects.</p>
<p>On the other hand, this is not meant as a competing standard to more ambitious efforts that try to satisfy the needs of many different applications and more complex effects.</p>
<h1><a class="anchor" id="sec_overview"></a>
Overview</h1>
<p>If you are new to frei0r, the best thing is probably to have a look at the <a href="frei0r_8h-source.html">frei0r header</a>, which is quite simple.</p>
<p>After that, you might want to look at the <a href="frei0r_8h.html">frei0r functions</a> in more detail.</p>
<p>When developing a new frei0r effect, you have to choose</p><ul>
<li>which effect type to use (<a class="el" href="group___p_l_u_g_i_n___t_y_p_e.html">Type of the Plugin</a>),</li>
<li>which color model to use (<a class="el" href="group___c_o_l_o_r___m_o_d_e_l.html">Color Models</a>), and</li>
<li>which parameter types (<a class="el" href="group___p_a_r_a_m___t_y_p_e.html">Parameter Types</a>) your effect will support.</li>
</ul>
<p>To round things up, you should decide whether your effect should have an associated icon (<a class="el" href="group__icons.html">Icons for frei0r effects</a>), and where it will be installed (<a class="el" href="group__pluglocations.html">Plugin Locations</a>).</p>
<h1><a class="anchor" id="sec_changes"></a>
Changes</h1>
<h2><a class="anchor" id="sec_changes_1_1_1_2"></a>
From frei0r 1.1 to frei0r 1.2</h2>
<ul>
<li>make <vendor> in plugin path optional</li>
<li>added section on FREI0R_PATH environment variable</li>
<li>added requirement to initialize all parameters in <a class="el" href="frei0r_8h.html#ac7765bbd77add97b318c09e2aba0724b">f0r_construct()</a></li>
</ul>
<h2><a class="anchor" id="sec_changes_1_0_1_1"></a>
From frei0r 1.0 to frei0r 1.1</h2>
<ul>
<li>added specifications for plugin locations</li>
<li>added specifications for frei0r icons</li>
<li>added RGBA8888 color model</li>
<li>added packed32 color model</li>
<li>added better specification of color models</li>
<li>added string type</li>
<li>added bounds to resolution (8 <= width, height <= 2048)</li>
<li>width and height must be an integer multiple of 8</li>
<li>frame data must be 16 byte aligned</li>
<li>improved update specification (must not change parameters, must restore fpu state)</li>
<li>added note for applications to ignore effects with unknown fields</li>
<li>added new plugin types mixer2 and mixer3</li>
<li>added section about <a class="el" href="group__concurrency.html">Concurrency</a> </li>
</ul>
</div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
</div>
</body>
</html>
|