/*
* Copyright (c) 2020-2021 Taner Sener
*
* This file is part of FFmpegKit.
*
* FFmpegKit is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* FFmpegKit is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with FFmpegKit. If not, see
Main class to run FFprobe
commands. Supports executing commands both synchronously and
* asynchronously.
*
* FFprobeSession session = FFprobeKit.execute("-hide_banner -v error -show_entries format=size -of default=noprint_wrappers=1 file1.mp4"); * * FFprobeSession asyncSession = FFprobeKit.executeAsync("-hide_banner -v error -show_entries format=size -of default=noprint_wrappers=1 file1.mp4", executeCallback); **
Provides overloaded execute
methods to define session specific callbacks.
*
* FFprobeSession session = FFprobeKit.executeAsync("-hide_banner -v error -show_entries format=size -of default=noprint_wrappers=1 file1.mp4", executeCallback, logCallback); **
It can extract media information for a file or a url, using {@link #getMediaInformation(String)} method. *
* MediaInformationSession session = FFprobeKit.getMediaInformation("file1.mp4"); **/ public class FFprobeKit { static { AbiDetect.class.getName(); FFmpegKitConfig.class.getName(); } /** * Default constructor hidden. */ private FFprobeKit() { } /** *
Builds the default command used to get media information for a file. * * @param path file path to use in the command * @return default command arguments to get media information */ private static String[] defaultGetMediaInformationCommandArguments(final String path) { return new String[]{"-v", "error", "-hide_banner", "-print_format", "json", "-show_format", "-show_streams", "-show_chapters", "-i", path}; } /** *
Synchronously executes FFprobe with arguments provided. * * @param arguments FFprobe command options/arguments as string array * @return FFprobe session created for this execution */ public static FFprobeSession execute(final String[] arguments) { final FFprobeSession session = new FFprobeSession(arguments); FFmpegKitConfig.ffprobeExecute(session); return session; } /** *
Starts an asynchronous FFprobe execution with arguments provided. * *
Note that this method returns immediately and does not wait the execution to complete. You must use an * {@link ExecuteCallback} if you want to be notified about the result. * * @param arguments FFprobe command options/arguments as string array * @param executeCallback callback that will be called when the execution is completed * @return FFprobe session created for this execution */ public static FFprobeSession executeWithArgumentsAsync(final String[] arguments, final ExecuteCallback executeCallback) { final FFprobeSession session = new FFprobeSession(arguments, executeCallback); FFmpegKitConfig.asyncFFprobeExecute(session); return session; } /** *
Starts an asynchronous FFprobe execution with arguments provided. * *
Note that this method returns immediately and does not wait the execution to complete. You must use an * {@link ExecuteCallback} if you want to be notified about the result. * * @param arguments FFprobe command options/arguments as string array * @param executeCallback callback that will be notified when execution is completed * @param logCallback callback that will receive logs * @return FFprobe session created for this execution */ public static FFprobeSession executeWithArgumentsAsync(final String[] arguments, final ExecuteCallback executeCallback, final LogCallback logCallback) { final FFprobeSession session = new FFprobeSession(arguments, executeCallback, logCallback); FFmpegKitConfig.asyncFFprobeExecute(session); return session; } /** *
Starts an asynchronous FFprobe execution with arguments provided. * *
Note that this method returns immediately and does not wait the execution to complete. You must use an * {@link ExecuteCallback} if you want to be notified about the result. * * @param arguments FFprobe command options/arguments as string array * @param executeCallback callback that will be called when the execution is completed * @param executorService executor service that will be used to run this asynchronous operation * @return FFprobe session created for this execution */ public static FFprobeSession executeWithArgumentsAsync(final String[] arguments, final ExecuteCallback executeCallback, final ExecutorService executorService) { final FFprobeSession session = new FFprobeSession(arguments, executeCallback); FFmpegKitConfig.asyncFFprobeExecute(session, executorService); return session; } /** *
Starts an asynchronous FFprobe execution with arguments provided. * *
Note that this method returns immediately and does not wait the execution to complete. You must use an * {@link ExecuteCallback} if you want to be notified about the result. * * @param arguments FFprobe command options/arguments as string array * @param executeCallback callback that will be notified when execution is completed * @param logCallback callback that will receive logs * @param executorService executor service that will be used to run this asynchronous operation * @return FFprobe session created for this execution */ public static FFprobeSession executeWithArgumentsAsync(final String[] arguments, final ExecuteCallback executeCallback, final LogCallback logCallback, final ExecutorService executorService) { final FFprobeSession session = new FFprobeSession(arguments, executeCallback, logCallback); FFmpegKitConfig.asyncFFprobeExecute(session, executorService); return session; } /** *
Synchronously executes FFprobe command provided. Space character is used to split command * into arguments. You can use single or double quote characters to specify arguments inside * your command. * * @param command FFprobe command * @return FFprobe session created for this execution */ public static FFprobeSession execute(final String command) { return execute(FFmpegKitConfig.parseArguments(command)); } /** *
Starts an asynchronous FFprobe execution for the given command. Space character is used to split the command * into arguments. You can use single or double quote characters to specify arguments inside your command. * *
Note that this method returns immediately and does not wait the execution to complete. You must use an * {@link ExecuteCallback} if you want to be notified about the result. * * @param command FFprobe command * @param executeCallback callback that will be called when the execution is completed * @return FFprobe session created for this execution */ public static FFprobeSession executeAsync(final String command, final ExecuteCallback executeCallback) { return executeWithArgumentsAsync(FFmpegKitConfig.parseArguments(command), executeCallback); } /** *
Starts an asynchronous FFprobe execution for the given command. Space character is used to split the command * into arguments. You can use single or double quote characters to specify arguments inside your command. * *
Note that this method returns immediately and does not wait the execution to complete. You must use an * {@link ExecuteCallback} if you want to be notified about the result. * * @param command FFprobe command * @param executeCallback callback that will be notified when execution is completed * @param logCallback callback that will receive logs * @return FFprobe session created for this execution */ public static FFprobeSession executeAsync(final String command, final ExecuteCallback executeCallback, final LogCallback logCallback) { return executeWithArgumentsAsync(FFmpegKitConfig.parseArguments(command), executeCallback, logCallback); } /** *
Starts an asynchronous FFprobe execution for the given command. Space character is used to split the command * into arguments. You can use single or double quote characters to specify arguments inside your command. * *
Note that this method returns immediately and does not wait the execution to complete. You must use an * {@link ExecuteCallback} if you want to be notified about the result. * * @param command FFprobe command * @param executeCallback callback that will be called when the execution is completed * @param executorService executor service that will be used to run this asynchronous operation * @return FFprobe session created for this execution */ public static FFprobeSession executeAsync(final String command, final ExecuteCallback executeCallback, final ExecutorService executorService) { final FFprobeSession session = new FFprobeSession(FFmpegKitConfig.parseArguments(command), executeCallback); FFmpegKitConfig.asyncFFprobeExecute(session, executorService); return session; } /** *
Starts an asynchronous FFprobe execution for the given command. Space character is used to split the command * into arguments. You can use single or double quote characters to specify arguments inside your command. * *
Note that this method returns immediately and does not wait the execution to complete. You must use an * {@link ExecuteCallback} if you want to be notified about the result. * * @param command FFprobe command * @param executeCallback callback that will be called when the execution is completed * @param logCallback callback that will receive logs * @param executorService executor service that will be used to run this asynchronous operation * @return FFprobe session created for this execution */ public static FFprobeSession executeAsync(final String command, final ExecuteCallback executeCallback, final LogCallback logCallback, final ExecutorService executorService) { final FFprobeSession session = new FFprobeSession(FFmpegKitConfig.parseArguments(command), executeCallback, logCallback); FFmpegKitConfig.asyncFFprobeExecute(session, executorService); return session; } /** *
Extracts media information for the file specified with path. * * @param path path or uri of a media file * @return media information session created for this execution */ public static MediaInformationSession getMediaInformation(final String path) { final MediaInformationSession session = new MediaInformationSession(defaultGetMediaInformationCommandArguments(path)); FFmpegKitConfig.getMediaInformationExecute(session, AbstractSession.DEFAULT_TIMEOUT_FOR_ASYNCHRONOUS_MESSAGES_IN_TRANSMIT); return session; } /** *
Extracts media information for the file specified with path. * * @param path path or uri of a media file * @param waitTimeout max time to wait until media information is transmitted * @return media information session created for this execution */ public static MediaInformationSession getMediaInformation(final String path, final int waitTimeout) { final MediaInformationSession session = new MediaInformationSession(defaultGetMediaInformationCommandArguments(path)); FFmpegKitConfig.getMediaInformationExecute(session, waitTimeout); return session; } /** *
Starts an asynchronous FFprobe execution to extract the media information for the specified file. * *
Note that this method returns immediately and does not wait the execution to complete. You must use an * {@link ExecuteCallback} if you want to be notified about the result. * * @param path path or uri of a media file * @param executeCallback callback that will be called when the execution is completed * @return media information session created for this execution */ public static MediaInformationSession getMediaInformationAsync(final String path, final ExecuteCallback executeCallback) { final MediaInformationSession session = new MediaInformationSession(defaultGetMediaInformationCommandArguments(path), executeCallback); FFmpegKitConfig.asyncGetMediaInformationExecute(session, AbstractSession.DEFAULT_TIMEOUT_FOR_ASYNCHRONOUS_MESSAGES_IN_TRANSMIT); return session; } /** *
Starts an asynchronous FFprobe execution to extract the media information for the specified file. * *
Note that this method returns immediately and does not wait the execution to complete. You must use an * {@link ExecuteCallback} if you want to be notified about the result. * * @param path path or uri of a media file * @param executeCallback callback that will be notified when execution is completed * @param logCallback callback that will receive logs * @param waitTimeout max time to wait until media information is transmitted * @return media information session created for this execution */ public static MediaInformationSession getMediaInformationAsync(final String path, final ExecuteCallback executeCallback, final LogCallback logCallback, final int waitTimeout) { final MediaInformationSession session = new MediaInformationSession(defaultGetMediaInformationCommandArguments(path), executeCallback, logCallback); FFmpegKitConfig.asyncGetMediaInformationExecute(session, waitTimeout); return session; } /** *
Starts an asynchronous FFprobe execution to extract the media information for the specified file. * *
Note that this method returns immediately and does not wait the execution to complete. You must use an * {@link ExecuteCallback} if you want to be notified about the result. * * @param path path or uri of a media file * @param executeCallback callback that will be called when the execution is completed * @param executorService executor service that will be used to run this asynchronous operation * @return media information session created for this execution */ public static MediaInformationSession getMediaInformationAsync(final String path, final ExecuteCallback executeCallback, final ExecutorService executorService) { final MediaInformationSession session = new MediaInformationSession(defaultGetMediaInformationCommandArguments(path), executeCallback); FFmpegKitConfig.asyncGetMediaInformationExecute(session, executorService, AbstractSession.DEFAULT_TIMEOUT_FOR_ASYNCHRONOUS_MESSAGES_IN_TRANSMIT); return session; } /** *
Starts an asynchronous FFprobe execution to extract the media information for the specified file. * *
Note that this method returns immediately and does not wait the execution to complete. You must use an * {@link ExecuteCallback} if you want to be notified about the result. * * @param path path or uri of a media file * @param executeCallback callback that will be notified when execution is completed * @param logCallback callback that will receive logs * @param executorService executor service that will be used to run this asynchronous operation * @param waitTimeout max time to wait until media information is transmitted * @return media information session created for this execution */ public static MediaInformationSession getMediaInformationAsync(final String path, final ExecuteCallback executeCallback, final LogCallback logCallback, final ExecutorService executorService, final int waitTimeout) { final MediaInformationSession session = new MediaInformationSession(defaultGetMediaInformationCommandArguments(path), executeCallback, logCallback); FFmpegKitConfig.asyncGetMediaInformationExecute(session, executorService, waitTimeout); return session; } /** *
Extracts media information using the command provided asynchronously. * * @param command FFprobe command that prints media information for a file in JSON format * @return media information session created for this execution */ public static MediaInformationSession getMediaInformationFromCommand(final String command) { final MediaInformationSession session = new MediaInformationSession(FFmpegKitConfig.parseArguments(command)); FFmpegKitConfig.asyncGetMediaInformationExecute(session, AbstractSession.DEFAULT_TIMEOUT_FOR_ASYNCHRONOUS_MESSAGES_IN_TRANSMIT); return session; } /** *
Starts an asynchronous FFprobe execution to extract media information using a command. The command passed to * this method must generate the output in JSON format in order to successfully extract media information from it. * *
Note that this method returns immediately and does not wait the execution to complete. You must use an * {@link ExecuteCallback} if you want to be notified about the result. * * @param command FFprobe command that prints media information for a file in JSON format * @param executeCallback callback that will be notified when execution is completed * @param logCallback callback that will receive logs * @param waitTimeout max time to wait until media information is transmitted * @return media information session created for this execution */ public static MediaInformationSession getMediaInformationFromCommandAsync(final String command, final ExecuteCallback executeCallback, final LogCallback logCallback, final int waitTimeout) { return getMediaInformationFromCommandArgumentsAsync(FFmpegKitConfig.parseArguments(command), executeCallback, logCallback, waitTimeout); } /** *
Starts an asynchronous FFprobe execution to extract media information using command arguments. The command * passed to this method must generate the output in JSON format in order to successfully extract media information * from it. * *
Note that this method returns immediately and does not wait the execution to complete. You must use an * {@link ExecuteCallback} if you want to be notified about the result. * * @param arguments FFprobe command arguments that print media information for a file in JSON format * @param executeCallback callback that will be notified when execution is completed * @param logCallback callback that will receive logs * @param waitTimeout max time to wait until media information is transmitted * @return media information session created for this execution */ private static MediaInformationSession getMediaInformationFromCommandArgumentsAsync(final String[] arguments, final ExecuteCallback executeCallback, final LogCallback logCallback, final int waitTimeout) { final MediaInformationSession session = new MediaInformationSession(arguments, executeCallback, logCallback); FFmpegKitConfig.getMediaInformationExecute(session, waitTimeout); return session; } /** *
Lists all FFprobe sessions in the session history.
*
* @return all FFprobe sessions in the session history
*/
public static List