├── .gitignore ├── .indent.pro ├── services ├── meson.build └── systemd │ ├── meson.build │ └── espeakup.service.in ├── meson_options.txt ├── src ├── meson.build ├── version.h.in ├── queue.h ├── stringhandling.h ├── signal.c ├── queue.c ├── espeakup.h ├── stringhandling.c ├── cli.c ├── espeakup.c ├── softsynth.c └── espeak.c ├── doc ├── meson.build └── espeakup.8.ronn ├── meson.build ├── .clang-format ├── README.md └── COPYING /.gitignore: -------------------------------------------------------------------------------- 1 | build* 2 | -------------------------------------------------------------------------------- /.indent.pro: -------------------------------------------------------------------------------- 1 | -kr 2 | -ts4 3 | -------------------------------------------------------------------------------- /services/meson.build: -------------------------------------------------------------------------------- 1 | systemd = dependency('systemd', required: get_option('systemd')) 2 | if systemd.found() 3 | subdir('systemd') 4 | endif 5 | -------------------------------------------------------------------------------- /meson_options.txt: -------------------------------------------------------------------------------- 1 | option('man', type : 'feature', value : 'auto', 2 | description : 'build manpage with ronn') 3 | option('systemd', type : 'feature', value : 'auto', 4 | description :'enable systemd support') 5 | -------------------------------------------------------------------------------- /src/meson.build: -------------------------------------------------------------------------------- 1 | espeakup_sources = files([ 2 | 'cli.c', 3 | 'espeak.c', 4 | 'espeakup.c', 5 | 'queue.c', 6 | 'signal.c', 7 | 'softsynth.c', 8 | 'stringhandling.c' 9 | ]) 10 | espeakup_version = vcs_tag(input : 'version.h.in', output : 'version.h') 11 | -------------------------------------------------------------------------------- /doc/meson.build: -------------------------------------------------------------------------------- 1 | ronn = find_program('ronn', required: get_option('man')) 2 | if ronn.found() 3 | custom_target('man', 4 | input : files('espeakup.8.ronn'), 5 | output : 'espeakup.8', 6 | command : [ronn, '--output-dir', '@OUTDIR@', '--roff', '@INPUT@'], 7 | install : true, install_dir: join_paths(get_option('mandir'),'man8')) 8 | endif 9 | -------------------------------------------------------------------------------- /services/systemd/meson.build: -------------------------------------------------------------------------------- 1 | unitdir = systemd.get_variable(pkgconfig: 'systemdsystemunitdir') 2 | prefixdir = get_option('prefix') 3 | bindir = join_paths(prefixdir, get_option('bindir')) 4 | 5 | unit_conf = configuration_data() 6 | unit_conf.set('bindir', bindir) 7 | 8 | service_file = configure_file( 9 | input : 'espeakup.service.in', 10 | output : 'espeakup.service', 11 | configuration : unit_conf 12 | ) 13 | 14 | install_data(service_file, 15 | install_dir : unitdir 16 | ) 17 | -------------------------------------------------------------------------------- /services/systemd/espeakup.service.in: -------------------------------------------------------------------------------- 1 | [Unit] 2 | Description=Software speech output for Speakup 3 | Documentation=man:espeakup(8) 4 | Wants=modprobe@speakup_soft.service 5 | After=modprobe@speakup_soft.service sound.target 6 | 7 | [Service] 8 | Type=forking 9 | PIDFile=/run/espeakup.pid 10 | Environment="default_voice=" 11 | ExecStart=@bindir@/espeakup --default-voice=${default_voice} 12 | ExecReload=kill -HUP $MAINPID 13 | Restart=always 14 | Nice=-10 15 | OOMScoreAdjust=-900 16 | 17 | [Install] 18 | WantedBy=sound.target 19 | -------------------------------------------------------------------------------- /meson.build: -------------------------------------------------------------------------------- 1 | project('espeakup', 'c', 2 | default_options : [ 3 | 'buildtype=debugoptimized', 4 | 'c_std=gnu11', 5 | 'warning_level=3' 6 | ], 7 | license : 'GPL-3.0-or-later', 8 | version : '0.90', 9 | meson_version : '>=0.51.0') 10 | 11 | cc = meson.get_compiler('c') 12 | thread_dep = dependency('threads') 13 | espeak_dep = dependency('espeak-ng') 14 | alsa_dep = dependency('alsa') 15 | math_dep = cc.find_library('m', required : false) 16 | 17 | subdir('doc') 18 | subdir('services') 19 | subdir('src') 20 | 21 | executable('espeakup', 22 | espeakup_version, 23 | espeakup_sources, 24 | dependencies : [thread_dep, espeak_dep, alsa_dep, math_dep], 25 | install : true) 26 | -------------------------------------------------------------------------------- /src/version.h.in: -------------------------------------------------------------------------------- 1 | /* 2 | * espeakup - interface which allows speakup to use espeak-ng 3 | * 4 | * Copyright (C) 2008 William Hubbs 5 | * 6 | * This program is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program. If not, see . 18 | */ 19 | 20 | #ifndef __VERSION_H 21 | #define __VERSION_H 22 | 23 | #define PACKAGE_VERSION "@VCS_TAG@" 24 | 25 | #endif 26 | -------------------------------------------------------------------------------- /src/queue.h: -------------------------------------------------------------------------------- 1 | /* 2 | * espeakup - interface which allows speakup to use espeak-ng 3 | * 4 | * Copyright (C) 2008 William Hubbs 5 | * 6 | * This program is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program. If not, see . 18 | */ 19 | 20 | #ifndef __QUEUE_H 21 | #define __QUEUE_H 22 | 23 | struct queue_t; // An opaque type. 24 | 25 | extern struct queue_t *new_queue(void); 26 | extern int queue_add(struct queue_t *q, void *entry); 27 | extern void *queue_remove(struct queue_t *q); 28 | extern void *queue_peek(struct queue_t *q); 29 | 30 | #endif 31 | -------------------------------------------------------------------------------- /src/stringhandling.h: -------------------------------------------------------------------------------- 1 | /* 2 | * espeakup - interface which allows speakup to use espeak-ng 3 | * 4 | * Copyright (C) 2011 William Hubbs 5 | * 6 | * This program is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program. If not, see . 18 | */ 19 | 20 | #ifndef __STRINGHANDLING_H 21 | #define __STRINGHANDLING_H 22 | 23 | #include 24 | 25 | extern char *EMPTYSTRING; 26 | 27 | void *allocMem(size_t n); 28 | void *reallocMem(void *p, size_t n); 29 | char *dupeString(char *s); 30 | char *initString(int *l); 31 | void stringAndString(char **s, int *l, const char *t); 32 | void stringAndBytes(char **s, int *l, const char *t, int cnt); 33 | 34 | #endif 35 | -------------------------------------------------------------------------------- /.clang-format: -------------------------------------------------------------------------------- 1 | --- 2 | Language: Cpp 3 | BasedOnStyle: LLVM 4 | 5 | AlignAfterOpenBracket: Align 6 | AlignEscapedNewlines: Left 7 | AlignOperands: AlignAfterOperator 8 | AlignTrailingComments: true 9 | AllowAllArgumentsOnNextLine: true 10 | AllowAllParametersOfDeclarationOnNextLine: true 11 | AllowShortEnumsOnASingleLine: false 12 | AllowShortBlocksOnASingleLine: Never 13 | AllowShortCaseLabelsOnASingleLine: false 14 | AllowShortFunctionsOnASingleLine: None 15 | AllowShortIfStatementsOnASingleLine: Never 16 | AllowShortLoopsOnASingleLine: false 17 | AlwaysBreakAfterDefinitionReturnType: None 18 | AlwaysBreakAfterReturnType: None 19 | AlwaysBreakBeforeMultilineStrings: false 20 | BinPackArguments: true 21 | BinPackParameters: true 22 | BreakBeforeBraces: Linux 23 | ColumnLimit: 80 24 | IndentPPDirectives: BeforeHash 25 | IndentWidth: 4 26 | InsertTrailingCommas: None 27 | KeepEmptyLinesAtTheStartOfBlocks: false 28 | PointerAlignment: Right 29 | ReflowComments: true 30 | SortIncludes: true 31 | SpaceAfterCStyleCast: true 32 | SpaceAfterLogicalNot: false 33 | SpaceBeforeAssignmentOperators: true 34 | SpaceBeforeParens: ControlStatements 35 | SpaceAroundPointerQualifiers: Before 36 | SpaceInEmptyBlock: false 37 | SpaceInEmptyParentheses: false 38 | SpacesBeforeTrailingComments: 5 39 | TabWidth: 4 40 | UseTab: AlignWithSpaces 41 | ... 42 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # espeakup connector 2 | 3 | espeakup is a program which makes it possible for speakup to use 4 | the espeak-ng software synthesizer. It does this by reading speakup's 5 | softsynth device and passing the text to espeak-ng which actually speaks. 6 | 7 | ## Requirements 8 | 9 | This program works with the speakup screen reader, which can be obtained 10 | from http://linux-speakup.org, and the 11 | [espeak-ng](https://github.com/espeak-ng/espeak-ng) software speech 12 | synthesizer. 13 | 14 | You must have both of these installed and operational. Setting them up 15 | is beyond the scope of this document. 16 | 17 | ## Installation 18 | 19 | The preferred way to install espeakup is using your distribution's 20 | packaging system, but if your distribution does not have a package for 21 | espeakup yet, espeakup just uses meson, so you should be able to 22 | change to the source directory, then type: 23 | 24 | ```bash 25 | meson setup . ./build 26 | cd ./build 27 | ninja 28 | sudo ninja install 29 | ``` 30 | 31 | ## Starting Up 32 | 33 | This program should be run after speakup is set up to communicate with a 34 | software synthesizer and after /dev/softsynth exists. The way this is 35 | done is distribution specific, so it is beyond the scope of this 36 | documentation. 37 | 38 | ## Acknowledgements 39 | 40 | I would like to thank Marc Mulcahy, the author of the speakup to 41 | TTSynth connector, on which this work is based. Also, I would like 42 | to thank Kirk Reiser and Jonathan Duddington, the 43 | authors of Speakup and Espeak, respectively, for their work. 44 | 45 | ## Filing Bugs 46 | 47 | Bugs should be filed on our bug tracker at 48 | https://github.com/linux-speakup/issues. 49 | -------------------------------------------------------------------------------- /src/signal.c: -------------------------------------------------------------------------------- 1 | /* 2 | * espeakup - interface which allows speakup to use espeak-ng 3 | * 4 | * Copyright (C) 2008 William Hubbs 5 | * 6 | * This program is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program. If not, see . 18 | */ 19 | 20 | #include 21 | #include 22 | #include 23 | #include 24 | 25 | #include "espeakup.h" 26 | 27 | #define STOP_MSG "s" 28 | 29 | /* 30 | * We install a dummy signal handler to let the o/s know that we 31 | * do not want the default action to be performed since we are 32 | * handling the signal. 33 | */ 34 | static void dummy_handler(int sig) 35 | { 36 | } 37 | 38 | void *signal_thread(void *arg) 39 | { 40 | struct sigaction temp; 41 | sigset_t sigset; 42 | int sig; 43 | 44 | memset(&temp, 0, sizeof(struct sigaction)); 45 | // install dummy handlers for the signals we want to process 46 | temp.sa_handler = dummy_handler; 47 | sigemptyset(&temp.sa_mask); 48 | sigaction(SIGINT, &temp, NULL); 49 | sigaction(SIGTERM, &temp, NULL); 50 | 51 | pthread_mutex_lock(&queue_guard); 52 | while (should_run) { 53 | pthread_mutex_unlock(&queue_guard); 54 | sigfillset(&sigset); 55 | sigwait(&sigset, &sig); 56 | switch (sig) { 57 | case SIGINT: 58 | case SIGTERM: 59 | pthread_mutex_lock(&queue_guard); 60 | should_run = 0; 61 | pthread_mutex_unlock(&queue_guard); 62 | break; 63 | default: 64 | printf("espeakup caught signal %d\n", sig); 65 | break; 66 | } 67 | pthread_mutex_lock(&queue_guard); 68 | } 69 | pthread_mutex_unlock(&queue_guard); 70 | // Tell the reader to stop, if it is in a select() call. 71 | write(PIPE_WRITE_FD, STOP_MSG, strlen(STOP_MSG)); 72 | return NULL; 73 | } 74 | -------------------------------------------------------------------------------- /src/queue.c: -------------------------------------------------------------------------------- 1 | /* 2 | * espeakup - interface which allows speakup to use espeak-ng 3 | * 4 | * Note that these functions are meant to be used in either a single or 5 | * multi-threaded environment, so they know nothing about mutexes, etc. 6 | * Handling this is up to the caller. 7 | * 8 | * Copyright (C) 2008 William Hubbs 9 | * 10 | * This program is free software: you can redistribute it and/or modify 11 | * it under the terms of the GNU General Public License as published by 12 | * the Free Software Foundation, either version 3 of the License, or 13 | * (at your option) any later version. 14 | * 15 | * This program is distributed in the hope that it will be useful, 16 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 | * GNU General Public License for more details. 19 | * 20 | * You should have received a copy of the GNU General Public License 21 | * along with this program. If not, see . 22 | */ 23 | 24 | #include 25 | #include 26 | 27 | #include "stringhandling.h" 28 | 29 | struct queue_entry_t { 30 | void *data; 31 | struct queue_entry_t *next; 32 | }; 33 | 34 | struct queue_t { 35 | struct queue_entry_t *head; 36 | struct queue_entry_t *tail; 37 | }; 38 | 39 | struct queue_t *new_queue(void) 40 | { 41 | struct queue_t *q = allocMem(sizeof(struct queue_t)); 42 | q->head = NULL; 43 | q->tail = NULL; 44 | return q; 45 | } 46 | 47 | int queue_add(struct queue_t *q, void *data) 48 | { 49 | struct queue_entry_t *tmp; 50 | 51 | assert(data); 52 | tmp = allocMem(sizeof(struct queue_entry_t)); 53 | tmp->data = data; 54 | tmp->next = NULL; 55 | if (!q->tail) { 56 | q->tail = tmp; 57 | } else { 58 | q->tail->next = tmp; 59 | q->tail = q->tail->next; 60 | } 61 | if (!q->head) 62 | q->head = tmp; 63 | return 1; 64 | } 65 | 66 | void *queue_remove(struct queue_t *q) 67 | { 68 | void *data = NULL; 69 | struct queue_entry_t *tmp; 70 | 71 | if (q->head) { 72 | tmp = q->head; 73 | data = tmp->data; 74 | q->head = tmp->next; 75 | free(tmp); 76 | if (!q->head) 77 | q->tail = q->head; 78 | } 79 | return data; 80 | } 81 | 82 | void *queue_peek(struct queue_t *q) 83 | { 84 | if (q->head) 85 | return q->head->data; 86 | else 87 | return NULL; 88 | } 89 | -------------------------------------------------------------------------------- /src/espeakup.h: -------------------------------------------------------------------------------- 1 | /* 2 | * espeakup - interface which allows speakup to use espeak-ng 3 | * 4 | * Copyright (C) 2008 William Hubbs 5 | * 6 | * This program is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program. If not, see . 18 | */ 19 | 20 | #ifndef __ESPEAKUP_H 21 | #define __ESPEAKUP_H 22 | 23 | // This was added for gcc 4.3 24 | #include 25 | #include 26 | 27 | #include 28 | 29 | #include "queue.h" 30 | 31 | #define PACKAGE_BUGREPORT "https://github.com/linux-speakup/espeakup/issues" 32 | 33 | enum espeakup_mode_t 34 | { 35 | ESPEAKUP_MODE_SPEAKUP, 36 | ESPEAKUP_MODE_ACSINT 37 | }; 38 | 39 | enum command_t 40 | { 41 | CMD_SET_FREQUENCY, 42 | CMD_SET_MARK, 43 | CMD_SET_PITCH, 44 | CMD_SET_RANGE, 45 | CMD_SET_PUNCTUATION, 46 | CMD_SET_RATE, 47 | CMD_SET_VOICE, 48 | CMD_SET_VOLUME, 49 | CMD_SPEAK_TEXT, 50 | CMD_FLUSH, 51 | CMD_PAUSE, 52 | CMD_UNKNOWN, 53 | }; 54 | 55 | enum adjust_t 56 | { 57 | ADJ_DEC, 58 | ADJ_SET, 59 | ADJ_INC, 60 | }; 61 | 62 | struct espeak_entry_t { 63 | enum command_t cmd; 64 | enum adjust_t adjust; 65 | int value; 66 | char *buf; 67 | int len; 68 | }; 69 | 70 | struct synth_t { 71 | int frequency; 72 | int pitch; 73 | int range; 74 | int punct; 75 | int rate; 76 | char voice[20]; 77 | int volume; 78 | char *buf; 79 | int len; 80 | }; 81 | 82 | extern struct queue_t *synth_queue; 83 | extern int debug; 84 | extern enum espeakup_mode_t espeakup_mode; 85 | 86 | extern void process_cli(int argc, char **argv); 87 | extern void *signal_thread(void *arg); 88 | extern int initialize_espeak(struct synth_t *s); 89 | extern void *espeak_thread(void *arg); 90 | extern int open_softsynth(void); 91 | extern void close_softsynth(void); 92 | extern void *softsynth_thread(void *arg); 93 | extern void softsynth_reportindex(int index); 94 | extern volatile int should_run; 95 | extern volatile int stop_requested; 96 | extern int paused_espeak; 97 | extern int self_pipe_fds[2]; 98 | #define PIPE_READ_FD (self_pipe_fds[0]) 99 | #define PIPE_WRITE_FD (self_pipe_fds[1]) 100 | 101 | extern pthread_cond_t runner_awake; 102 | extern pthread_cond_t wake_stop; 103 | extern pthread_cond_t stop_acknowledged; 104 | extern pthread_mutex_t queue_guard; 105 | 106 | #endif 107 | -------------------------------------------------------------------------------- /doc/espeakup.8.ronn: -------------------------------------------------------------------------------- 1 | 2 | 3 | # espeakup(8) --- connect Speakup to the espeak-ng TTS engine 4 | 5 | ## SYNOPSIS 6 | 7 | `espeakup` [`--pid-path=`] [`--alsa-volume`] 8 | [`--default-voice=`[]] [`--debug`] [`--help`] [`--version`] 9 | 10 | ## OPTIONS 11 | 12 | * `-P` , `--pid-path=`: 13 | Set the full path for the pid file espeakup uses when in daemon mode. 14 | 15 | * `--alsa-volume`: 16 | Drive the ALSA volume. useful for live environments where volume 17 | adjustments maybe impossible. 18 | 19 | * `-V` , `--default-voice=`: 20 | Set the espeak-ng voice to be used by default. 21 | 22 | * `-d`, `--debug`: 23 | run in the foreground, rather than becoming a daemon process. 24 | 25 | * `-h`, `--help`: 26 | display a brief help message and exit. 27 | 28 | * `-v`, `--version`: 29 | output version information and exit. 30 | 31 | ## DESCRIPTION 32 | 33 | espeakup bridges the gap between two tools: the Speakup screen review system and 34 | the espeak-ng text-to-speech engine. Each of these tools performs a 35 | well-defined task. 36 | 37 | Speakup is a kernel-based screen reader for the Linux console. It extracts and 38 | processes the text that is displayed on the foreground virtual console. It 39 | supports several hardware based speech synthesizers directly. However, since it 40 | is in kernel space, it cannot support a software speech synthesizer directly 41 | since these are in user space. 42 | 43 | espeak-ng is a popular software speech synthesizer. It is small, light weight, 44 | very responsive, and supports multiple languages. espeakup is a connector which 45 | will read text sent to it by speakup and forward it to espeak-ng. This allows 46 | Speakup to use espeak-ng as its speech synthesizer. 47 | 48 | espeakup is a daemon. Typically, it is started at boot time, and it terminates 49 | when the system is halted or rebooted. It should be started by the system's init 50 | scripts. This process varies among Linux distributions, but the details are 51 | usually managed by the person who packaged espeakup for your distribution. From 52 | the perspective of an average user, espeakup's operation is invisible. 53 | 54 | ## BUGS 55 | 56 | If you find a bug, please create a 57 | [github issue](https://github.com/linux-speakup/espeakup/issues) 58 | You might also consider mentioning it on the mailing list for the Speakup 59 | screenreader. Visit 60 | [list page](https://linux-speakup.org/cgi-bin/mailman/listinfo/speakup) 61 | to learn more about the mailing list. 62 | 63 | ## SEE ALSO 64 | 65 | For more information about Speakup, visit its 66 | [homepage](https://linux-speakup.org). 67 | 68 | espeak-ng can be found at [github](https://github.com/espeak-ng/espeak-ng) 69 | 70 | ## AUTHOR 71 | 72 | William Hubbs is the author of espeakup. 73 | 74 | This manual page was written by Chris Brannon . 75 | 76 | current authors and maintainers can be found at 77 | [github](https://github.com/linux-speakup/espeakup/graphs/contributors) 78 | -------------------------------------------------------------------------------- /src/stringhandling.c: -------------------------------------------------------------------------------- 1 | /* 2 | * espeakup - interface which allows speakup to use espeak-ng 3 | * 4 | * Copyright (C) 2011 William Hubbs 5 | * 6 | * This program is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program. If not, see . 18 | */ 19 | 20 | /* 21 | * These string routines were borrowed from edbrowse, which was 22 | * originally written by Karl Dahlke, and is being currently maintained 23 | * by Christopher Brannon. 24 | * I would like to thank both of them for their work on this software. 25 | */ 26 | 27 | #include 28 | #include 29 | #include 30 | 31 | char *EMPTYSTRING = ""; 32 | 33 | void *allocMem(size_t n) 34 | { 35 | void *s; 36 | if (!n) 37 | return EMPTYSTRING; 38 | if (!(s = malloc(n))) { 39 | fprintf(stderr, "Out of memory!\n"); 40 | exit(1); 41 | } 42 | return s; 43 | } 44 | 45 | void *reallocMem(void *p, size_t n) 46 | { 47 | void *s; 48 | if (!n) { 49 | fprintf(stderr, "Trying to reallocate memory with size of 0.\n"); 50 | exit(1); 51 | } 52 | if (!p) { 53 | fprintf(stderr, "realloc called with a NULL pointer!\n"); 54 | exit(1); 55 | } 56 | if (p == EMPTYSTRING) 57 | return allocMem(n); 58 | if (!(s = realloc(p, n))) { 59 | fprintf(stderr, "Failed to allocate memory.\n"); 60 | exit(1); 61 | } 62 | return s; 63 | } 64 | 65 | char *dupeString(char *s) 66 | { 67 | char *c; 68 | 69 | if (!(c = strdup(s))) { 70 | fprintf(stderr, "Out of memory!\n"); 71 | exit(1); 72 | } 73 | return c; 74 | } 75 | 76 | char *initString(int *l) 77 | { 78 | *l = 0; 79 | return EMPTYSTRING; 80 | } 81 | 82 | void stringAndString(char **s, int *l, const char *t) 83 | { 84 | char *p = *s; 85 | int oldlen, newlen, x; 86 | oldlen = *l; 87 | newlen = oldlen + strlen(t); 88 | *l = newlen; 89 | ++newlen; // room for the 0 90 | x = oldlen ^ newlen; 91 | if (x > oldlen) { // must realloc 92 | newlen |= (newlen >> 1); 93 | newlen |= (newlen >> 2); 94 | newlen |= (newlen >> 4); 95 | newlen |= (newlen >> 8); 96 | newlen |= (newlen >> 16); 97 | p = reallocMem(p, newlen); 98 | *s = p; 99 | } 100 | strcpy(p + oldlen, t); 101 | } 102 | 103 | void stringAndBytes(char **s, int *l, const char *t, int cnt) 104 | { 105 | char *p = *s; 106 | int oldlen, newlen, x; 107 | oldlen = *l; 108 | newlen = oldlen + cnt; 109 | *l = newlen; 110 | ++newlen; 111 | x = oldlen ^ newlen; 112 | if (x > oldlen) { // must realloc 113 | newlen |= (newlen >> 1); 114 | newlen |= (newlen >> 2); 115 | newlen |= (newlen >> 4); 116 | newlen |= (newlen >> 8); 117 | newlen |= (newlen >> 16); 118 | p = reallocMem(p, newlen); 119 | *s = p; 120 | } 121 | memcpy(p + oldlen, t, cnt); 122 | p[oldlen + cnt] = 0; 123 | } 124 | -------------------------------------------------------------------------------- /src/cli.c: -------------------------------------------------------------------------------- 1 | /* 2 | * espeakup - interface which allows speakup to use espeak-ng 3 | * 4 | * Copyright (C) 2008 William Hubbs 5 | * 6 | * This program is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program. If not, see . 18 | */ 19 | 20 | #include 21 | #include 22 | #include 23 | #include 24 | 25 | #include "espeakup.h" 26 | #include "stringhandling.h" 27 | #include "version.h" 28 | 29 | /* pid path */ 30 | extern char *pidPath; 31 | 32 | /* default voice */ 33 | extern char *defaultVoice; 34 | 35 | /* Whether to drive ALSA volume */ 36 | extern int alsaVolume; 37 | 38 | /* command line options */ 39 | const char *shortOptions = "P:V:adhv"; 40 | const struct option longOptions[] = { 41 | {"pid-path", required_argument, NULL, 'P'}, 42 | {"default-voice", required_argument, NULL, 'V'}, 43 | {"alsa-volume", no_argument, &alsaVolume, 1}, 44 | {"acsint", no_argument, NULL, 'a'}, 45 | {"debug", no_argument, NULL, 'd'}, 46 | {"help", no_argument, NULL, 'h'}, 47 | {"version", no_argument, NULL, 'v'}, 48 | {0, 0, 0, 0}}; 49 | 50 | static void show_help() 51 | { 52 | printf("Usage: espeakup [options]\n\n"); 53 | printf("Options are as follows:\n"); 54 | printf(" --pid-path=path, -P path\t\tSet path for pid file.\n"); 55 | printf(" --default-voice=voice, -V voice\tSet default voice.\n"); 56 | printf(" --alsa-volume\t\t\t\tDrive the ALSA volume.\n"); 57 | printf(" --debug, -d\t\t\t\tDebug mode (stay in the foreground).\n"); 58 | printf(" --help, -h\t\t\t\tShow this help.\n"); 59 | printf(" --version, -v\t\t\t\tDisplay the software version.\n"); 60 | exit(0); 61 | } 62 | 63 | static void show_version(void) 64 | { 65 | printf("ESpeakup %s\n", PACKAGE_VERSION); 66 | printf("Copyright (C) 2008 William Hubbs \n"); 67 | printf("License GPLv3+: GNU GPL version 3 or later\n"); 68 | printf("You are free to change and redistribute this software.\n"); 69 | printf("Please report bugs to %s\n", PACKAGE_BUGREPORT); 70 | exit(0); 71 | } 72 | 73 | void process_cli(int argc, char **argv) 74 | { 75 | int opt; 76 | 77 | do { 78 | opt = getopt_long(argc, argv, shortOptions, longOptions, NULL); 79 | switch (opt) { 80 | case 'P': 81 | pidPath = dupeString(optarg); 82 | break; 83 | case 'V': 84 | defaultVoice = dupeString(optarg); 85 | break; 86 | case 'a': 87 | espeakup_mode = ESPEAKUP_MODE_ACSINT; 88 | break; 89 | case 'd': 90 | debug = 1; 91 | break; 92 | case 'h': 93 | show_help(); 94 | break; 95 | case 'v': 96 | show_version(); 97 | break; 98 | case -1: 99 | case 0: 100 | break; 101 | default: 102 | show_help(); 103 | break; 104 | } 105 | } while (opt != -1); 106 | } 107 | -------------------------------------------------------------------------------- /src/espeakup.c: -------------------------------------------------------------------------------- 1 | /* 2 | * espeakup - interface which allows speakup to use espeak-ng 3 | * 4 | * Copyright (C) 2008 William Hubbs 5 | * 6 | * This program is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program. If not, see . 18 | */ 19 | 20 | #include 21 | #include 22 | #include 23 | #include 24 | #include 25 | #include 26 | #include 27 | #include 28 | 29 | #include "espeakup.h" 30 | 31 | // path to our pid file 32 | char *pidPath = "/var/run/espeakup.pid"; 33 | 34 | int debug = 0; 35 | enum espeakup_mode_t espeakup_mode = ESPEAKUP_MODE_SPEAKUP; 36 | struct queue_t *synth_queue = NULL; 37 | 38 | int self_pipe_fds[2]; 39 | volatile int should_run = 1; 40 | espeak_AUDIO_OUTPUT audio_mode; 41 | 42 | pthread_cond_t runner_awake = PTHREAD_COND_INITIALIZER; 43 | pthread_cond_t wake_stop = PTHREAD_COND_INITIALIZER; 44 | pthread_cond_t stop_acknowledged = PTHREAD_COND_INITIALIZER; 45 | pthread_mutex_t queue_guard = PTHREAD_MUTEX_INITIALIZER; 46 | 47 | int espeakup_start_daemon(void) 48 | { 49 | int fds[2]; 50 | pid_t pid; 51 | char c; 52 | 53 | if (pipe(fds) < 0) { 54 | perror("pipe"); 55 | exit(1); 56 | } 57 | pid = fork(); 58 | 59 | if (pid < 0) { 60 | perror("fork"); 61 | exit(1); 62 | } 63 | if (pid) { 64 | // Parent, just wait for daemon 65 | if (read(fds[0], &c, 1) < 0) { 66 | printf("Espeakup is already running!\n"); 67 | exit(1); 68 | } 69 | exit(c); 70 | } 71 | 72 | // Child, create new session 73 | setsid(); 74 | pid = fork(); 75 | if (pid) 76 | // Intermediate child, just exit 77 | exit(0); 78 | 79 | // Child 80 | if (chdir("/") < 0) { 81 | c = 1; 82 | (void) write(fds[1], &c, 1); 83 | exit(1); 84 | } 85 | return fds[1]; 86 | } 87 | 88 | int espeakup_is_running(void) 89 | { 90 | int pidFile; 91 | int n; 92 | char s[16]; 93 | pid_t pid; 94 | 95 | pidFile = open(pidPath, O_RDWR | O_CREAT, 0666); 96 | if (pidFile < 0) { 97 | printf("Can not work with the pid file %s: %s\n", pidPath, 98 | strerror(errno)); 99 | return -1; 100 | } 101 | 102 | if (flock(pidFile, LOCK_EX) < 0) { 103 | printf("Can not lock the pid file %s: %s\n", pidPath, strerror(errno)); 104 | goto error; 105 | } 106 | n = read(pidFile, s, sizeof(s) - 1); 107 | if (n < 0) { 108 | printf("Can not read the pid file %s: %s\n", pidPath, strerror(errno)); 109 | goto error; 110 | } 111 | s[n] = 0; 112 | n = sscanf(s, "%d", &pid); 113 | if (n == 1 && (!kill(pid, 0) || errno != ESRCH)) { 114 | // Already running 115 | close(pidFile); 116 | return 1; 117 | } 118 | if (ftruncate(pidFile, 0) < 0) { 119 | printf("Could not truncate the pid file %s: %s\n", pidPath, 120 | strerror(errno)); 121 | goto error; 122 | } 123 | lseek(pidFile, 0, SEEK_SET); 124 | n = snprintf(s, sizeof(s), "%d", getpid()); 125 | if (write(pidFile, s, n) < 0) { 126 | printf("Could not write to the pid file %s: %s\n", pidPath, 127 | strerror(errno)); 128 | goto error; 129 | } 130 | close(pidFile); 131 | return 0; 132 | 133 | error: 134 | close(pidFile); 135 | return -1; 136 | } 137 | 138 | int main(int argc, char **argv) 139 | { 140 | int fd, devnull; 141 | char ret = 0; 142 | sigset_t sigset; 143 | int err; 144 | pthread_t signal_thread_id; 145 | pthread_t espeak_thread_id; 146 | pthread_t softsynth_thread_id; 147 | struct synth_t s = { 148 | .voice = "", 149 | }; 150 | synth_queue = new_queue(); 151 | 152 | if (!synth_queue) { 153 | fprintf(stderr, "Unable to allocate memory.\n"); 154 | return 2; 155 | } 156 | 157 | // set up the pipe used to wake the espeak thread 158 | if (pipe(self_pipe_fds) < 0) { 159 | perror("Unable to create pipe"); 160 | return 5; 161 | } 162 | 163 | // process command line options 164 | process_cli(argc, argv); 165 | 166 | if (!debug && espeakup_mode == ESPEAKUP_MODE_SPEAKUP) { 167 | fd = espeakup_start_daemon(); 168 | 169 | if (espeakup_is_running()) { 170 | printf("Espeakup is already running!\n"); 171 | ret = 1; 172 | goto out; 173 | } 174 | 175 | devnull = open("/dev/null", O_RDWR); 176 | dup2(devnull, STDIN_FILENO); 177 | dup2(devnull, STDOUT_FILENO); 178 | dup2(devnull, STDERR_FILENO); 179 | if (devnull > 2) 180 | close(devnull); 181 | } 182 | 183 | // create the signal processing thread here. 184 | err = pthread_create(&signal_thread_id, NULL, signal_thread, NULL); 185 | if (err != 0) { 186 | ret = 4; 187 | goto out; 188 | } 189 | 190 | /* 191 | * Set up the signal mask which will be the default for all threads. 192 | * We are handling sigint and sigterm, so block them. 193 | */ 194 | sigemptyset(&sigset); 195 | sigaddset(&sigset, SIGINT); 196 | sigaddset(&sigset, SIGTERM); 197 | sigprocmask(SIG_BLOCK, &sigset, NULL); 198 | 199 | // Initialize espeak 200 | if (initialize_espeak(&s) < 0) { 201 | ret = 2; 202 | goto out; 203 | } 204 | 205 | // open the softsynth 206 | if (open_softsynth() < 0) { 207 | ret = 2; 208 | goto out; 209 | } 210 | 211 | // Spawn our softsynth thread. 212 | err = pthread_create(&softsynth_thread_id, NULL, softsynth_thread, &s); 213 | if (err != 0) { 214 | ret = 4; 215 | goto out; 216 | } 217 | 218 | // Spawn our espeak-interacting thread. 219 | err = pthread_create(&espeak_thread_id, NULL, espeak_thread, &s); 220 | if (err != 0) { 221 | ret = 4; 222 | goto out; 223 | } 224 | 225 | if (!debug && espeakup_mode == ESPEAKUP_MODE_SPEAKUP) 226 | (void) write(fd, &ret, 1); 227 | 228 | // wait for the threads to shut down. 229 | pthread_join(signal_thread_id, NULL); 230 | pthread_join(softsynth_thread_id, NULL); 231 | pthread_join(espeak_thread_id, NULL); 232 | 233 | if (!paused_espeak) 234 | espeak_Terminate(); 235 | close_softsynth(); 236 | 237 | out: 238 | if (!debug && espeakup_mode == ESPEAKUP_MODE_SPEAKUP) { 239 | if (ret != 1) 240 | unlink(pidPath); 241 | if (ret != 0) 242 | (void) write(fd, &ret, 1); 243 | // If ret was 0, the status byte was written before joining the threads. 244 | } 245 | return ret; 246 | } 247 | -------------------------------------------------------------------------------- /src/softsynth.c: -------------------------------------------------------------------------------- 1 | /* 2 | * espeakup - interface which allows speakup to use espeak-ng 3 | * 4 | * Copyright (C) 2008 William Hubbs 5 | * 6 | * This program is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program. If not, see . 18 | */ 19 | 20 | #include 21 | #include 22 | #include 23 | #include 24 | #include 25 | #include 26 | #include 27 | #include 28 | 29 | #include "espeakup.h" 30 | #include "stringhandling.h" 31 | 32 | // max buffer size 33 | static const size_t maxBufferSize = 16 * 1024 + 1; 34 | 35 | // synth flush character 36 | static const int synthFlushChar = 0x18; 37 | 38 | static int softFD = 0; 39 | 40 | // Text accumulator: 41 | char *textAccumulator; 42 | int textAccumulator_l; 43 | 44 | static void queue_add_cmd(enum command_t cmd, enum adjust_t adj, int value) 45 | { 46 | struct espeak_entry_t *entry; 47 | int added = 0; 48 | 49 | entry = allocMem(sizeof(struct espeak_entry_t)); 50 | entry->cmd = cmd; 51 | entry->adjust = adj; 52 | entry->value = value; 53 | pthread_mutex_lock(&queue_guard); 54 | added = queue_add(synth_queue, (void *) entry); 55 | if (!added) 56 | free(entry); 57 | else 58 | pthread_cond_signal(&runner_awake); 59 | pthread_mutex_unlock(&queue_guard); 60 | } 61 | 62 | static void queue_add_text(char *txt, size_t length) 63 | { 64 | struct espeak_entry_t *entry; 65 | int added = 0; 66 | 67 | entry = allocMem(sizeof(struct espeak_entry_t)); 68 | entry->cmd = CMD_SPEAK_TEXT; 69 | entry->adjust = ADJ_SET; 70 | entry->buf = strdup(txt); 71 | if (!entry->buf) { 72 | perror("unable to allocate space for text"); 73 | free(entry); 74 | return; 75 | } 76 | entry->len = length; 77 | pthread_mutex_lock(&queue_guard); 78 | added = queue_add(synth_queue, (void *) entry); 79 | if (!added) { 80 | free(entry->buf); 81 | free(entry); 82 | } else { 83 | pthread_cond_signal(&runner_awake); 84 | } 85 | 86 | pthread_mutex_unlock(&queue_guard); 87 | } 88 | 89 | static int process_command(struct synth_t *s, char *buf, int start) 90 | { 91 | char *cp; 92 | int value; 93 | enum adjust_t adj; 94 | enum command_t cmd; 95 | 96 | cp = buf + start; 97 | switch (*cp) { 98 | case 1: 99 | cp++; 100 | switch (*cp) { 101 | case '+': 102 | adj = ADJ_INC; 103 | cp++; 104 | break; 105 | case '-': 106 | adj = ADJ_DEC; 107 | cp++; 108 | break; 109 | default: 110 | adj = ADJ_SET; 111 | break; 112 | } 113 | 114 | value = 0; 115 | while (isdigit(*cp)) { 116 | value = value * 10 + (*cp - '0'); 117 | cp++; 118 | } 119 | 120 | switch (*cp) { 121 | case 'b': 122 | cmd = CMD_SET_PUNCTUATION; 123 | break; 124 | case 'f': 125 | cmd = CMD_SET_FREQUENCY; 126 | break; 127 | case 'i': 128 | cmd = CMD_SET_MARK; 129 | break; 130 | case 'p': 131 | cmd = CMD_SET_PITCH; 132 | break; 133 | case 'r': 134 | cmd = CMD_SET_RANGE; 135 | break; 136 | case 's': 137 | cmd = CMD_SET_RATE; 138 | break; 139 | case 'v': 140 | cmd = CMD_SET_VOLUME; 141 | break; 142 | case 'P': 143 | cmd = CMD_PAUSE; 144 | break; 145 | default: 146 | cmd = CMD_UNKNOWN; 147 | break; 148 | } 149 | cp++; 150 | break; 151 | default: 152 | cmd = CMD_UNKNOWN; 153 | cp++; 154 | break; 155 | } 156 | 157 | if (cmd != CMD_FLUSH && cmd != CMD_UNKNOWN) { 158 | if (espeakup_mode == ESPEAKUP_MODE_ACSINT && textAccumulator_l != 0) { 159 | queue_add_text(textAccumulator, textAccumulator_l); 160 | free(textAccumulator); 161 | textAccumulator = initString(&textAccumulator_l); 162 | } 163 | queue_add_cmd(cmd, adj, value); 164 | } 165 | 166 | return cp - (buf + start); 167 | } 168 | 169 | static void process_buffer(struct synth_t *s, char *buf, ssize_t length) 170 | { 171 | int start; 172 | int end; 173 | char txtBuf[maxBufferSize]; 174 | size_t txtLen; 175 | 176 | start = 0; 177 | end = 0; 178 | while (start < length) { 179 | while ((buf[end] < 0 || buf[end] >= ' ' || buf[end] == '\n') && 180 | end < length) 181 | end++; 182 | if (end != start) { 183 | txtLen = end - start; 184 | strncpy(txtBuf, buf + start, txtLen); 185 | *(txtBuf + txtLen) = 0; 186 | queue_add_text(txtBuf, txtLen); 187 | } 188 | if (end < length) 189 | start = end = end + process_command(s, buf, end); 190 | else 191 | start = length; 192 | } 193 | } 194 | 195 | static void process_buffer_acsint(struct synth_t *s, char *buf, ssize_t length) 196 | { 197 | int start = 0; 198 | int i; 199 | int flushIt = 0; 200 | 201 | while (start < length) { 202 | for (i = start; i < length; i++) { 203 | if (buf[i] == '\r' || buf[i] == '\n') 204 | flushIt = 1; 205 | if (buf[i] >= 0 && buf[i] < ' ') 206 | break; 207 | } 208 | if (i > start) 209 | stringAndBytes(&textAccumulator, &textAccumulator_l, buf + start, 210 | i - start); 211 | if (flushIt) { 212 | if (textAccumulator != EMPTYSTRING) { 213 | queue_add_text(textAccumulator, textAccumulator_l); 214 | free(textAccumulator); 215 | textAccumulator = initString(&textAccumulator_l); 216 | } 217 | flushIt = 0; 218 | } 219 | if (i < length) 220 | start = i = i + process_command(s, buf, i); 221 | else 222 | start = length; 223 | } 224 | } 225 | 226 | static void request_espeak_stop(void) 227 | { 228 | pthread_mutex_lock(&queue_guard); 229 | stop_requested = 1; 230 | pthread_cond_signal(&runner_awake); // Wake runner, if necessary. 231 | pthread_cond_signal(&wake_stop); // Wake runner, if necessary. 232 | while (should_run && stop_requested) 233 | // wait for acknowledgement. 234 | pthread_cond_wait(&stop_acknowledged, &queue_guard); 235 | pthread_mutex_unlock(&queue_guard); 236 | } 237 | 238 | int open_softsynth(void) 239 | { 240 | int rc = 0; 241 | // If we're in acsint mode, we read from stdin. No need to open. 242 | if (espeakup_mode == ESPEAKUP_MODE_ACSINT) { 243 | softFD = STDIN_FILENO; 244 | return 0; 245 | } 246 | 247 | // open the softsynth. 248 | softFD = open("/dev/softsynthu", O_RDWR | O_NONBLOCK); 249 | if (softFD < 0 && errno == ENOENT) 250 | // Kernel without unicode support? Try without unicode. 251 | softFD = open("/dev/softsynth", O_RDWR | O_NONBLOCK); 252 | if (softFD < 0) { 253 | perror("Unable to open the /dev/softsynth device"); 254 | rc = -1; 255 | } 256 | return rc; 257 | } 258 | 259 | void close_softsynth(void) 260 | { 261 | if (softFD) 262 | close(softFD); 263 | } 264 | 265 | void *softsynth_thread(void *arg) 266 | { 267 | struct synth_t *s = (struct synth_t *) arg; 268 | fd_set set; 269 | ssize_t length; 270 | char buf[maxBufferSize]; 271 | char *cp; 272 | int terminalFD = PIPE_READ_FD; 273 | int greatestFD; 274 | 275 | textAccumulator = initString(&textAccumulator_l); 276 | 277 | if (terminalFD > softFD) 278 | greatestFD = terminalFD; 279 | else 280 | greatestFD = softFD; 281 | pthread_mutex_lock(&queue_guard); 282 | while (should_run) { 283 | pthread_mutex_unlock(&queue_guard); 284 | FD_ZERO(&set); 285 | FD_SET(softFD, &set); 286 | FD_SET(terminalFD, &set); 287 | 288 | if (select(greatestFD + 1, &set, NULL, NULL, NULL) < 0) { 289 | if (errno == EINTR) { 290 | pthread_mutex_lock(&queue_guard); 291 | continue; 292 | } 293 | perror("Select failed"); 294 | pthread_mutex_lock(&queue_guard); 295 | break; 296 | } 297 | 298 | if (FD_ISSET(terminalFD, &set)) { 299 | pthread_mutex_lock(&queue_guard); 300 | break; 301 | } 302 | 303 | if (!FD_ISSET(softFD, &set)) { 304 | pthread_mutex_lock(&queue_guard); 305 | continue; 306 | } 307 | 308 | length = read(softFD, buf, maxBufferSize - 1); 309 | if (length < 0) { 310 | if (errno == EAGAIN || errno == EINTR) { 311 | pthread_mutex_lock(&queue_guard); 312 | continue; 313 | } 314 | perror("Read from softsynth failed"); 315 | pthread_mutex_lock(&queue_guard); 316 | break; 317 | } 318 | *(buf + length) = 0; 319 | cp = strrchr(buf, synthFlushChar); 320 | if (cp) { 321 | request_espeak_stop(); 322 | memmove(buf, cp + 1, strlen(cp + 1) + 1); 323 | length = strlen(buf); 324 | } 325 | if (espeakup_mode == ESPEAKUP_MODE_SPEAKUP) 326 | process_buffer(s, buf, length); 327 | else 328 | process_buffer_acsint(s, buf, length); 329 | pthread_mutex_lock(&queue_guard); 330 | } 331 | pthread_cond_signal(&runner_awake); 332 | pthread_mutex_unlock(&queue_guard); 333 | return NULL; 334 | } 335 | 336 | void softsynth_reportindex(int index) 337 | { 338 | if (espeakup_mode == ESPEAKUP_MODE_ACSINT) { 339 | putchar(index); 340 | fflush(stdout); 341 | } else { 342 | char buf[16]; 343 | snprintf(buf, sizeof(buf), "%d", index); 344 | if (write(softFD, buf, strlen(buf)) < 0) 345 | perror("Writing index failed"); 346 | } 347 | } 348 | -------------------------------------------------------------------------------- /src/espeak.c: -------------------------------------------------------------------------------- 1 | /* 2 | * espeakup - interface which allows speakup to use espeak-ng 3 | * 4 | * Copyright (C) 2008 William Hubbs 5 | * 6 | * This program is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program. If not, see . 18 | */ 19 | 20 | #define _GNU_SOURCE 21 | #include 22 | #include 23 | #include 24 | #include 25 | #include 26 | #include 27 | 28 | #include "espeakup.h" 29 | 30 | /* default voice settings */ 31 | const int defaultFrequency = 5; 32 | const int defaultPitch = 5; 33 | const int defaultRange = 5; 34 | const int defaultRate = 2; 35 | const int defaultVolume = 5; 36 | char *defaultVoice = NULL; 37 | int alsaVolume = 0; 38 | 39 | /* multipliers and offsets */ 40 | const int frequencyMultiplier = 11; 41 | const int pitchMultiplier = 11; 42 | const int rangeMultiplier = 11; 43 | const int rateMultiplier = 41; 44 | const int rateOffset = 80; 45 | const int volumeMultiplier = 22; 46 | 47 | volatile int stop_requested = 0; 48 | int paused_espeak = 1; 49 | 50 | static int callback(short *wav, int numsamples, espeak_EVENT *events) 51 | { 52 | int i; 53 | for (i = 0; events[i].type != espeakEVENT_LIST_TERMINATED; i++) { 54 | if (events[i].type == espeakEVENT_MARK) { 55 | int mark = atoi(events[i].id.name); 56 | if ((mark < 0) || (mark > 255)) 57 | continue; 58 | softsynth_reportindex(mark); 59 | } 60 | } 61 | return 0; 62 | } 63 | 64 | static espeak_ERROR set_frequency(struct synth_t *s, int freq, 65 | enum adjust_t adj) 66 | { 67 | espeak_ERROR rc; 68 | 69 | if (adj == ADJ_DEC) 70 | freq = -freq; 71 | if (adj != ADJ_SET) 72 | freq += s->frequency; 73 | rc = espeak_SetParameter(espeakRANGE, freq * frequencyMultiplier, 0); 74 | if (rc == EE_OK) 75 | s->frequency = freq; 76 | return rc; 77 | } 78 | 79 | static espeak_ERROR set_pitch(struct synth_t *s, int pitch, enum adjust_t adj) 80 | { 81 | espeak_ERROR rc; 82 | 83 | if (adj == ADJ_DEC) 84 | pitch = -pitch; 85 | if (adj != ADJ_SET) 86 | pitch += s->pitch; 87 | rc = espeak_SetParameter(espeakPITCH, pitch * pitchMultiplier, 0); 88 | if (rc == EE_OK) 89 | s->pitch = pitch; 90 | return rc; 91 | } 92 | 93 | static espeak_ERROR set_range(struct synth_t *s, int range, enum adjust_t adj) 94 | { 95 | espeak_ERROR rc; 96 | 97 | if (adj == ADJ_DEC) 98 | range = -range; 99 | if (adj != ADJ_SET) 100 | range += s->range; 101 | rc = espeak_SetParameter(espeakRANGE, range * rangeMultiplier, 0); 102 | if (rc == EE_OK) 103 | s->range = range; 104 | return rc; 105 | } 106 | 107 | static espeak_ERROR set_punctuation(struct synth_t *s, int punct, 108 | enum adjust_t adj) 109 | { 110 | espeak_ERROR rc; 111 | espeak_PUNCT_TYPE espeak_punct; 112 | 113 | if (adj == ADJ_DEC) 114 | punct = -punct; 115 | if (adj != ADJ_SET) 116 | punct += s->punct; 117 | 118 | switch (punct) { 119 | case 0: 120 | espeak_punct = espeakPUNCT_NONE; 121 | break; 122 | case 1: 123 | espeak_punct = espeakPUNCT_SOME; 124 | break; 125 | case 2: 126 | /* XXX: approximation */ 127 | espeak_punct = espeakPUNCT_SOME; 128 | break; 129 | case 3: 130 | default: 131 | espeak_punct = espeakPUNCT_ALL; 132 | break; 133 | } 134 | 135 | rc = espeak_SetParameter(espeakPUNCTUATION, espeak_punct, 0); 136 | if (rc == EE_OK) 137 | s->punct = punct; 138 | return rc; 139 | } 140 | 141 | static espeak_ERROR set_rate(struct synth_t *s, int rate, enum adjust_t adj) 142 | { 143 | espeak_ERROR rc; 144 | 145 | if (adj == ADJ_DEC) 146 | rate = -rate; 147 | if (adj != ADJ_SET) 148 | rate += s->rate; 149 | rc = espeak_SetParameter(espeakRATE, rate * rateMultiplier + rateOffset, 0); 150 | if (rc == EE_OK) 151 | s->rate = rate; 152 | return rc; 153 | } 154 | 155 | static espeak_ERROR set_voice(struct synth_t *s, char *voice) 156 | { 157 | espeak_ERROR rc; 158 | espeak_VOICE voice_select; 159 | 160 | rc = espeak_SetVoiceByName(voice); 161 | if (rc != EE_OK) { 162 | memset(&voice_select, 0, sizeof(voice_select)); 163 | voice_select.languages = voice; 164 | rc = espeak_SetVoiceByProperties(&voice_select); 165 | } 166 | if (rc == EE_OK) 167 | strcpy(s->voice, voice); 168 | return rc; 169 | } 170 | 171 | static void set_alsa_volume(int vol) 172 | { 173 | snd_mixer_t *m; 174 | snd_mixer_elem_t *e; 175 | int err; 176 | 177 | err = snd_mixer_open(&m, 0); 178 | if (err < 0) { 179 | fprintf(stderr, "ALSA mixer open error: %s\n", snd_strerror(err)); 180 | return; 181 | } 182 | 183 | err = snd_mixer_attach(m, "default"); 184 | if (err < 0) { 185 | fprintf(stderr, "ALSA mixer attach error: %s\n", snd_strerror(err)); 186 | return; 187 | } 188 | err = snd_mixer_selem_register(m, NULL, NULL); 189 | if (err < 0) { 190 | fprintf(stderr, "ALSA mixer load error: %s\n", snd_strerror(err)); 191 | return; 192 | } 193 | err = snd_mixer_load(m); 194 | if (err < 0) { 195 | fprintf(stderr, "ALSA mixer load error: %s\n", snd_strerror(err)); 196 | return; 197 | } 198 | 199 | /* Turn vol value to volume %. 200 | * We do not want to soften that much with ALSA, espeak is already 201 | * doing it. We want the default value (5) to be the usual default 202 | * volume (80%), and make higher values increase ALSA volume, up to 203 | * 100%. */ 204 | 205 | int volume = (vol + 1) * 50 / 10 + 50; 206 | 207 | for (e = snd_mixer_first_elem(m); e; e = snd_mixer_elem_next(e)) { 208 | if (snd_mixer_elem_get_type(e) != SND_MIXER_ELEM_SIMPLE) 209 | continue; 210 | if (snd_mixer_selem_is_enumerated(e)) 211 | continue; 212 | 213 | if (snd_mixer_selem_has_playback_switch(e)) { 214 | snd_mixer_selem_set_playback_switch_all(e, 1); 215 | } 216 | 217 | if (snd_mixer_selem_has_playback_volume(e)) { 218 | long min, max, set; 219 | 220 | err = snd_mixer_selem_get_playback_dB_range(e, &min, &max); 221 | if (err == 0 && min < max) { 222 | if (max - min < 2400) { 223 | /* 24dB amplitude is too small for using a logscale */ 224 | set = min + volume * (max - min) / 100; 225 | } else { 226 | /* Use a logscale */ 227 | double volf = volume / 100.; 228 | if (min != SND_CTL_TLV_DB_GAIN_MUTE) { 229 | double minf = pow(10, (min - max) / 6000.); 230 | volf = volf * (1 - minf) + minf; 231 | } 232 | set = 6000. * log10(volf) + max; 233 | } 234 | snd_mixer_selem_set_playback_dB_all(e, set, 0); 235 | } else { 236 | /* No dB setting, try a linear scale */ 237 | snd_mixer_selem_get_playback_volume_range(e, &min, &max); 238 | set = min + volume * (max - min) / 100; 239 | snd_mixer_selem_set_playback_volume_all(e, set); 240 | } 241 | } 242 | } 243 | } 244 | 245 | static espeak_ERROR set_volume(struct synth_t *s, int vol, enum adjust_t adj) 246 | { 247 | espeak_ERROR rc; 248 | 249 | if (adj == ADJ_DEC) 250 | vol = -vol; 251 | if (adj != ADJ_SET) 252 | vol += s->volume; 253 | rc = espeak_SetParameter(espeakVOLUME, (vol + 1) * volumeMultiplier, 0); 254 | if (rc == EE_OK) { 255 | s->volume = vol; 256 | if (alsaVolume) 257 | set_alsa_volume(vol); 258 | } 259 | 260 | return rc; 261 | } 262 | 263 | static espeak_ERROR stop_speech(void) 264 | { 265 | espeak_ERROR rc; 266 | 267 | rc = espeak_Cancel(); 268 | return rc; 269 | } 270 | 271 | static espeak_ERROR speak_text(struct synth_t *s) 272 | { 273 | espeak_ERROR rc; 274 | int synth_mode = 0; 275 | 276 | if (espeakup_mode == ESPEAKUP_MODE_ACSINT) 277 | synth_mode |= espeakSSML; 278 | 279 | if (espeakup_mode == ESPEAKUP_MODE_SPEAKUP && (s->len == 1)) { 280 | char *buf; 281 | int n; 282 | if (s->buf[0] == ' ') 283 | n = asprintf(&buf, 284 | " "); 285 | else 286 | n = asprintf(&buf, 287 | "%c", 288 | s->buf[0]); 289 | if (n == -1) { 290 | /* D'oh. Not much to do on allocation failure. 291 | * Perhaps espeak will happen to say the character */ 292 | rc = espeak_Synth(s->buf, s->len + 1, 0, POS_CHARACTER, 0, 293 | synth_mode, NULL, NULL); 294 | } else { 295 | rc = espeak_Synth(buf, n + 1, 0, POS_CHARACTER, 0, espeakSSML, NULL, 296 | NULL); 297 | free(buf); 298 | } 299 | } else 300 | rc = espeak_Synth(s->buf, s->len + 1, 0, POS_CHARACTER, 0, synth_mode, 301 | NULL, NULL); 302 | return rc; 303 | } 304 | 305 | static void free_espeak_entry(struct espeak_entry_t *entry) 306 | { 307 | assert(entry); 308 | if (entry->cmd == CMD_SPEAK_TEXT) 309 | free(entry->buf); 310 | free(entry); 311 | } 312 | 313 | static void synth_queue_clear() 314 | { 315 | struct espeak_entry_t *current; 316 | 317 | while (queue_peek(synth_queue)) { 318 | current = (struct espeak_entry_t *) queue_remove(synth_queue); 319 | free_espeak_entry(current); 320 | } 321 | } 322 | 323 | static void reinitialize_espeak(struct synth_t *s) 324 | { 325 | int rate; 326 | 327 | /* Re-initialize espeak */ 328 | rate = espeak_Initialize(AUDIO_OUTPUT_PLAYBACK, 0, NULL, 0); 329 | if (rate < 0) { 330 | fprintf(stderr, "Unable to initialize espeak.\n"); 331 | return; 332 | } 333 | 334 | espeak_SetSynthCallback(callback); 335 | 336 | /* Set parameters again */ 337 | espeak_SetVoiceByName(s->voice); 338 | espeak_SetParameter(espeakRANGE, s->frequency * frequencyMultiplier, 0); 339 | espeak_SetParameter(espeakPITCH, s->pitch * pitchMultiplier, 0); 340 | espeak_SetParameter(espeakRATE, s->rate * rateMultiplier + rateOffset, 0); 341 | espeak_SetParameter(espeakVOLUME, (s->volume + 1) * volumeMultiplier, 0); 342 | espeak_SetParameter(espeakCAPITALS, 0, 0); 343 | paused_espeak = 0; 344 | return; 345 | } 346 | 347 | static struct espeak_entry_t *current = NULL; 348 | static void queue_process_entry(struct synth_t *s) 349 | { 350 | espeak_ERROR error = EE_OK; 351 | char markbuff[50]; 352 | 353 | if (current != queue_peek(synth_queue)) { 354 | if (current) 355 | free_espeak_entry(current); 356 | current = queue_peek(synth_queue); 357 | } 358 | pthread_mutex_unlock(&queue_guard); 359 | 360 | if (current->cmd != CMD_PAUSE && paused_espeak) { 361 | reinitialize_espeak(s); 362 | } 363 | 364 | switch (current->cmd) { 365 | case CMD_SET_FREQUENCY: 366 | error = set_frequency(s, current->value, current->adjust); 367 | break; 368 | case CMD_SET_MARK: 369 | snprintf(markbuff, sizeof(markbuff), "", 370 | current->value); 371 | error = espeak_Synth(markbuff, strlen(markbuff) + 1, 0, POS_CHARACTER, 372 | 0, espeakSSML, NULL, NULL); 373 | break; 374 | case CMD_SET_PITCH: 375 | error = set_pitch(s, current->value, current->adjust); 376 | break; 377 | case CMD_SET_RANGE: 378 | error = set_range(s, current->value, current->adjust); 379 | break; 380 | case CMD_SET_PUNCTUATION: 381 | error = set_punctuation(s, current->value, current->adjust); 382 | break; 383 | case CMD_SET_RATE: 384 | error = set_rate(s, current->value, current->adjust); 385 | break; 386 | case CMD_SET_VOICE: 387 | error = EE_OK; 388 | break; 389 | case CMD_SET_VOLUME: 390 | error = set_volume(s, current->value, current->adjust); 391 | break; 392 | case CMD_SPEAK_TEXT: 393 | s->buf = current->buf; 394 | s->len = current->len; 395 | error = speak_text(s); 396 | break; 397 | case CMD_PAUSE: 398 | if (!paused_espeak) { 399 | error = espeak_Cancel(); 400 | if (error == EE_OK) 401 | error = espeak_Terminate(); 402 | if (error == EE_OK) 403 | paused_espeak = 1; 404 | } else { 405 | error = EE_OK; 406 | } 407 | break; 408 | default: 409 | /* Uh? */ 410 | error = EE_OK; 411 | break; 412 | } 413 | 414 | pthread_mutex_lock(&queue_guard); 415 | if (error == EE_OK) { 416 | /* Processed, drop it */ 417 | struct espeak_entry_t *unqueued = queue_remove(synth_queue); 418 | assert(unqueued == current); 419 | free_espeak_entry(current); 420 | current = NULL; 421 | } else { 422 | if (error == EE_BUFFER_FULL) 423 | { 424 | /* Give speak a little break before retrying */ 425 | struct timespec timeout; 426 | clock_gettime(CLOCK_REALTIME, &timeout); 427 | timeout.tv_sec++; 428 | /* But wake up immediately if we have to stop */ 429 | pthread_cond_timedwait(&wake_stop, &queue_guard, &timeout); 430 | } 431 | else 432 | fprintf(stderr, "espeak error: %d\n", error); 433 | } 434 | } 435 | 436 | int initialize_espeak(struct synth_t *s) 437 | { 438 | int rate; 439 | 440 | /* initialize espeak */ 441 | rate = espeak_Initialize(AUDIO_OUTPUT_PLAYBACK, 0, NULL, 0); 442 | if (rate < 0) { 443 | fprintf(stderr, "Unable to initialize espeak.\n"); 444 | return -1; 445 | } 446 | 447 | espeak_SetSynthCallback(callback); 448 | 449 | /* Setup initial voice parameters */ 450 | if (defaultVoice && defaultVoice[0]) { 451 | set_voice(s, defaultVoice); 452 | free(defaultVoice); 453 | defaultVoice = NULL; 454 | } 455 | set_frequency(s, defaultFrequency, ADJ_SET); 456 | set_pitch(s, defaultPitch, ADJ_SET); 457 | set_range(s, defaultRange, ADJ_SET); 458 | set_rate(s, defaultRate, ADJ_SET); 459 | set_volume(s, defaultVolume, ADJ_SET); 460 | espeak_SetParameter(espeakCAPITALS, 0, 0); 461 | paused_espeak = 0; 462 | return 0; 463 | } 464 | 465 | /* espeak_thread is the "main" function of our secondary (queue-processing) 466 | * thread. 467 | * First, lock queue_guard, because it needs to be locked when we call 468 | * pthread_cond_wait on the runner_awake condition variable. 469 | * Next, enter an infinite loop. 470 | * The wait call also unlocks queue_guard, so that the other thread can 471 | * manipulate the queue. 472 | * When runner_awake is signaled, the pthread_cond_wait call re-locks 473 | * queue_guard, and the "queue processor" thread has access to the queue. 474 | * While there is an entry in the queue, call queue_process_entry. 475 | * queue_process_entry unlocks queue_guard after removing an item from the 476 | * queue, so that the main thread doesn't have to wait for us to finish 477 | * processing the entry. So re-lock queue_guard after each call to 478 | * queue_process_entry. 479 | * 480 | * The main thread can add items to the queue in exactly two situations: 481 | * 1. We are waiting on runner_awake, or 482 | * 2. We are processing an entry that has just been removed from the queue. 483 | */ 484 | void *espeak_thread(void *arg) 485 | { 486 | struct synth_t *s = (struct synth_t *) arg; 487 | 488 | pthread_mutex_lock(&queue_guard); 489 | while (should_run) { 490 | while (should_run && !queue_peek(synth_queue) && !stop_requested) 491 | pthread_cond_wait(&runner_awake, &queue_guard); 492 | 493 | if (stop_requested) { 494 | current = NULL; 495 | stop_speech(); 496 | synth_queue_clear(); 497 | stop_requested = 0; 498 | pthread_cond_signal(&stop_acknowledged); 499 | } 500 | 501 | while (should_run && queue_peek(synth_queue) && !stop_requested) { 502 | queue_process_entry(s); 503 | } 504 | } 505 | pthread_cond_signal(&stop_acknowledged); 506 | pthread_mutex_unlock(&queue_guard); 507 | return NULL; 508 | } 509 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------