apply a bitwise XOR (written as `^` in most C-like languages) to every byte of the buffer using the provided `key`
**`key`** is required, and can be either
_the output length remains the same as the input length_
\n| `rol(n)`, `ror(n)` |apply a [bitwise rotation](https://en.wikipedia.org/wiki/Bitwise_operation#bit_rotation) (also known as a [circular shift](https://en.wikipedia.org/wiki/Circular_shift)) by **`n`** bits to every byte of the buffer
`rol` = left circular shift, `ror` = right circular shift
**`n`** is required, and should be in range **0-7** for consistent results (to be safe, use `shift_amount % 8` as the **`n`** parameter, if the value of `shift_amount` itself may not fall into that range)
\n| `zlib` |apply a _zlib_ decompression to the input buffer, expecting it to be a full-fledged _zlib_ stream, i.e. having a regular 2-byte _zlib_ header.
typical _zlib_ header values:
`{my_custom_processor}(a, b, ...)`
(`{my_custom_processor}` is an arbitrary name matching `[a-z][a-z0-9_.]*`)
|use a custom processing routine, which you implement in imperative code in the target language
the generated code will use the class name `{my_custom_processor}` using the naming convention of the target language (in most languages `MyCustomProcessor`, but e.g. `my_custom_processor_t` in C++: check the generated code)
the processing class **must** define the method `public byte[] decode(byte[] src)` and should implement the interface `CustomDecoder` (available in [C++](https://github.com/kaitai-io/kaitai_struct_cpp_stl_runtime/blob/d020781b96ea1e2fe7e0ecf47ff3ae3c829ccd31/kaitai/custom_decoder.h#L8-L12), [C#](https://github.com/kaitai-io/kaitai_struct_csharp_runtime/blob/1b66a9a85f39c52728893400a23504844cc78e34/KaitaiStruct.cs#L24-L37) and [Java](https://github.com/kaitai-io/kaitai_struct_java_runtime/blob/c342c6e836ddba03c9ec33a59034e209bb04a976/src/main/java/io/kaitai/struct/CustomDecoder.java#L26-L39))
you can pass any parameters `(a, b, ...)` to your `{my_custom_processor}` class constructor (**omit** the `()` brackets for parameter-less invocation)
one can reference a class in a different namespace/package like `com.example.my_rle(5, 3)`
see [Custom processing routines](https://doc.kaitai.io/user_guide.html#custom-process) in the User Guide for more info
", "type": "string", "pattern": "^zlib|(xor|rol|ror)\\(.*\\)$" }, "enum": { "description": "name of existing enum field data type becomes given enum", "type": "string", "pattern": "^([a-z][a-z0-9_]*::)*[a-z][a-z0-9_]*$" }, "encoding": { "$ref": "#/definitions/CharacterEncoding" }, "pad-right": { "type": "integer", "minimum": 0, "maximum": 255, "description": "specify a byte which is the string or byte array padded with after the end up to the total size\n\ncan be used only with `size` or `size-eos: true` (when the size is fixed)\n\nwhen `terminator`:\n - isn't specified, then the `pad-right` controls where the string ends (basically acts like a terminator)\n - is specified, padding comes after the terminator, not before. The value is terminated immediately after the terminator occurs, so the `pad-right` has no effect on parsing and is only relevant for serialization" }, "terminator": { "type": "integer", "minimum": 0, "maximum": 255, "description": "string or byte array reading will stop when it encounters this byte\n\ncannot be used with `type: strz` (which already implies `terminator: 0` - null-terminated string)" }, "consume": { "type": "boolean", "description": "specify if terminator byte should be \"consumed\" when reading\n\nif true: the stream pointer will point to the byte after the terminator byte\n\nif false: the stream pointer will point to the terminator byte itself\n\ndefault is true", "default": true }, "include": { "type": "boolean", "description": "specifies if terminator byte should be considered part of the string read and thus be appended to it\n\ndefault is false", "default": false }, "eos-error": { "type": "boolean", "description": "allows the compiler to ignore the lack of a terminator if eos-error is disabled, string reading will stop at either:\n\n1. terminator being encountered\n\n2. end of stream is reached\n\ndefault is `true`", "default": true }, "pos": { "description": "specifies position at which the value should be parsed", "$ref": "#/definitions/StringOrInteger" }, "io": { "type": "string", "description": "specifies an IO stream from which a value should be parsed" }, "value": { "description": "overrides any reading & parsing. Instead, just calculates function specified in value and returns the result as this instance. Has many purposes" } }, "patternProperties": { "^-": true }, "additionalProperties": false, "allOf": [ { "if": { "required": [ "type" ], "properties": { "type": { "const": "strz" } } }, "then": { "not": { "required": [ "terminator" ] } } }, { "if": { "required": ["pad-right"] }, "then": { "anyOf": [ { "required": ["size"] }, { "required": [ "size-eos" ], "properties": { "size-eos": { "const": true } } } ] } }, { "if": { "required": [ "valid" ], "properties": { "valid": { "type": "object", "required": [ "in-enum" ] } } }, "then": { "required": ["enum"] } } ] }, "Attributes": { "type": "array", "items": { "$ref": "#/definitions/Attribute" } }, "StringOrInteger": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "TypeSpec": { "type": "object", "properties": { "meta": { "$ref": "#/definitions/MetaSpec" }, "doc": { "$ref": "#/definitions/Doc" }, "doc-ref": { "$ref": "#/definitions/DocRef" }, "to-string": { "$ref": "#/definitions/ToString" }, "params": { "$ref": "#/definitions/ParamsSpec" }, "seq": { "$ref": "#/definitions/Attributes" }, "instances": { "$ref": "#/definitions/InstancesSpec" }, "types": { "$ref": "#/definitions/TypesSpec" }, "enums": { "$ref": "#/definitions/EnumsSpec" } }, "patternProperties": { "^-": true }, "additionalProperties": false }, "TypesSpec": { "type": "object", "patternProperties": { "^[a-z][a-z0-9_]*$": { "$ref": "#/definitions/TypeSpec" } }, "additionalProperties": false }, "ParamSpec": { "type": "object", "required": [ "id" ], "properties": { "id": { "allOf": [ { "type": "string", "pattern": "^[a-z][a-z0-9_]*$" }, { "not": { "enum": ["true", "false", "null"] } } ] }, "type": { "description": "specifies \"pure\" type of the parameter, without any serialization details (like endianness, sizes, encodings)\n\n| Value | Description\n|-\n| `u1`, `u2`, `u4`, `u8` | unsigned integer\n| `s1`, `s2`, `s4`, `s8` | signed integer\n| `bX` | bit-sized integer (if `X` != 1)\n| `f4`, `f8` | floating point number\n| `type` key missing