79a63d9b0d78a8ee066306392b9beeb40eef23a3
[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++11 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 OpenGL 3.0 or newer. GLES3 (for mobile devices)
24   will also work.
25 * The [Eigen 3], [FFTW3] and [Google Test] libraries. (The library itself
26   does not depend on the latter, but you probably want to run the unit tests.)
27   If you also have the Google microbenchmark library, you can get some
28   benchmarks as well.
29 * The [epoxy] 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, white balance, and a deinterlacer (YADIF).
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 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 (either a classic OpenGL
58 context, a GL 3.x forward-compatible or core context, or a GLES3 context):
59
60 <code>
61   using namespace movit;
62   EffectChain chain(1280, 720);
63
64   ImageFormat inout_format;
65   inout_format.color_space = COLORSPACE_sRGB;
66   inout_format.gamma_curve = GAMMA_sRGB;
67   FlatInput *input = new FlatInput(inout_format, FORMAT_BGRA_POSTMULTIPLIED_ALPHA, GL_UNSIGNED_BYTE, 1280, 720));
68   chain.add_input(input);
69
70   Effect *saturation_effect = chain.add_effect(new SaturationEffect());
71   saturation_effect->set_float("saturation", 0.7f);
72
73   Effect *lift_gamma_gain_effect = chain.add_effect(new LiftGammaGainEffect());
74   const float gain[] = { 0.8f, 1.0f, 1.0f };
75   lift_gamma_gain_effect->set_vec3("gain", &gain);
76
77   chain.add_output(inout_format, OUTPUT_ALPHA_FORMAT_POSTMULTIPLIED);
78   chain.finalize();
79
80   for ( ;; ) {
81     // Do whatever you need here to decode the next frame into <pixels>.
82     input->set_pixel_data(pixels);
83     chain.render_to_screen();
84   }
85 </code>
86
87
88 OK, I can read a bit. What do you mean by “modern”?
89 ===================================================
90
91 Backwards compatibility is fine and all, but sometimes we can do better
92 by observing that the world has moved on. In particular:
93
94 * It's 2018, so people want to edit HD video.
95 * It's 2018, so everybody has a GPU.
96 * It's 2018, so everybody has a working C++ compiler.
97   (Even Microsoft fixed theirs around 2003!)
98
99 While from a programming standpoint I'd love to say that it's 2018
100 and interlacing does no longer exist, but that's not true (and interlacing,
101 hated as it might be, is actually a useful and underrated technique for
102 bandwidth reduction in broadcast video). Movit may eventually provide
103 limited support for working with interlaced video; it has a deinterlacer,
104 but cannot currently process video in interlaced form.
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, mostly using GLSL
117 fragment shaders. While “run on the GPU” does not equal “infinite speed”,
118 GPU programming is probably the _simplest_ way of writing highly parallel code,
119 and it also frees the CPU to do other things like video decoding.
120
121 Although compute shaders are supported, and can be used or speedups if
122 available (currently, only the deinterlacer runs as a compute shader), it is
123 surprisingly hard to get good performance for compute shaders for anything
124 nontrivial. This is also one of the primary reasons why Movit uses GLSL and
125 not any of the major GPU compute frameworks (CUDA and OpenCL), although it
126 is also important that it is widely supported (unlike CUDA) and driver quality
127 general is fairly good (unlike OpenCL).
128
129 Exactly what speeds you can expect is of course highly dependent on
130 your GPU and the exact filter chain you are running. As a rule of thumb,
131 you can run a reasonable filter chain (a lift/gamma/gain operation,
132 a bit of diffusion, maybe a vignette) at 720p in around 30 fps on a four-year-old
133 Intel laptop. If you have a somewhat newer Intel card, you can do 1080p
134 video without much problems. And on a low-range nVidia card of today
135 (GTX 550 Ti), you can probably process 4K movies directly.
136
137
138 What do you mean by “high-quality”?
139 ===================================
140
141 Movit aims to be high-quality in two important aspects, namely _code quality_
142 and _output quality_. (Unfortunately, documentation quality is not on the
143 list yet. Sorry.)
144
145
146 High-quality output?
147 ====================
148
149 Movit works internally in linear floating-point all the way, strongly
150 reducing interim round-off and clipping errors. Furthermore, Movit is
151 (weakly) colorspace-aware. Why do colorspaces matter? Well, here's a video frame from a typical
152 camera, which records in Rec. 709 (the typical HDTV color space), and here's the 
153 same frame misinterpreted as Rec. 601 (the typical SDTV color space):
154
155 [insert picture here]
156
157 The difference might be subtle, but would you like that color cast?
158 Maybe you could correct for it manually, but what if it happened on output
159 instead of on input? And I can promise you that once we move to more
160 wide-gamut color spaces, like the one in Rec. 2020 (used for UHDTV), the
161 difference will be anything but subtle. As of [why working in linear
162 light matters](http://www.4p8.com/eric.brasseur/gamma.html),
163 others have explained it better than I can; note also that this makes Movit
164 future-proof when the world moves towards 10- and 12-bit color precision
165 (although the latter requires Movit to change from 16-bit to 32-bit floating
166 point, it is a simple switch). The extra power from the GPU makes all of this
167 simple, so do we not need to make too many concessions for the sake of speed.
168
169 Movit does not currently do ICC profiles or advanced gamut mapping;
170 if you have out-of-gamut colors, they will clip. Sorry.
171
172
173 OK, and high-quality code?
174 ==========================
175
176 Image processing code can be surprisingly subtle; it's easy to write
177 code that looks right, but that makes subtle artifacts that explode
178 when processed further in a later step. (Or code that simply never
179 worked, just that nobody cared to look at the output when a given
180 parameter was set. I've seen that, too.)
181
182 Movit tries to counteract this by three different strategies:
183
184 * First, _look at the output_. Does it look good? Really?
185   Even if you zoom in on the results? Don't settle for “meh, I'm 
186   sure that's the best it can get”.
187 * Second, _keep things simple_. Movit does not aim for including
188   every possible video effect under the sun (there are [others out there]
189   that want that); the [YAGNI] principle is applied quite strongly throughout
190   the code. It's much better to write less code but actually
191   understand what it does; whenever I can replace some magic matrix
192   or obscure formula from the web with a clean calculation and a descriptive
193   comment on top, it makes me a bit happier. (Most of the time,
194   it turns out that I had used the matrix or formula in a wrong
195   way anyway. My degree is in multimedia signal processing, but it
196   does not mean I have a deep understanding of everything people do
197   in graphics.)
198 * Third, _have unit tests_. Tests are boring, but they are unforgiving
199   (much more unforgiving than your eye), and they keep stuff from breaking
200   afterwards. Almost every single test I wrote has uncovered bugs in Movit,
201   so they have already paid for themselves.
202
203 There is, of course, always room for improvement. I'm sure you can find
204 things that are stupid, little-thought-out, or buggy. If so, please let me
205 know.
206
207
208 What do you mean by “open-source”?
209 ==================================
210
211 Movit is licensed under the [GNU GPL](http://www.gnu.org/licenses/gpl.html),
212 either version 2 or (at your option) any later version. You can find the full
213 text of the license in the COPYING file, included with Movit.