Android.mk 详解

Android.mk是Android提供的一种makefile文件，用来指定诸如编译生成so库名、引用的头文件目录、需要编译的.c/.cpp文件和.a静态库文件等。要掌握jni，就必须熟练掌握Android.mk的语法规范。 

一、Android.mk文件的用途  
一个android子项目中会存在一个或多个Android.mk文件 
1、单一的Android.mk文件 
直接参考NDK的sample目录下的hello-jni项目，在这个项目中只有一个Android.mk文件 
2、多个Android.mk文件 
如果需要编译的模块比较多，我们可能会将对应的模块放置在相应的目录中， 
这样，我们可以在每个目录中定义对应的Android.mk文件（类似于上面的写法）， 
最后，在根目录放置一个Android.mk文件，内容如下： 
include $(call all-subdir-makefiles) 
只需要这一行就可以了，它的作用就是包含所有子目录中的Android.mk文件 
3、多个模块共用一个Android.mk 
这个文件允许你将源文件组织成模块，这个模块中含有： 
  -静态库(.a文件) 
  -动态库(.so文件) 
只有共享库才能被安装/复制到您的应用软件（APK）包中 
include $(BUILD_STATIC_LIBRARY)，编译出的是静态库 
include $(BUILD_SHARED_LIBRARY)，编译出的是动态库 



二、自定义变量  
以下是在 Android.mk中依赖或定义的变量列表，可以定义其他变量为自己使用，但是NDK编译系统保留下列变量名： 
-以 LOCAL_开头的名字（例如 LOCAL_MODULE） 
-以 PRIVATE_, NDK_ 或 APP_开头的名字（内部使用） 
-小写名字（内部使用，例如‘my-dir’） 
  如果为了方便在 Android.mk 中定义自己的变量，建议使用 MY_前缀，一个小例子： 
MY_SOURCES := foo.c 
ifneq ($(MY_CONFIG_BAR),) 
MY_SOURCES += bar.c 
endif 
LOCAL_SRC_FILES += $(MY_SOURCES) 
注意：‘:=’是赋值的意思；'+='是追加的意思；‘$’表示引用某变量的值。 



三、GNU Make系统变量  
  这些 GNU Make变量在你的 Android.mk 文件解析之前，就由编译系统定义好了。注意在某些情况下，NDK可能分析 Android.mk 几次，每一次某些变量的定义会有不同。 
  （1）CLEAR_VARS:  指向一个编译脚本，几乎所有未定义的 LOCAL_XXX 变量都在"Module-description"节中列出。必须在开始一个新模块之前包含这个脚本：include$(CLEAR_VARS)，用于重置除LOCAL_PATH变量外的，所有LOCAL_XXX系列变量。 
  （2）BUILD_SHARED_LIBRARY:  指向编译脚本，根据所有的在 LOCAL_XXX 变量把列出的源代码文件编译成一个共享库。 
       注意，必须至少在包含这个文件之前定义 LOCAL_MODULE 和 LOCAL_SRC_FILES。 
  （3）BUILD_STATIC_LIBRARY:  一个 BUILD_SHARED_LIBRARY 变量用于编译一个静态库。静态库不会复制到的APK包中，但是能够用于编译共享库。 
       示例：include $(BUILD_STATIC_LIBRARY) 
       注意，这将会生成一个名为 lib$(LOCAL_MODULE).a 的文件 
  （4）TARGET_ARCH: 目标 CPU平台的名字 
  （5）TARGET_PLATFORM: Android.mk 解析的时候，目标 Android 平台的名字.详情可考/development/ndk/docs/stable- apis.txt. 
       android-3 -> Official Android 1.5 system images 
       android-4 -> Official Android 1.6 system images 
       android-5 -> Official Android 2.0 system images 
  （6）TARGET_ARCH_ABI:  暂时只支持两个 value，armeabi 和 armeabi-v7a。。 
  （7）TARGET_ABI: 目标平台和 ABI 的组合， 

                               
四、模块描述变量  
  下面的变量用于向编译系统描述你的模块。应该定义在'include  $(CLEAR_VARS)'和'include $(BUILD_XXXXX)'之间。$(CLEAR_VARS)是一个脚本，清除所有这些变量。 
  （1）LOCAL_PATH:  这个变量用于给出当前文件的路径。 
       必须在 Android.mk 的开头定义，可以这样使用：LOCAL_PATH := $(call my-dir) 
       如当前目录下有个文件夹名称 src，则可以这样写 $(call src)，那么就会得到 src 目录的完整路径 
       这个变量不会被$(CLEAR_VARS)清除，因此每个 Android.mk 只需要定义一次(即使在一个文件中定义了几个模块的情况下)。 
  （2）LOCAL_MODULE: 这是模块的名字，它必须是唯一的，而且不能包含空格。 
       必须在包含任一的$(BUILD_XXXX)脚本之前定义它。模块的名字决定了生成文件的名字。 
  （3）LOCAL_SRC_FILES:  这是要编译的源代码文件列表。 
       只要列出要传递给编译器的文件，因为编译系统自动计算依赖。注意源代码文件名称都是相对于 LOCAL_PATH的，你可以使用路径部分，例如： 
        LOCAL_SRC_FILES := foo.c toto/bar.c\ 
        Hello.c 
       文件之间可以用空格或Tab键进行分割,换行请用"\" 
       如果是追加源代码文件的话，请用LOCAL_SRC_FILES += 
       注意：可以LOCAL_SRC_FILES := $(call all-subdir-java-files)这种形式来包含local_path目录下的所有java文件。 
  （4）LOCAL_C_INCLUDES:  可选变量，表示头文件的搜索路径。 
        默认的头文件的搜索路径是LOCAL_PATH目录。 
  （5）LOCAL_STATIC_LIBRARIES: 表示该模块需要使用哪些静态库，以便在编译时进行链接。 
  （6）LOCAL_SHARED_LIBRARIES:  表示模块在运行时要依赖的共享库（动态库），在链接时就需要，以便在生成文件时嵌入其相应的信息。 
       注意：它不会附加列出的模块到编译图，也就是仍然需要在Application.mk 中把它们添加到程序要求的模块中。 
  （7）LOCAL_LDLIBS:  编译模块时要使用的附加的链接器选项。这对于使用‘-l’前缀传递指定库的名字是有用的。 
       例如，LOCAL_LDLIBS := -lz表示告诉链接器生成的模块要在加载时刻链接到/system/lib/libz.so 
       可查看 docs/STABLE-APIS.TXT 获取使用 NDK发行版能链接到的开放的系统库列表。 
   (8)LOCAL_MODULE_PATH 和 LOCAL_UNSTRIPPED_PATH 
       在 Android.mk 文件中， 还可以用LOCAL_MODULE_PATH 和LOCAL_UNSTRIPPED_PATH指定最后的目标安装路径. 
       不同的文件系统路径用以下的宏进行选择： 
       TARGET_ROOT_OUT：表示根文件系统。 
       TARGET_OUT：表示 system文件系统。 
       TARGET_OUT_DATA：表示 data文件系统。 
       用法如：LOCAL_MODULE_PATH :=$(TARGET_ROOT_OUT) 
       至于LOCAL_MODULE_PATH 和LOCAL_UNSTRIPPED_PATH的区别，暂时还不清楚。 
   （9）LOCAL_JNI_SHARED_LIBRARIES：定义了要包含的so库文件的名字，如果程序没有采用jni，不需要 
        LOCAL_JNI_SHARED_LIBRARIES := libxxx 这样在编译的时候，NDK自动会把这个libxxx打包进apk； 放在youapk/lib/目录下 



五、NDK提供的函数宏  
GNU Make函数宏，必须通过使用'$(call  )'来调用，返回值是文本化的信息。 
   （1）my-dir:返回当前 Android.mk 所在的目录的路径，相对于 NDK 编译系统的顶层。这是有用的，在 Android.mk 文件的开头如此定义： 
        LOCAL_PATH := $(call my-dir) 
   （2）all-subdir-makefiles: 返回一个位于当前'my-dir'路径的子目录中的所有Android.mk的列表。 
       例如，某一子项目的目录层次如下： 
            src/foo/Android.mk 
            src/foo/lib1/Android.mk 
            src/foo/lib2/Android.mk 
      如果 src/foo/Android.mk 包含一行： 
           include $(call all-subdir-makefiles) 
      那么它就会自动包含 src/foo/lib1/Android.mk 和 src/foo/lib2/Android.mk。 
      这项功能用于向编译系统提供深层次嵌套的代码目录层次。 
      注意，在默认情况下，NDK 将会只搜索在 src/*/Android.mk 中的文件。 
   （3）this-makefile:  返回当前Makefile 的路径(即这个函数调用的地方) 
   （4）parent-makefile:  返回调用树中父 Makefile 路径。即包含当前Makefile的Makefile 路径。 
   （5）grand-parent-makefile：返回调用树中父Makefile的父Makefile的路径 

Android.mk结构
多目录Android.mk包含语句
设置头文件搜索路径
设置需要链接的动态库
导出模块头文件路径
导出模块依赖关系
预编译
实例

Android.mk规则在NDK中有文档ANDROID-MK说明,我觉得了解了基本规则的人都要去看一下,以便灵活运用.

1.Android.mk结构:

LOCAL_PATH:=$(call my-dir) 
include $(CLEAR_VARS)
LOCAL_MODULE:=module_name 
LOCAL_SRC_FILES:=srcfile1.cpp srcfile2.cpp 
include $(BUILD_SHARED_LIBRARY) 

说明:

LOCAL_PATH:=$(call my-dir) #设置当前编译目录(包含此Android.mk的目录)
include $(CLEAR_VARS) #清除LOCAL_XXX变量,LOCAL_PATH除外
LOCAL_MODULE:=module_name #模块名字,不能包含空格,唯一
LOCAL_SRC_FILES:=srcfile1.cpp srcfile2.cpp #模块编译需要的c或cpp文件
include $(BUILD_SHARED_LIBRARY) #BUILD_SHARED_LIBRARY指定编译成动态库,BUILD_STATIC_LIBRARY指定生成静态库,BUILD_EXECUTEABLE指定生成可执行文件.
只有动态库才能被打包到安装包中,静态库可以用来生成动态库.

2.多目录Android.mk包含语句
包含指定的目录下的Android.mk
include $(call all-makefiles-under,指定目录)
通常是这样用的:include $(call all-makefiles-under,$(LOCAL_PATH))

包含所有当前目录中子目录的Android.mk(注意,这种方式运行于当前目录没有编译模块,不然在编译完当前目录模块后,不会再到子目录去了).
include $(call all-subdir-makefiles) 

包含语句必须放在Android.mk文件的末尾:
IMPORTANT NOTE: Due to the way GNU Make works, this really returns
the path of the *last* *included* *Makefile* during the parsing of
build scripts. Do not call my-dir after including another file.
不要在包含别的Android.mk后再调用call my-dir,会出错的,因此...如果需要包含别的Android.mk,需要放到末尾.


3.设置头文件搜索路径:
当前目录会被默认搜索(不包含子目录),设置其他位置的头文件查找路径:
LOCAL_C_INCLUDES:= $(ANDROID_SOURCE)/frameworks/av/include
LOCAL_C_INCLUDES+= $(ANDROID_SOURCE)/frameworks/base/include

设置需要链接的动态库
LOCAL_LDLIBS:=-Llibspath -lxxx -lyyy ... #libspath是库所在路径,xxx和yyy是库

指定链接Android.mk中定义的模块(如果xxx没有被编译好,它会先被编译):
LOCAL_SHARED_LIBRARIES:=module_name #指定动态库
LOCAL_STATIC_LIBRARIES:=module_name #指定静态库

5.导出模块头文件路径:
LOCAL_EXPORT_C_INCLUDES:=module_include
这个主要用来输出当前模块的头文件所在路径,其他模块如果依赖它,就不需要指定它的头文件路径了.

6.导出模块依赖关系:
LOCAL_EXPORT_LDLIBS:= -lxxx -lyyy
当用静态库生成动态库时,可以用此方法设置静态库的依赖环境,一般用法是:
LOCAL_EXPORT_LDLIBS:=$(LOCAL_LDLIBS) #上面提到用LOCAL_LDLIBS设置链接路径的好处就在这里,可以直接导出库和库所在的路径.

7.预编译,目的是为了在Android.mk中生成一个模块名字.
include $(PREBUILT_SHARED_LIBRARY)
include $(PREBUILT_STATIC_LIBRARY)
主要用来包含第三方库,为第三方库在Android.mk中创建模块名字,被其他库使用.使用这种编译时,LOCAL_SRC_FILES中指向一个动态库,并且最后被打包到安装包里的库会是这个动态库.


实例:

一个播放器的native代码,模块有:

    ffmpeg库(第三方库),androidvideo库,androidaudio库,androidomx库,ffmpeg-jni库

依赖关系:

    ffmpeg是由ffmpeg源码使用makefile生成.

    ffmpeg-jni依赖于前面四个模块,androidomx库依赖于ffmpeg库.

思路:

    将ffmpeg库编译成预编译模块,以供ffmpeg-jni和androidomx使用

    将androidomx,androidaudio,androidvideo生成静态库,并导出头文件路径和依赖关系,以供ffmepg-jni使用

    最后生成ffmpeg-jni库和ffmpeg库

文件结构说明:

jni
jni/android_omx 
jni/android_video 
jni/android_audio

-----------------------------------------------------------------------------------------------------------------

#jni/Android.mk

LOCAL_PATH:= $(call my-dir)
include $(CLEAR_VARS)
LOCAL_MODULE := android-ffmpeg
LOCAL_SRC_FILES := ffmpeg-build/$(TARGET_ARCH_ABI)/libffmpeg.so
LOCAL_EXPORT_C_INCLUDES := ffmpeg-build/$(TARGET_ARCH_ABI)/include
LOCAL_ARM_NEON:=true
include $(PREBUILT_SHARED_LIBRARY)

include $(CLEAR_VARS)
LOCAL_MODULE:=ffmpeg-jni
LOCAL_SRC_FILES:=ffmpeg-jni.cpp player.cpp fast_queue.cpp
LOCAL_LDLIBS:=-llog -lz -lm -landroid
LOCAL_SHARED_LIBRARIES:=android-ffmpeg
LOCAL_STATIC_LIBRARIES:=androidvideo androidaudio omxdecoder
include $(BUILD_SHARED_LIBRARY)

include $(call all-makefiles-under,$(LOCAL_PATH))

---------------------------------------------------------------------------------------------------------------------------------------

#jni/android_video/Android.mk

LOCAL_PATH:=$(call my-dir)

include $(CLEAR_VARS)
LOCAL_MODULE:=androidvideo
LOCAL_SRC_FILES:=androidvideo_surface.cpp
MY_ANDROID_SOURCE:=/media/d/android/jb4.1.2
MY_ANDROID_LIBS:=/media/d/android/jb4.1.2_libs
LOCAL_C_INCLUDES:= $(MY_ANDROID_SOURCE)/frameworks/av/include
LOCAL_C_INCLUDES+= $(MY_ANDROID_SOURCE)/frameworks/base/include
LOCAL_C_INCLUDES+= $(MY_ANDROID_SOURCE)/frameworks/native/include
LOCAL_C_INCLUDES+= $(MY_ANDROID_SOURCE)/frameworks/native/include/media/openmax
LOCAL_C_INCLUDES+= $(MY_ANDROID_SOURCE)/system/core/include
LOCAL_C_INCLUDES+= $(MY_ANDROID_SOURCE)/hardware/libhardware/include

LOCAL_LDLIBS:= -L$(MY_ANDROID_LIBS) -L$(LOCAL_PATH)/../ffmpeg-build/armeabi-v7a -llog -landroid_runtime -lmedia -lstagefright -landroid -lcutils -lui -lgui -lutils -lbinder
LOCAL_CPPFLAGS:=-Wno-multichar

LOCAL_EXPORT_C_INCLUDES:=$(LOCAL_PATH)
LOCAL_EXPORT_LDLIBS:=$(LOCAL_LDLIBS)

include $(BUILD_STATIC_LIBRARY)

android_omx,android_audio目录下的Android.mk和上面类似,不再列出.
中间会生成libandroidomx.a libandroidvideo.a libandroidaudio.a
最终生成的动态库是libffmpeg-jni.so和libffmpeg.so.

六、 Android.mk示例  

Java代码  

1. #编译静态库  
2. LOCAL_PATH := $(call my-dir)  
3. include $(CLEAR_VARS)  
4. LOCAL_MODULE = libhellos  
5. LOCAL_CFLAGS = $(L_CFLAGS)  
6. LOCAL_SRC_FILES = hellos.c  
7. LOCAL_C_INCLUDES = $(INCLUDES)  
8. LOCAL_SHARED_LIBRARIES := libcutils  
9. LOCAL_COPY_HEADERS_TO := libhellos  
10. LOCAL_COPY_HEADERS := hellos.h  
11. include $(BUILD_STATIC_LIBRARY)  
12.   
13. #编译动态库  
14. LOCAL_PATH := $(call my-dir)  
15. include $(CLEAR_VARS)  
16. LOCAL_MODULE = libhellod  
17. LOCAL_CFLAGS = $(L_CFLAGS)  
18. LOCAL_SRC_FILES = hellod.c  
19. LOCAL_C_INCLUDES = $(INCLUDES)  
20. LOCAL_SHARED_LIBRARIES := libcutils  
21. LOCAL_COPY_HEADERS_TO := libhellod  
22. LOCAL_COPY_HEADERS := hellod.h  
23. include $(BUILD_SHARED_LIBRARY)  
24.   
25. #使用静态库  
26. LOCAL_PATH := $(call my-dir)  
27. include $(CLEAR_VARS)  
28. LOCAL_MODULE := hellos  
29. LOCAL_STATIC_LIBRARIES := libhellos  
30. LOCAL_SHARED_LIBRARIES :=  
31. LOCAL_LDLIBS += -ldl  
32. LOCAL_CFLAGS := $(L_CFLAGS)  
33. LOCAL_SRC_FILES := mains.c  
34. LOCAL_C_INCLUDES := $(INCLUDES)  
35. include $(BUILD_EXECUTABLE)  
36.   
37. #使用动态库  
38. LOCAL_PATH := $(call my-dir)  
39. include $(CLEAR_VARS)  
40. LOCAL_MODULE := hellod  
41. LOCAL_MODULE_TAGS := debug  
42. LOCAL_SHARED_LIBRARIES := libc libcutils libhellod  
43. LOCAL_LDLIBS += -ldl  
44. LOCAL_CFLAGS := $(L_CFLAGS)  
45. LOCAL_SRC_FILES := maind.c  
46. LOCAL_C_INCLUDES := $(INCLUDES)  
47. include $(BUILD_EXECUTABLE)