Merge branch 'epoxy' into epoxy
[movit] / README
1 <!-- Author's note; this was intended to become a home page at some point,
2      but I'm not interested enough in grokking HTML right now, so it became
3      the README instead. Most of it should be valid Markdown. -->
4
5 Announcing Movit
6 ================
7
8 Movit is the Modern Video Toolkit, notwithstanding that anything that's
9 called “modern” usually isn't, and it's really not a toolkit.
10
11 Movit aims to be a _high-quality_, _high-performance_, _open-source_
12 library for video filters.
13
14
15 TL;DR, please give me download link and system demands
16 ======================================================
17
18 OK, you need
19
20 * A C++98 compiler. GCC will do. (I haven't tried Windows, but it
21   works fine on Linux and OS X, and Movit is not very POSIX-bound.)
22 * GNU Make.
23 * A GPU capable of running GLSL fragment shaders,
24   processing floating-point textures, and a few other things (all are
25   part of OpenGL 3.0 or newer, although most OpenGL 2.0 cards also
26   have what's needed through extensions). If your machine is less than five
27   years old _and you have the appropriate drivers_, you're home free.
28 * The [Eigen 3], [FFTW3] and [Google Test] libraries. (The library itself
29   does not depend on the latter, but you probably want to run the unit tests.)
30 * The [epoxy] library, for dealing with OpenGL extensions on various
31   platforms.
32
33 Movit has been tested with Intel GPUs with the Mesa drivers
34 (you'll probably need at least Mesa 8.0), Radeon 3850 and GeForce GTX 550
35 on Linux with the manufacturer's drivers, and with GeForce 8800 on OS X.
36 Again, most likely, GPU compatibility shouldn't be a big issue. See below
37 for performance estimates.
38
39
40 Still TL;DR, please give me the list of filters
41 ===============================================
42
43 Blur, diffusion, FFT-based convolution, glow, lift/gamma/gain (color
44 correction), mirror, mix (add two inputs), luma mix (use a map to wipe between
45 two inputs), overlay (the Porter-Duff “over” operation), scale (bilinear and
46 Lanczos), sharpen (both by unsharp mask and by Wiener filters), saturation
47 (or desaturation), vignette, and white balance.
48
49 Yes, that's a short list. But they all look great, are fast and don't give
50 you any nasty surprises. (I'd love to include denoise, deinterlace and
51 framerate up-/downconversion to the list, but doing them well are
52 all research-grade problems, and Movit is currently not there.)
53
54
55 TL;DR, but I am interested in a programming example instead
56 ===========================================================
57
58 Assuming you have an OpenGL context already set up (currently you need
59 a classic OpenGL context; a GL 3.2+ core context won't do):
60
61 <code>
62   using namespace movit;
63   EffectChain chain(1280, 720);
64
65   ImageFormat inout_format;
66   inout_format.color_space = COLORSPACE_sRGB;
67   inout_format.gamma_curve = GAMMA_sRGB;
68   FlatInput *input = new FlatInput(inout_format, FORMAT_BGRA_POSTMULTIPLIED_ALPHA, GL_UNSIGNED_BYTE, 1280, 720));
69   chain.add_input(input);
70
71   Effect *saturation_effect = chain.add_effect(new SaturationEffect());
72   saturation_effect->set_float("saturation", 0.7f);
73
74   Effect *lift_gamma_gain_effect = chain.add_effect(new LiftGammaGainEffect());
75   const float gain[] = { 0.8f, 1.0f, 1.0f };
76   lift_gamma_gain_effect->set_vec3("gain", &gain);
77
78   chain.add_output(inout_format, OUTPUT_ALPHA_FORMAT_POSTMULTIPLIED);
79   chain.finalize();
80
81   for ( ;; ) {
82     // Do whatever you need here to decode the next frame into <pixels>.
83     input->set_pixel_data(pixels);
84     chain.render_to_screen();
85   }
86 </code>
87
88
89 OK, I can read a bit. What do you mean by “modern”?
90 ===================================================
91
92 Backwards compatibility is fine and all, but sometimes we can do better
93 by observing that the world has moved on. In particular:
94
95 * It's 2014, so people want to edit HD video.
96 * It's 2014, so everybody has a GPU.
97 * It's 2014, so everybody has a working C++ compiler.
98   (Even Microsoft fixed theirs around 2003!)
99
100 While from a programming standpoint I'd love to say that it's 2014
101 and interlacing does no longer exist, but that's not true (and interlacing,
102 hated as it might be, is actually a useful and underrated technique for
103 bandwidth reduction in broadcast video). Movit will eventually provide
104 limited support for working with interlaced video, but currently does not.
105
106
107 What do you mean by “high-performance”?
108 =======================================
109
110 Today, you can hardly get a _cellphone_ without a multi-core, SIMD-capable
111 CPU, and a GPU. Yet, almost all open-source pixel processing I've seen
112 is written using straight-up single-threaded, scalar C! Clearly there is
113 room for improvement here, and that improvement is sorely needed.
114 We want to edit 1080p video, not watch slideshows.
115
116 Movit has chosen to run all pixel processing on the GPU, using GLSL—OpenCL is
117 way too young, and CUDA is single-vendor (and also surprisingly hard to
118 get good performance from for anything nontrivial). While “run on the GPU”
119 does not equal “infinite speed” (I am fairly certain that for many common
120 filters, I can beat the Intel-based GPU in my laptop with multithreaded SSE
121 code on the CPU—especially as moving the data to and from the GPU has a cost that is not
122 to be taken lightly), GPU programming is probably the _simplest_ way of writing
123 highly parallel code, and it also frees the CPU to do other things like video
124 decoding.
125
126 Exactly what speeds you can expect is of course highly dependent on
127 your GPU and the exact filter chain you are running. As a rule of thumb,
128 you can run a reasonable filter chain (a lift/gamma/gain operation,
129 a bit of diffusion, maybe a vignette) at 720p in around 30 fps on a two-year-old
130 Intel laptop. If you have a somewhat newer Intel card, you can do 1080p
131 video without much problems. And on a mid-range nVidia card of today
132 (GTX 550 Ti), you can probably process 4K movies directly.
133
134
135 What do you mean by “high-quality”?
136 ===================================
137
138 Movit aims to be high-quality in two important aspects, namely _code quality_
139 and _output quality_. (Unfortunately, documentation quality is not on the
140 list yet. Sorry.)
141
142
143 High-quality output?
144 ====================
145
146 Movit works internally in linear floating-point all the way, strongly
147 reducing interim round-off and clipping errors. Furthermore, Movit is
148 (weakly) colorspace-aware. Why do colorspaces matter? Well, here's a video frame from a typical
149 camera, which records in Rec. 709 (the typical HDTV color space), and here's the 
150 same frame misinterpreted as Rec. 601 (the typical SDTV color space):
151
152 [insert picture here]
153
154 The difference might be subtle, but would you like that color cast?
155 Maybe you could correct for it manually, but what if it happened on output
156 instead of on input? And I can promise you that once we move to more
157 wide-gamut color spaces, like the one in Rec. 2020 (used for UHDTV), the
158 difference will be anything but subtle. As of [why working in linear
159 light matters](http://www.4p8.com/eric.brasseur/gamma.html),
160 others have explained it better than I can; note also that this makes Movit
161 future-proof when the world moves towards 10- and 12-bit color precision
162 (although the latter requires Movit to change from 16-bit to 32-bit floating
163 point, it is a simple switch). The extra power from the GPU makes all of this
164 simple, so do we not need to make too many concessions for the sake of speed.
165
166 Movit does not currently do ICC profiles or advanced gamut mapping;
167 if you have out-of-gamut colors, they will clip. Sorry.
168
169
170 OK, and high-quality code?
171 ==========================
172
173 Image processing code can be surprisingly subtle; it's easy to write
174 code that looks right, but that makes subtle artifacts that explode
175 when processed further in a later step. (Or code that simply never
176 worked, just that nobody cared to look at the output when a given
177 parameter was set. I've seen that, too.)
178
179 Movit tries to counteract this by three different strategies:
180
181 * First, _look at the output_. Does it look good? Really?
182   Even if you zoom in on the results? Don't settle for “meh, I'm 
183   sure that's the best it can get”.
184 * Second, _keep things simple_. Movit does not aim for including
185   every possible video effect under the sun (there are [others out there]
186   that want that); the [YAGNI] principle is applied quite strongly throughout
187   the code. It's much better to write less code but actually
188   understand what it does; whenever I can replace some magic matrix
189   or obscure formula from the web with a clean calculation and a descriptive
190   comment on top, it makes me a bit happier. (Most of the time,
191   it turns out that I had used the matrix or formula in a wrong
192   way anyway. My degree is in multimedia signal processing, but it
193   does not mean I have a deep understanding of everything people do
194   in graphics.)
195 * Third, _have unit tests_. Tests are boring, but they are unforgiving
196   (much more unforgiving than your eye), and they keep stuff from breaking
197   afterwards. Almost every single test I wrote has uncovered bugs in Movit,
198   so they have already paid for themselves.
199
200 There is, of course, always room for improvement. I'm sure you can find
201 things that are stupid, little-thought-out, or buggy. If so, please let me
202 know.
203
204
205 What do you mean by “open-source”?
206 ==================================
207
208 Movit is licensed under the [GNU GPL](http://www.gnu.org/licenses/gpl.html),
209 either version 2 or (at your option) any later version.