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 libswfdec-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 The library is still in heavy development. The intended audience are developers
  11 or people using it for pretested Flash animations (think embedded here). If you
  12 use it on unknown content, expect it to have issues and don't be surprised if
  13 it crashes. If you encounter such a crash however, make sure to file a bug
  14 immediately.
  15
  16 Swfdec contains some applications for testing and debugging the library. These
  17 are available in the player/ and test/ directory. They are not installed. Most
  18 of them require the libswfdec-gtk library.
  19
  20 The test/ directory contains subdirectories that run automated tests with the
  21 provided SWF files in the directory. See the README files in those directories
  22 for details on how to run or add these tests.
  23
  24 If you want to playing Flash files in your web browser, you need a browser
  25 plugin additional to this library. The plugins are shipped in separate
  26 packages, like swfdec-mozilla. You can get them at the same location as swfdec.
  27
  28
  29 Locations:
  30
  31    The Swfdec homepage is at http://swfdec.freedesktop.org
  32    A bugtracker can be found at https://bugzilla.freedesktop.org
  33    A mailing list is available at swfdec@lists.freedesktop.org
  34      For information about subscribing or unsubscribing from this list see
  35      http://lists.freedesktop.org/mailman/listinfo/swfdec
  36    The development source code is kept in git. The following command gets it:
  37      git clone git://anongit.freedesktop.org/git/swfdec
  38
  39
  40 Maintainers:
  41
  42    see the file MAINTAINERS
  43
  44
  45 Limitations:
  46
  47  - A few rare object types are not handled at all. They are ignored.
  48
  49  - SWF files that use Flash generally heavily depend on ActionScript features.
  50    Support for ActionScript is currently incomplete. Unsupported scripts are
  51    skipped.
  52
  53  - If any known unsupported behaviour is encountered, Swfdec will print a
  54    notice to stderr and try to interpret the file nonetheless. If you
  55    encounter a file with only some unsupported things, it may be a good idea
  56    to open a feature request bug and provide the file. The developers are
  57    always interested in files that motivate them to do little steps.
  58
  59
  60 Dependencies:
  61
  62   cairo (>= 1.2.0 - >= 1.4.0 recommended) with png support enabled
  63   glib (>= 2.10.0)
  64   liboil (>= 0.3.6)
  65   Pangocairo (>= 1.16.0) - this is provided by Pango
  66   zlib (>= 1.1.4)
  67
  68   FFMpeg (current SVN - optional, required for various audio and video formats)
  69   GStreamer (>= 0.10.11 - optional, required for various audio and video formats)
  70   MAD (>= 0.15.1b - optional, required for MP3 audio format support)
  71
  72   GTK+ (>= 2.8.0 - used by libswfdec-gtk)
  73   ALSA (>= 1.0 - used by libswfdec-gtk)
  74
  75