~audio-recorder/audio-recorder/trunk

« back to all changes in this revision

Viewing changes to README

  • Committer: Osmo Antero Maatta
  • Date: 2011-01-17 08:09:50 UTC
  • Revision ID: osmoma@gmail.com-20110117080950-4cbm2fnnsr0332jw
InitialĀ importĀ 17.jan.2011

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
autoheader && aclocal && autoconf && automake -a 
 
2
 
 
3
 
 
4
Audio Recorder Applet <https://launchpad.net/rec-applet>
 
5
Author: Osmo Antero Maatta <osmoma@gmail.com>
 
6
 
 
7
This is an audio recording applet for the GNOME-desktop. This toolbar-applet allows you to record 
 
8
your favourite music or audio to a file. It can record audio from your system soundcard, microphones, 
 
9
browsers, webcams & more. Put simply; if it plays out of your loudspeakers you can record it. 
 
10
 
 
11
The applet has a timer that can stop the recording at "silence" or given clock time, after time duration 
 
12
or file size. It supports several audio (output) formats such as OGG audio, Flac, MP3 and WAV. The MP3-format 
 
13
requires gstreamer0.10-plugins-ugly* (or newer) packages.
 
14
 
 
15
Please read the README and INSTALL files before compilation. 
 
16
 
 
17
Important files:
 
18
****************
 
19
README  - This file.
 
20
INSTALL - Compilation from source and installation.
 
21
COPYING - The license text.
 
22
AUTHORS - Authors and contributors.
 
23
NEWS    - Recent news, releases.
 
24
debian/README - Instructions to create a Debian/Ubuntu package.
 
25
 
 
26
Compilation from source and installation:
 
27
*****************************************
 
28
Read the INSTALL file for detailed information about compilation of this program.
 
29
 
 
30
Runtime:
 
31
********
 
32
Runtime (running this program) has currently these dependencies. The package names are from 
 
33
Debian/Ubuntu but you should find similar packages in any other Linux-distribution.
 
34
 
 
35
libgtk2.0-dev  (gtk+-2.0, gdk-2.0 and gthread-2.0 libraries)
 
36
libglib2.0-dev (glib-2.0 library)
 
37
libgconf2-dev  (gconf-2.0 library)
 
38
libpanel-applet2-dev (libpanelapplet-2.0 library)
 
39
libgstreamer0.10-dev (gstreamer-0.10 library)
 
40
libgstreamer-plugins-base0.10-dev  (gstreamer-interfaces-0.10 library)
 
41
libgnome-media-dev - (gnome-media-profiles library)
 
42
libpulse-dev (PulseAudio's pulse library)
 
43
 
 
44
For developers:
 
45
***************
 
46
The configuration uses Automake/Autoconf tools. The most important files are: 
 
47
 
 
48
Makefile.am  - General build and installation instructions.
 
49
configure.in  - Configuration of source with library existens and error check.
 
50
pixmaps/Makefile.am - Installation of icons.  
 
51
src/Makefile.am - Build and installation instructions. Contains list of all source files.
 
52
po/POTFILES.in - Language support. List of source files that has translatable text.
 
53
 
 
54
The general sequence of commands to re-configure the source is:
 
55
cd rec-audio*
 
56
autoheader
 
57
aclocal
 
58
autoconf
 
59
automake -a 
 
60
 
 
61
./configure  #configure produces the final Makefile (food for make).
 
62
make
 
63
make install  #run this as root or sudo!
 
64
 
 
65
File locations:
 
66
***************
 
67
Make install will copy the rec-audio executable to /usr/bin directory.
 
68
This default locations can be changed during the ./configure phase.
 
69
Run ./configure --help for more instructions.
 
70
 
 
71
Pixmap images are copied to /usr/share/pixmaps/rec-applet/.
 
72
Icons are installed to /usr/share/icons/hicolor/48x48/apps/.
 
73
 
 
74
The HTML help files from rec-applet/data/ are copied to /usr/share/rec-applet/.
 
75
 
 
76
The applet's server file is copied from "rec-applet/data/rec-applet.server.in.in" 
 
77
to /usr/lib/bonobo/servers/rec-applet.server. 
 
78
 
 
79
Run "pkill gnome-panel" to make GNOME reload the applets configurations.
 
80
The applet will then become visible in the "Add to panel" list.
 
81
-------------
 
82
 
 
83
If you plan to create a Debian/Ubuntu package of this program, 
 
84
read the rec-applet*/debian/README file.
 
85
-------------
 
86
 
 
87
Language support by gettext:
 
88
****************************
 
89
 
 
90
1) First, translate the "rec-applet.server.in.in" file.
 
91
You can find this file in the source's rec-applet/data/ folder.
 
92
The installer vil rename and copy this file to /usr/lib/bonobo/servers/rec-applet.server.
 
93
 
 
94
2) Tanslate the applet/program itself.
 
95
The language files are saved in the source's po/ directory.
 
96
 
 
97
Each translatable file should be listed in the po/POTFILES.in file. Add names of new code-files there.
 
98
 
 
99
Translating rec-applet.pot to a new language.
 
100
 
 
101
Translate on the Launchpad.
 
102
Use Launchpad for the translations. Browse to https://translations.launchpad.net/rec-applet
 
103
Login and open a new language file.
 
104
 
 
105
Important: The translations from the Launchpad are automatically copied/synchronized to the source code's po/ directory. 
 
106
They appear in the http://bazaar.launchpad.net/~osmoma/rec-applet/trunk/files/head:/po/ directory.
 
107
Launchpad does this transfer once a day.
 
108
 
 
109
3) Add a new language code to "rec-applet/configure.in" file, change the ALL_LINGUAS variable.
 
110
ALL_LINGUAS="de en_AU fi_FI fr hu nb_NO pt pt_BR ru"
 
111
 
 
112
cd rec-applet*
 
113
gedit configure.in 
 
114
 
 
115
Run these command after you edited the configure.in.
 
116
cd rec-audio*
 
117
autoconf
 
118
autoheader
 
119
automake -a
 
120
 
 
121
Then update the "rec-applet.pot" file by running "make update-po" in the po/ directory. 
 
122
rec-applet.pot contains all translatable _("xxx") strings found in the code. Do:
 
123
 
 
124
cd rec-audio*
 
125
cd po
 
126
make update-po
 
127
 
 
128
It creates binary language files (*.gmo) of each *.po.
 
129
 
 
130
4) You may also translate the HTML-files (help files) in the rec-applet/data directory.
 
131
If not translated, the program will show the original english text.
 
132
 
 
133
Send new language files to developers for inclusion in the package.
 
134
See: https://launchpad.net/rec-applet
 
135
 
 
136
Development:
 
137
************
 
138
First of all, install necessary development (*-dev) packages as instructed in the INSTALL file. 
 
139
Of cource you will also need the compiler (gcc) and Automake tools. 
 
140
In Ubuntu you should simply get the "build-essential", "automake" and "autoconf" packages.
 
141
 
 
142
The code is written in c with GDK/GTK+ libraries and it is hosted on the Launchpad at address:
 
143
https://launchpad.net/rec-applet
 
144
 
 
145
Launchpad uses Bazar (bzr) as the code versioning system. In Ubuntu you should install the "bzr" package. 
 
146
 
 
147
Then (very important!) read the README and INSTALL files for further instructions.
 
148
----
 
149
 
 
150
I use the Gedit for code editing. In the the preferences I set:
 
151
Tab-stops width to 4, and checkmark the "Insert spaces instead of tabs" option.
 
152
----
 
153
 
 
154
The program's about-dialog vill show details about the installation directories and locations.
 
155
Run the program and check the about-dialog.
 
156
 
 
157
You can clean up binary and object (*.o) files with "make clean".
 
158
make clean
 
159
----
 
160
 
 
161
To test the applet on the panel, I find this command line very quick & useful
 
162
$ make && sudo make install; pkill rec-applet
 
163
Let it reload the applet.
 
164
 
 
165
It compiles and installs the applet + reloads it.
 
166
 
 
167
You can also reset the entire panel
 
168
$ make && sudo make install; pkill gnome-panel
 
169
-------------
 
170
 
 
171
Debugging:
 
172
**********
 
173
You may enable the AUDIO_REC_APPLET_DEBUG directive in the main.c file. 
 
174
It allows you to test the applet in an ordinary GTK-window, instead of toolbar panel.
 
175
 
 
176
You can also activate the ACTIVE_DEBUGGING directive in the log.h file.
 
177
Run the src/rec-applet from a terminal window and it vill output debug-information on the command prompt. 
 
178
$ src/rec-applet
 
179
----
 
180
 
 
181
Important resources on the web:
 
182
http://live.gnome.org/GnomeLove/PanelAppletTutorial
 
183
----
 
184
 
 
185
Ready-made Debian/Ubuntu packages:
 
186
**********************************
 
187
See: https://launchpad.net/~osmoma/+archive/rec-applet
 
188
 
 
189
-- end --
 
190