/* * 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_FFMPEG_SESSION_H #define FFMPEG_KIT_FFMPEG_SESSION_H #include "AbstractSession.h" #include "StatisticsCallback.h" #include "FFmpegSessionCompleteCallback.h" namespace ffmpegkit { /** *

An FFmpeg session. */ class FFmpegSession : public AbstractSession { public: /** * Builds a new FFmpeg session. * * @param arguments command arguments * @return created session */ static std::shared_ptr create(const std::list& arguments); /** * Builds a new FFmpeg session. * * @param arguments command arguments * @param completeCallback session specific complete callback * @return created session */ static std::shared_ptr create(const std::list& arguments, ffmpegkit::FFmpegSessionCompleteCallback completeCallback); /** * Builds a new FFmpeg session. * * @param arguments command arguments * @param completeCallback session specific complete callback * @param logCallback session specific log callback * @param statisticsCallback session specific statistics callback * @return created session */ static std::shared_ptr create(const std::list& arguments, ffmpegkit::FFmpegSessionCompleteCallback completeCallback, ffmpegkit::LogCallback logCallback, ffmpegkit::StatisticsCallback statisticsCallback); /** * Builds a new FFmpeg session. * * @param arguments command arguments * @param completeCallback session specific complete callback * @param logCallback session specific log callback * @param statisticsCallback session specific statistics callback * @param logRedirectionStrategy session specific log redirection strategy * @return created session */ static std::shared_ptr create(const std::list& arguments, ffmpegkit::FFmpegSessionCompleteCallback completeCallback, ffmpegkit::LogCallback logCallback, ffmpegkit::StatisticsCallback statisticsCallback, ffmpegkit::LogRedirectionStrategy logRedirectionStrategy); /** * Returns the session specific statistics callback. * * @return session specific statistics callback */ ffmpegkit::StatisticsCallback getStatisticsCallback(); /** * Returns the session specific complete callback. * * @return session specific complete callback */ ffmpegkit::FFmpegSessionCompleteCallback getCompleteCallback(); /** * Returns all statistics 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 statistics entries generated for this session */ std::shared_ptr>> getAllStatisticsWithTimeout(const int waitTimeout); /** * Returns all statistics entries generated for this session. If there are asynchronous * messages that are not delivered yet, this method waits for them until * AbstractSessionDefaultTimeoutForAsynchronousMessagesInTransmit expires. * * @return list of statistics entries generated for this session */ std::shared_ptr>> getAllStatistics(); /** * Returns all statistics 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 statistics entries received for this session */ std::shared_ptr>> getStatistics(); /** * Returns the last received statistics entry. * * @return the last received statistics entry or nullptr if there are not any statistics entries * received */ std::shared_ptr getLastReceivedStatistics(); /** * Adds a new statistics entry for this session. It is invoked internally by FFmpegKit library methods. * Must not be used by user applications. * * @param statistics statistics entry */ void addStatistics(const std::shared_ptr statistics); /** * Returns whether it is an FFmpeg session or not. * * @return true if it is an FFmpeg session, false otherwise */ bool isFFmpeg() const override; /** * Returns whether it is an FFprobe session or not. * * @return true if it is an FFprobe session, false otherwise */ bool isFFprobe() const override; /** * Returns whether it is a MediaInformation session or not. * * @return true if it is a MediaInformation session, false otherwise */ bool isMediaInformation() const override; private: struct PublicFFmpegSession; /** * Builds a new FFmpeg session. * * @param arguments command arguments * @param completeCallback session specific complete callback * @param logCallback session specific log callback * @param statisticsCallback session specific statistics callback * @param logRedirectionStrategy session specific log redirection strategy */ FFmpegSession(const std::list& arguments, ffmpegkit::FFmpegSessionCompleteCallback completeCallback, ffmpegkit::LogCallback logCallback, ffmpegkit::StatisticsCallback statisticsCallback, ffmpegkit::LogRedirectionStrategy logRedirectionStrategy); ffmpegkit::StatisticsCallback _statisticsCallback; FFmpegSessionCompleteCallback _completeCallback; std::shared_ptr>> _statistics; }; } #endif // FFMPEG_KIT_FFMPEG_SESSION_H