1 /*
2  * Copyright (C) 2013-2018 Robin Gareus <robin@gareus.org>
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; either version 2 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License along
15  * with this program; if not, write to the Free Software Foundation, Inc.,
16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
17  */
18 #ifndef __ardour_transcode_ffmpeg_h__
19 #define __ardour_transcode_ffmpeg_h__
20 
21 #include <string>
22 #include "ardour/system_exec.h"
23 #include "ardour/types.h"
24 
25 
26 /** @class TranscodeFfmpeg
27  *  @brief wrapper around ffmpeg and ffprobe command-line utils
28  *
29  *  This class includes parsers for stdi/o communication with
30  *  'ffmpeg' and 'ffprobe' and provide an abstraction to
31  *  transcode video-files and extract aufio tracks and query
32  *  file information.
33  */
34 class TranscodeFfmpeg : public sigc::trackable
35                       , public PBD::ScopedConnectionList
36 {
37 	public:
38 
39 	struct FFAudioStream {
40 		std::string name;
41 		std::string stream_id;
42 		uint32_t channels;
43 	};
44 	typedef std::vector<FFAudioStream> FFAudioStreams;
45 	typedef std::map<std::string,std::string> FFSettings;
46 
47 
48 		/** instantiate a new transcoder. If a file-name is given, the file's
49 		 * attributes (fps, duration, geometry etc) are read.
50 		 *
51 		 * @param f path to the video-file to probe or use as input for \ref extract_audio and \ref transcode .
52 		 */
53 		TranscodeFfmpeg (std::string f);
54 		virtual ~TranscodeFfmpeg ();
55 
56 		/** transcode to (import a video-file)
57 		 *
58 		 * @param outfile full-path (incl. file-extension) of the file to create
59 		 * @param width video-width, if \c <0 no scaling
60 		 * @param height video-height, with \c <0 preserve aspect (\p width \c / \c aspect-ratio)
61 		 * @param kbitps video bitrate, with \c 0 calculate to use 0.7 bits per pixel on average
62 		 * @return \c true if the transcoder process was successfully started.
63 		 */
64 		bool transcode (std::string outfile, const int width=0, const int height=0, const int kbitps =0);
65 
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 
75 		/** transcode video and mux audio files into a new video-file.
76 		 * @param outfile full-path of output file to create (existing files are overwritten)
77 		 * @param inf_a filename of input audio-file
78 		 * @param inf_v filename of input video-file
79 		 * @param ffs additional command-line parameters for 'ffmpeg'. key/value pairs
80 		 * eg ffs["-vcodec"] = "mpeg4"
81 		 * @param meta additional meta-data results in -metadata "<key>"="<value>" command-line
82 		 * arguments
83 		 * @param map if set to \c true stream mapping from input streams to output streams is set to use
84 		 * only the first available stream from the audio & video file (-map 0.0 -map 1.0).
85 		 * @return \c true if the encoder process was successfully started.
86 		 */
87 		bool encode (std::string outfile, std::string inf_a, std::string inf_v, FFSettings ffs, FFSettings meta, bool map = true);
88 
89 		/** @return array with default encoder settings */
90 		FFSettings default_encoder_settings ();
91 		/** @return array with default meta data */
92 		FFSettings default_meta_data ();
93 		/** abort any running transcoding process */
94 		void cancel();
95 		/**
96 		 * @return \c true if the input file was parsed correctly on class creation. */
probe_ok()97 		bool probe_ok () { return probeok; }
98 		/** @return \c true if the ffmpeg/ffparse executables are avail on this system */
ffexec_ok()99 		bool ffexec_ok () { return ffexecok; }
100 
101 		/** signal emitted when ffmpeg reports progress updates
102 		 * during \ref encode \ref transcode and \ref extract_audio
103 		 * The parameters are current and last video-frame.
104 		 */
105 		PBD::Signal2<void, ARDOUR::samplecnt_t, ARDOUR::samplecnt_t> Progress;
106 		/** signal emitted when the transcoder process terminates. */
107 		PBD::Signal0<void> Finished;
108 
get_fps()109 		double get_fps () { return m_fps; }
get_aspect()110 		double get_aspect () { return m_aspect; }
get_width()111 		int    get_width() { return m_width; }
get_height()112 		int    get_height() { return m_height; }
get_duration()113 		ARDOUR::samplecnt_t get_duration() { return m_duration; }
get_codec()114 		std::string  get_codec() { return m_codec; }
115 
get_audio()116 		FFAudioStreams get_audio() { return m_audio; }
117 
118 		/** override file duration used with the \ref Progress signal.
119 		 * @param d duration in video-frames = length_in_seconds * get_fps()
120 		 */
set_duration(ARDOUR::samplecnt_t d)121 		void set_duration(ARDOUR::samplecnt_t d) { m_duration = d; }
122 
123 		/* offset, lead-in/out are in seconds */
set_avoffset(double av_offset)124 		void set_avoffset(double av_offset) { m_avoffset = av_offset; }
set_leadinout(double lead_in,double lead_out)125 		void set_leadinout(double lead_in, double lead_out) { m_lead_in = lead_in; m_lead_out = lead_out; }
126 
set_fps(double fps)127 		void set_fps(double fps) { m_fps = fps; } // on export, used for rounding only.
128 
129 #if 1 /* tentative debug mode */
set_debug(bool onoff)130 		void   set_debug (bool onoff) { debug_enable = onoff; }
131 #endif
132 	protected:
133 		std::string infile;
134 		ARDOUR::SystemExec  *ffcmd;
135 
136 		bool probe ();
137 
138 		double m_fps;
139 		double m_aspect;
140 		std::string m_sar;
141 		ARDOUR::samplecnt_t m_duration;
142 		int m_width;
143 		int m_height;
144 		std::string m_codec;
145 
146 		int m_videoidx;
147 		double m_avoffset;
148 		double m_lead_in;
149 		double m_lead_out;
150 		bool ffexecok;
151 		bool probeok;
152 
153 		FFAudioStreams m_audio;
154 
155 		void ffmpegparse_v (std::string d, size_t s);
156 		void ffmpegparse_a (std::string d, size_t s);
157 		void ffprobeparse (std::string d, size_t s);
158 		void ffexit ();
159 		std::string ffoutput;
160 
161 		std::string ffmpeg_exe;
162 		std::string ffprobe_exe;
163 #if 1 /* tentative debug mode */
164 		bool debug_enable;
165 #endif
166 };
167 
168 #endif /* __ardour_transcode_ffmpeg_h__ */
169