diff options
author | Tuomas Virtanen <katajakasa@gmail.com> | 2018-06-25 01:01:10 +0300 |
---|---|---|
committer | Tuomas Virtanen <katajakasa@gmail.com> | 2018-06-25 01:01:10 +0300 |
commit | 96fcaacab60a582a97938f824cb872145664399b (patch) | |
tree | 0cc0d9c694ff9f14216dce5d4161cc7897ca83a1 | |
parent | 73f97ba21cd86c603c851c39f511c985a4e5f626 (diff) |
Whoops
-rw-r--r-- | doc/enum_Kit_HintType.rst | 32 | ||||
-rw-r--r-- | doc/enum_Kit_PlayerState.rst | 70 | ||||
-rw-r--r-- | doc/enum_Kit_StreamType.rst | 90 | ||||
-rw-r--r-- | doc/global.rst | 381 | ||||
-rw-r--r-- | doc/index.rst | 12 | ||||
-rw-r--r-- | doc/struct_Kit_Codec.rst | 67 | ||||
-rw-r--r-- | doc/struct_Kit_OutputFormat.rst | 107 | ||||
-rw-r--r-- | doc/struct_Kit_Player.rst | 97 | ||||
-rw-r--r-- | doc/struct_Kit_PlayerInfo.rst | 33 | ||||
-rw-r--r-- | doc/struct_Kit_PlayerStreamInfo.rst | 30 | ||||
-rw-r--r-- | doc/struct_Kit_Source.rst | 57 | ||||
-rw-r--r-- | doc/struct_Kit_SourceStreamInfo.rst | 57 | ||||
-rw-r--r-- | doc/struct_Kit_Version.rst | 33 | ||||
-rw-r--r-- | generate-docs.sh | 2 |
14 files changed, 1 insertions, 1067 deletions
diff --git a/doc/enum_Kit_HintType.rst b/doc/enum_Kit_HintType.rst deleted file mode 100644 index 4057316..0000000 --- a/doc/enum_Kit_HintType.rst +++ /dev/null @@ -1,32 +0,0 @@ -.. index:: pair: enum; Kit_HintType -.. _doxid-kitlib_8h_1ad71bf7853ac2e3a7f98bf9638a58844e: -.. _cid-kit_hinttype: - -enum Kit_HintType -================= - - - - - -.. _doxid-kitlib_8h_1ad71bf7853ac2e3a7f98bf9638a58844eac7df99975fe83195bda161e36062aa4f: -.. _cid-kit_hinttype::kit_hint_font_hinting: -.. _doxid-kitlib_8h_1ad71bf7853ac2e3a7f98bf9638a58844ea07d96dfe0b91d89868a035922e378261: -.. _cid-kit_hinttype::kit_hint_thread_count: -.. _doxid-kitlib_8h_1ad71bf7853ac2e3a7f98bf9638a58844ea95497f87575fab85cd942f75ea01664f: -.. _cid-kit_hinttype::kit_hint_video_buffer_frames: -.. _doxid-kitlib_8h_1ad71bf7853ac2e3a7f98bf9638a58844ea7ef75e71851b15db39e113f341ec4e8b: -.. _cid-kit_hinttype::kit_hint_audio_buffer_frames: -.. _doxid-kitlib_8h_1ad71bf7853ac2e3a7f98bf9638a58844ea0cec691c4f2ff4bd2324c717fc5efec7: -.. _cid-kit_hinttype::kit_hint_subtitle_buffer_frames: -.. ref-code-block:: cpp - :class: overview-code-block - - // enum values - - KIT_HINT_FONT_HINTING - KIT_HINT_THREAD_COUNT - KIT_HINT_VIDEO_BUFFER_FRAMES - KIT_HINT_AUDIO_BUFFER_FRAMES - KIT_HINT_SUBTITLE_BUFFER_FRAMES - diff --git a/doc/enum_Kit_PlayerState.rst b/doc/enum_Kit_PlayerState.rst deleted file mode 100644 index e51cb4d..0000000 --- a/doc/enum_Kit_PlayerState.rst +++ /dev/null @@ -1,70 +0,0 @@ -.. index:: pair: enum; Kit_PlayerState -.. _doxid-kitplayer_8h_1a02988a97b08c9a74fed9009f64e6a1b0: -.. _cid-kit_playerstate: - -enum Kit_PlayerState -==================== - - - -Overview -~~~~~~~~ - - - -.. ref-code-block:: cpp - :class: overview-code-block - - // enum values - - :ref:`KIT_STOPPED<doxid-kitplayer_8h_1a02988a97b08c9a74fed9009f64e6a1b0a37c33efe5c4ab0e31f08d2896a4c1c97>` = 0 - :ref:`KIT_PLAYING<doxid-kitplayer_8h_1a02988a97b08c9a74fed9009f64e6a1b0aaff3e9ef5d56a43a94e9cd7bdcea7fca>` - :ref:`KIT_PAUSED<doxid-kitplayer_8h_1a02988a97b08c9a74fed9009f64e6a1b0a1018d4528f321840ea8e3aa24d63a8b1>` - :ref:`KIT_CLOSED<doxid-kitplayer_8h_1a02988a97b08c9a74fed9009f64e6a1b0af61b5f082f5efefa088235bf838206bd>` - -.. _details-doxid-kitplayer_8h_1a02988a97b08c9a74fed9009f64e6a1b0: - -Detailed Documentation -~~~~~~~~~~~~~~~~~~~~~~ - - - -Enum Values ------------ - -.. _doxid-kitplayer_8h_1a02988a97b08c9a74fed9009f64e6a1b0a37c33efe5c4ab0e31f08d2896a4c1c97: -.. _cid-kit_playerstate::kit_stopped: -.. ref-code-block:: cpp - :class: title-code-block - - KIT_STOPPED - -Playback stopped or has not started yet. - -.. _doxid-kitplayer_8h_1a02988a97b08c9a74fed9009f64e6a1b0aaff3e9ef5d56a43a94e9cd7bdcea7fca: -.. _cid-kit_playerstate::kit_playing: -.. ref-code-block:: cpp - :class: title-code-block - - KIT_PLAYING - -Playback started & player is actively decoding. - -.. _doxid-kitplayer_8h_1a02988a97b08c9a74fed9009f64e6a1b0a1018d4528f321840ea8e3aa24d63a8b1: -.. _cid-kit_playerstate::kit_paused: -.. ref-code-block:: cpp - :class: title-code-block - - KIT_PAUSED - -Playback paused; player is actively decoding but no new data is given out. - -.. _doxid-kitplayer_8h_1a02988a97b08c9a74fed9009f64e6a1b0af61b5f082f5efefa088235bf838206bd: -.. _cid-kit_playerstate::kit_closed: -.. ref-code-block:: cpp - :class: title-code-block - - KIT_CLOSED - -Playback is stopped and player is closing. - diff --git a/doc/enum_Kit_StreamType.rst b/doc/enum_Kit_StreamType.rst deleted file mode 100644 index f634843..0000000 --- a/doc/enum_Kit_StreamType.rst +++ /dev/null @@ -1,90 +0,0 @@ -.. index:: pair: enum; Kit_StreamType -.. _doxid-kitsource_8h_1af54654f42d6733aacfe0f6a95379d9c2: -.. _cid-kit_streamtype: - -enum Kit_StreamType -=================== - - - -Overview -~~~~~~~~ - - - -.. ref-code-block:: cpp - :class: overview-code-block - - // enum values - - :ref:`KIT_STREAMTYPE_UNKNOWN<doxid-kitsource_8h_1af54654f42d6733aacfe0f6a95379d9c2aa5abdfe502b8e8b1417b5ebd68ba3845>` - :ref:`KIT_STREAMTYPE_VIDEO<doxid-kitsource_8h_1af54654f42d6733aacfe0f6a95379d9c2a023f5adbc02e2f58bc6faeb45e401a6f>` - :ref:`KIT_STREAMTYPE_AUDIO<doxid-kitsource_8h_1af54654f42d6733aacfe0f6a95379d9c2aafa789005f90a81cddb4307ac6bae2b6>` - :ref:`KIT_STREAMTYPE_DATA<doxid-kitsource_8h_1af54654f42d6733aacfe0f6a95379d9c2ae017b34b4994b58fedd2231d24a21b68>` - :ref:`KIT_STREAMTYPE_SUBTITLE<doxid-kitsource_8h_1af54654f42d6733aacfe0f6a95379d9c2af963735c85f94f4b41caf748ba1645a7>` - :ref:`KIT_STREAMTYPE_ATTACHMENT<doxid-kitsource_8h_1af54654f42d6733aacfe0f6a95379d9c2ae177efdb8cd6f01732fcbc46979abb66>` - -.. _details-doxid-kitsource_8h_1af54654f42d6733aacfe0f6a95379d9c2: - -Detailed Documentation -~~~~~~~~~~~~~~~~~~~~~~ - - - -Enum Values ------------ - -.. _doxid-kitsource_8h_1af54654f42d6733aacfe0f6a95379d9c2aa5abdfe502b8e8b1417b5ebd68ba3845: -.. _cid-kit_streamtype::kit_streamtype_unknown: -.. ref-code-block:: cpp - :class: title-code-block - - KIT_STREAMTYPE_UNKNOWN - -Unknown stream type. - -.. _doxid-kitsource_8h_1af54654f42d6733aacfe0f6a95379d9c2a023f5adbc02e2f58bc6faeb45e401a6f: -.. _cid-kit_streamtype::kit_streamtype_video: -.. ref-code-block:: cpp - :class: title-code-block - - KIT_STREAMTYPE_VIDEO - -Video stream. - -.. _doxid-kitsource_8h_1af54654f42d6733aacfe0f6a95379d9c2aafa789005f90a81cddb4307ac6bae2b6: -.. _cid-kit_streamtype::kit_streamtype_audio: -.. ref-code-block:: cpp - :class: title-code-block - - KIT_STREAMTYPE_AUDIO - -Audio stream. - -.. _doxid-kitsource_8h_1af54654f42d6733aacfe0f6a95379d9c2ae017b34b4994b58fedd2231d24a21b68: -.. _cid-kit_streamtype::kit_streamtype_data: -.. ref-code-block:: cpp - :class: title-code-block - - KIT_STREAMTYPE_DATA - -Data stream. - -.. _doxid-kitsource_8h_1af54654f42d6733aacfe0f6a95379d9c2af963735c85f94f4b41caf748ba1645a7: -.. _cid-kit_streamtype::kit_streamtype_subtitle: -.. ref-code-block:: cpp - :class: title-code-block - - KIT_STREAMTYPE_SUBTITLE - -Subtitle streawm. - -.. _doxid-kitsource_8h_1af54654f42d6733aacfe0f6a95379d9c2ae177efdb8cd6f01732fcbc46979abb66: -.. _cid-kit_streamtype::kit_streamtype_attachment: -.. ref-code-block:: cpp - :class: title-code-block - - KIT_STREAMTYPE_ATTACHMENT - -Attachment stream (images, etc) - diff --git a/doc/global.rst b/doc/global.rst deleted file mode 100644 index 6df6ce5..0000000 --- a/doc/global.rst +++ /dev/null @@ -1,381 +0,0 @@ -.. _global-namespace: - -Global Namespace -================ - -.. index:: pair: namespace; global - -.. toctree:: - :hidden: - - enum_Kit_HintType.rst - enum_Kit_PlayerState.rst - enum_Kit_StreamType.rst - struct_Kit_Codec.rst - struct_Kit_OutputFormat.rst - struct_Kit_Player.rst - struct_Kit_PlayerInfo.rst - struct_Kit_PlayerStreamInfo.rst - struct_Kit_Source.rst - struct_Kit_SourceStreamInfo.rst - struct_Kit_Version.rst - - - -Overview -~~~~~~~~ - - - -.. _doxid-kitsource_8h_1aeee27e7a9aec5db8c436f9b654069f96: -.. _cid-kit_readcallback: -.. _doxid-kitsource_8h_1af1bf42b44a8adbb44f3c5cbdf5fb9994: -.. _cid-kit_seekcallback: -.. _doxid-kitlib_8h_1a06fc87d81c62e9abb8790b6e5713c55bac83d5d0a8047f9539b812b345e474514: -.. _cid-kit_font_hinting_none: -.. _doxid-kitlib_8h_1a06fc87d81c62e9abb8790b6e5713c55bad0e31158321ea49d89964fb97b790df7: -.. _cid-kit_font_hinting_light: -.. _doxid-kitlib_8h_1a06fc87d81c62e9abb8790b6e5713c55ba781efa23bf6f887cc48f2413e9fc100b: -.. _cid-kit_font_hinting_normal: -.. _doxid-kitlib_8h_1a06fc87d81c62e9abb8790b6e5713c55ba97b38fff75460ebb01550e49fe4216a4: -.. _cid-kit_font_hinting_native: -.. _doxid-kitlib_8h_1a06fc87d81c62e9abb8790b6e5713c55baa7ed6dce828d3ae8c6103f3fae788c7f: -.. _cid-kit_font_hinting_count: -.. _doxid-kitlib_8h_1adf764cbdea00d65edcd07bb9953ad2b7a22ca5f271135f2d71ce2ab22a41edbfa: -.. _cid-kit_init_network: -.. _doxid-kitlib_8h_1adf764cbdea00d65edcd07bb9953ad2b7a62c9dc6b5a2b836dccc78b3de7bb5a25: -.. _cid-kit_init_ass: -.. _doxid-kiterror_8h_1aa87517d3272e56a664be753f983a105e: -.. _cid-kit_geterror: -.. _doxid-kiterror_8h_1a142e957051a9255cd1163f75f390e09e: -.. _cid-kit_seterror: -.. _doxid-kiterror_8h_1abb81d1212de0be17b9d3d6360808ee07: -.. _cid-kit_clearerror: -.. _doxid-kitlib_8h_1aaf1aa9267665ec110fce23bdefe3b859: -.. _cid-kit_init: -.. _doxid-kitlib_8h_1a61597347333fdb5a32ad6a0c0a56bff2: -.. _cid-kit_quit: -.. _doxid-kitlib_8h_1a381a1975f68a9f38a84079a375ba7a37: -.. _cid-kit_sethint: -.. _doxid-kitlib_8h_1a00a081690155922333437007e5a8847e: -.. _cid-kit_gethint: -.. _doxid-kitlib_8h_1abccf63b4ede524b6a983ae2f4314cd3a: -.. _cid-kit_getversion: -.. _doxid-kitplayer_8h_1ae289e32c4b7247f1d9745f0efe69be88: -.. _cid-kit_createplayer: -.. _doxid-kitplayer_8h_1a11f15d871f0f00cfd317d7d7631bddc7: -.. _cid-kit_closeplayer: -.. _doxid-kitplayer_8h_1a37c2594af61d78283b0b0931327ab8c6: -.. _cid-kit_setplayerscreensize: -.. _doxid-kitplayer_8h_1a1c5af5c46faa6146910a4c475a099b6a: -.. _cid-kit_getplayervideostream: -.. _doxid-kitplayer_8h_1a65cacfbd2473753b5da5ba4b8c11cb57: -.. _cid-kit_getplayeraudiostream: -.. _doxid-kitplayer_8h_1a27eac12c57193ea1df5cab9fa3ad05a1: -.. _cid-kit_getplayersubtitlestream: -.. _doxid-kitplayer_8h_1ada1f6861f415600a168667b03d665bf0: -.. _cid-kit_updateplayer: -.. _doxid-kitplayer_8h_1ab624ca871d996116327cde4d7d171f86: -.. _cid-kit_getplayervideodata: -.. _doxid-kitplayer_8h_1a9da1e6368fb42bee61170ba5259b55e9: -.. _cid-kit_getplayersubtitledata: -.. _doxid-kitplayer_8h_1a396d9e6611a79071730b18cbf8d43a75: -.. _cid-kit_getplayeraudiodata: -.. _doxid-kitplayer_8h_1a1dffc4e565f60fec223032b3c52bc6f5: -.. _cid-kit_getplayerinfo: -.. _doxid-kitplayer_8h_1a7e9c3b0f5ced1ad65336f3c7543147d8: -.. _cid-kit_getplayerstate: -.. _doxid-kitplayer_8h_1aff4b23fded79add9ee40df9ee17ca5fd: -.. _cid-kit_playerplay: -.. _doxid-kitplayer_8h_1ae05f61f1246c7845527fac2647b3e2f1: -.. _cid-kit_playerstop: -.. _doxid-kitplayer_8h_1a30378eb20bb95f9a13c83674767e9539: -.. _cid-kit_playerpause: -.. _doxid-kitplayer_8h_1a13687f4ec1a0ea21fa1ce6387107cfa6: -.. _cid-kit_playerseek: -.. _doxid-kitplayer_8h_1a721a87d0bdad1f16d8e32d75b9598a67: -.. _cid-kit_getplayerduration: -.. _doxid-kitplayer_8h_1a3083744312ce3b37e63be1e47151d1a4: -.. _cid-kit_getplayerposition: -.. _doxid-kitsource_8h_1a2033cf689466faa2aa2c61bed2de3f3e: -.. _cid-kit_createsourcefromurl: -.. _doxid-kitsource_8h_1a4674541bc8c95db9500c8ac5a09149fe: -.. _cid-kit_createsourcefromcustom: -.. _doxid-kitsource_8h_1ae5b6e651789b308c594f7040a6e6bd2e: -.. _cid-kit_closesource: -.. _doxid-kitsource_8h_1ab832e7a5db41f73af3ec849f6ff7bbaa: -.. _cid-kit_getsourcestreaminfo: -.. _doxid-kitsource_8h_1a1a8ac4a412646ca5b445e0e75165fd1f: -.. _cid-kit_getsourcestreamcount: -.. _doxid-kitsource_8h_1afd339c3956193700466eddd51ddc7b70: -.. _cid-kit_getbestsourcestream: -.. _doxid-kitconfig_8h_1ab1c036a10f5a265f155e61f6e4b53eac: -.. _cid-kit_api: -.. _doxid-kitcodec_8h_1a403358e3731b03abe43227b7d0bba494: -.. _cid-kit_codec_desc_max: -.. _doxid-kitcodec_8h_1a8df06194dd3ad7073060f3ffe5d95ee4: -.. _cid-kit_codec_name_max: -.. _doxid-kitconfig_8h_1af58c772c6f0da16b8258b23bd2253ec5: -.. _cid-kit_dll_export: -.. _doxid-kitconfig_8h_1a6a6ecbe120951240795535a3622c3d4c: -.. _cid-kit_dll_import: -.. _doxid-kitconfig_8h_1af4944ba06c64765f9066a689e74fe13b: -.. _cid-kit_dll_local: -.. _doxid-kitconfig_8h_1aad54d0729497924f16c2e4ffa87c9509: -.. _cid-kit_local: -.. ref-code-block:: cpp - :class: overview-code-block - - // typedefs - - typedef int (* Kit_ReadCallback)( - void *, - uint8_t *, - int - ) - - typedef int64_t (* Kit_SeekCallback)( - void *, - int64_t, - int - ) - - // enums - - enum - { - KIT_FONT_HINTING_NONE = 0 - KIT_FONT_HINTING_LIGHT - KIT_FONT_HINTING_NORMAL - KIT_FONT_HINTING_NATIVE - KIT_FONT_HINTING_COUNT - } - - enum - { - KIT_INIT_NETWORK = 0x1 - KIT_INIT_ASS = 0x2 - } - - enum :ref:`Kit_HintType<doxid-kitlib_8h_1ad71bf7853ac2e3a7f98bf9638a58844e>` - enum :ref:`Kit_PlayerState<doxid-kitplayer_8h_1a02988a97b08c9a74fed9009f64e6a1b0>` - enum :ref:`Kit_StreamType<doxid-kitsource_8h_1af54654f42d6733aacfe0f6a95379d9c2>` - - // structs - - struct :ref:`Kit_Codec<doxid-struct_kit___codec>` - struct :ref:`Kit_OutputFormat<doxid-struct_kit___output_format>` - struct :ref:`Kit_Player<doxid-struct_kit___player>` - struct :ref:`Kit_PlayerInfo<doxid-struct_kit___player_info>` - struct :ref:`Kit_PlayerStreamInfo<doxid-struct_kit___player_stream_info>` - struct :ref:`Kit_Source<doxid-struct_kit___source>` - struct :ref:`Kit_SourceStreamInfo<doxid-struct_kit___source_stream_info>` - struct :ref:`Kit_Version<doxid-struct_kit___version>` - - // global functions - - :ref:`KIT_API<doxid-kitconfig_8h_1ab1c036a10f5a265f155e61f6e4b53eac>` const char* Kit_GetError () - - :ref:`KIT_API<doxid-kitconfig_8h_1ab1c036a10f5a265f155e61f6e4b53eac>` void Kit_SetError ( - const char* fmt, - ... - ) - - :ref:`KIT_API<doxid-kitconfig_8h_1ab1c036a10f5a265f155e61f6e4b53eac>` void Kit_ClearError () - :ref:`KIT_API<doxid-kitconfig_8h_1ab1c036a10f5a265f155e61f6e4b53eac>` int Kit_Init (unsigned int flags) - :ref:`KIT_API<doxid-kitconfig_8h_1ab1c036a10f5a265f155e61f6e4b53eac>` void Kit_Quit () - - :ref:`KIT_API<doxid-kitconfig_8h_1ab1c036a10f5a265f155e61f6e4b53eac>` void Kit_SetHint ( - :ref:`Kit_HintType<doxid-kitlib_8h_1ad71bf7853ac2e3a7f98bf9638a58844e>` type, - int value - ) - - :ref:`KIT_API<doxid-kitconfig_8h_1ab1c036a10f5a265f155e61f6e4b53eac>` int Kit_GetHint (:ref:`Kit_HintType<doxid-kitlib_8h_1ad71bf7853ac2e3a7f98bf9638a58844e>` type) - :ref:`KIT_API<doxid-kitconfig_8h_1ab1c036a10f5a265f155e61f6e4b53eac>` void Kit_GetVersion (:ref:`Kit_Version<doxid-struct_kit___version>`* version) - - :ref:`KIT_API<doxid-kitconfig_8h_1ab1c036a10f5a265f155e61f6e4b53eac>` :ref:`Kit_Player<doxid-struct_kit___player>`* Kit_CreatePlayer ( - const :ref:`Kit_Source<doxid-struct_kit___source>`* src, - int video_stream_index, - int audio_stream_index, - int subtitle_stream_index, - int screen_w, - int screen_h - ) - - :ref:`KIT_API<doxid-kitconfig_8h_1ab1c036a10f5a265f155e61f6e4b53eac>` void Kit_ClosePlayer (:ref:`Kit_Player<doxid-struct_kit___player>`* player) - - :ref:`KIT_API<doxid-kitconfig_8h_1ab1c036a10f5a265f155e61f6e4b53eac>` void Kit_SetPlayerScreenSize ( - :ref:`Kit_Player<doxid-struct_kit___player>`* player, - int w, - int h - ) - - :ref:`KIT_API<doxid-kitconfig_8h_1ab1c036a10f5a265f155e61f6e4b53eac>` int Kit_GetPlayerVideoStream (const :ref:`Kit_Player<doxid-struct_kit___player>`* player) - :ref:`KIT_API<doxid-kitconfig_8h_1ab1c036a10f5a265f155e61f6e4b53eac>` int Kit_GetPlayerAudioStream (const :ref:`Kit_Player<doxid-struct_kit___player>`* player) - :ref:`KIT_API<doxid-kitconfig_8h_1ab1c036a10f5a265f155e61f6e4b53eac>` int Kit_GetPlayerSubtitleStream (const :ref:`Kit_Player<doxid-struct_kit___player>`* player) - :ref:`KIT_API<doxid-kitconfig_8h_1ab1c036a10f5a265f155e61f6e4b53eac>` int Kit_UpdatePlayer (:ref:`Kit_Player<doxid-struct_kit___player>`* player) - - :ref:`KIT_API<doxid-kitconfig_8h_1ab1c036a10f5a265f155e61f6e4b53eac>` int Kit_GetPlayerVideoData ( - :ref:`Kit_Player<doxid-struct_kit___player>`* player, - SDL_Texture* texture - ) - - :ref:`KIT_API<doxid-kitconfig_8h_1ab1c036a10f5a265f155e61f6e4b53eac>` int Kit_GetPlayerSubtitleData ( - :ref:`Kit_Player<doxid-struct_kit___player>`* player, - SDL_Texture* texture, - SDL_Rect* sources, - SDL_Rect* targets, - int limit - ) - - :ref:`KIT_API<doxid-kitconfig_8h_1ab1c036a10f5a265f155e61f6e4b53eac>` int Kit_GetPlayerAudioData ( - :ref:`Kit_Player<doxid-struct_kit___player>`* player, - unsigned char* buffer, - int length - ) - - :ref:`KIT_API<doxid-kitconfig_8h_1ab1c036a10f5a265f155e61f6e4b53eac>` void Kit_GetPlayerInfo ( - const :ref:`Kit_Player<doxid-struct_kit___player>`* player, - :ref:`Kit_PlayerInfo<doxid-struct_kit___player_info>`* info - ) - - :ref:`KIT_API<doxid-kitconfig_8h_1ab1c036a10f5a265f155e61f6e4b53eac>` :ref:`Kit_PlayerState<doxid-kitplayer_8h_1a02988a97b08c9a74fed9009f64e6a1b0>` Kit_GetPlayerState (const :ref:`Kit_Player<doxid-struct_kit___player>`* player) - :ref:`KIT_API<doxid-kitconfig_8h_1ab1c036a10f5a265f155e61f6e4b53eac>` void Kit_PlayerPlay (:ref:`Kit_Player<doxid-struct_kit___player>`* player) - :ref:`KIT_API<doxid-kitconfig_8h_1ab1c036a10f5a265f155e61f6e4b53eac>` void Kit_PlayerStop (:ref:`Kit_Player<doxid-struct_kit___player>`* player) - :ref:`KIT_API<doxid-kitconfig_8h_1ab1c036a10f5a265f155e61f6e4b53eac>` void Kit_PlayerPause (:ref:`Kit_Player<doxid-struct_kit___player>`* player) - - :ref:`KIT_API<doxid-kitconfig_8h_1ab1c036a10f5a265f155e61f6e4b53eac>` int Kit_PlayerSeek ( - :ref:`Kit_Player<doxid-struct_kit___player>`* player, - double time - ) - - :ref:`KIT_API<doxid-kitconfig_8h_1ab1c036a10f5a265f155e61f6e4b53eac>` double Kit_GetPlayerDuration (const :ref:`Kit_Player<doxid-struct_kit___player>`* player) - :ref:`KIT_API<doxid-kitconfig_8h_1ab1c036a10f5a265f155e61f6e4b53eac>` double Kit_GetPlayerPosition (const :ref:`Kit_Player<doxid-struct_kit___player>`* player) - :ref:`KIT_API<doxid-kitconfig_8h_1ab1c036a10f5a265f155e61f6e4b53eac>` :ref:`Kit_Source<doxid-struct_kit___source>`* Kit_CreateSourceFromUrl (const char* path) - - :ref:`KIT_API<doxid-kitconfig_8h_1ab1c036a10f5a265f155e61f6e4b53eac>` :ref:`Kit_Source<doxid-struct_kit___source>`* Kit_CreateSourceFromCustom ( - :ref:`Kit_ReadCallback<doxid-kitsource_8h_1aeee27e7a9aec5db8c436f9b654069f96>` read_cb, - :ref:`Kit_SeekCallback<doxid-kitsource_8h_1af1bf42b44a8adbb44f3c5cbdf5fb9994>` seek_cb, - void* userdata - ) - - :ref:`KIT_API<doxid-kitconfig_8h_1ab1c036a10f5a265f155e61f6e4b53eac>` void Kit_CloseSource (:ref:`Kit_Source<doxid-struct_kit___source>`* src) - - :ref:`KIT_API<doxid-kitconfig_8h_1ab1c036a10f5a265f155e61f6e4b53eac>` int Kit_GetSourceStreamInfo ( - const :ref:`Kit_Source<doxid-struct_kit___source>`* src, - :ref:`Kit_SourceStreamInfo<doxid-struct_kit___source_stream_info>`* info, - int index - ) - - :ref:`KIT_API<doxid-kitconfig_8h_1ab1c036a10f5a265f155e61f6e4b53eac>` int Kit_GetSourceStreamCount (const :ref:`Kit_Source<doxid-struct_kit___source>`* src) - - :ref:`KIT_API<doxid-kitconfig_8h_1ab1c036a10f5a265f155e61f6e4b53eac>` int Kit_GetBestSourceStream ( - const :ref:`Kit_Source<doxid-struct_kit___source>`* src, - const :ref:`Kit_StreamType<doxid-kitsource_8h_1af54654f42d6733aacfe0f6a95379d9c2>` type - ) - - :ref:`KIT_API<doxid-kitconfig_8h_1ab1c036a10f5a265f155e61f6e4b53eac>` const char* :ref:`Kit_GetSDLAudioFormatString<doxid-kitutils_8h_1af0fd2df7dded6af732b481209d004b26>` (unsigned int type) - :ref:`KIT_API<doxid-kitconfig_8h_1ab1c036a10f5a265f155e61f6e4b53eac>` const char* :ref:`Kit_GetSDLPixelFormatString<doxid-kitutils_8h_1a553ebe72950a7687874f9a0f5b737138>` (unsigned int type) - :ref:`KIT_API<doxid-kitconfig_8h_1ab1c036a10f5a265f155e61f6e4b53eac>` const char* :ref:`Kit_GetKitStreamTypeString<doxid-kitutils_8h_1ac8e439b66934625d4d46c660d111fedd>` (unsigned int type) - - // macros - - #define KIT_API - #define KIT_CODEC_DESC_MAX - #define KIT_CODEC_NAME_MAX - #define KIT_DLL_EXPORT - #define KIT_DLL_IMPORT - #define KIT_DLL_LOCAL - #define KIT_LOCAL - -.. _details-doxid-global: - -Detailed Documentation -~~~~~~~~~~~~~~~~~~~~~~ - - - -Global Functions ----------------- - -.. _doxid-kitutils_8h_1af0fd2df7dded6af732b481209d004b26: -.. _cid-kit_getsdlaudioformatstring: -.. ref-code-block:: cpp - :class: title-code-block - - :ref:`KIT_API<doxid-kitconfig_8h_1ab1c036a10f5a265f155e61f6e4b53eac>` const char* Kit_GetSDLAudioFormatString (unsigned int type) - -Returns a descriptive string for SDL audio format types. - - - -.. rubric:: Parameters: - -.. list-table:: - :widths: 20 80 - - * - - type - - - SDL_AudioFormat - - - -.. rubric:: Returns: - -Format string, eg. "AUDIO_S8". - -.. _doxid-kitutils_8h_1a553ebe72950a7687874f9a0f5b737138: -.. _cid-kit_getsdlpixelformatstring: -.. ref-code-block:: cpp - :class: title-code-block - - :ref:`KIT_API<doxid-kitconfig_8h_1ab1c036a10f5a265f155e61f6e4b53eac>` const char* Kit_GetSDLPixelFormatString (unsigned int type) - -Returns a descriptive string for SDL pixel format types. - - - -.. rubric:: Parameters: - -.. list-table:: - :widths: 20 80 - - * - - type - - - SDL_PixelFormat - - - -.. rubric:: Returns: - -Format string, eg. "SDL_PIXELFORMAT_YV12" - -.. _doxid-kitutils_8h_1ac8e439b66934625d4d46c660d111fedd: -.. _cid-kit_getkitstreamtypestring: -.. ref-code-block:: cpp - :class: title-code-block - - :ref:`KIT_API<doxid-kitconfig_8h_1ab1c036a10f5a265f155e61f6e4b53eac>` const char* Kit_GetKitStreamTypeString (unsigned int type) - -Returns a descriptibe string for Kitchensink stream types. - - - -.. rubric:: Parameters: - -.. list-table:: - :widths: 20 80 - - * - - type - - - Kit_StreamType - - - -.. rubric:: Returns: - -Format string, eg. "KIT_STREAMTYPE_VIDEO" - diff --git a/doc/index.rst b/doc/index.rst deleted file mode 100644 index 9e3147f..0000000 --- a/doc/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -My Project Documentation -======================== - -.. rubric:: Reference and Index: - -.. toctree:: - :hidden: - - global.rst - -| :doc:`global` -| :ref:`genindex` diff --git a/doc/struct_Kit_Codec.rst b/doc/struct_Kit_Codec.rst deleted file mode 100644 index 23e6d8b..0000000 --- a/doc/struct_Kit_Codec.rst +++ /dev/null @@ -1,67 +0,0 @@ -.. index:: pair: struct; Kit_Codec -.. _doxid-struct_kit___codec: -.. _cid-kit_codec: - -struct Kit_Codec -================ - -.. toctree:: - :hidden: - -.. code-block:: cpp - :class: overview-code-block - - #include <kitcodec.h> - - -Overview -~~~~~~~~ - - - -.. ref-code-block:: cpp - :class: overview-code-block - - // fields - - unsigned int :ref:`threads<doxid-struct_kit___codec_1a936dd913b2909941e76f5557b1d58513>` - char :ref:`name<doxid-struct_kit___codec_1ad4f851cd09bb98a6f627ce89012535df>`[KIT_CODEC_NAME_MAX] - char :ref:`description<doxid-struct_kit___codec_1a541467f595a7146e131297fb7a34a177>`[KIT_CODEC_DESC_MAX] - -.. _details-doxid-struct_kit___codec: - -Detailed Documentation -~~~~~~~~~~~~~~~~~~~~~~ - - - -Fields ------- - -.. _doxid-struct_kit___codec_1a936dd913b2909941e76f5557b1d58513: -.. _cid-kit_codec::threads: -.. ref-code-block:: cpp - :class: title-code-block - - unsigned int threads - -Currently enabled threads. - -.. _doxid-struct_kit___codec_1ad4f851cd09bb98a6f627ce89012535df: -.. _cid-kit_codec::name: -.. ref-code-block:: cpp - :class: title-code-block - - char name [KIT_CODEC_NAME_MAX] - -Codec short name, eg. "ogg" or "webm". - -.. _doxid-struct_kit___codec_1a541467f595a7146e131297fb7a34a177: -.. _cid-kit_codec::description: -.. ref-code-block:: cpp - :class: title-code-block - - char description [KIT_CODEC_DESC_MAX] - -Codec longer, more descriptive name. - diff --git a/doc/struct_Kit_OutputFormat.rst b/doc/struct_Kit_OutputFormat.rst deleted file mode 100644 index 617748e..0000000 --- a/doc/struct_Kit_OutputFormat.rst +++ /dev/null @@ -1,107 +0,0 @@ -.. index:: pair: struct; Kit_OutputFormat -.. _doxid-struct_kit___output_format: -.. _cid-kit_outputformat: - -struct Kit_OutputFormat -======================= - -.. toctree:: - :hidden: - -.. code-block:: cpp - :class: overview-code-block - - #include <kitformat.h> - - -Overview -~~~~~~~~ - - - -.. ref-code-block:: cpp - :class: overview-code-block - - // fields - - unsigned int :ref:`format<doxid-struct_kit___output_format_1a5d458a74effbd53125e25132e7bbe51a>` - bool :ref:`is_signed<doxid-struct_kit___output_format_1abd9639f26071284d0089f5faa5cf9c35>` - int :ref:`bytes<doxid-struct_kit___output_format_1ab498771bc7b91153549229f063c563d9>` - int :ref:`samplerate<doxid-struct_kit___output_format_1ab93e998816c7838c471e923d0ecfa011>` - int :ref:`channels<doxid-struct_kit___output_format_1ab644e71c41825fc55a7fa2bbf4e1e795>` - int :ref:`width<doxid-struct_kit___output_format_1a69cf1282972c007c95fcffaf393de309>` - int :ref:`height<doxid-struct_kit___output_format_1a8e0d763cd312c37baf5fd7e052ffaba5>` - -.. _details-doxid-struct_kit___output_format: - -Detailed Documentation -~~~~~~~~~~~~~~~~~~~~~~ - - - -Fields ------- - -.. _doxid-struct_kit___output_format_1a5d458a74effbd53125e25132e7bbe51a: -.. _cid-kit_outputformat::format: -.. ref-code-block:: cpp - :class: title-code-block - - unsigned int format - -SDL Format. - -.. _doxid-struct_kit___output_format_1abd9639f26071284d0089f5faa5cf9c35: -.. _cid-kit_outputformat::is_signed: -.. ref-code-block:: cpp - :class: title-code-block - - bool is_signed - -Signedness (if audio) - -.. _doxid-struct_kit___output_format_1ab498771bc7b91153549229f063c563d9: -.. _cid-kit_outputformat::bytes: -.. ref-code-block:: cpp - :class: title-code-block - - int bytes - -Bytes per sample per channel (if audio) - -.. _doxid-struct_kit___output_format_1ab93e998816c7838c471e923d0ecfa011: -.. _cid-kit_outputformat::samplerate: -.. ref-code-block:: cpp - :class: title-code-block - - int samplerate - -Sampling rate (if audio) - -.. _doxid-struct_kit___output_format_1ab644e71c41825fc55a7fa2bbf4e1e795: -.. _cid-kit_outputformat::channels: -.. ref-code-block:: cpp - :class: title-code-block - - int channels - -Channels (if audio) - -.. _doxid-struct_kit___output_format_1a69cf1282972c007c95fcffaf393de309: -.. _cid-kit_outputformat::width: -.. ref-code-block:: cpp - :class: title-code-block - - int width - -Width in pixels (if video) - -.. _doxid-struct_kit___output_format_1a8e0d763cd312c37baf5fd7e052ffaba5: -.. _cid-kit_outputformat::height: -.. ref-code-block:: cpp - :class: title-code-block - - int height - -Height in pixels (if video) - diff --git a/doc/struct_Kit_Player.rst b/doc/struct_Kit_Player.rst deleted file mode 100644 index 0279330..0000000 --- a/doc/struct_Kit_Player.rst +++ /dev/null @@ -1,97 +0,0 @@ -.. index:: pair: struct; Kit_Player -.. _doxid-struct_kit___player: -.. _cid-kit_player: - -struct Kit_Player -================= - -.. toctree:: - :hidden: - -.. code-block:: cpp - :class: overview-code-block - - #include <kitplayer.h> - - -Overview -~~~~~~~~ - - - -.. ref-code-block:: cpp - :class: overview-code-block - - // fields - - :ref:`Kit_PlayerState<doxid-kitplayer_8h_1a02988a97b08c9a74fed9009f64e6a1b0>` :ref:`state<doxid-struct_kit___player_1aeaf3509c9fa8e94895a51617a26e547e>` - void* :ref:`decoders<doxid-struct_kit___player_1a488627172ff25490c078af37e5990bad>`[3] - SDL_Thread* :ref:`dec_thread<doxid-struct_kit___player_1ada80740b051471386256483a559f01b5>` - SDL_mutex* :ref:`dec_lock<doxid-struct_kit___player_1aea2d87aa236c94fee5fa4d552fe877e6>` - const :ref:`Kit_Source<doxid-struct_kit___source>`* :ref:`src<doxid-struct_kit___player_1a9fac0eb022fd8fec32a3e976140413f3>` - double :ref:`pause_started<doxid-struct_kit___player_1a3a064f029f174ff2d6df292565f81856>` - -.. _details-doxid-struct_kit___player: - -Detailed Documentation -~~~~~~~~~~~~~~~~~~~~~~ - - - -Fields ------- - -.. _doxid-struct_kit___player_1aeaf3509c9fa8e94895a51617a26e547e: -.. _cid-kit_player::state: -.. ref-code-block:: cpp - :class: title-code-block - - :ref:`Kit_PlayerState<doxid-kitplayer_8h_1a02988a97b08c9a74fed9009f64e6a1b0>` state - -Playback state. - -.. _doxid-struct_kit___player_1a488627172ff25490c078af37e5990bad: -.. _cid-kit_player::decoders: -.. ref-code-block:: cpp - :class: title-code-block - - void* decoders [3] - -Decoder contexts. - -.. _doxid-struct_kit___player_1ada80740b051471386256483a559f01b5: -.. _cid-kit_player::dec_thread: -.. ref-code-block:: cpp - :class: title-code-block - - SDL_Thread* dec_thread - -Decoder thread. - -.. _doxid-struct_kit___player_1aea2d87aa236c94fee5fa4d552fe877e6: -.. _cid-kit_player::dec_lock: -.. ref-code-block:: cpp - :class: title-code-block - - SDL_mutex* dec_lock - -Decoder lock. - -.. _doxid-struct_kit___player_1a9fac0eb022fd8fec32a3e976140413f3: -.. _cid-kit_player::src: -.. ref-code-block:: cpp - :class: title-code-block - - const :ref:`Kit_Source<doxid-struct_kit___source>`* src - -Reference to Audio/Video source. - -.. _doxid-struct_kit___player_1a3a064f029f174ff2d6df292565f81856: -.. _cid-kit_player::pause_started: -.. ref-code-block:: cpp - :class: title-code-block - - double pause_started - -Temporary flag for handling pauses. - diff --git a/doc/struct_Kit_PlayerInfo.rst b/doc/struct_Kit_PlayerInfo.rst deleted file mode 100644 index c384734..0000000 --- a/doc/struct_Kit_PlayerInfo.rst +++ /dev/null @@ -1,33 +0,0 @@ -.. index:: pair: struct; Kit_PlayerInfo -.. _doxid-struct_kit___player_info: -.. _cid-kit_playerinfo: - -struct Kit_PlayerInfo -===================== - -.. toctree:: - :hidden: - -.. code-block:: cpp - :class: overview-code-block - - #include <kitplayer.h> - - - - -.. _doxid-struct_kit___player_info_1ae05114ab6d4f22ae0542973f00e8ca0a: -.. _cid-kit_playerinfo::video: -.. _doxid-struct_kit___player_info_1aacf91672a10c3b29cb1586459a4b1043: -.. _cid-kit_playerinfo::audio: -.. _doxid-struct_kit___player_info_1a00e00f031ceff73880e16125a333c7dc: -.. _cid-kit_playerinfo::subtitle: -.. ref-code-block:: cpp - :class: overview-code-block - - // fields - - :ref:`Kit_PlayerStreamInfo<doxid-struct_kit___player_stream_info>` video - :ref:`Kit_PlayerStreamInfo<doxid-struct_kit___player_stream_info>` audio - :ref:`Kit_PlayerStreamInfo<doxid-struct_kit___player_stream_info>` subtitle - diff --git a/doc/struct_Kit_PlayerStreamInfo.rst b/doc/struct_Kit_PlayerStreamInfo.rst deleted file mode 100644 index 91f17b5..0000000 --- a/doc/struct_Kit_PlayerStreamInfo.rst +++ /dev/null @@ -1,30 +0,0 @@ -.. index:: pair: struct; Kit_PlayerStreamInfo -.. _doxid-struct_kit___player_stream_info: -.. _cid-kit_playerstreaminfo: - -struct Kit_PlayerStreamInfo -=========================== - -.. toctree:: - :hidden: - -.. code-block:: cpp - :class: overview-code-block - - #include <kitplayer.h> - - - - -.. _doxid-struct_kit___player_stream_info_1a52b87f3d035b2c2f10fd6d6f8c054189: -.. _cid-kit_playerstreaminfo::codec: -.. _doxid-struct_kit___player_stream_info_1adc5bba55cb53ed5df5d5132849e165d6: -.. _cid-kit_playerstreaminfo::output: -.. ref-code-block:: cpp - :class: overview-code-block - - // fields - - :ref:`Kit_Codec<doxid-struct_kit___codec>` codec - :ref:`Kit_OutputFormat<doxid-struct_kit___output_format>` output - diff --git a/doc/struct_Kit_Source.rst b/doc/struct_Kit_Source.rst deleted file mode 100644 index 67d38ac..0000000 --- a/doc/struct_Kit_Source.rst +++ /dev/null @@ -1,57 +0,0 @@ -.. index:: pair: struct; Kit_Source -.. _doxid-struct_kit___source: -.. _cid-kit_source: - -struct Kit_Source -================= - -.. toctree:: - :hidden: - -.. code-block:: cpp - :class: overview-code-block - - #include <kitsource.h> - - -Overview -~~~~~~~~ - - - -.. ref-code-block:: cpp - :class: overview-code-block - - // fields - - void* :ref:`format_ctx<doxid-struct_kit___source_1a4ffcfec54f02151ba35c34cdc7c0990f>` - void* :ref:`avio_ctx<doxid-struct_kit___source_1a93cc652e0375338fdf76e5d9b27c858f>` - -.. _details-doxid-struct_kit___source: - -Detailed Documentation -~~~~~~~~~~~~~~~~~~~~~~ - - - -Fields ------- - -.. _doxid-struct_kit___source_1a4ffcfec54f02151ba35c34cdc7c0990f: -.. _cid-kit_source::format_ctx: -.. ref-code-block:: cpp - :class: title-code-block - - void* format_ctx - -FFmpeg: Videostream format context. - -.. _doxid-struct_kit___source_1a93cc652e0375338fdf76e5d9b27c858f: -.. _cid-kit_source::avio_ctx: -.. ref-code-block:: cpp - :class: title-code-block - - void* avio_ctx - -FFmpeg: AVIO context. - diff --git a/doc/struct_Kit_SourceStreamInfo.rst b/doc/struct_Kit_SourceStreamInfo.rst deleted file mode 100644 index 68172c7..0000000 --- a/doc/struct_Kit_SourceStreamInfo.rst +++ /dev/null @@ -1,57 +0,0 @@ -.. index:: pair: struct; Kit_SourceStreamInfo -.. _doxid-struct_kit___source_stream_info: -.. _cid-kit_sourcestreaminfo: - -struct Kit_SourceStreamInfo -=========================== - -.. toctree:: - :hidden: - -.. code-block:: cpp - :class: overview-code-block - - #include <kitsource.h> - - -Overview -~~~~~~~~ - - - -.. ref-code-block:: cpp - :class: overview-code-block - - // fields - - int :ref:`index<doxid-struct_kit___source_stream_info_1afd2ed4fc0ddcca2c71f30f2c743af6c9>` - :ref:`Kit_StreamType<doxid-kitsource_8h_1af54654f42d6733aacfe0f6a95379d9c2>` :ref:`type<doxid-struct_kit___source_stream_info_1a72054b0b25e8a87216da3f4e7170f312>` - -.. _details-doxid-struct_kit___source_stream_info: - -Detailed Documentation -~~~~~~~~~~~~~~~~~~~~~~ - - - -Fields ------- - -.. _doxid-struct_kit___source_stream_info_1afd2ed4fc0ddcca2c71f30f2c743af6c9: -.. _cid-kit_sourcestreaminfo::index: -.. ref-code-block:: cpp - :class: title-code-block - - int index - -Stream index. - -.. _doxid-struct_kit___source_stream_info_1a72054b0b25e8a87216da3f4e7170f312: -.. _cid-kit_sourcestreaminfo::type: -.. ref-code-block:: cpp - :class: title-code-block - - :ref:`Kit_StreamType<doxid-kitsource_8h_1af54654f42d6733aacfe0f6a95379d9c2>` type - -Stream type. - diff --git a/doc/struct_Kit_Version.rst b/doc/struct_Kit_Version.rst deleted file mode 100644 index 429849a..0000000 --- a/doc/struct_Kit_Version.rst +++ /dev/null @@ -1,33 +0,0 @@ -.. index:: pair: struct; Kit_Version -.. _doxid-struct_kit___version: -.. _cid-kit_version: - -struct Kit_Version -================== - -.. toctree:: - :hidden: - -.. code-block:: cpp - :class: overview-code-block - - #include <kitlib.h> - - - - -.. _doxid-struct_kit___version_1aa3ab70f662a41b2d56b08375dd0cf3a5: -.. _cid-kit_version::major: -.. _doxid-struct_kit___version_1a1625ca5468671dff7981e5b5700c61a2: -.. _cid-kit_version::minor: -.. _doxid-struct_kit___version_1a0ece9ba3c8271003023c242e998f1ce6: -.. _cid-kit_version::patch: -.. ref-code-block:: cpp - :class: overview-code-block - - // fields - - unsigned char major - unsigned char minor - unsigned char patch - diff --git a/generate-docs.sh b/generate-docs.sh index da3d7ba..538d85e 100644 --- a/generate-docs.sh +++ b/generate-docs.sh @@ -1,4 +1,4 @@ #!/bin/sh doxygen Doxyfile -doxyrest docs/xml/index.xml -o doc/index.rst -F $DOXYREST_FRAME_DIR -f c_index.rst.in +doxyrest docs/xml/index.xml -o docs/tmp/index.rst -F $DOXYREST_FRAME_DIR -f c_index.rst.in |