git.sesse.net Git - movit/blob - 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. It is currently in alpha stage.
  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] and [Google Test] libraries. (The library itself
  29   depends only on the former, 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, glow, lift/gamma/gain (color correction), mirror,
  44 mix (add two inputs), overlay (the Porter-Duff “over” operation),
  45 scale (bilinear and Lanczos), sharpen (both by unsharp mask and by
  46 Wiener filters), saturation (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 (currently you need
  58 a classic OpenGL context; a GL 3.2+ core context won't do):
  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 2014, so people want to edit HD video.
  95 * It's 2014, so everybody has a GPU.
  96 * It's 2014, 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 2014
 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 will eventually provide
 103 limited support for working with interlaced video, but currently does not.
 104
 105
 106 What do you mean by “high-performance”?
 107 =======================================
 108
 109 Today, you can hardly get a _cellphone_ without a multi-core, SIMD-capable
 110 CPU, and a GPU. Yet, almost all open-source pixel processing I've seen
 111 is written using straight-up single-threaded, scalar C! Clearly there is
 112 room for improvement here, and that improvement is sorely needed.
 113 We want to edit 1080p video, not watch slideshows.
 114
 115 Movit has chosen to run all pixel processing on the GPU, using GLSL—OpenCL is
 116 way too young, and CUDA is single-vendor (and also surprisingly hard to
 117 get good performance from for anything nontrivial). While “run on the GPU”
 118 does not equal “infinite speed” (I am fairly certain that for many common
 119 filters, I can beat the Intel-based GPU in my laptop with multithreaded SSE
 120 code on the CPU—especially as moving the data to and from the GPU has a cost that is not
 121 to be taken lightly), GPU programming is probably the _simplest_ way of writing
 122 highly parallel code, and it also frees the CPU to do other things like video
 123 decoding.
 124
 125 Exactly what speeds you can expect is of course highly dependent on
 126 your GPU and the exact filter chain you are running. As a rule of thumb,
 127 you can run a reasonable filter chain (a lift/gamma/gain operation,
 128 a bit of diffusion, maybe a vignette) at 720p in around 30 fps on a two-year-old
 129 Intel laptop. If you have a somewhat newer Intel card, you can do 1080p
 130 video without much problems. And on a mid-range nVidia card of today
 131 (GTX 550 Ti), you can probably process 4K movies directly.
 132
 133
 134 What do you mean by “high-quality”?
 135 ===================================
 136
 137 Movit aims to be high-quality in two important aspects, namely _code quality_
 138 and _output quality_. (Unfortunately, documentation quality is not on the
 139 list yet. Sorry.)
 140
 141
 142 High-quality output?
 143 ====================
 144
 145 Movit works internally in linear floating-point all the way, strongly
 146 reducing interim round-off and clipping errors. Furthermore, Movit is
 147 (weakly) colorspace-aware. Why do colorspaces matter? Well, here's a video frame from a typical
 148 camera, which records in Rec. 709 (the typical HDTV color space), and here's the
 149 same frame misinterpreted as Rec. 601 (the typical SDTV color space):
 150
 151 [insert picture here]
 152
 153 The difference might be subtle, but would you like that color cast?
 154 Maybe you could correct for it manually, but what if it happened on output
 155 instead of on input? And I can promise you that once we move to more
 156 wide-gamut color spaces, like the one in Rec. 2020 (used for UHDTV), the
 157 difference will be anything but subtle. As of [why working in linear
 158 light matters](http://www.4p8.com/eric.brasseur/gamma.html),
 159 others have explained it better than I can; note also that this makes Movit
 160 future-proof when the world moves towards 10- and 12-bit color precision
 161 (although the latter requires Movit to change from 16-bit to 32-bit floating
 162 point, it is a simple switch). The extra power from the GPU makes all of this
 163 simple, so do we not need to make too many concessions for the sake of speed.
 164
 165 Movit does not currently do ICC profiles or advanced gamut mapping;
 166 if you have out-of-gamut colors, they will clip. Sorry.
 167
 168
 169 OK, and high-quality code?
 170 ==========================
 171
 172 Image processing code can be surprisingly subtle; it's easy to write
 173 code that looks right, but that makes subtle artifacts that explode
 174 when processed further in a later step. (Or code that simply never
 175 worked, just that nobody cared to look at the output when a given
 176 parameter was set. I've seen that, too.)
 177
 178 Movit tries to counteract this by three different strategies:
 179
 180 * First, _look at the output_. Does it look good? Really?
 181   Even if you zoom in on the results? Don't settle for “meh, I'm
 182   sure that's the best it can get”.
 183 * Second, _keep things simple_. Movit does not aim for including
 184   every possible video effect under the sun (there are [others out there]
 185   that want that); the [YAGNI] principle is applied quite strongly throughout
 186   the code. It's much better to write less code but actually
 187   understand what it does; whenever I can replace some magic matrix
 188   or obscure formula from the web with a clean calculation and a descriptive
 189   comment on top, it makes me a bit happier. (Most of the time,
 190   it turns out that I had used the matrix or formula in a wrong
 191   way anyway. My degree is in multimedia signal processing, but it
 192   does not mean I have a deep understanding of everything people do
 193   in graphics.)
 194 * Third, _have unit tests_. Tests are boring, but they are unforgiving
 195   (much more unforgiving than your eye), and they keep stuff from breaking
 196   afterwards. Almost every single test I wrote has uncovered bugs in Movit,
 197   so they have already paid for themselves.
 198
 199 There is, of course, always room for improvement. I'm sure you can find
 200 things that are stupid, little-thought-out, or buggy. If so, please let me
 201 know.
 202
 203
 204 What do you mean by “open-source”?
 205 ==================================
 206
 207 Movit is licensed under the [GNU GPL](http://www.gnu.org/licenses/gpl.html),
 208 either version 2 or (at your option) any later version.