ヘッダーファイル、リソースファイル、コンパイル時マクロによるバイナリリソースインクルージョン

C言語におけるバイナリリソースのインクルージョン

• ヘッダーファイル
• リソースファイル
• コンパイル時マクロ

について解説します。

ヘッダーファイル

バイナリリソースをCソースファイルに直接埋め込むことは、コードの可読性と保守性を低下させるため、一般的には避けます。代わりに、バイナリリソースをヘッダーファイルに格納し、Cソースファイルからインクルードする方法がよく用いられます。

例:

// header.h
#include <stdint.h>

extern const uint8_t icon[];
extern const size_t icon_size;

// source.c
#include "header.h"

void draw_icon(void) {
  // ...
  for (size_t i = 0; i < icon_size; i++) {
    // ...
  }
  // ...
}

この例では、icon.binというバイナリファイルの内容をiconという名前の配列に格納し、header.hというヘッダーファイルで宣言しています。Cソースファイルsource.cでは、header.hをインクルードすることで、icon配列とicon_size変数を使用することができます。

リソースファイル

バイナリリソースを独立したファイルとして格納し、コンパイル時にプログラムに組み込む方法もあります。

例:

// Makefile
icon.o: icon.bin
  $(CC) -c icon.bin -o icon.o

all: main.o icon.o
  $(CC) main.o icon.o -o main

この例では、icon.binというバイナリファイルをicon.oというオブジェクトファイルに変換し、main.cというCソースファイルとリンクして最終的なプログラムを作成しています。

コンパイル時マクロ

単純なバイナリリソースであれば、コンパイル時マクロを使用してプログラムに直接埋め込むこともできます。

例:

#define ICON_DATA 0x01, 0x02, 0x03, ...

void draw_icon(void) {
  // ...
  for (uint8_t i = 0; i < sizeof(ICON_DATA); i++) {
    // ...
  }
  // ...
}

この例では、ICON_DATAというマクロを使用して、icon.binの内容を直接Cソースファイルに埋め込んでいます。

C言語でバイナリリソースをプログラムに含めるには、ヘッダーファイル、リソースファイル、コンパイル時マクロなどの方法があります。それぞれの方法にはメリットとデメリットがあり、状況に応じて最適な方法を選択する必要があります。

C言語におけるバイナリリソースインクルジョンのサンプルコード

ヘッダーファイル

// header.h
#include <stdint.h>

extern const uint8_t icon[];
extern const size_t icon_size;

extern const uint8_t font[];
extern const size_t font_size;

Cソースファイル:

#include "header.h"

void draw_icon(void) {
  // ...
  for (size_t i = 0; i < icon_size; i++) {
    // ...
  }
  // ...
}

void draw_text(void) {
  // ...
  for (size_t i = 0; i < font_size; i++) {
    // ...
  }
  // ...
}

リソースファイル

Makefile:

icon.o: icon.bin
  $(CC) -c icon.bin -o icon.o

font.o: font.bin
  $(CC) -c font.bin -o font.o

all: main.o icon.o font.o
  $(CC) main.o icon.o font.o -o main

Cソースファイル:

#include <stdio.h>

extern const uint8_t icon[];
extern const size_t icon_size;

extern const uint8_t font[];
extern const size_t font_size;

int main(void) {
  // ...
  printf("Hello, world!\n");
  // ...

  return 0;
}

コンパイル時マクロ

Cソースファイル:

#define ICON_DATA 0x01, 0x02, 0x03, ...

#define FONT_DATA 0x10, 0x11, 0x12, ...

void draw_icon(void) {
  // ...
  for (uint8_t i = 0; i < sizeof(ICON_DATA); i++) {
    // ...
  }
  // ...
}

void draw_text(void) {
  // ...
  for (uint8_t i = 0; i < sizeof(FONT_DATA); i++) {
    // ...
  }
  // ...
}

画像リソースをプログラムに含める場合は、PNGやJPEGなどの画像フォーマットに対応したライブラリが必要です。

例:

#include <png.h>

void draw_image(void) {
  // ...
  png_structp png_ptr = png_create_read_struct(PNG_LIBPNG_VER_STRING, NULL, NULL, NULL);
  png_infop info_ptr = png_create_info_struct(png_ptr);

  // ...

  png_read_png(png_ptr, info_ptr, PNG_TRANSFORM_IDENTITY, NULL);

  // ...

  png_destroy_read_struct(&png_ptr, &info_ptr, NULL);
  // ...
}

音声リソースをプログラムに含める場合は、WAVやMP3などの音声フォーマットに対応したライブラリが必要です。

例:

#include <mpg123.h>

void play_sound(void) {
  // ...
  mpg123_handle *mh = mpg123_new(NULL, NULL);
  int err = mpg123_open(mh, "sound.mp3");

  // ...

  while (mpg123_read(mh, buffer, sizeof(buffer)) > 0) {
    // ...
  }

  // ...

  mpg123_close(mh);
  mpg123_delete(mh);
  // ...
}

C言語でバイナリリソースをプログラムに含めるには、様々な方法があります。それぞれの方法にはメリットとデメリットがあり、状況に応じて最適な方法を選択する必要があります。

C言語におけるバイナリリソースインクルジョンのその他の方法

データファイル

例:

#include <stdio.h>

int main(void) {
  // ...
  FILE *fp = fopen("data.bin", "rb");
  if (fp == NULL) {
    // エラー処理
  }

  // ...

  fclose(fp);
  // ...

  return 0;
}

オブジェクトファイル

バイナリリソースをコンパイルしてオブジェクトファイルを作成し、プログラムにリンクする方法です。

例:

// Makefile
data.o: data.bin
  $(CC) -c data.bin -o data.o

all: main.o data.o
  $(CC) main.o data.o -o main

Cソースファイル:

#include <stdio.h>

extern const uint8_t data[];
extern const size_t data_size;

int main(void) {
  // ...
  for (size_t i = 0; i < data_size; i++) {
    // ...
  }
  // ...

  return 0;
}

リソース埋め込みツール

バイナリリソースをプログラムに埋め込むためのツールを使用する方法です。

例:

// コマンドライン
bin2c data.bin data.h

// Makefile
all: main.o data.o
  $(CC) main.o data.o -o main

Cソースファイル:

#include "data.h"

int main(void) {
  // ...
  for (size_t i = 0; i < data_size; i++) {
    // ...
  }
  // ...

  return 0;
}

C言語でバイナリリソースをプログラムに含めるには、様々な方法があります。それぞれの方法にはメリットとデメリットがあり、状況に応じて最適な方法を選択する必要があります。