FFmpeg
hap.h
Go to the documentation of this file.
1 /*
2  * Vidvox Hap
3  * Copyright (C) 2015 Vittorio Giovara <vittorio.giovara@gmail.com>
4  * Copyright (C) 2015 Tom Butterworth <bangnoise@gmail.com>
5  *
6  * This file is part of FFmpeg.
7  *
8  * FFmpeg is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * FFmpeg is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with FFmpeg; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  */
22 
23 #ifndef AVCODEC_HAP_H
24 #define AVCODEC_HAP_H
25 
26 #include <stddef.h>
27 #include <stdint.h>
28 
29 #include "bytestream.h"
30 #include "texturedsp.h"
31 
36  HAP_FMT_RGTC1 = 0x01,
37 };
38 
40  HAP_COMP_NONE = 0xA0,
43 };
44 
50 };
51 
52 typedef struct HapChunk {
58 } HapChunk;
59 
60 typedef struct HapContext {
61  const struct AVClass *class;
62 
64 
65  enum HapTextureFormat opt_tex_fmt; /* Texture type (encoder only) */
66  int opt_chunk_count; /* User-requested chunk count (encoder only) */
67  int opt_compressor; /* User-requested compressor (encoder only) */
68 
71  int *chunk_results; /* Results from threaded operations */
72 
73  uint8_t *tex_buf; /* Buffer for compressed texture */
74  size_t tex_size; /* Size of the compressed texture */
75 
76  size_t max_snappy; /* Maximum compressed size for snappy buffer */
77 
78  int texture_count; /* 2 for HAQA, 1 for other version */
79  int texture_section_size; /* size of the part of the texture section (for HAPQA) */
80 
83 } HapContext;
84 
85 /*
86  * Set the number of chunks in the frame. Returns 0 on success or an error if:
87  * - first_in_frame is 0 and the number of chunks has changed
88  * - any other error occurs
89  */
90 int ff_hap_set_chunk_count(HapContext *ctx, int count, int first_in_frame);
91 
92 /*
93  * Free resources associated with the context
94  */
96 
97 /* The first three bytes are the size of the section past the header, or zero
98  * if the length is stored in the next long word. The fourth byte in the first
99  * long word indicates the type of the current section. */
100 int ff_hap_parse_section_header(GetByteContext *gbc, int *section_size,
101  enum HapSectionType *section_type);
102 
103 #endif /* AVCODEC_HAP_H */
HAP_FMT_YCOCGDXT5
@ HAP_FMT_YCOCGDXT5
Definition: hap.h:35
HapContext::opt_compressor
int opt_compressor
Definition: hap.h:67
GetByteContext
Definition: bytestream.h:33
ff_hap_parse_section_header
int ff_hap_parse_section_header(GetByteContext *gbc, int *section_size, enum HapSectionType *section_type)
Definition: hap.c:58
HapChunk::compressed_size
size_t compressed_size
Definition: hap.h:55
HapContext::tex_buf
uint8_t * tex_buf
Definition: hap.h:73
HapContext::chunks
HapChunk * chunks
Definition: hap.h:70
HapContext::enc
TextureDSPThreadContext enc
Definition: hap.h:81
HapContext
Definition: hap.h:60
texturedsp.h
HAP_FMT_RGBADXT5
@ HAP_FMT_RGBADXT5
Definition: hap.h:34
HAP_COMP_SNAPPY
@ HAP_COMP_SNAPPY
Definition: hap.h:41
TextureDSPThreadContext
Definition: texturedsp.h:69
HAP_FMT_RGTC1
@ HAP_FMT_RGTC1
Definition: hap.h:36
ff_hap_free_context
av_cold void ff_hap_free_context(HapContext *ctx)
Definition: hap.c:51
HAP_COMP_NONE
@ HAP_COMP_NONE
Definition: hap.h:40
av_cold
#define av_cold
Definition: attributes.h:90
HapContext::max_snappy
size_t max_snappy
Definition: hap.h:76
HapContext::opt_chunk_count
int opt_chunk_count
Definition: hap.h:66
HAP_ST_SIZE_TABLE
@ HAP_ST_SIZE_TABLE
Definition: hap.h:48
ctx
AVFormatContext * ctx
Definition: movenc.c:49
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:75
HapContext::chunk_count
int chunk_count
Definition: hap.h:69
HAP_ST_DECODE_INSTRUCTIONS
@ HAP_ST_DECODE_INSTRUCTIONS
Definition: hap.h:46
HAP_COMP_COMPLEX
@ HAP_COMP_COMPLEX
Definition: hap.h:42
HapChunk::uncompressed_size
size_t uncompressed_size
Definition: hap.h:57
HapContext::gbc
GetByteContext gbc
Definition: hap.h:63
HapSectionType
HapSectionType
Definition: hap.h:45
HapChunk::compressor
enum HapCompressor compressor
Definition: hap.h:53
HapCompressor
HapCompressor
Definition: hap.h:39
HapTextureFormat
HapTextureFormat
Definition: hap.h:32
HAP_ST_COMPRESSOR_TABLE
@ HAP_ST_COMPRESSOR_TABLE
Definition: hap.h:47
HapChunk
Definition: hap.h:52
HapChunk::uncompressed_offset
int uncompressed_offset
Definition: hap.h:56
HapContext::texture_count
int texture_count
Definition: hap.h:78
HapContext::dec
TextureDSPThreadContext dec[2]
Definition: hap.h:82
HAP_ST_OFFSET_TABLE
@ HAP_ST_OFFSET_TABLE
Definition: hap.h:49
HAP_FMT_RGBDXT1
@ HAP_FMT_RGBDXT1
Definition: hap.h:33
HapContext::tex_size
size_t tex_size
Definition: hap.h:74
HapChunk::compressed_offset
uint32_t compressed_offset
Definition: hap.h:54
bytestream.h
HapContext::opt_tex_fmt
enum HapTextureFormat opt_tex_fmt
Definition: hap.h:65
ff_hap_set_chunk_count
int ff_hap_set_chunk_count(HapContext *ctx, int count, int first_in_frame)
Definition: hap.c:29
HapContext::texture_section_size
int texture_section_size
Definition: hap.h:79
HapContext::chunk_results
int * chunk_results
Definition: hap.h:71