tablegen.txt 2.73 KB
Newer Older
1 2 3 4 5 6 7 8 9
Writing a table generator

This documentation is preliminary.
Parts of the API are not good and should be changed.

Basic concepts

A table generator consists of two files, *_tablegen.c and *_tablegen.h.
The .h file will provide the variable declarations and initialization
10 11
code for the tables, the .c calls the initialization code and then prints
the tables as a header file using the tableprint.h helpers.
12 13 14
Both of these files will be compiled for the host system, so to avoid
breakage with cross-compilation neither of them may include, directly
or indirectly, config.h or avconfig.h.
15
This means that e.g. libavutil/mathematics.h is ok but libavutil/libm.h is not.
16 17
Due to this, the .c file or Makefile may have to provide additional defines
or stubs, though if possible this should be avoided.
18
In particular, CONFIG_HARDCODED_TABLES should always be defined to 0.
19 20 21 22 23 24

The .c file

This file should include the *_tablegen.h and tableprint.h files and
anything else it needs as long as it does not depend on config.h or
avconfig.h.
25 26 27 28 29 30
In addition to that it must contain a main() function which initializes
all tables by calling the init functions from the .h file and then prints
them.
The printing code typically looks like this:
    write_fileheader();
    printf("static const uint8_t my_array[100] = {\n");
31
    write_uint8_t_array(my_array, 100);
32 33
    printf("};\n");

34 35 36 37 38
This is the more generic form, in case you need to do something special.
Usually you should instead use the short form:
    write_fileheader();
    WRITE_ARRAY("static const", uint8_t, my_array);

39 40 41 42 43 44 45 46 47 48
write_fileheader() adds some minor things like a "this is a generated file"
comment and some standard includes.
tablegen.h defines some write functions for one- and two-dimensional arrays
for standard types - they print only the "core" parts so they are easier
to reuse for multi-dimensional arrays so the outermost {} must be printed
separately.
If there's no standard function for printing the type you need, the
WRITE_1D_FUNC_ARGV macro is a very quick way to create one.
See libavcodec/dv_tablegen.c for an example.

49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70

The .h file

This file should contain:
 - one or more initialization functions
 - the table variable declarations
If CONFIG_HARDCODED_TABLES is set, the initialization functions should
not do anything, and instead of the variable declarations the
generated *_tables.h file should be included.
Since that will be generated in the build directory, the path must be
included, i.e.
#include "libavcodec/example_tables.h"
not
#include "example_tables.h"

Makefile changes

To make the automatic table creation work, you must manually declare the
new dependency.
For this add a line similar to this:
$(SUBDIR)example.o: $(SUBDIR)example_tables.h
under the "ifdef CONFIG_HARDCODED_TABLES" section in the Makefile.