diff options
| author | Tuomas Virtanen <katajakasa@gmail.com> | 2018-06-27 23:17:47 +0300 |
|---|---|---|
| committer | Tuomas Virtanen <katajakasa@gmail.com> | 2018-06-27 23:17:47 +0300 |
| commit | f0d0aa50910ba9536f40e8a635bb4f70de84a76f (patch) | |
| tree | 3f58c51353a165d79d4d0ee9b5f2c6f64e87678a /include/kitchensink/kitformat.h | |
| parent | c7fc4f2ca9a0d750f32a9f6cf7c86cd2ac548d0f (diff) | |
Add documentation and api cleanups
Diffstat (limited to 'include/kitchensink/kitformat.h')
| -rw-r--r-- | include/kitchensink/kitformat.h | 15 |
1 files changed, 12 insertions, 3 deletions
diff --git a/include/kitchensink/kitformat.h b/include/kitchensink/kitformat.h index 4c428c5..3e8df91 100644 --- a/include/kitchensink/kitformat.h +++ b/include/kitchensink/kitformat.h @@ -1,15 +1,24 @@ #ifndef KITFORMAT_H
#define KITFORMAT_H
-#include <stdbool.h>
+/**
+ * @brief Audio/video output format type
+ *
+ * @file kitformat.h
+ * @author Tuomas Virtanen
+ * @date 2018-06-25
+ */
#ifdef __cplusplus
extern "C" {
#endif
+/**
+ * @brief Contains information about the data format coming out from the player
+ */
typedef struct Kit_OutputFormat {
- unsigned int format; ///< SDL Format
- bool is_signed; ///< Signedness (if audio)
+ unsigned int format; ///< SDL Format (SDL_PixelFormat if video/subtitle, SDL_AudioFormat if audio)
+ int is_signed; ///< Signedness, 1 = signed, 0 = unsigned (if audio)
int bytes; ///< Bytes per sample per channel (if audio)
int samplerate; ///< Sampling rate (if audio)
int channels; ///< Channels (if audio)
|