README

   1
   2 Swfdec is a decoder/renderer for Macromedia Flash animations. The decoding and
   3 rendering engine is provided in a library that can be used by other
   4 applications.
   5
   6 An additional library named swfdec-gtk is provided for easy integration of
   7 Swfdec into Gtk applications. This library is what developers most likely want
   8 to target their applications at. Building this library can be disabled.
   9
  10 Swfdec is intended to be used as a replacement for the default Flash player.
  11 While it is not yet a 100% complete replacement, a big focus is on stability
  12 and security. So it is deemed to be suitable for use in production
  13 applications.
  14
  15 The library however is still in heavy development. Because of that, the
  16 Programming interface will change between major versions. No guarantees are
  17 made about the API. However, during stable release cycles, the API and ABI are
  18 guaranteed to stay stable.
  19
  20 Swfdec contains some applications for testing and debugging the library. These
  21 are available in the player/, test/ and tools/ directories. They are not
  22 installed. Most of them require the swfdec-gtk library.
  23
  24 The test/ directory contains subdirectories that run automated tests with the
  25 provided SWF files in the directory. See the README files in those directories
  26 for details on how to run or add these tests.
  27
  28 If you want to playing Flash files in your web browser, you need a browser
  29 plugin additional to this library. The plugins are shipped in separate
  30 packages, like swfdec-mozilla. You can get them at the same location as swfdec.
  31
  32
  33 Locations:
  34
  35    The Swfdec homepage is at http://swfdec.freedesktop.org
  36    A bugtracker can be found at https://bugzilla.freedesktop.org
  37    A mailing list is available at swfdec@lists.freedesktop.org
  38      For information about subscribing or unsubscribing from this list see
  39      http://lists.freedesktop.org/mailman/listinfo/swfdec
  40    The development source code is kept in git. The following command gets it:
  41      git clone git://anongit.freedesktop.org/git/swfdec
  42
  43
  44 Maintainers:
  45
  46    see the file MAINTAINERS
  47
  48
  49 Limitations:
  50
  51  - A few rare object types are not handled at all. They are ignored.
  52
  53  - SWF files that use Flash generally heavily depend on ActionScript.
  54    Support for ActionScript is currently incomplete. Unsupported functions in
  55    scripts are skipped.
  56
  57  - If any known unsupported behaviour is encountered, Swfdec will print a
  58    notice to stderr and try to interpret the file nonetheless. If you
  59    encounter a file with only some unsupported things, it may be a good idea
  60    to open a feature request bug and provide the file. The developers are
  61    always interested in files that motivate them to do little steps.
  62
  63
  64 Dependencies:
  65
  66   cairo (>= 1.2.0 - >= 1.8.0 recommended) with png support enabled
  67   glib (>= 2.16.0)
  68   liboil (>= 0.3.6)
  69   Pangocairo (>= 1.16.0) - this is provided by Pango
  70   zlib (>= 1.1.4)
  71
  72   GStreamer (>= 0.10.15 - optional, required for various audio and video formats)
  73
  74   GTK+ (>= 2.8.0 - used by swfdec-gtk)
  75   libsoup (>= 2.4.0 - used by swfdec-gtk)
  76   ALSA (>= 1.0 - optional, required for sound output by swfdec-gtk)
  77
  78