Description: Fix links Author: Sebastian Ramacher Last-Update: 2015-07-13 --- a/doc/ffms2-api.md +++ b/doc/ffms2-api.md @@ -184,7 +184,7 @@ ### FFMS_Init - initializes the library -[Init]: #ffms_init---initializes-the-library +[Init]: #ffms_init-initializes-the-library ```c++ void FFMS_Init(int Unused, int Unused2); ``` @@ -204,7 +204,7 @@ ### FFMS_GetLogLevel - gets FFmpeg message level -[GetLogLevel]: #ffms_getloglevel---gets-ffmpeg-message-level +[GetLogLevel]: #ffms_getloglevel-gets-ffmpeg-message-level ```c++ int FFMS_GetLogLevel(); ``` @@ -214,7 +214,7 @@ ### FFMS_SetLogLevel - sets FFmpeg message level -[SetLogLevel]: #ffms_setloglevel---sets-ffmpeg-message-level +[SetLogLevel]: #ffms_setloglevel-sets-ffmpeg-message-level ```c++ void FFMS_SetLogLevel(int Level); ``` @@ -222,7 +222,7 @@ ### FFMS_CreateVideoSource - creates a video source object -[CreateVideoSource]: #ffms_createvideosource---creates-a-video-source-object +[CreateVideoSource]: #ffms_createvideosource-creates-a-video-source-object ```c++ FFMS_VideoSource *FFMS_CreateVideoSource(const char *SourceFile, int Track, FFMS_Index *Index, int Threads, int SeekMode, FFMS_ErrorInfo *ErrorInfo); @@ -263,7 +263,7 @@ ### FFMS_CreateAudioSource - creates an audio source object -[CreateAudioSource]: #ffms_createaudiosource---creates-an-audio-source-object +[CreateAudioSource]: #ffms_createaudiosource-creates-an-audio-source-object ```c++ FFMS_AudioSource *FFMS_CreateAudioSource(const char *SourceFile, int Track, FFMS_Index *Index, int DelayMode, FFMS_ErrorInfo *ErrorInfo); @@ -286,8 +286,8 @@ ### FFMS_DestroyVideoSource, FFMS_DestroyAudioSource - deallocates a video or audio source object -[DestroyVideoSource]: #ffms_destroyvideosource-ffms_destroyaudiosource---deallocates-a-video-or-audio-source-object -[DestroyAudioSource]: #ffms_destroyvideosource-ffms_destroyaudiosource---deallocates-a-video-or-audio-source-object +[DestroyVideoSource]: #ffms_destroyvideosource-ffms_destroyaudiosource-deallocates-a-video-or-audio-source-object +[DestroyAudioSource]: #ffms_destroyvideosource-ffms_destroyaudiosource-deallocates-a-video-or-audio-source-object ```c++ void FFMS_DestroyVideoSource(FFMS_VideoSource *V); void FFMS_DestroyAudioSource(FFMS_AudioSource *A); @@ -296,7 +296,7 @@ ### FFMS_GetVideoProperties - retrieves video properties -[GetVideoProperties]: #ffms_getvideoproperties---retrieves-video-properties +[GetVideoProperties]: #ffms_getvideoproperties-retrieves-video-properties ```c++ const FFMS_VideoProperties *FFMS_GetVideoProperties(FFMS_VideoSource *V); ``` @@ -305,7 +305,7 @@ ### FFMS_GetAudioProperties - retrieves audio properties -[GetAudioProperties]: #ffms_getaudioproperties---retrieves-audio-properties +[GetAudioProperties]: #ffms_getaudioproperties-retrieves-audio-properties ```c++ const FFMS_AudioProperties *FFMS_GetAudioProperties(FFMS_AudioSource *A); ``` @@ -314,7 +314,7 @@ ### FFMS_GetFrame - retrieves a given video frame -[GetFrame]: #ffms_getframe---retrieves-a-given-video-frame +[GetFrame]: #ffms_getframe-retrieves-a-given-video-frame ```c++ const FFMS_Frame *FFMS_GetFrame(FFMS_VideoSource *V, int n, FFMS_ErrorInfo *ErrorInfo); ``` @@ -342,7 +342,7 @@ ### FFMS_GetFrameByTime - retrieves a video frame at a given timestamp -[GetFrameByTime]: #ffms_getframebytime---retrieves-a-video-frame-at-a-given-timestamp +[GetFrameByTime]: #ffms_getframebytime-retrieves-a-video-frame-at-a-given-timestamp ```c++ const FFMS_Frame *FFMS_GetFrameByTime(FFMS_VideoSource *V, double Time, FFMS_ErrorInfo *ErrorInfo); ``` @@ -351,7 +351,7 @@ ### FFMS_GetAudio - decodes a number of audio samples -[GetAudio]: #ffms_getaudio---decodes-a-number-of-audio-samples +[GetAudio]: #ffms_getaudio-decodes-a-number-of-audio-samples ```c++ int FFMS_GetAudio(FFMS_AudioSource *A, void *Buf, int64_t Start, int64_t Count, FFMS_ErrorInfo *ErrorInfo); ``` @@ -383,7 +383,7 @@ ### FFMS_SetOutputFormatV2 - sets the output format for video frames -[SetOutputFormatV2]: #ffms_setoutputformatv2---sets-the-output-format-for-video-frames +[SetOutputFormatV2]: #ffms_setoutputformatv2-sets-the-output-format-for-video-frames ```c++ int FFMS_SetOutputFormatV2(FFMS_VideoSource *V, int *TargetFormats, int Width, int Height, int Resizer, FFMS_ErrorInfo *ErrorInfo); @@ -432,7 +432,7 @@ ### FFMS_ResetOutputFormatV - resets the video output format -[ResetOutputFormatV]: #ffms_resetoutputformatv---resets-the-video-output-format +[ResetOutputFormatV]: #ffms_resetoutputformatv-resets-the-video-output-format ```c++ void FFMS_ResetOutputFormatV(FFMS_VideoSource *V); ``` @@ -442,7 +442,7 @@ ### FFMS_SetInputFormatV - override the source format for video frames -[SetInputFormatV]: #ffms_setinputformatv---override-the-source-format-for-video-frames +[SetInputFormatV]: #ffms_setinputformatv-override-the-source-format-for-video-frames ```c++ int FFMS_SetInputFormatV(FFMS_VideoSource *V, int ColorSpace, int ColorRange, int PixelFormat, FFMS_ErrorInfo *ErrorInfo); @@ -479,7 +479,7 @@ ### FFMS_ResetInputFormatV - resets the video input format -[ResetInputFormatV]: #ffms_resetinputformatv---resets-the-video-input-format +[ResetInputFormatV]: #ffms_resetinputformatv-resets-the-video-input-format ```c++ void FFMS_ResetInputFormatV(FFMS_VideoSource *V); ``` @@ -487,7 +487,7 @@ ### FFMS_DestroyIndex - deallocates an index object -[DestroyIndex]: #ffms_destroyindex---deallocates-an-index-object +[DestroyIndex]: #ffms_destroyindex-deallocates-an-index-object ```c++ void FFMS_DestroyFFMS_Index(FFMS_Index *Index); ``` @@ -495,7 +495,7 @@ ### FFMS_GetSourceType - gets which source module was used to open the given index -[GetSourceType]: #ffms_getsourcetype---gets-which-source-module-was-used-to-open-the-given-index +[GetSourceType]: #ffms_getsourcetype-gets-which-source-module-was-used-to-open-the-given-index ```c++ int FFMS_GetSourceType(FFMS_Index *Index); ``` @@ -503,7 +503,7 @@ ### FFMS_GetSourceTypeI - gets which source module was used to open the given indexer -[GetSourceTypeI]: #ffms_getsourcetypei---gets-which-source-module-was-used-to-open-the-given-indexer +[GetSourceTypeI]: #ffms_getsourcetypei-gets-which-source-module-was-used-to-open-the-given-indexer ```c++ int FFMS_GetSourceTypeI(FFMS_Index *Indexer); ``` @@ -511,7 +511,7 @@ ### FFMS_GetErrorHandling - gets which error handling mode was used when creating the given index -[GetErrorHandling]: #ffms_geterrorhandling---gets-which-error-handling-mode-was-used-when-creating-the-given-index +[GetErrorHandling]: #ffms_geterrorhandling-gets-which-error-handling-mode-was-used-when-creating-the-given-index ```c++ int FFMS_GetErrorHandling(FFMS_Index *Index); ``` @@ -519,7 +519,7 @@ ### FFMS_GetFirstTrackOfType - gets the track number of the first track of a given type -[GetFirstTrackOfType]: #ffms_getfirsttrackoftype---gets-the-track-number-of-the-first-track-of-a-given-type +[GetFirstTrackOfType]: #ffms_getfirsttrackoftype-gets-the-track-number-of-the-first-track-of-a-given-type ```c++ int FFMS_GetFirstTrackOfType(FFMS_Index *Index, int TrackType, FFMS_ErrorInfo *ErrorInfo); ``` @@ -543,7 +543,7 @@ ### FFMS_GetFirstIndexedTrackOfType - gets the track number of the first track of a given type -[GetFirstIndexedTrackOfType]: #ffms_getfirstindexedtrackoftype---gets-the-track-number-of-the-first-track-of-a-given-type +[GetFirstIndexedTrackOfType]: #ffms_getfirstindexedtrackoftype-gets-the-track-number-of-the-first-track-of-a-given-type ```c++ int FFMS_GetFirstIndexedTrackOfType(FFMS_Index *Index, int TrackType, FFMS_ErrorInfo *ErrorInfo); ``` @@ -551,7 +551,7 @@ ### FFMS_GetNumTracks - gets the number of tracks in a given index -[GetNumTracks]: #ffms_getnumtracks---gets-the-number-of-tracks-in-a-given-index +[GetNumTracks]: #ffms_getnumtracks-gets-the-number-of-tracks-in-a-given-index ```c++ int FFMS_GetNumTracks(FFMS_Index *Index); ``` @@ -559,7 +559,7 @@ ### FFMS_GetNumTracksI - gets the number of tracks in a given indexer -[GetNumTracksI]: #ffms_getnumtracksi---gets-the-number-of-tracks-in-a-given-indexer +[GetNumTracksI]: #ffms_getnumtracksi-gets-the-number-of-tracks-in-a-given-indexer ```c++ int FFMS_GetNumTracksI(FFMS_Indexer *Indexer); ``` @@ -568,7 +568,7 @@ ### FFMS_GetTrackType - gets the track type of a given track -[GetTrackType]: #ffms_gettracktype---gets-the-track-type-of-a-given-track +[GetTrackType]: #ffms_gettracktype-gets-the-track-type-of-a-given-track ```c++ int FFMS_GetTrackType(FFMS_Track *T); ``` @@ -576,7 +576,7 @@ ### FFMS_GetTrackTypeI - gets the track type of a given track -[GetTrackTypeI]: #ffms_gettracktypei---gets-the-track-type-of-a-given-track +[GetTrackTypeI]: #ffms_gettracktypei-gets-the-track-type-of-a-given-track ```c++ int FFMS_GetTrackTypeI(FFMS_Indexer *Indexer, int Track); ``` @@ -587,7 +587,7 @@ ### FFMS_GetCodecNameI - gets the name of the codec used for a given track -[GetCodecNameI]: #ffms_getcodecnamei---gets-the-name-of-the-codec-used-for-a-given-track +[GetCodecNameI]: #ffms_getcodecnamei-gets-the-name-of-the-codec-used-for-a-given-track ```c++ const char *FFMS_GetCodecNameI(FFMS_Indexer *Indexer, int Track); ``` @@ -597,7 +597,7 @@ ### FFMS_GetFormatNameI - gets the name of the container format used in the given indexer -[GetFormatNameI]: #ffms_getformatnamei---gets-the-name-of-the-container-format-used-in-the-given-indexer +[GetFormatNameI]: #ffms_getformatnamei-gets-the-name-of-the-container-format-used-in-the-given-indexer ```c++ const char *FFMS_GetFormatNameI(FFMS_Indexer *Indexer); ``` @@ -605,7 +605,7 @@ ### FFMS_GetNumFrames - gets the number of frames in a given track -[GetNumFrames]: #ffms_getnumframes---gets-the-number-of-frames-in-a-given-track +[GetNumFrames]: #ffms_getnumframes-gets-the-number-of-frames-in-a-given-track ```c++ int FFMS_GetNumFrames(FFMS_Track *T); ``` @@ -615,7 +615,7 @@ ### FFMS_GetFrameInfo - gets information about a given frame -[GetFrameInfo]: #ffms_getframeinfo---gets-information-about-a-given-frame +[GetFrameInfo]: #ffms_getframeinfo-gets-information-about-a-given-frame ```c++ const FFMS_FrameInfo *FFMS_GetFrameInfo(FFMS_Track *T, int Frame); ``` @@ -641,7 +641,7 @@ ### FFMS_GetTrackFromIndex - retrieves track info from an index -[GetTrackFromIndex]: #ffms_gettrackfromindex---retrieves-track-info-from-an-index +[GetTrackFromIndex]: #ffms_gettrackfromindex-retrieves-track-info-from-an-index ```c+++ FFMS_Track *FFMS_GetTrackFromIndex(FFMS_Index *Index, int Track); ``` @@ -668,8 +668,8 @@ ### FFMS_GetTrackFromVideo, FFMS_GetTrackFromAudio - retrieves track info from audio or video source -[GetTrackFromVideo]: #ffms_gettrackfromvideo-ffms_gettrackfromaudio---retrieves-track-info-from-audio-or-video-source -[GetTrackFromAudio]: #ffms_gettrackfromvideo-ffms_gettrackfromaudio---retrieves-track-info-from-audio-or-video-source +[GetTrackFromVideo]: #ffms_gettrackfromvideo-ffms_gettrackfromaudio-retrieves-track-info-from-audio-or-video-source +[GetTrackFromAudio]: #ffms_gettrackfromvideo-ffms_gettrackfromaudio-retrieves-track-info-from-audio-or-video-source ```c++ FFMS_Track *FFMS_GetTrackFromVideo(FFMS_VideoSource *V); FFMS_Track *FFMS_GetTrackFromAudio(FFMS_AudioSource *A); @@ -680,7 +680,7 @@ ### FFMS_GetTimeBase - retrieves the time base for the given track -[GetTimeBase]: #ffms_gettimebase---retrieves-the-time-base-for-the-given-track +[GetTimeBase]: #ffms_gettimebase-retrieves-the-time-base-for-the-given-track ```c++ const FFMS_TrackTimeBase *FFMS_GetTimeBase(FFMS_Track *T); ``` @@ -689,7 +689,7 @@ ### FFMS_WriteTimecodes - writes timecodes for the given track to disk -[WriteTimecodes]: #ffms_writetimecodes---writes-timecodes-for-the-given-track-to-disk +[WriteTimecodes]: #ffms_writetimecodes-writes-timecodes-for-the-given-track-to-disk ```c++ int FFMS_WriteTimecodes(FFMS_Track *T, const char *TimecodeFile, FFMS_ErrorInfo *ErrorInfo); ``` @@ -715,14 +715,14 @@ ### FFMS_DefaultAudioFilename - default callback for audio filename generation -[DefaultAudioFilename]: #ffms_defaultaudiofilename---default-callback-for-audio-filename-generation +[DefaultAudioFilename]: #ffms_defaultaudiofilename-default-callback-for-audio-filename-generation This function generates a default audio filename for use when dumping audio tracks to disk as Wave64 files during indexing. Its only use in the public API is as a default callback for `FFMS_MakeIndex` and `FFMS_DoIndexing`; you should never call it directly. See `FFMS_MakeIndex` for a description of its arguments. ### FFMS_CreateIndexer - creates an indexer object for the given file -[CreateIndexer]: #ffms_createindexer---creates-an-indexer-object-for-the-given-file +[CreateIndexer]: #ffms_createindexer-creates-an-indexer-object-for-the-given-file ```c++ FFMS_Indexer *FFMS_CreateIndexer(const char *SourceFile, FFMS_ErrorInfo *ErrorInfo); ``` @@ -736,7 +736,7 @@ ### FFMS_CreateIndexerWithDemuxer - creates an indexer object for the given file, using the given source module -[CreateIndexerWithDemuxer]: #ffms_createindexerwithdemuxer---creates-an-indexer-object-for-the-given-file-using-the-given-source-module +[CreateIndexerWithDemuxer]: #ffms_createindexerwithdemuxer-creates-an-indexer-object-for-the-given-file-using-the-given-source-module ```c++ FFMS_Indexer *FFMS_CreateIndexerWithDemuxer(const char *SourceFile, int Demuxer, FFMS_ErrorInfo *ErrorInfo); ``` @@ -753,7 +753,7 @@ ### FFMS_DoIndexing2 - indexes the file represented by an indexer object -[DoIndexing2]: #ffms_doindexing2---indexes-the-file-represented-by-an-indexer-object +[DoIndexing2]: #ffms_doindexing2-indexes-the-file-represented-by-an-indexer-object ```c++ FFMS_Index *FFMS_DoIndexing2(FFMS_Indexer *Indexer, int ErrorHandling, FFMS_ErrorInfo *ErrorInfo); ``` @@ -783,7 +783,7 @@ ### FFMS_TrackIndexSettings - enable or disable indexing of a track -[TrackIndexSettings]: #ffms_trackindexsettings---enable-or-disable-indexing-of-a-track +[TrackIndexSettings]: #ffms_trackindexsettings-enable-or-disable-indexing-of-a-track ```c++ void FFMS_TrackIndexSettings(FFMS_Indexer *Indexer, int Track, int Index, int Dump); ``` @@ -811,7 +811,7 @@ ### FFMS_TrackTypeIndexSettings - enable or disable indexing of a tracks of a given type -[TrackTypeIndexSettings]: #ffms_tracktypeindexsettings---enable-or-disable-indexing-of-a-tracks-of-a-given-type +[TrackTypeIndexSettings]: #ffms_tracktypeindexsettings-enable-or-disable-indexing-of-a-tracks-of-a-given-type ```c++ void FFMS_TrackTypeIndexSettings(FFMS_Indexer *Indexer, int TrackType, int Index, int Dump); ``` @@ -820,7 +820,7 @@ ### FFMS_SetAudioNameCallback - choose the filename for audio track dumping -[SetAudioNameCallback]: #ffms_setaudionamecallback---choose-the-filename-for-audio-track-dumping +[SetAudioNameCallback]: #ffms_setaudionamecallback-choose-the-filename-for-audio-track-dumping ```c++ void FFMS_SetAudioNameCallback(FFMS_Indexer *Indexer, TAudioNameCallback ANC, void *ANCPrivate); ``` @@ -854,7 +854,7 @@ ### FFMS_SetProgressCallback - set callback function for indexing progress updates -[SetProgressCallback]: #ffms_setprogresscallback---set-callback-function-for-indexing-progress-updates +[SetProgressCallback]: #ffms_setprogresscallback-set-callback-function-for-indexing-progress-updates ```c++ void FFMS_SetProgressCallback(FFMS_Indexer *Indexer, TIndexCallback IC, void *ICPrivate); ``` @@ -874,7 +874,7 @@ ### FFMS_CancelIndexing - destroys the given indexer object -[CancelIndexing]: #ffms_cancelindexing---destroys-the-given-indexer-object +[CancelIndexing]: #ffms_cancelindexing-destroys-the-given-indexer-object ```c++ void FFMS_CancelIndexing(FFMS_Indexer *Indexer); ``` @@ -882,7 +882,7 @@ ### FFMS_ReadIndex - reads an index file from disk -[ReadIndex]: #ffms_readindex---reads-an-index-file-from-disk +[ReadIndex]: #ffms_readindex-reads-an-index-file-from-disk ```c++ FFMS_Index *FFMS_ReadIndex(const char *IndexFile, FFMS_ErrorInfo *ErrorInfo); ``` @@ -901,7 +901,7 @@ ### FFMS_IndexBelongsToFile - check if a given index belongs to a given file -[IndexBelongsToFile]: #ffms_indexbelongstofile---check-if-a-given-index-belongs-to-a-given-file +[IndexBelongsToFile]: #ffms_indexbelongstofile-check-if-a-given-index-belongs-to-a-given-file ```c++ int FFMS_IndexBelongsToFile(FFMS_Index *Index, const char *SourceFile, FFMS_ErrorInfo *ErrorInfo); ``` @@ -922,7 +922,7 @@ ### FFMS_WriteIndex - writes an index object to disk -[WriteIndex]: #ffms_writeindex---writes-an-index-object-to-disk +[WriteIndex]: #ffms_writeindex-writes-an-index-object-to-disk ```c++ int FFMS_WriteIndex(const char *IndexFile, FFMS_Index *TrackIndices, FFMS_ErrorInfo *ErrorInfo); ``` @@ -950,7 +950,7 @@ ### FFMS_GetPixFmt - gets a colorspace identifier from a colorspace name -[GetPixFmt]: #ffms_getpixfmt---gets-a-colorspace-identifier-from-a-colorspace-name +[GetPixFmt]: #ffms_getpixfmt-gets-a-colorspace-identifier-from-a-colorspace-name ```c++ int FFMS_GetPixFmt(const char *Name); ``` @@ -972,7 +972,7 @@ ### FFMS_GetPresentSources - checks what source modules the library was compiled with -[GetPresentSources]: #ffms_getpresentsources---checks-what-source-modules-the-library-was-compiled-with +[GetPresentSources]: #ffms_getpresentsources-checks-what-source-modules-the-library-was-compiled-with ```c++ int FFMS_GetPresentSources(); ``` @@ -980,7 +980,7 @@ ### FFMS_GetEnabledSources - checks what source modules are actually available for use -[GetEnabledSources]: #ffms_getenabledsources---checks-what-source-modules-are-actually-available-for-use +[GetEnabledSources]: #ffms_getenabledsources-checks-what-source-modules-are-actually-available-for-use ```c++ int FFMS_GetEnabledSources(); ``` @@ -988,7 +988,7 @@ ### FFMS_GetVersion - returns FFMS_VERSION constant -[GetVersion]: #ffms_getversion---returns-ffms_version-constant +[GetVersion]: #ffms_getversion-returns-ffms_version-constant ```c++ int FFMS_GetVersion(); ``` @@ -996,7 +996,7 @@ ### FFMS_MakeIndex - indexes a given source file [DEPRECATED] -[MakeIndex]: #ffms_makeindex---indexes-a-given-source-file +[MakeIndex]: #ffms_makeindex-indexes-a-given-source-file ```c++ FFMS_Index *FFMS_MakeIndex(const char *SourceFile, int IndexMask, int DumpMask, TAudioNameCallback ANC, void *ANCPrivate, int ErrorHandling, @@ -1095,7 +1095,7 @@ ### FFMS_DoIndexing - indexes the file represented by an indexer object [DEPRECATED] -[DoIndexing]: #ffms_doindexing---indexes-the-file-represented-by-an-indexer-object +[DoIndexing]: #ffms_doindexing-indexes-the-file-represented-by-an-indexer-object ```c++ FFMS_Index *FFMS_DoIndexing(FFMS_Indexer *Indexer, int IndexMask, int DumpMask, TAudioNameCallback ANC, void *ANCPrivate, int ErrorHandling, TIndexCallback IC, void *ICPrivate,