README.dev 1.3 KB

1234567891011121314151617181920212223242526272829303132333435363738
  1. 1) API
  2. ------
  3. * libavcodec is the library containing the codecs (both encoding and
  4. decoding). See libavcodec/apiexample.c to see how to use it.
  5. * libav is the library containing the file formats handling (mux and
  6. demux code for several formats). (no example yet, the API is likely
  7. to evolve).
  8. 2) Integrating libavXXX in your GPL'ed program
  9. ----------------------------------------------
  10. You can integrate all the source code of the libraries to link them
  11. statically to avoid any version problem. All you need is to provide a
  12. 'config.mak' and a 'config.h' in the parent directory. See the defines
  13. generated by ./configure to understand what is needed.
  14. 3) Coding Rules
  15. ---------------
  16. ffmpeg is programmed in ANSI C language. GCC extension are
  17. tolerated. TAB size is 4. The identation is the one specified by
  18. 'indent -i4 -kr'.
  19. Main priority in ffmpeg is simplicity and small code size (=less
  20. bugs).
  21. 4) Submitting patches
  22. ---------------------
  23. When you submit your patch, try to send a unified diff (diff '-u'
  24. option). I cannot read other diffs :-)
  25. Except if your patch is really big and adds an important feature, by
  26. submitting it to me, you accept implicitely to put it under my
  27. copyright. I prefer to do this to avoid potential problems if
  28. licensing of ffmpeg changes.