You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
ffmpeg-kit/apple/src/FFmpegKit.h

252 lines
10 KiB

/*
* Copyright (c) 2018-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 <http://www.gnu.org/licenses/>.
*/
#ifndef FFMPEG_KIT_H
#define FFMPEG_KIT_H
#import "FFmpegSession.h"
#import "LogCallback.h"
#import "StatisticsCallback.h"
#import <Foundation/Foundation.h>
#import <stdlib.h>
#import <string.h>
/**
* <p>Main class to run <code>FFmpeg</code> commands. Supports executing
* commands both synchronously and asynchronously. <pre> FFmpegSession *session
* = [FFmpegKit execute:@"-i file1.mp4 -c:v libxvid file1.avi"];
*
* FFmpegSession *asyncSession = [FFmpegKit executeAsync:@"-i file1.mp4 -c:v
* libxvid file1.avi" withCompleteCallback:completeCallback];
* </pre>
* <p>Provides overloaded <code>execute</code> methods to define session
* specific callbacks. <pre> FFmpegSession *asyncSession = [FFmpegKit
* executeAsync:@"-i file1.mp4 -c:v libxvid file1.avi"
* withCompleteCallback:completeCallback withLogCallback:logCallback
* withStatisticsCallback:statisticsCallback];
* </pre>
*/
@interface FFmpegKit : NSObject
/**
* <p>Synchronously executes FFmpeg with arguments provided.
*
* @param arguments FFmpeg command options/arguments as string array
* @return FFmpeg session created for this execution
*/
+ (FFmpegSession *)executeWithArguments:(NSArray *)arguments;
/**
* <p>Starts an asynchronous FFmpeg execution with arguments provided.
*
* <p>Note that this method returns immediately and does not wait the execution
* to complete. You must use an FFmpegSessionCompleteCallback if you want to be
* notified about the result.
*
* @param arguments FFmpeg command options/arguments as string array
* @param completeCallback callback that will be called when the execution has
* completed
* @return FFmpeg session created for this execution
*/
+ (FFmpegSession *)executeWithArgumentsAsync:(NSArray *)arguments
withCompleteCallback:
(FFmpegSessionCompleteCallback)completeCallback;
/**
* <p>Starts an asynchronous FFmpeg execution with arguments provided.
*
* <p>Note that this method returns immediately and does not wait the execution
* to complete. You must use an FFmpegSessionCompleteCallback if you want to be
* notified about the result.
*
* @param arguments FFmpeg command options/arguments as string array
* @param completeCallback callback that will be called when the execution
* has completed
* @param logCallback callback that will receive logs
* @param statisticsCallback callback that will receive statistics
* @return FFmpeg session created for this execution
*/
+ (FFmpegSession *)
executeWithArgumentsAsync:(NSArray *)arguments
withCompleteCallback:(FFmpegSessionCompleteCallback)completeCallback
withLogCallback:(LogCallback)logCallback
withStatisticsCallback:(StatisticsCallback)statisticsCallback;
/**
* <p>Starts an asynchronous FFmpeg execution with arguments provided.
*
* <p>Note that this method returns immediately and does not wait the execution
* to complete. You must use an FFmpegSessionCompleteCallback if you want to be
* notified about the result.
*
* @param arguments FFmpeg command options/arguments as string array
* @param completeCallback callback that will be called when the execution has
* completed
* @param queue dispatch queue that will be used to run this
* asynchronous operation
* @return FFmpeg session created for this execution
*/
+ (FFmpegSession *)executeWithArgumentsAsync:(NSArray *)arguments
withCompleteCallback:
(FFmpegSessionCompleteCallback)completeCallback
onDispatchQueue:(dispatch_queue_t)queue;
/**
* <p>Starts an asynchronous FFmpeg execution with arguments provided.
*
* <p>Note that this method returns immediately and does not wait the execution
* to complete. You must use an FFmpegSessionCompleteCallback if you want to be
* notified about the result.
*
* @param arguments FFmpeg command options/arguments as string array
* @param completeCallback callback that will be called when the execution
* has completed
* @param logCallback callback that will receive logs
* @param statisticsCallback callback that will receive statistics
* @param queue dispatch queue that will be used to run this
* asynchronous operation
* @return FFmpeg session created for this execution
*/
+ (FFmpegSession *)
executeWithArgumentsAsync:(NSArray *)arguments
withCompleteCallback:(FFmpegSessionCompleteCallback)completeCallback
withLogCallback:(LogCallback)logCallback
withStatisticsCallback:(StatisticsCallback)statisticsCallback
onDispatchQueue:(dispatch_queue_t)queue;
/**
* <p>Synchronously executes FFmpeg 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 FFmpeg command
* @return FFmpeg session created for this execution
*/
+ (FFmpegSession *)execute:(NSString *)command;
/**
* <p>Starts an asynchronous FFmpeg 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.
*
* <p>Note that this method returns immediately and does not wait the execution
* to complete. You must use an FFmpegSessionCompleteCallback if you want to be
* notified about the result.
*
* @param command FFmpeg command
* @param completeCallback callback that will be called when the execution has
* completed
* @return FFmpeg session created for this execution
*/
+ (FFmpegSession *)executeAsync:(NSString *)command
withCompleteCallback:(FFmpegSessionCompleteCallback)completeCallback;
/**
* <p>Starts an asynchronous FFmpeg 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.
*
* <p>Note that this method returns immediately and does not wait the execution
* to complete. You must use an FFmpegSessionCompleteCallback if you want to be
* notified about the result.
*
* @param command FFmpeg command
* @param completeCallback callback that will be called when the execution
* has completed
* @param logCallback callback that will receive logs
* @param statisticsCallback callback that will receive statistics
* @return FFmpeg session created for this execution
*/
+ (FFmpegSession *)executeAsync:(NSString *)command
withCompleteCallback:(FFmpegSessionCompleteCallback)completeCallback
withLogCallback:(LogCallback)logCallback
withStatisticsCallback:(StatisticsCallback)statisticsCallback;
/**
* <p>Starts an asynchronous FFmpeg 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.
*
* <p>Note that this method returns immediately and does not wait the execution
* to complete. You must use an FFmpegSessionCompleteCallback if you want to be
* notified about the result.
*
* @param command FFmpeg command
* @param completeCallback callback that will be called when the execution has
* completed
* @param queue dispatch queue that will be used to run this
* asynchronous operation
* @return FFmpeg session created for this execution
*/
+ (FFmpegSession *)executeAsync:(NSString *)command
withCompleteCallback:(FFmpegSessionCompleteCallback)completeCallback
onDispatchQueue:(dispatch_queue_t)queue;
/**
* <p>Starts an asynchronous FFmpeg 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.
*
* <p>Note that this method returns immediately and does not wait the execution
* to complete. You must use an FFmpegSessionCompleteCallback if you want to be
* notified about the result.
*
* @param command FFmpeg command
* @param completeCallback callback that will be called when the execution
* has completed
* @param logCallback callback that will receive logs
* @param statisticsCallback callback that will receive statistics
* @param queue dispatch queue that will be used to run this
* asynchronous operation
* @return FFmpeg session created for this execution
*/
+ (FFmpegSession *)executeAsync:(NSString *)command
withCompleteCallback:(FFmpegSessionCompleteCallback)completeCallback
withLogCallback:(LogCallback)logCallback
withStatisticsCallback:(StatisticsCallback)statisticsCallback
onDispatchQueue:(dispatch_queue_t)queue;
/**
* <p>Cancels all running sessions.
*
* <p>This method does not wait for termination to complete and returns
* immediately.
*/
+ (void)cancel;
/**
* <p>Cancels the session specified with <code>sessionId</code>.
*
* <p>This method does not wait for termination to complete and returns
* immediately.
*
* @param sessionId id of the session that will be cancelled
*/
+ (void)cancel:(long)sessionId;
/**
* <p>Lists all FFmpeg sessions in the session history.
*
* @return all FFmpeg sessions in the session history
*/
+ (NSArray *)listSessions;
@end
#endif // FFMPEG_KIT_H