ktx2-rw 0.2.3

A high-level Rust wrapper for KTX2 texture format with full Basis Universal support
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
use std::ffi::CString;
use std::fmt;
use std::path::Path;
use std::ptr;

use crate::bindings::*;
use crate::compression::BasisCompressionParams;
use crate::error::{Error, Result};
use crate::format::TranscodeFormat;
use crate::vk_format::VkFormat;

/// Main texture handle for KTX2 textures
///
/// This struct provides a safe, high-level interface to KTX2 textures with automatic
/// memory management. All operations are memory-safe and use proper error handling.
///
/// ## Thread Safety
///
/// `Ktx2Texture` implements `Send + Sync` and can be safely used across threads.
///
/// ## Memory Management
///
/// The texture handle automatically manages the underlying C resources via RAII.
/// When dropped, all associated memory is properly freed.
///
/// # Examples
///
/// ```rust,no_run
/// use ktx2_rw::{Ktx2Texture, BasisCompressionParams, VkFormat};
/// # fn main() -> ktx2_rw::Result<()> {
///
/// // Create a new texture
/// let mut texture = Ktx2Texture::create(512, 512, 1, 1, 1, 1, VkFormat::R8G8B8A8Unorm)?;
///
/// // Load from file
/// let texture = Ktx2Texture::from_file("texture.ktx2")?;
///
/// // Load from memory
/// let data = std::fs::read("texture.ktx2").map_err(|_| ktx2_rw::Error::FileReadError)?;
/// let texture = Ktx2Texture::from_memory(&data)?;
/// # Ok(())
/// # }
/// ```
pub struct Ktx2Texture {
    texture: *mut ktxTexture2,
}

impl Ktx2Texture {
    pub fn from_file<P: AsRef<Path>>(path: P) -> Result<Self> {
        let path_str = path.as_ref().to_str().ok_or(Error::InvalidValue)?;
        let c_path = CString::new(path_str).map_err(|_| Error::InvalidValue)?;

        let mut texture: *mut ktxTexture2 = ptr::null_mut();

        let result = unsafe {
            ktxTexture2_CreateFromNamedFile(
                c_path.as_ptr(),
                {
                    #[cfg(windows)]
                    {
                        #[allow(clippy::useless_conversion)]
                        ktxTextureCreateFlagBits_KTX_TEXTURE_CREATE_LOAD_IMAGE_DATA_BIT
                            .try_into()
                            .unwrap_or(0)
                    }
                    #[cfg(not(windows))]
                    {
                        ktxTextureCreateFlagBits_KTX_TEXTURE_CREATE_LOAD_IMAGE_DATA_BIT
                    }
                },
                &mut texture,
            )
        };

        if result != ktx_error_code_e_KTX_SUCCESS {
            return Err(result.into());
        }

        Ok(Self { texture })
    }

    pub fn from_memory(data: &[u8]) -> Result<Self> {
        let mut texture: *mut ktxTexture2 = ptr::null_mut();

        let result = unsafe {
            ktxTexture2_CreateFromMemory(
                data.as_ptr(),
                data.len(),
                {
                    #[cfg(windows)]
                    {
                        #[allow(clippy::useless_conversion)]
                        ktxTextureCreateFlagBits_KTX_TEXTURE_CREATE_LOAD_IMAGE_DATA_BIT
                            .try_into()
                            .unwrap_or(0)
                    }
                    #[cfg(not(windows))]
                    {
                        ktxTextureCreateFlagBits_KTX_TEXTURE_CREATE_LOAD_IMAGE_DATA_BIT
                    }
                },
                &mut texture,
            )
        };

        if result != ktx_error_code_e_KTX_SUCCESS {
            return Err(result.into());
        }

        Ok(Self { texture })
    }

    pub fn create(
        width: u32,
        height: u32,
        depth: u32,
        layers: u32,
        faces: u32,
        levels: u32,
        vk_format: VkFormat,
    ) -> Result<Self> {
        // Validate input parameters
        if width == 0 || height == 0 {
            return Err(Error::InvalidValue);
        }
        if depth == 0 || layers == 0 || faces == 0 || levels == 0 {
            return Err(Error::InvalidValue);
        }

        // Validate reasonable limits to prevent excessive memory allocation
        const MAX_DIMENSION: u32 = 65536; // 64K max dimension
        if width > MAX_DIMENSION || height > MAX_DIMENSION || depth > MAX_DIMENSION {
            return Err(Error::InvalidValue);
        }

        let create_info = ktxTextureCreateInfo {
            glInternalformat: 0,
            vkFormat: vk_format.as_raw(),
            pDfd: ptr::null_mut(),
            baseWidth: width,
            baseHeight: height,
            baseDepth: depth,
            numDimensions: if depth > 1 {
                3
            } else if height > 1 {
                2
            } else {
                1
            },
            numLevels: levels,
            numLayers: layers,
            numFaces: faces,
            isArray: layers > 1,
            generateMipmaps: false,
        };

        let mut texture: *mut ktxTexture2 = ptr::null_mut();

        let result = unsafe {
            ktxTexture2_Create(
                &create_info,
                ktxTextureCreateStorageEnum_KTX_TEXTURE_CREATE_ALLOC_STORAGE,
                &mut texture,
            )
        };

        if result != ktx_error_code_e_KTX_SUCCESS {
            return Err(result.into());
        }

        // Safety: Check that texture was actually created
        if texture.is_null() {
            return Err(Error::OutOfMemory);
        }

        Ok(Self { texture })
    }

    pub fn width(&self) -> u32 {
        if self.texture.is_null() {
            return 0;
        }
        unsafe { (*self.texture).baseWidth }
    }

    pub fn height(&self) -> u32 {
        if self.texture.is_null() {
            return 0;
        }
        unsafe { (*self.texture).baseHeight }
    }

    pub fn depth(&self) -> u32 {
        if self.texture.is_null() {
            return 0;
        }
        unsafe { (*self.texture).baseDepth }
    }

    pub fn layers(&self) -> u32 {
        if self.texture.is_null() {
            return 0;
        }
        unsafe { (*self.texture).numLayers }
    }

    pub fn faces(&self) -> u32 {
        if self.texture.is_null() {
            return 0;
        }
        unsafe { (*self.texture).numFaces }
    }

    pub fn levels(&self) -> u32 {
        if self.texture.is_null() {
            return 0;
        }
        unsafe { (*self.texture).numLevels }
    }

    pub fn vk_format(&self) -> VkFormat {
        if self.texture.is_null() {
            return VkFormat::Undefined;
        }
        unsafe { VkFormat::from_raw((*self.texture).vkFormat).unwrap_or(VkFormat::Undefined) }
    }

    pub fn is_array(&self) -> bool {
        if self.texture.is_null() {
            return false;
        }
        unsafe { (*self.texture).isArray }
    }

    pub fn is_cubemap(&self) -> bool {
        if self.texture.is_null() {
            return false;
        }
        unsafe { (*self.texture).isCubemap }
    }

    pub fn is_compressed(&self) -> bool {
        if self.texture.is_null() {
            return false;
        }
        unsafe { (*self.texture).isCompressed }
    }

    pub fn needs_transcoding(&self) -> bool {
        unsafe {
            // Safety: Check texture is valid first
            if self.texture.is_null() {
                return false;
            }

            let vtbl = (*self.texture).vtbl;
            if vtbl.is_null() {
                return false;
            }

            let needs_transcoding = (*vtbl).NeedsTranscoding;
            match needs_transcoding {
                Some(func) => func(self.texture as *mut ktxTexture),
                None => false,
            }
        }
    }

    pub fn get_image_data(&self, level: u32, layer: u32, face: u32) -> Result<&[u8]> {
        // Safety: Check texture validity first
        if self.texture.is_null() {
            return Err(Error::InvalidOperation);
        }

        // Validate parameters against texture properties
        let texture = unsafe { &*self.texture };
        if level >= texture.numLevels || layer >= texture.numLayers || face >= texture.numFaces {
            return Err(Error::InvalidValue);
        }

        let mut offset = 0usize;

        let result = unsafe {
            let vtbl = texture.vtbl;
            if vtbl.is_null() {
                return Err(Error::InvalidOperation);
            }

            let get_image_offset = (*vtbl).GetImageOffset;
            match get_image_offset {
                Some(func) => func(
                    self.texture as *mut ktxTexture,
                    level,
                    layer,
                    face,
                    &mut offset,
                ),
                None => return Err(Error::UnsupportedFeature),
            }
        };

        if result != ktx_error_code_e_KTX_SUCCESS {
            return Err(result.into());
        }

        let size = unsafe {
            let vtbl = texture.vtbl;
            let get_image_size = (*vtbl).GetImageSize;
            match get_image_size {
                Some(func) => func(self.texture as *mut ktxTexture, level),
                None => return Err(Error::UnsupportedFeature),
            }
        };

        // Safety: Validate the calculated bounds
        if texture.pData.is_null() {
            return Err(Error::InvalidOperation);
        }

        let data_size = texture.dataSize;
        if offset.saturating_add(size) > data_size {
            return Err(Error::InvalidOperation);
        }

        unsafe {
            let data_ptr = texture.pData.add(offset);
            Ok(std::slice::from_raw_parts(data_ptr, size))
        }
    }

    pub fn set_image_data(&mut self, level: u32, layer: u32, face: u32, data: &[u8]) -> Result<()> {
        // Safety: Check texture validity first
        if self.texture.is_null() {
            return Err(Error::InvalidOperation);
        }

        // Validate parameters against texture properties
        let texture = unsafe { &*self.texture };
        if level >= texture.numLevels || layer >= texture.numLayers || face >= texture.numFaces {
            return Err(Error::InvalidValue);
        }

        // Check data is not empty
        if data.is_empty() {
            return Err(Error::InvalidValue);
        }

        let result = unsafe {
            let vtbl = texture.vtbl;
            if vtbl.is_null() {
                return Err(Error::InvalidOperation);
            }

            let set_image_from_memory = (*vtbl).SetImageFromMemory;
            match set_image_from_memory {
                Some(func) => func(
                    self.texture as *mut ktxTexture,
                    level,
                    layer,
                    face,
                    data.as_ptr(),
                    data.len(),
                ),
                None => return Err(Error::UnsupportedFeature),
            }
        };

        if result != ktx_error_code_e_KTX_SUCCESS {
            return Err(result.into());
        }

        Ok(())
    }

    pub fn transcode_basis(&mut self, format: TranscodeFormat) -> Result<()> {
        let result = unsafe { ktxTexture2_TranscodeBasis(self.texture, format.into(), 0) };

        if result != ktx_error_code_e_KTX_SUCCESS {
            return Err(result.into());
        }

        Ok(())
    }

    pub fn compress_basis(&mut self, params: &BasisCompressionParams) -> Result<()> {
        let mut ktx_params: ktxBasisParams = params.into();

        let result = unsafe { ktxTexture2_CompressBasisEx(self.texture, &mut ktx_params) };

        if result != ktx_error_code_e_KTX_SUCCESS {
            return Err(result.into());
        }

        Ok(())
    }

    pub fn compress_basis_simple(&mut self, quality: u32) -> Result<()> {
        let result = unsafe { ktxTexture2_CompressBasis(self.texture, quality) };

        if result != ktx_error_code_e_KTX_SUCCESS {
            return Err(result.into());
        }

        Ok(())
    }

    pub fn write_to_file<P: AsRef<Path>>(&self, path: P) -> Result<()> {
        let path_str = path.as_ref().to_str().ok_or(Error::InvalidValue)?;
        let c_path = CString::new(path_str).map_err(|_| Error::InvalidValue)?;

        let result = unsafe { ktxTexture2_WriteToNamedFile(self.texture, c_path.as_ptr()) };

        if result != ktx_error_code_e_KTX_SUCCESS {
            return Err(result.into());
        }

        Ok(())
    }

    pub fn write_to_memory(&self) -> Result<Vec<u8>> {
        let mut data: *mut ktx_uint8_t = ptr::null_mut();
        let mut size: ktx_size_t = 0;

        let result = unsafe { ktxTexture2_WriteToMemory(self.texture, &mut data, &mut size) };

        if result != ktx_error_code_e_KTX_SUCCESS {
            return Err(result.into());
        }

        // Safety: Check that we got valid data before proceeding
        if data.is_null() || size == 0 {
            return Err(Error::InvalidOperation);
        }

        // Create Vec from the allocated memory - this is safe because:
        // 1. data is non-null and size > 0 (checked above)
        // 2. ktxTexture2_WriteToMemory allocates with malloc()
        // 3. Vec::from_raw_parts will take ownership and free with the global allocator
        let vec = unsafe { Vec::from_raw_parts(data, size, size) };

        Ok(vec)
    }

    pub fn get_metadata(&self, key: &str) -> Result<Vec<u8>> {
        let c_key = CString::new(key).map_err(|_| Error::InvalidValue)?;

        let mut value_len = 0u32;
        let mut value: *mut libc::c_void = ptr::null_mut();

        let result = unsafe {
            ktxHashList_FindValue(
                &mut (*self.texture).kvDataHead,
                c_key.as_ptr(),
                &mut value_len,
                &mut value,
            )
        };

        if result != ktx_error_code_e_KTX_SUCCESS {
            return Err(result.into());
        }

        if value.is_null() {
            return Err(Error::NotFound);
        }

        let data =
            unsafe { std::slice::from_raw_parts(value as *const u8, value_len as usize).to_vec() };

        Ok(data)
    }

    pub fn set_metadata(&mut self, key: &str, value: &[u8]) -> Result<()> {
        let c_key = CString::new(key).map_err(|_| Error::InvalidValue)?;

        let result = unsafe {
            ktxHashList_AddKVPair(
                &mut (*self.texture).kvDataHead,
                c_key.as_ptr(),
                value.len() as u32,
                value.as_ptr() as *const libc::c_void,
            )
        };

        if result != ktx_error_code_e_KTX_SUCCESS {
            return Err(result.into());
        }

        Ok(())
    }
}

impl Drop for Ktx2Texture {
    fn drop(&mut self) {
        if !self.texture.is_null() {
            unsafe {
                ktxTexture2_Destroy(self.texture);
            }
        }
    }
}

impl fmt::Debug for Ktx2Texture {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("Ktx2Texture")
            .field("width", &self.width())
            .field("height", &self.height())
            .field("depth", &self.depth())
            .field("layers", &self.layers())
            .field("faces", &self.faces())
            .field("levels", &self.levels())
            .field("vk_format", &self.vk_format())
            .field("is_array", &self.is_array())
            .field("is_cubemap", &self.is_cubemap())
            .field("is_compressed", &self.is_compressed())
            .finish()
    }
}

unsafe impl Send for Ktx2Texture {}
unsafe impl Sync for Ktx2Texture {}