← Back to branch summary

~audio-recorder/audio-recorder/trunk

« back to all changes in this revision

Viewing changes to README

  • Committer: Osmo Antero Maatta
  • Date: 2011-01-17 09:38:13 UTC
  • Revision ID: osmoma@gmail.com-20110117093813-88ii2qx7bn9qeltt
Updated INSTALL, README and NEWS files

Show diffs side-by-side

added added

removed removed

Lines of Context:
README
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 
 
1
Audio Recorder Application <https://launchpad.net/audio-recorder>
 
2
 
 
3
This is an audio recording application for the GNOME and Unity Desktops. This program allows you to record 
8
4
your favourite music or audio to a file. It can record audio from your system soundcard, microphones, 
9
5
browsers, webcams & more. Put simply; if it plays out of your loudspeakers you can record it. 
10
6
 
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.
 
7
It has a timer that can start, stop or pause recording on a given clock time, time period or file size.
 
8
It can also react to "sound", "voice" and "silence" events.
 
9
 
 
10
This recorder supports several audio (output) formats such as OGG audio, Flac, MP3 and WAV.
14
11
 
15
12
Please read the README and INSTALL files before compilation. 
16
13
 
35
32
libgtk2.0-dev  (gtk+-2.0, gdk-2.0 and gthread-2.0 libraries)
36
33
libglib2.0-dev (glib-2.0 library)
37
34
libgconf2-dev  (gconf-2.0 library)
38
 
libpanel-applet2-dev (libpanelapplet-2.0 library)
39
35
libgstreamer0.10-dev (gstreamer-0.10 library)
40
36
libgstreamer-plugins-base0.10-dev  (gstreamer-interfaces-0.10 library)
41
37
libgnome-media-dev - (gnome-media-profiles library)
42
38
libpulse-dev (PulseAudio's pulse library)
43
39
 
 
40
libdbus-1-dev - Simple interprocess messaging system (development headers).
 
41
libdbus-glib-1-dev - Simple interprocess messaging system (GLib interface).
 
42
 
44
43
For developers:
45
44
***************
46
45
The configuration uses Automake/Autoconf tools. The most important files are: 
52
51
po/POTFILES.in - Language support. List of source files that has translatable text.
53
52
 
54
53
The general sequence of commands to re-configure the source is:
55
 
cd rec-audio*
 
54
 
 
55
cd audio-recorder*
56
56
autoheader
57
57
aclocal
58
58
autoconf
59
59
automake -a 
60
60
 
61
 
./configure  #configure produces the final Makefile (food for make).
 
61
./configure  # configure produces the final Makefile (food for make).
62
62
make
63
 
make install  #run this as root or sudo!
 
63
sudo make install  # run this as root or sudo.
64
64
 
65
65
File locations:
66
66
***************
67
 
Make install will copy the rec-audio executable to /usr/bin directory.
 
67
"Make install" will copy the audio-recorder executable to /usr/bin directory.
68
68
This default locations can be changed during the ./configure phase.
69
69
Run ./configure --help for more instructions.
70
70
 
71
 
Pixmap images are copied to /usr/share/pixmaps/rec-applet/.
 
71
Pixmap images are copied to /usr/share/pixmaps/audio-recorder/.
72
72
Icons are installed to /usr/share/icons/hicolor/48x48/apps/.
73
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.
 
74
The HTML help files from audio-recorder/data/ are by default copied to /usr/share/audio-recorder/.
 
75
-------------
 
76
 
 
77
Language support:
 
78
*****************
 
79
 
 
80
1) First, translate the data/audio-recorder.desktop file.
 
81
Open it and add your translations to it.
 
82
 
 
83
gedit data/audio-recorder.desktop
 
84
 
 
85
 
 
86
2) Tanslate the program itself.
95
87
The language files are saved in the source's po/ directory.
96
88
 
97
89
Each translatable file should be listed in the po/POTFILES.in file. Add names of new code-files there.
98
90
 
99
 
Translating rec-applet.pot to a new language.
 
91
Translating audio-recorder.pot to a new language.
100
92
 
101
93
Translate on the Launchpad.
102
 
Use Launchpad for the translations. Browse to https://translations.launchpad.net/rec-applet
 
94
Use Launchpad for the translations. Browse to https://translations.launchpad.net/audio-recorder
103
95
Login and open a new language file.
104
96
 
105
97
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
98
Launchpad does this transfer once a day.
108
99
 
109
 
3) Add a new language code to "rec-applet/configure.in" file, change the ALL_LINGUAS variable.
 
100
3) Add a new language code to "audio-recorder/configure.in" file, change the ALL_LINGUAS variable.
110
101
ALL_LINGUAS="de en_AU fi_FI fr hu nb_NO pt pt_BR ru"
111
102
 
112
 
cd rec-applet*
 
103
cd audio-recorder*
113
104
gedit configure.in 
114
105
 
115
106
Run these command after you edited the configure.in.
116
 
cd rec-audio*
 
107
cd audio-recorder*
117
108
autoconf
118
109
autoheader
119
110
automake -a
120
111
 
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:
 
112
Then update the "audio-recorder.pot" file by running "make update-po" in the po/ directory. 
 
113
audio-recorder.pot contains all translatable _("xxx") strings found in the code. Do:
123
114
 
124
 
cd rec-audio*
 
115
cd audio-recorder*
125
116
cd po
126
117
make update-po
127
118
 
128
119
It creates binary language files (*.gmo) of each *.po.
129
120
 
130
 
4) You may also translate the HTML-files (help files) in the rec-applet/data directory.
 
121
4) You may also translate the HTML-files (help files) in the audio-recorder/data directory.
131
122
If not translated, the program will show the original english text.
132
123
 
133
124
Send new language files to developers for inclusion in the package.
134
 
See: https://launchpad.net/rec-applet
 
125
See: https://launchpad.net/audio-recorder
135
126
 
136
127
Development:
137
128
************
140
131
In Ubuntu you should simply get the "build-essential", "automake" and "autoconf" packages.
141
132
 
142
133
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
 
134
https://launchpad.net/audio-recorder
144
135
 
145
136
Launchpad uses Bazar (bzr) as the code versioning system. In Ubuntu you should install the "bzr" package. 
146
137
 
147
138
Then (very important!) read the README and INSTALL files for further instructions.
148
139
----
149
140
 
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.
 
141
I use the Gedit for code editing. In the the preferences I set tab-stops width to 4, 
 
142
and checkmark the "Insert spaces instead of tabs" option.
152
143
----
153
144
 
154
145
The program's about-dialog vill show details about the installation directories and locations.
158
149
make clean
159
150
----
160
151
 
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
152
Debugging:
172
153
**********
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
 
154
You may enable the DEBUG_ALL and ACTIVATE_DEBUGGING directives in the src/log.h file. 
 
155
Open src/log.h and enable or disable
 
156
 
 
157
#define DEBUG_ALL
 
158
#define ACTIVE_DEBUGGING
 
159
 
 
160
Some modules have their own debugging flags. You may enable/disable 
 
161
DEBUG_PLAYER in src/dbus_player.h
 
162
DEBUG_SKYPE in src/dbus-skype.h
 
163
DEBUG_LISTENER in src/gst_listener.h
 
164
DEBUG_TIMER src/timer.h
179
165
----
180
166
 
181
 
Important resources on the web:
182
 
http://live.gnome.org/GnomeLove/PanelAppletTutorial
 
167
Command line options:
 
168
*********************
 
169
src/audio-recorder --help
 
170
 
 
171
Usage:
 
172
  audio-recorder [OPTION...] Command line aguments.
 
173
 
 
174
Application Options:
 
175
  -w, --show-window   Show application window at startup (0=hide main window, 1=force display of main window).
 
176
  -i, --show-icon     Show icon on the system tray (0=hide icon, 1=force display of icon).
 
177
  -d, --debug-signal  List signal level values in a terminal window (0=do not list values, 1=list values).
 
178
 
 
179
Sample usage:
 
180
audio-recorder --show-window=1 --show-icon=0
 
181
 
 
182
The --show-window and --show-icon are self explanatory.
 
183
The --debug-signal option can help you to study the signal level from microphones and webcams.
 
184
The listing will print out several values from the listener (monitoring) process.
 
185
The most important is the Average RMS value. It is used to set the decibel (dB) or % value in the timer commands.
183
186
----
184
187
 
185
188
Ready-made Debian/Ubuntu packages:
186
189
**********************************
187
 
See: https://launchpad.net/~osmoma/+archive/rec-applet
 
190
See: https://launchpad.net/~osmoma/+archive/audio-recorder
188
191
 
189
192
-- end --
190
193