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