Linux

FFmpegKit doesn't publish any prebuilt Linux libraries, as it does for other platforms. Therefore, you need to manually build and import FFmpegKit libraries into your projects.

Then, you can use the following API methods to execute FFmpeg and FFprobe commands inside your application.

1. Execute synchronous FFmpeg commands.

   #include <FFmpegKit.h>
   #include <FFmpegKitConfig.h>
   
   using namespace ffmpegkit;
   
   auto session = FFmpegKit::execute("-i file1.mp4 -c:v mpeg4 file2.mp4");
   if (ReturnCode::isSuccess(session->getReturnCode())) {
   
       // SUCCESS
   
   } else if (ReturnCode::isCancel(session->getReturnCode())) {
   
       // CANCEL
   
   } else {
   
       // FAILURE
       std::cout << "Command failed with state " << FFmpegKitConfig::sessionStateToString(session->getState()) << " and rc " << session->getReturnCode() << "." << session->getFailStackTrace() << std::endl;
   
   }

2. Each execute call (sync or async) creates a new session. Access every detail about your execution from the session created.

   #include <FFmpegKit.h>
   #include <FFmpegKitConfig.h>
   
   using namespace ffmpegkit;
   
   auto session = FFmpegKit::execute("-i file1.mp4 -c:v mpeg4 file2.mp4");
   
   // Unique session id created for this execution
   long sessionId = session->getSessionId();
   
   // Command arguments as a single string
   auto command = session->getCommand();
   
   // Command arguments
   auto arguments = session->getArguments();
   
   // State of the execution. Shows whether it is still running or completed
   SessionState state = session->getState();
   
   // Return code for completed sessions. Will be null if session is still running or ends with a failure
   auto returnCode = session->getReturnCode();
   
   auto startTime = session->getStartTime();
   auto endTime = session->getEndTime();
   long duration = session->getDuration();
   
   // Console output generated for this execution
   auto output = session->getOutput();
   
   // The stack trace if FFmpegKit fails to run a command
   auto failStackTrace = session->getFailStackTrace();
   
   // The list of logs generated for this execution
   auto logs = session->getLogs();
   
   // The list of statistics generated for this execution
   auto statistics = session->getStatistics();

3. Execute asynchronous FFmpeg commands by providing session specific execute/log/session callbacks.

   #include <FFmpegKit.h>
   #include <FFmpegKitConfig.h>
   
   using namespace ffmpegkit;
   
   FFmpegKit::executeAsync("-i file1.mp4 -c:v mpeg4 file2.mp4", [](auto session) {
       const auto state = session->getState();
       auto returnCode = session->getReturnCode();
   
       // CALLED WHEN SESSION IS EXECUTED
   
       std::cout << "FFmpeg process exited with state " << FFmpegKitConfig::sessionStateToString(state) << " and rc " << returnCode << "." << session->getFailStackTrace() << std::endl;
   }, [](auto log) {
   
       // CALLED WHEN SESSION PRINTS LOGS
   
   }, [](auto statistics) {
   
       // CALLED WHEN SESSION GENERATES STATISTICS
   
   });

4. Execute FFprobe commands.

   • Synchronous

   #include <FFprobeKit.h>
   #include <FFmpegKitConfig.h>
   
   using namespace ffmpegkit;
   
   auto session = FFprobeKit::execute(ffprobeCommand);
   
   if (!ReturnCode::isSuccess(session->getReturnCode())) {
       std::cout << "Command failed. Please check output for the details." << std::endl;
   }

   • Asynchronous

   #include <FFprobeKit.h>
   #include <FFmpegKitConfig.h>
   
   using namespace ffmpegkit;
   
   FFprobeKit::executeAsync(ffprobeCommand, [](auto session) {
   
       // CALLED WHEN SESSION IS EXECUTED
   
   });

5. Get media information for a file.

   #include <FFprobeKit.h>
   
   using namespace ffmpegkit;
   
   auto mediaInformation = FFprobeKit::getMediaInformation("<file path or uri>");
   mediaInformation->getMediaInformation();

6. Stop ongoing FFmpeg operations.

   • Stop all executions

     FFmpegKit::cancel();

   • Stop a specific session

     FFmpegKit::cancel(sessionId);

7. Get previous FFmpeg and FFprobe sessions from session history.

   #include <FFmpegKitConfig.h>
   
   using namespace ffmpegkit;
   
   auto sessions = FFmpegKitConfig::getSessions();
   int i = 0;
   std::for_each(sessions->begin(), sessions->end(), [](const auto session) {
       std::cout << "Session " << i++ << " = id:" << session->getSessionId() << ", startTime:" << session->getStartTime() << ", duration:" << session-> getDuration() << ", state:" << FFmpegKitConfig::sessionStateToString(session->getState()) << ", returnCode:" << session->getReturnCode() << "." << std::endl;
   });

8. Enable global callbacks.

   • Session type specific Complete Callbacks, called when an async session has been completed

     #include <FFmpegKitConfig.h>
     
     using namespace ffmpegkit;
     
     FFmpegKitConfig::enableFFmpegSessionCompleteCallback([](auto session) {
     
     });
     
     FFmpegKitConfig::enableFFprobeSessionCompleteCallback([](auto session) {
     
     });
     
     FFmpegKitConfig::enableMediaInformationSessionCompleteCallback([](auto session) {
     
     });

   • Log Callback, called when a session generates logs

     #include <FFmpegKitConfig.h>
     
     using namespace ffmpegkit;
     
     FFmpegKitConfig::enableLogCallback([](auto log) {
         ...
     });

   • Statistics Callback, called when a session generates statistics

     #include <FFmpegKitConfig.h>
     
     using namespace ffmpegkit;
     
     FFmpegKitConfig::enableStatisticsCallback([](auto statistics) {
         ...
     });

9. Register system fonts and custom font directories.

   #include <FFmpegKitConfig.h>
   
   using namespace ffmpegkit;
   
   FFmpegKitConfig::setFontDirectoryList(std::list<std::string>{"/usr/share/fonts"}, std::map<std::string,std::string>()));