From 93ceb59b0f8beec3faae394c7a7763fede70791b Mon Sep 17 00:00:00 2001 From: Amar Takhar Date: Thu, 3 Feb 2011 15:47:43 +0000 Subject: [PATCH] Move ffmpegsource_common.(cpp|h) and change the license to fit the rest of libaegisub with permission of the current license holder (Karl Blomster) Originally committed to SVN as r5275. --- aegisub/libaegisub/media/ffms_common.cpp | 391 +++++++++++++++++++++++ aegisub/libaegisub/media/ffms_common.h | 114 +++++++ 2 files changed, 505 insertions(+) create mode 100644 aegisub/libaegisub/media/ffms_common.cpp create mode 100644 aegisub/libaegisub/media/ffms_common.h diff --git a/aegisub/libaegisub/media/ffms_common.cpp b/aegisub/libaegisub/media/ffms_common.cpp new file mode 100644 index 000000000..7601c7c02 --- /dev/null +++ b/aegisub/libaegisub/media/ffms_common.cpp @@ -0,0 +1,391 @@ +// Copyright (c) 2008-2009, Karl Blomster +// All rights reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are met: +// +// * Redistributions of source code must retain the above copyright notice, +// this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above copyright notice, +// this list of conditions and the following disclaimer in the documentation +// and/or other materials provided with the distribution. +// * Neither the name of the Aegisub Group nor the names of its contributors +// may be used to endorse or promote products derived from this software +// without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE +// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +// POSSIBILITY OF SUCH DAMAGE. +// +// Aegisub Project http://www.aegisub.org/ +// +// $Id$ + +/// @file ffmpegsource_common.cpp +/// @brief Shared code for ffms video and audio providers +/// @ingroup video_input audio_input ffms +/// + +#include "config.h" + +#ifdef WITH_FFMPEGSOURCE + +#ifndef AGI_PRE +#include +#include + +//#include +//#include // Keep this last so wxUSE_CHOICEDLG is set. +#endif + +#include + +#include "ffms_common.h" + +//#include "compat.h" +//#include "ffmpegsource_common.h" +//#include "frame_main.h" +//#include "main.h" +//#include "md5.h" +//#include "standard_paths.h" + +namespace agi { + namespace ffms { + +/// @brief Callback function that updates the indexing progress dialog +/// @param Current The current file positition in bytes +/// @param Total The total file size in bytes +/// @param Private A pointer to the progress dialog box to update +/// @return Returns non-0 if indexing is cancelled, 0 otherwise. +/// +int FFMS_CC FFmpegSourceProvider::UpdateIndexingProgress(int64_t Current, int64_t Total, void *Private) { + IndexingProgressDialog *Progress = (IndexingProgressDialog *)Private; + + if (Progress->IndexingCanceled) + return 1; + + // no one cares about a little bit of a rounding error here anyway +// Progress->ProgressDialog->SetProgress(((int64_t)1000*Current)/Total, 1000); + + return 0; +} + + + +/// @brief Does indexing of a source file +/// @param Indexer A pointer to the indexer object representing the file to be indexed +/// @param CacheName The filename of the output index file +/// @param Trackmask A binary mask of the track numbers to index +/// @param IgnoreDecodeErrors True if audio decoding errors will be tolerated, false otherwise +/// @return Returns the index object on success, NULL otherwise +/// +FFMS_Index *FFmpegSourceProvider::DoIndexing(FFMS_Indexer *Indexer, const std::string &CacheName, int Trackmask, FFMS_IndexErrorHandling IndexEH) { + char FFMSErrMsg[1024]; + FFMS_ErrorInfo ErrInfo; + ErrInfo.Buffer = FFMSErrMsg; + ErrInfo.BufferSize = sizeof(FFMSErrMsg); + ErrInfo.ErrorType = FFMS_ERROR_SUCCESS; + ErrInfo.SubType = FFMS_ERROR_SUCCESS; + std::string MsgString; +/* + // set up progress dialog callback + IndexingProgressDialog Progress; + Progress.IndexingCanceled = false; + Progress.ProgressDialog = new DialogProgress(AegisubApp::Get()->frame, + _("Indexing"), &Progress.IndexingCanceled, + _("Reading timecodes and frame/sample data"), 0, 1); + Progress.ProgressDialog->Show(); + Progress.ProgressDialog->SetProgress(0,1); + + // index all audio tracks + FFMS_Index *Index = FFMS_DoIndexing(Indexer, Trackmask, FFMS_TRACKMASK_NONE, NULL, NULL, IndexEH, + FFmpegSourceProvider::UpdateIndexingProgress, &Progress, &ErrInfo); + Progress.ProgressDialog->Destroy(); + if (Progress.IndexingCanceled) { + throw agi::UserCancelException("indexing cancelled by user"); + } + if (Index == NULL) { + MsgString.append("Failed to index: ").append(ErrInfo.Buffer); + throw MsgString; + } + + // write index to disk for later use + // ignore write errors for now + FFMS_WriteIndex(CacheName.c_str(), Index, &ErrInfo); +// if (FFMS_WriteIndex(CacheName.char_str(), Index, FFMSErrMsg, MsgSize)) { +// wxString temp(FFMSErrMsg, wxConvUTF8); +// MsgString << _T("Failed to write index: ") << temp; +// throw MsgString; +// } +*/ +FFMS_Index *Index; + return Index; +} + +/// @brief Finds all tracks of the given type and return their track numbers and respective codec names +/// @param Indexer The indexer object representing the source file +/// @param Type The track type to look for +/// @return Returns a std::map with the track numbers as keys and the codec names as values. +std::map FFmpegSourceProvider::GetTracksOfType(FFMS_Indexer *Indexer, FFMS_TrackType Type) { + std::map TrackList; + int NumTracks = FFMS_GetNumTracksI(Indexer); + + for (int i=0; i(i, CodecName)); + } + } + return TrackList; +} + +/// @brief Ask user for which track he wants to load +/// @param TrackList A std::map with the track numbers as keys and codec names as values +/// @param Type The track type to ask about +/// @return Returns the track number chosen (an integer >= 0) on success, or a negative integer if the user cancelled. +/* +int FFmpegSourceProvider::AskForTrackSelection(const std::map &TrackList, FFMS_TrackType Type) { + std::vector TrackNumbers; + wxArrayString Choices; + std::string TypeName = ""; + if (Type == FFMS_TYPE_VIDEO) + TypeName = _("video"); + else if (Type == FFMS_TYPE_AUDIO) + TypeName = _("audio"); + + for (std::map::const_iterator i = TrackList.begin(); i != TrackList.end(); i++) { + istream str; +//XXX Choices.Add(ng::Format(_("Track %02d: %s"), i->first, i->second.c_str())); + TrackNumbers.push_back(i->first); + } + + int Choice = wxGetSingleChoiceIndex(wxString::Format(_("Multiple %s tracks detected, please choose the one you wish to load:"), TypeName.c_str()), + wxString::Format(_("Choose %s track"), TypeName.c_str()), Choices); + + if (Choice < 0) + return Choice; + else + return TrackNumbers[Choice]; +} +*/ + + +/// @brief Set ffms2 log level according to setting in config.dat +void FFmpegSourceProvider::SetLogLevel() { +/* + wxString LogLevel = lagi_wxString(OPT_GET("Provider/FFmpegSource/Log Level")->GetString()); + if (!LogLevel.CmpNoCase("panic")) + FFMS_SetLogLevel(FFMS_LOG_PANIC); + else if (!LogLevel.CmpNoCase("fatal")) + FFMS_SetLogLevel(FFMS_LOG_FATAL); + else if (!LogLevel.CmpNoCase("error")) + FFMS_SetLogLevel(FFMS_LOG_ERROR); + else if (!LogLevel.CmpNoCase("warning")) + FFMS_SetLogLevel(FFMS_LOG_WARNING); + else if (!LogLevel.CmpNoCase("info")) + FFMS_SetLogLevel(FFMS_LOG_INFO); + else if (!LogLevel.CmpNoCase("verbose")) + FFMS_SetLogLevel(FFMS_LOG_VERBOSE); + else if (!LogLevel.CmpNoCase("debug")) + FFMS_SetLogLevel(FFMS_LOG_DEBUG); + else */ + FFMS_SetLogLevel(FFMS_LOG_QUIET); +} + + +FFMS_IndexErrorHandling FFmpegSourceProvider::GetErrorHandlingMode() { +// std::string Mode = lagi_wxString(OPT_GET("Provider/Audio/FFmpegSource/Decode Error Handling")->GetString()); +std::string mode = "ignore"; + + if (mode == "ignore") + return FFMS_IEH_IGNORE; + else if (mode == "clear") + return FFMS_IEH_CLEAR_TRACK; + else if (mode == "stop") + return FFMS_IEH_STOP_TRACK; + else if (mode == "abort") + return FFMS_IEH_ABORT; + else + return FFMS_IEH_STOP_TRACK; // questionable default? +} + +#include +/// @brief Generates an unique name for the ffms2 index file and prepares the cache folder if it doesn't exist +/// @param filename The name of the source file +/// @return Returns the generated filename. +std::string FFmpegSourceProvider::GetCacheFilename(const std::string& _filename) +{ +/* + // Get the size of the file to be hashed + wxFileOffset len = 0; + { + wxFile file(_filename,wxFile::read); + if (file.IsOpened()) len = file.Length(); + } + + wxFileName filename(_filename); + + // Generate string to be hashed +// std::string toHash = wxString::Format("%s %" PRId64 " %" PRId64, filename.GetFullName(), len, (int64_t)filename.GetModificationTime().GetTicks()); +std::string toHash = "XXX"; + + // Get the MD5 digest of the string + const wchar_t *tmp = toHash.wc_str(); + md5_state_t state; + md5_byte_t digest[16]; + md5_init(&state); + md5_append(&state,(md5_byte_t*)tmp,toHash.Length()*sizeof(wchar_t)); + md5_finish(&state,digest); + + // Generate the filename + unsigned int *md5 = (unsigned int*) digest; + wxString result = wxString::Format("?user/ffms2cache/%08X%08X%08X%08X.ffindex",md5[0],md5[1],md5[2],md5[3]); + result = StandardPaths::DecodePath(result); + + // Ensure that folder exists + wxFileName fn(result); + wxString dir = fn.GetPath(); + if (!wxFileName::DirExists(dir)) { + wxFileName::Mkdir(dir); + } + + wxFileName dirfn(dir); + return dirfn.GetShortPath() + "/" + fn.GetFullName(); +*/ +return "XXX"; +} + +/* + +/// @brief Starts the cache cleaner thread +/// @return True on success, false if the thread could not be started. +bool FFmpegSourceProvider::CleanCache() { + LOG_D("provider/ffmpegsource/cache") << "attempting to start thread"; + + FFmpegSourceCacheCleaner *CleaningThread = new FFmpegSourceCacheCleaner(this); + + if (CleaningThread->Create() != wxTHREAD_NO_ERROR) { + LOG_D("provider/ffmpegsource/cache") << "thread creation failed"; + delete CleaningThread; + CleaningThread = NULL; + return false; + } + if (CleaningThread->Run() != wxTHREAD_NO_ERROR) { + LOG_D("provider/ffmpegsource/cache") << "failed to start thread"; + delete CleaningThread; + CleaningThread = NULL; + return false; + } + + LOG_D("provider/ffmpegsource/cache") << "thread started successfully"; + return true; +} + + + +/// @brief constructor +/// @param par the parent provider +FFmpegSourceCacheCleaner::FFmpegSourceCacheCleaner(FFmpegSourceProvider *par) : wxThread(wxTHREAD_DETACHED) { + parent = par; +} + +/// @brief Cleans the ffms2 index cache folder +/// @return Returns non-0 on error, 0 otherwise. +wxThread::ExitCode FFmpegSourceCacheCleaner::Entry() { + wxMutexLocker lock(FFmpegSourceProvider::CleaningInProgress); + if (!lock.IsOk()) { + LOG_D("provider/ffmpegsource/cache") << "cleaning already in progress, thread exiting"; + return (wxThread::ExitCode)1; + } + + wxString cachedirname = StandardPaths::DecodePath(_T("?user/ffms2cache/")); + wxDir cachedir; + if (!cachedir.Open(cachedirname)) { + LOG_D("provider/ffmpegsource/cache") << "couldn't open cache directory " << cachedirname.c_str(); + return (wxThread::ExitCode)1; + } + + // sleep for a bit so we (hopefully) don't thrash the disk too much while indexing is in progress + wxThread::This()->Sleep(2000); + + // the option is in megabytes, we need bytes + // shift left by 20 is CLEARLY more efficient than multiplying by 1048576 + int64_t maxsize = OPT_GET("Provider/FFmpegSource/Cache/Size")->GetInt() << 20; + int64_t cursize = wxDir::GetTotalSize(cachedirname).GetValue(); + int maxfiles = OPT_GET("Provider/FFmpegSource/Cache/Files")->GetInt(); + + if (!cachedir.HasFiles(_T("*.ffindex"))) { + LOG_D("provider/ffmpegsource/cache") << "no index files in cache folder, exiting"; + return (wxThread::ExitCode)0; + } + + int deleted = 0; + int numfiles = 0; + std::multimap cachefiles; + wxString curfn_str; + wxFileName curfn; + wxDateTime curatime; + + // unusually paranoid sanity check + // (someone might have deleted the file(s) after we did HasFiles() above; does wxDir.Open() lock the dir?) + if (!cachedir.GetFirst(&curfn_str, _T("*.ffindex"), wxDIR_FILES)) { + LOG_D("provider/ffmpegsource/cache") << "undefined error"; + return (wxThread::ExitCode)1; + } + + numfiles++; + curfn = wxFileName(cachedirname, curfn_str); + curfn.GetTimes(&curatime, NULL, NULL); + // FIXME: will break when the time_t's wrap around!!1! + cachefiles.insert(std::pair(curatime.GetTicks(),curfn)); + + while (cachedir.GetNext(&curfn_str)) { + curfn = wxFileName(cachedirname, curfn_str); + curfn.GetTimes(&curatime, NULL, NULL); + cachefiles.insert(std::pair(curatime.GetTicks(),curfn)); + numfiles++; + + wxThread::This()->Sleep(250); + } + + if (numfiles <= maxfiles && cursize <= maxsize) { + LOG_D("provider/ffmpegsource/cache") << "cache does not need cleaning (maxsize=" << (int)maxsize << ", cursize=" << (int)cursize << "; maxfiles=" << maxfiles << "numfiles=" << numfiles << ",exiting"; + return (wxThread::ExitCode)0; + } + + for (std::multimap::iterator i = cachefiles.begin(); i != cachefiles.end(); i++) { + // stop cleaning? + if ((cursize <= maxsize && numfiles <= maxfiles) || numfiles <= 1) + break; + + int64_t fsize = i->second.GetSize().GetValue(); + if (!wxRemoveFile(i->second.GetFullPath())) { + LOG_D("provider/ffmpegsource/cache") << "failed to remove file " << i->second.GetFullPath().c_str(); + continue; + } + cursize -= fsize; + numfiles--; + deleted++; + + wxThread::This()->Sleep(250); + } + + LOG_D("provider/ffmpegsource/cache") << "deleted " << deleted << " files, exiting"; + + return (wxThread::ExitCode)0; +} +*/ + +#endif // WITH_FFMPEGSOURCE + + + } // namespace ffms +} // namespace agi diff --git a/aegisub/libaegisub/media/ffms_common.h b/aegisub/libaegisub/media/ffms_common.h new file mode 100644 index 000000000..7c6a7f530 --- /dev/null +++ b/aegisub/libaegisub/media/ffms_common.h @@ -0,0 +1,114 @@ +// Copyright (c) 2008-2009, Karl Blomster +// All rights reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are met: +// +// * Redistributions of source code must retain the above copyright notice, +// this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above copyright notice, +// this list of conditions and the following disclaimer in the documentation +// and/or other materials provided with the distribution. +// * Neither the name of the Aegisub Group nor the names of its contributors +// may be used to endorse or promote products derived from this software +// without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE +// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +// POSSIBILITY OF SUCH DAMAGE. +// +// Aegisub Project http://www.aegisub.org/ +// +// $Id$ + +/// @file ffmpegsource_common.h +/// @see ffmpegsource_common.cpp +/// @ingroup video_input audio_input ffms +/// + +#ifdef WITH_FFMPEGSOURCE + +#ifndef AGI_PRE +#include + +//#include +//#include +#endif + +#include "../../libffms/include/ffms.h" + +namespace agi { + namespace ffms { + +//#include "dialog_progress.h" + +/// Index all tracks +#define FFMS_TRACKMASK_ALL -1 +/// Index no tracks +#define FFMS_TRACKMASK_NONE 0 + +/// @class FFmpegSourceProvider +/// @brief Base class for FFMS2 source providers; contains common functions etc +class FFmpegSourceProvider { + friend class FFmpegSourceCacheCleaner; +public: + /// Logging level constants from avutil/log.h + enum FFMS_LogLevel { + /// nothing printed + FFMS_LOG_QUIET = -8, + FFMS_LOG_PANIC = 0, + FFMS_LOG_FATAL = 8, + FFMS_LOG_ERROR = 16, + FFMS_LOG_WARNING = 24, + FFMS_LOG_INFO = 32, + FFMS_LOG_VERBOSE = 40, + FFMS_LOG_DEBUG = 48, + }; + + /// Indexing progress report dialog + struct IndexingProgressDialog { + volatile bool IndexingCanceled; +// DialogProgress *ProgressDialog; + }; + + /// Mutex preventing two cache cleaner threads from running at the same time +// static wxMutex CleaningInProgress; + bool CleanCache(); + + static int FFMS_CC UpdateIndexingProgress(int64_t Current, int64_t Total, void *Private); + + FFMS_Index *DoIndexing(FFMS_Indexer *Indexer, const std::string& Cachename, int Trackmask, FFMS_IndexErrorHandling IndexEH); + std::map GetTracksOfType(FFMS_Indexer *Indexer, FFMS_TrackType Type); + int AskForTrackSelection(const std::map& TrackList, FFMS_TrackType Type); + std::string GetCacheFilename(const std::string& filename); + void SetLogLevel(); + FFMS_IndexErrorHandling GetErrorHandlingMode(); + + virtual ~FFmpegSourceProvider() {} +}; + +/// @class FFmpegSourceCacheCleaner +/// @brief Implements index cache cleaning functionality for the FFMS2 providers +class FFmpegSourceCacheCleaner { +private: + FFmpegSourceProvider *parent; + +public: + FFmpegSourceCacheCleaner(FFmpegSourceProvider *par); + + ~FFmpegSourceCacheCleaner() {}; +// wxThread::ExitCode Entry(); +}; + +#endif /* WITH_FFMPEGSOURCE */ + + } // namespace ffms +} // namespace agi