gtk2_ardour/transcode_ffmpeg.h

   1 /*
   2     Copyright (C) 2010 Paul Davis
   3     Author: 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 __ardour_transcode_ffmpeg_h__
  21 #define __ardour_transcode_ffmpeg_h__
  22
  23 #include <string>
  24 #include "ardour/system_exec.h"
  25 #include "ardour/types.h"
  26
  27
  28 /** @class TranscodeFfmpeg
  29  *  @brief wrapper around ffmpeg and ffprobe command-line utils
  30  *
  31  *  This class includes parsers for stdi/o communication with
  32  *  'ffmpeg' and 'ffprobe' and provide an abstraction to
  33  *  transcode video-files and extract aufio tracks and query
  34  *  file information.
  35  */
  36 class TranscodeFfmpeg : public sigc::trackable
  37                       , public PBD::ScopedConnectionList
  38 {
  39         public:
  40
  41         struct FFAudioStream {
  42                 std::string name;
  43                 std::string stream_id;
  44                 uint32_t channels;
  45         };
  46         typedef std::vector<FFAudioStream> FFAudioStreams;
  47         typedef std::map<std::string,std::string> FFSettings;
  48
  49
  50                 /** instantiate a new transcoder. If a file-name is given, the file's
  51                  * attributes (fps, duration, geometry etc) are read.
  52                  *
  53                  * @param f path to the video-file to probe or use as input for
  54                  * \ref extract_audio and \ref transcode.
  55                  */
  56                 TranscodeFfmpeg (std::string f);
  57                 virtual ~TranscodeFfmpeg ();
  58                 /** transcode/import a video-file
  59                  * @param outfile full-path (incl. file-extension)
  60                  * @param outwidth video-width, \c <0 no scaling)
  61                  * @param outheight video-height \c <0 use aspect \c \ref outwidth /c / \c aspect-ratio
  62                  * @param kbitps video bitrate \c 0 calculate to use 0.7 bits per pixel on average
  63                  * @return \c true if the transcoder process was successfully started.
  64                  */
  65                 bool transcode (std::string, const int outwidth=0, const int outheight=0, const int kbitps =0);
  66                 /** Extract an audio track from the given input file to a new 32bit float little-endian PCM WAV file.
  67                  * @param outfile full-path (incl. file-extension) to .wav file to write
  68                  * @param samplerate target samplerate
  69                  * @param stream Stream-ID of the audio-track to extract
  70                  * specified as element-number in \ref get_audio().
  71                  * @return \c true if the transcoder process was successfully started.
  72                  */
  73                 bool extract_audio (std::string outfile, ARDOUR::samplecnt_t samplerate, unsigned int stream=0);
  74                 /** transcode video and mux audio files into a new video-file.
  75                  * @param outfile full-path of output file to create (existing files are overwritten)
  76                  * @param inf_a filename of input audio-file
  77                  * @param inf_v filename of input video-file
  78                  * @param ffs additional command-line parameters for 'ffmpeg'. key/value pairs
  79                  * eg ffs["-vcodec"] = "mpeg4"
  80                  * @param meta additional meta-data results in -metadata "<key>"="<value>" command-line
  81                  * arguments
  82                  * @param map if set to \c true stream mapping from input streams to output streams is set to use
  83                  * only the first available stream from the audio & video file (-map 0.0 -map 1.0).
  84                  * @return \c true if the encoder process was successfully started.
  85                  */
  86                 bool encode (std::string outfile, std::string inf_a, std::string inf_v, FFSettings ffs, FFSettings meta, bool map = true);
  87                 /** @return array with default encoder settings */
  88                 FFSettings default_encoder_settings ();
  89                 /** @return array with default meta data */
  90                 FFSettings default_meta_data ();
  91                 /** abort any running transcoding process */
  92                 void cancel();
  93                 /**
  94                  * @return \c true if the input file was parsed correctly on class creation. */
  95                 bool probe_ok () { return probeok; }
  96                 /** @return \c true if the ffmpeg/ffparse executables are avail on this system */
  97                 bool ffexec_ok () { return ffexecok; }
  98
  99                 /** signal emitted when ffmpeg reports progress updates
 100                  * during \ref encode \ref transcode and \ref extract_audio
 101                  * The parameters are current and last video-frame.
 102                  */
 103                 PBD::Signal2<void, ARDOUR::samplecnt_t, ARDOUR::samplecnt_t> Progress;
 104                 /** signal emitted when the transcoder process terminates. */
 105                 PBD::Signal0<void> Finished;
 106
 107                 double get_fps () { return m_fps; }
 108                 double get_aspect () { return m_aspect; }
 109                 int    get_width() { return m_width; }
 110                 int    get_height() { return m_height; }
 111                 ARDOUR::samplecnt_t get_duration() { return m_duration; }
 112                 std::string  get_codec() { return m_codec; }
 113
 114                 FFAudioStreams get_audio() { return m_audio; }
 115
 116                 /** override file duration used with the \ref Progress signal.
 117                  * @param d duration in video-frames = length_in_seconds * get_fps()
 118                  */
 119                 void set_duration(ARDOUR::samplecnt_t d) { m_duration = d; }
 120
 121                 /* offset, lead-in/out are in seconds */
 122                 void set_avoffset(double av_offset) { m_avoffset = av_offset; }
 123                 void set_leadinout(double lead_in, double lead_out) { m_lead_in = lead_in; m_lead_out = lead_out; }
 124
 125                 void set_fps(double fps) { m_fps = fps; } // on export, used for rounding only.
 126
 127 #if 1 /* tentative debug mode */
 128                 void   set_debug (bool onoff) { debug_enable = onoff; }
 129 #endif
 130         protected:
 131                 std::string infile;
 132                 ARDOUR::SystemExec  *ffcmd;
 133
 134                 bool probe ();
 135
 136                 double m_fps;
 137                 double m_aspect;
 138                 std::string m_sar;
 139                 ARDOUR::samplecnt_t m_duration;
 140                 int m_width;
 141                 int m_height;
 142                 std::string m_codec;
 143
 144                 int m_videoidx;
 145                 double m_avoffset;
 146                 double m_lead_in;
 147                 double m_lead_out;
 148                 bool ffexecok;
 149                 bool probeok;
 150
 151                 FFAudioStreams m_audio;
 152
 153                 void ffmpegparse_v (std::string d, size_t s);
 154                 void ffmpegparse_a (std::string d, size_t s);
 155                 void ffprobeparse (std::string d, size_t s);
 156                 void ffexit ();
 157                 std::string ffoutput;
 158
 159                 std::string ffmpeg_exe;
 160                 std::string ffprobe_exe;
 161 #if 1 /* tentative debug mode */
 162                 bool debug_enable;
 163 #endif
 164 };
 165
 166 #endif /* __ardour_transcode_ffmpeg_h__ */