libs/pbd/pbd/system_exec.h

   1 /*
   2     Copyright (C) 2010 Paul Davis
   3     Copyright (C) 2010-2014 Robin Gareus <robin@gareus.org>
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 2 of the License, or
   8     (at your option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License
  16     along with this program; if not, write to the Free Software
  17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18
  19 */
  20 #ifndef _libpbd_system_exec_h_
  21 #define _libpbd_system_exec_h_
  22
  23 #ifndef STDIN_FILENO
  24 #define STDIN_FILENO 0
  25 #endif
  26 #ifndef STDOUT_FILENO
  27 #define STDOUT_FILENO 1
  28 #endif
  29 #ifndef STDERR_FILENO
  30 #define STDERR_FILENO 2
  31 #endif
  32
  33 #if defined (__MINGW64__)
  34 #include <windows.h>
  35
  36 #ifdef interface
  37 #undef interface // VKamyshniy: to avoid "include/giomm-2.4/giomm/dbusmessage.h:270:94: error: expected ',' or '...' before 'struct'"
  38 #endif
  39
  40 #endif
  41
  42 #include <string>
  43 #include <pthread.h>
  44 #include <signal.h>
  45 #ifdef NOPBD  /* unit-test outside ardour */
  46 #include <sigc++/bind.h>
  47 #include <sigc++/signal.h>
  48 #else
  49 #include "pbd/signals.h"
  50 #endif
  51
  52 namespace PBD {
  53
  54 /** @class: SystemExec
  55  *  @brief execute an external command
  56  *
  57  * This class allows launche an external command-line application
  58  * opening a full-duplex connection to its standard I/O.
  59  *
  60  * In Ardour context it is used to launch xjadeo and ffmpeg.
  61  *
  62  * The \ref write_to_stdin function provides for injecting data into STDIN
  63  * of the child-application while output of the program to STDOUT/STDERR is
  64  * forwarded using the \ref ReadStdout signal.
  65  * \ref Terminated is sent if the child application exits.
  66  *
  67  */
  68 class LIBPBD_API SystemExec
  69 {
  70         public:
  71                 /** prepare execution of a program with 'execve'
  72                  *
  73                  * This function takes over the existing environment variable and provides
  74                  * an easy way to speciy command-line arguments for the new process.
  75                  *
  76                  * Note: The argument parser does not interpret quotation-marks and splits
  77                  * arugments on whitespace. The argument string can be empty.
  78                  * The alternative constructor below allows to specify quoted parameters
  79                  * incl. whitespace.
  80                  *
  81                  * @param c program pathname that identifies the new process image file.
  82                  * @param a string of commandline-arguments to be passed to the new program.
  83                  */
  84                 SystemExec (std::string c, std::string a = "");
  85                 /** similar to \ref SystemExec but allows to specify custom arguments
  86                  *
  87                  * @param c program pathname that identifies the new process image file.
  88                  * @param a array of argument strings passed to the new program as 'argv'.
  89                  *          it must be terminated by a null pointer (see the 'evecve'
  90                  *          POSIX-C documentation for more information)
  91                  *          The array must be dynamically allocated using malloc or strdup.
  92                  *          Unless they're NULL, the array itself and each of its content
  93                  *          memory is freed() in the destructor.
  94                  *
  95                  */
  96                 SystemExec (std::string c, char ** a);
  97                 virtual ~SystemExec ();
  98
  99                 /** fork and execute the given program
 100                  *
 101                  * @param stderr_mode select what to do with program's standard error
 102                  * output:
 103                  * '0': keep STDERR; mix it with parent-process' STDERR
 104                  * '1': ignore STDERR of child-program
 105                  * '2': merge STDERR into STDOUT and send it with the
 106                  *      ReadStdout signal.
 107                  * @return If the process is already running or was launched successfully
 108                  * the function returns zero (0). A negative number indicates an error.
 109                  */
 110                 int start (int stderr_mode = 1);
 111                 /** kill running child-process
 112                  *
 113                  * if a child process exists trt to shut it down by closing its STDIN.
 114                  * if the program dies not react try SIGTERM and eventually SIGKILL
 115                  */
 116                 void terminate ();
 117                 /** check if the child programm is (still) running.
 118                  *
 119                  * This function calls waitpid(WNOHANG) to check the state of the
 120                  * child-process.
 121                  * @return true if the program is (still) running.
 122                  */
 123                 bool is_running ();
 124                 /** call the waitpid system-call with the pid of the child-program
 125                  *
 126                  * Basically what \ref terminate uses internally.
 127                  *
 128                  * This function is only useful if you want to control application
 129                  * termination yourself (eg timeouts or progress-dialog).
 130                  * @param option flags - see waitpid manual
 131                  * @return status info from waitpid call (not waitpid's return value)
 132                  * or -1 if the child-program is not running.
 133                  */
 134                 int wait (int options=0);
 135                 /** closes both STDIN and STDOUT connections to/from
 136                  * the child-program.
 137                  * With the output-interposer thread gone, the program
 138                  * should terminate.
 139                  * used by \ref terminate()
 140                  */
 141                 void close_stdin ();
 142                 /** write into child-program's STDIN
 143                  * @param d data to write
 144                  * @param len length of data to write, if it is 0 (zero), d.length() is
 145                  * used to determine the number of bytes to transmit.
 146                  * @return number of bytes written.
 147                  */
 148                 int write_to_stdin (std::string d, size_t len=0);
 149
 150                 /** The ReadStdout signal is emitted when the application writes to STDOUT.
 151                  * it passes the written data and its length in bytes as arguments to the bound
 152                  * slot(s).
 153                  */
 154 #ifdef NOPBD  /* outside ardour */
 155                 sigc::signal<void, std::string,size_t> ReadStdout;
 156 #else
 157                 PBD::Signal2<void, std::string,size_t> ReadStdout;
 158 #endif
 159
 160                 /** The Terminated signal is emitted when application terminates. */
 161 #ifdef NOPBD  /* outside ardour */
 162                 sigc::signal<void> Terminated;
 163 #else
 164                 PBD::Signal0<void> Terminated;
 165 #endif
 166
 167                 /** interposer to emit signal for writes to STDOUT/ERR.
 168                  *
 169                  * Thread that reads the stdout of the forked
 170                  * process and signal-sends it to the main thread.
 171                  * It also emits the Terminated() signal once
 172                  * the the forked process closes it's stdout.
 173                  *
 174                  * Note: it's actually 'private' function but used
 175                  * by the internal pthread, which only has a pointer
 176                  * to this instance and thus can only access public fn.
 177                  */
 178                 void output_interposer ();
 179
 180         protected:
 181                 std::string cmd; ///< path to command - set when creating the class
 182                 int nicelevel; ///< process nice level - defaults to 0
 183
 184                 void make_argp(std::string);
 185                 void make_envp();
 186
 187                 char **argp;
 188                 char **envp;
 189
 190         private:
 191 #ifdef PLATFORM_WINDOWS
 192                 PROCESS_INFORMATION *pid;
 193                 HANDLE stdinP[2];
 194                 HANDLE stdoutP[2];
 195                 HANDLE stderrP[2];
 196                 char *w_args;
 197                 void make_wargs(char **);
 198 #else
 199                 pid_t pid;
 200 #endif
 201                 pthread_mutex_t write_lock;
 202
 203                 int fdin; ///< file-descriptor for writing to child's STDIN. This variable is identical to pin[1] but also used as status check if the stdin pipe is open: <0 means closed.
 204                 int pok[2];
 205                 int pin[2];
 206                 int pout[2];
 207
 208                 pthread_t      thread_id_tt;
 209                 bool           thread_active;
 210
 211 }; /* end class */
 212
 213 }; /* end namespace */
 214
 215 #endif /* _libpbd_system_exec_h_ */