/* * Copyright (c) 2022 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 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 License for more details. * * You should have received a copy of the GNU Lesser General License * along with FFmpegKit. If not, see . */ #ifndef FFMPEG_KIT_SESSION_H #define FFMPEG_KIT_SESSION_H #include "Log.h" #include "LogCallback.h" #include "LogRedirectionStrategy.h" #include "ReturnCode.h" #include "SessionState.h" #include #include #include namespace ffmpegkit { /** *

Common interface for all FFmpegKit sessions. */ class Session { public: /** * Returns the session specific log callback. * * @return session specific log callback */ virtual ffmpegkit::LogCallback getLogCallback() const = 0; /** * Returns the session identifier. * * @return session identifier */ virtual long getSessionId() const = 0; /** * Returns session create time. * * @return session create time */ virtual std::chrono::time_point getCreateTime() const = 0; /** * Returns session start time. * * @return session start time */ virtual std::chrono::time_point getStartTime() const = 0; /** * Returns session end time. * * @return session end time */ virtual std::chrono::time_point getEndTime() const = 0; /** * Returns the time taken to execute this session. * * @return time taken to execute this session in milliseconds or zero (0) if the session is * not over yet */ virtual long getDuration() const = 0; /** * Returns command arguments as a list. * * @return command arguments as a list */ virtual std::shared_ptr> getArguments() const = 0; /** * Returns command arguments as a concatenated string. * * @return command arguments as a concatenated string */ virtual std::string getCommand() const = 0; /** * Returns all log entries generated for this session. If there are asynchronous * messages that are not delivered yet, this method waits for them until the given timeout. * * @param waitTimeout wait timeout for asynchronous messages in milliseconds * @return list of log entries generated for this session */ virtual std::shared_ptr>> getAllLogsWithTimeout(const int waitTimeout) const = 0; /** * Returns all log entries generated for this session. If there are asynchronous * messages that are not delivered yet, this method waits for them. * * @return list of log entries generated for this session */ virtual std::shared_ptr>> getAllLogs() const = 0; /** * Returns all log entries delivered for this session. Note that if there are asynchronous * messages that are not delivered yet, this method will not wait for them and will return * immediately. * * @return list of log entries received for this session */ virtual std::shared_ptr>> getLogs() const = 0; /** * Returns all log entries generated for this session as a concatenated string. If there are * asynchronous messages that are not delivered yet, this method waits for them until * the given timeout. * * @param waitTimeout wait timeout for asynchronous messages in milliseconds * @return all log entries generated for this session as a concatenated string */ virtual std::string getAllLogsAsStringWithTimeout(const int waitTimeout) const = 0; /** * Returns all log entries generated for this session as a concatenated string. If there are * asynchronous messages that are not delivered yet, this method waits for them. * * @return all log entries generated for this session as a concatenated string */ virtual std::string getAllLogsAsString() const = 0; /** * Returns all log entries delivered for this session as a concatenated string. Note that if * there are asynchronous messages that are not delivered yet, this method will not wait * for them and will return immediately. * * @return list of log entries received for this session */ virtual std::string getLogsAsString() const = 0; /** * Returns the log output generated while running the session. * * @return log output generated */ virtual std::string getOutput() const = 0; /** * Returns the state of the session. * * @return state of the session */ virtual ffmpegkit::SessionState getState() const = 0; /** * Returns the return code for this session. Note that return code is only set for sessions * that end with SessionStateCompleted state. If a session is not started, still running or failed then * this method returns nullptr. * * @return the return code for this session if the session has completed, nullptr if session is * not started, still running or failed */ virtual std::shared_ptr getReturnCode() const = 0; /** * Returns the stack trace of the exception received while executing this session. *

* The stack trace is only set for sessions that end with SessionStateFailed state. For sessions that has * SessionStateCompleted state this method returns an empty string. * * @return stack trace of the exception received while executing this session, an empty string if session * is not started, still running or completed */ virtual std::string getFailStackTrace() const = 0; /** * Returns session specific log redirection strategy. * * @return session specific log redirection strategy */ virtual LogRedirectionStrategy getLogRedirectionStrategy() const = 0; /** * Returns whether there are still asynchronous messages being transmitted for this * session or not. * * @return true if there are still asynchronous messages being transmitted, false * otherwise */ virtual bool thereAreAsynchronousMessagesInTransmit() const = 0; /** * Adds a new log entry for this session. * * It is invoked internally by FFmpegKit library methods. Must not be used by user * applications. * * @param log log entry */ virtual void addLog(const std::shared_ptr log) = 0; /** * Starts running the session. */ virtual void startRunning() = 0; /** * Completes running the session with the provided return code. * * @param returnCode return code of the execution */ virtual void complete(const std::shared_ptr returnCode) = 0; /** * Ends running the session with a failure. * * @param error error received */ virtual void fail(const char* error) = 0; /** * Returns whether it is an FFmpeg session or not. * * @return true if it is an FFmpeg session, false otherwise */ virtual bool isFFmpeg() const = 0; /** * Returns whether it is an FFprobe session or not. * * @return true if it is an FFprobe session, false otherwise */ virtual bool isFFprobe() const = 0; /** * Returns whether it is a MediaInformation session or not. * * @return true if it is a MediaInformation session, false otherwise */ virtual bool isMediaInformation() const = 0; /** * Cancels running the session. */ virtual void cancel() = 0; }; } #endif // FFMPEG_KIT_SESSION_H