annotate PROGRAMMING_NOTES @ 12903:2bb4dc533a31

[gaim-migrate @ 15256] redpen686 posted modified sounds to gaim-devel: "The tones were sampled at 44.1 KHz (with a range of up to 22.05 KHz), which is fine, but since the tones are only up to ~3 to 4 KHz, a lot of space could be saved by downsampling. I went to 11,025 Hz, since it is already enough for these frequencies, and it's also the lowest common denominator for soundcards (rather than 8 or 16 KHz, for example). The 'alert' sound needed a lowpass filter, but only because of the high-pitched attack, which people won't notice anyway. All are still 16-bit, and in stereo (except for the 'alert' sound, which didn't need it), and so should sound virtually identical." These are significantly smaller files and I didn't notice a difference in the sound (of course, my speakers suck). They're also louder, which is good. I'm committing these so people can try them out. committer: Tailor Script <[e-mail]>

Notes on keeping GAIM OS independant
------------------------------------

General
-------
- Use G_DIR_SEPARATOR_S and G_DIR_SEPARATOR for paths

- Use g_getenv, g_snprintf, g_vsnprintf

- Use gaim_home_dir instead of g_get_home_dir or g_getenv("HOME")

- Make sure when including win32dep.h that it is the last header to
  be included.

- Open binary files when reading or writing with 'b' mode.

  e.g: fopen("somefile", "wb");

  Not doing so will open files in windows using defaut translation mode. 
  i.e. newline -> <CR><LF>

Paths
-----

- DATADIR, LOCALEDIR & LIBDIR are defined in wingaim as functions.
  Doing the following will therefore break the windows build:

  printf("File in DATADIR is: %s\n", DATADIR G_DIR_SEPARATOR_S "pic.png");

  it should be:

  printf("File in DATADIR is: %s%s%s\n", DATADIR, G_DIR_SEPARATOR_S, "pic.png");

PLUGINS & PROTOS
----------------

- G_MODULE_EXPORT all functions which are to be accessed from outside the
  scope of its "dll" or "so". (E.G. gaim_plugin_init)

- G_MODULE_IMPORT all global variables which are located outside your
  dynamic library. (E.G. connections)

  (Not doing this will cause "Memory Access Violations" in Win32)