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