VLC框架分析

功能部份:

VLC媒体播放器的核心是libvlc ，它提供了界面，应用处理功能，如播放列表管理，音频和视频解码和输出，线程系统。所有libvlc源文件设在的/src目录及其子目录：

# config/ ：从命令行和配置文件加载配置，提供功能模块的读取和写入配置
# control/: 提供动作控制功能，如播放/暂停，音量管理，全屏，日志等。
# extras/: 大多是平台的特殊代码
# modules/: 模块管理
# network/: 提供网络接口（socket管理，网络错误等）
# osd/: 显示屏幕上的操作
# test/: libvlc测试模块
# text/: 字符集
# interface/ : 提供代码中可以调用的接口中,如按键后硬件作出反应。
# playlist/: 管理播放功能,如停止,播放,下一首,随机播放等
# input/: 建立并读取一个输入流,并且分离其中的音频和视频,然后把分离好的音频流和视频流发送给解码器.
# video_output/ : 初始化视频播放器,把从解码器得到的视频画面转化格式(从YUV 转为 RGB)然后播放它们
# audio_output/ : 初始化音频混合器,即设置正确的同步频率,并对从解码器传来的音频流重新取样
# stream_output/: 输出音频流和视频流到网络
# misc/: libvlc使用的其他部分功能 ，如线程系统，消息队列， CPU的检测，对象查找系统，或平台的特定代码。

模块部份:

VLC媒体播放器的模块部份,在/modules的子目录下(详细说明可以参考其下的List文件),这些模块只在程序载入它们时有效.每一个模块，可提供不同的功能，它们会适合的特定文件或某一特定的环境.此外，audio_output/video_output/interface 模块都写成了可跨平台的代码,方便支持新的平台（如beos或服务Mac OS X ） 。

插件模块可以在 src/modules.c 和 include/vlc_modules*.h 提供函数中,动态加载和卸载

LibVLC可以将模块直接插入到应用程序中,例如不支持动态加载代码的操作系统.模块静态插入到应用程序叫内建.

1.vlc.c 只是入口程序

2.Libvlc.c 是各个模块的结合点，这要是对接口编程

• Vlc_Create(): 两个重要的数据结构：libvlc_t & vlc_t , 所有的参数传递都在这里面
• Vlc_Init(): 初始化参数， module_bank
• Vlc_AddInf(): 添加module

3./src/misc/configure.c 命令行参数和参数文件分析
参数文件是~/.vnc/vlcrc。其中可以设置log文件的位置

4./include/ 所有头文件的集合

5./src/interface/Interface.h 所有module的集合

6./src/misc/Modules.c
其中module_t * __module_Need( vlc_object_t *p_this, const char *psz_capability,
const char *psz_name, vlc_bool_t b_strict ) 方法是寻找合适的interface
如果找到合适的，就调用AllocatePlugin()动态的分配一个。

7.how to link to different modules without OOP

对VLC源代码阅读的计划是从其程序的框架开始，先对其主要的文件进行整理：

1.include/main.h 文件： access to all program variables,主要定义了2个结构体：libvlc_t,vlc_t。

a. struct libvlc_t 根据程序注释：该结构体只有一个实例，在main函数中被分配，而且只能在main中访问。它用来存储一些只能初始化一次的数据，比如说cpu容量或者global lock.

b. struct vlc_t 注释称：This structure is a LibVLC instance

libvlc_t,vlc_t在VLC_COMMON_MEMBERS宏中出现，分别定义了 libvlc_t * p_libvlc; vlc_t * p_vlc; 对象，注释称为 root of the evil,可见其结构体的重要性.所有的参数传递都在这里面(具体尚不清楚)。

2.include/Vlc_common.h 文件:common definitions,Collection of useful common types and macros definitions,通用类型和宏定义的集合

主要作用是为了将不同的操作系统中的变量定义统一起来,比如说根据将unit_8来统一代表unsiged char类型.

该文件中还定义了VLC_COMMON_MEMBERS宏，该宏中包括了所有VLC基本对象的通用成员变量：these members are common for all vlc objects。

定义导出函数
#ifndef __PLUGIN__ 
# define VLC_EXPORT( type, name, args ) type name args
#else
# define VLC_EXPORT( type, name, args ) struct _u_n_u_s_e_d_
extern module_symbols_t* p_symbols;
#endif
定义回调函数

typedef int ( * vlc_callback_t ) ( vlc_object_t *, /* variable's object */
char const *, /* variable name */
vlc_value_t, /* old value */
vlc_value_t, /* new value */

void * ); /* callback data */

3.include/vlc_objects.h 文件:vlc_object_t definition and manipulation methods,vlc_object_t的定义和处理函数

struct vlc_object_t
{
VLC_COMMON_MEMBERS 
}; //定义一个结构来使用宏定义的公共成员


VLC中vlm介绍

代码从两大部分入手，一个telnet 的deamon。还有就是rtsp的实现部分 。结果发现，他们通过了一个桥梁vlm的media进行沟通。

• 当受到new MEDIANAME vod enabled 就建立一个media。
• 如果受到setup MEDIANAME input filename.mpg 就读入流准备分析，建立input流
• 当受到rtsp的请求后，就建立这个output流

这样，vod就和别的模块一致了。rtsp只是一种output流的module。

代码分析

1. /modules/control/telnet.c
/*****************************************************************************
* Run: main loop
*****************************************************************************/
static void Run( intf_thread_t *p_intf ){
vlm_ExecuteCommand( p_sys->mediatheque, cl->buffer_read,
& message );
}

2. /src/Misc/vlm.c
/*****************************************************************************
* vlm_ExecuteCommand:
*****************************************************************************/
int vlm_ExecuteCommand( vlm_t *p_vlm, const char *psz_command,
vlm_message_t **pp_message)
{
}

vlm_MediaNew( vlm_t *vlm, const char *psz_name, int i_type ){

vlm_media_t *media = malloc( sizeof( vlm_media_t ) );
}
*****************************************************
struct vlm_t
{
VLC_COMMON_MEMBERS

vlc_mutex_t lock;

int i_media;
vlm_media_t **media;

int i_vod;
vod_t *vod;

int i_schedule;
vlm_schedule_t **schedule;
};
*****************************************************
int vlm_MediaSetup( vlm_t *vlm, vlm_media_t *media, const char *psz_cmd,
const char *psz_value ){

if( (p_input = input_CreateThread2( vlm, &media->item, psz_header
) ) )
{
while( !p_input->b_eof && !p_input->b_error ) msleep( 100000 );

input_StopThread( p_input );
input_DestroyThread( p_input );
vlc_object_detach( p_input );
vlc_object_destroy( p_input );
}
}

3. /src/Input/input.c
input_thread_t *__input_CreateThread2( vlc_object_t *p_parent,
input_item_t *p_item,
char *psz_header )
{
input_thread_t *p_input = NULL; /* thread descriptor */ 
p_input = Create( p_parent, p_item, psz_header, VLC_FALSE );
/* Now we can attach our new input */
vlc_object_attach( p_input, p_parent );

/* Create thread and wait for its readiness. */
if( vlc_thread_create( p_input, "input", Run,
VLC_THREAD_PRIORITY_INPUT, VLC_TRUE ) )
{
msg_Err( p_input, "cannot create input thread" );
vlc_object_detach( p_input );
vlc_object_destroy( p_input );
return NULL;
}
}

static input_thread_t *Create( vlc_object_t *p_parent, input_item_t *p_item,
char *psz_header, vlc_bool_t b_quick )
{
}

/*****************************************************************************
* Run: main thread loop
* This is the "normal" thread that spawns the input processing chain,
* reads the stream, cleans up and waits
*****************************************************************************/
static int Run( input_thread_t *p_input )
{
}

=====================================================================================
4. \modules\misc\rtsp.c
static vod_media_t *MediaNew( vod_t *p_vod, const char *psz_name,
input_item_t *p_item )
{
vod_sys_t *p_sys = p_vod->p_sys;
vod_media_t *p_media = malloc( sizeof(vod_media_t) );
int i;

if( !p_media )
{
msg_Err( p_vod, "not enough memory" );
return NULL;
}

memset( p_media, 0, sizeof(vod_media_t) );
p_media->es = 0;
p_media->psz_mux = 0;
p_media->rtsp = 0;
p_media->b_raw = VLC_FALSE;

asprintf( &p_media->psz_rtsp_path, "%s%s", p_sys->psz_path, psz_name );
p_media->p_rtsp_url =
httpd_UrlNewUnique( p_sys->p_rtsp_host, p_media->psz_rtsp_path, NULL,
NULL, NULL );

if( !p_media->p_rtsp_url )
{
msg_Err( p_vod, "cannot create RTSP url (%s)", p_media->psz_rtsp_path);
free( p_media->psz_rtsp_path );
free( p_media );
return NULL;
}

msg_Dbg( p_vod, "created RTSP url: %s", p_media->psz_rtsp_path );

asprintf( &p_media->psz_rtsp_control_v4,
"a=control:rtsp://%%s:%d%s/trackID=%%d\r\n",
p_sys->i_port, p_media->psz_rtsp_path );
asprintf( &p_media->psz_rtsp_control_v6,
"a=control:rtsp://[%%s]:%d%s/trackID=%%d\r\n",
p_sys->i_port, p_media->psz_rtsp_path );

httpd_UrlCatch( p_media->p_rtsp_url, HTTPD_MSG_SETUP,
RtspCallback, (void*)p_media );
httpd_UrlCatch( p_media->p_rtsp_url, HTTPD_MSG_DESCRIBE,
RtspCallback, (void*)p_media );
httpd_UrlCatch( p_media->p_rtsp_url, HTTPD_MSG_PLAY,
RtspCallback, (void*)p_media );
httpd_UrlCatch( p_media->p_rtsp_url, HTTPD_MSG_PAUSE,
RtspCallback, (void*)p_media );
httpd_UrlCatch( p_media->p_rtsp_url, HTTPD_MSG_TEARDOWN,
RtspCallback, (void*)p_media );
}

static int RtspCallback( httpd_callback_sys_t *p_args, httpd_client_t *cl,
httpd_message_t *answer, httpd_message_t *query )
{
switch( query->i_type )
{
case HTTPD_MSG_SETUP:
{
}
case HTTPD_MSG_PLAY:
{
p_rtsp = RtspClientGet( p_media, psz_session );
vod_MediaControl( p_vod, p_media, psz_session, VOD_MEDIA_PLAY,
psz_output );

}
}

}

5. vlc_vod.h
static inline int vod_MediaControl( vod_t *p_vod, vod_media_t *p_media,
char *psz_id, int i_query, ... )
{
i_result = p_vod->pf_media_control( p_vod->p_data, p_media, psz_id,
i_query, args );
}

libvlc外部api的简单整理

libvlc.h

定义了libvlc的外部api，引用这个头文件就可以把VLC嵌入到我们的程序里面了。

libvlc的对象必须先被初始化之后才能被使用。

libvlc core

libvlc_new() 用于初始化一个libvlc的实例，argc表示参数的个数，argv表示参数，返回创建的实例若当发生错误时返回NULL

libvlc_release()用于销毁一个libvlc的实例

　　libvlc error handling

• libvlc_errmsg()返回的是在idaoyong线程中产生的最新的libvlc错误，这个错误信息至少在另外一个错误发生之前（至少再调用一次libvlc）都是有效的，当没有任何错误的时候返回的是NULL
• libvlc_clearerr()用于清除当前线程的libvlc的错误状态.此操作是可选的,默认情况下,错误状态是会在新的错误发生时被覆盖.
• libvlc_vprinterr()用于设置当前线程的libvlc的错误状态和消息.无论何时都返回一个nul字符
• libvlc_printerr() /源码里的注释和上一个一模一样
• libvlc_retain()增加libvlc的引用计数,任何新的libvlc实例的引用计数为1
• libvlc_add_intf():尝试启动libvlc实例的用户接口,p_instance表示要启动的实例,name为接口名,NULL表示默认,返回0表示成功-1表示发生错误
• libvlc_set_exits_handler():此函数用于为一个已存在的libvlc事件注册一个回调.此方法在你用libvlc_add_intf()开启了至少一个接口时非常有用.典型的,这个函数将唤醒你的程序主循环(从其他线程).参数p_instance 表示libvlc实例,cb表示当libvlc要退出时要调用的回调.opaque表示回调的数据指针.警告:此函数不能同libvlc_wait()同时调用.
• libvlc_wait():等待到有一个接口引发实例的推出动作.必须先用libvlc_add_intf()开启至少一个接口.
• libvlc_set_user_agent(): 设置应用程序名,当有协议要求的时候,libvlc将把这个名字作为用户代理串传递给它.参数name应该是一个可读的应用程序名,例如"FooBar player 1.2.3"，http参数为HTTP User Agent。例如"FooBar/1.2.3 Python/2.6.0。
• libvlc_get_Version()：返回libvlc的版本号
• libvlc_get_compiler()：返回编译libvlc的编译器的版本。
• libvlc_get_changeset() ：返回libvlc的 changeset？

libvlc asynchronous events

libvlc 发出不同步事件

许多libvlc对象，如libvlc_instance_t libvlc_media_player_t不同步的产生时间，它们中的每一个都提供了libvlc_event_manager_t事件管理器。你可以通过libvlc_event_attach（）来订阅这些事件以及用libvlc_event_detach（）来退订事件。

• libvlc_event_manager_t是属于libvlc对象的事件管理器
• libvlc_event_type_t：表示libvlc的事件
• libvlc_callback_t():回调函数通知(call back function notification翻译不准确）,参数p_event为触发回调的时间.
• libvlc_event_attach():注册一个event notification。参数p_event_manager 想要绑定的事件管理器.通常来说它是由vlc_my_object_event_manager()处获得的,此处的my_object是你想要监听的对象,i_event_type是想要监听的事件，f_callback是当i_event_type发生时要调用的函数。user_data是用户提供的伴随事件而传递的数据。成功时此函数返回0，发生错误时返回ENOMEM
• libvlc_event_detach()退订一个event notification

• libvlc_event_type_name()：获得一个事件的类型名

libvlc_log LibVLC logging

libvlc_log系列函数提供了访问libvlc消息日志的方法.这些函数仅用于高级用户或调试之用.

• libvlc_get_log_verbosity()：获得VLC消息的详细级别
• libvlc_set_log_verbosity():设置VLC消息的详细级别
• libvlc_log_open():开启VLC消息日志实例(从一个libvlc实例中获得其消息日志实例)
• libvlc_log_close():关闭VLC消息日志实例
• libvlc_log_count():返回日志中消息条数
• libvlc_log_clear():清除日志实例.将把实例中的所有消息删除,为了防止消息阻塞,应该经常清除.
• libvlc_log_get_iterator():定位并返回一个日志中记录的iterator
• libvlc_log_iterator_free():释放一个先前定位好的iterator
• libvlc_log_iterator_next():返回下一条日志消息,当接下来为空的时候返回NULL,否则返回下一个消息对象

---

libvlc_media.h

libvlc_media_t是一个可播放的媒体的抽象表达.它包含了这个媒体的位置以及各种可选的元数据.

• libvlc_state_t:此枚举类型的循序必须严格保证和源码一致,同时可参考mediacontrol_PlayerStatus,input_state_e枚举类型以及VideoLan.LibVLC.State（在bindings/cil/src/media.cs)
• libvlc_media_stats_t：Libvlc的媒体统计信息
• libvlc_media_track_info_t:没有注释，主要是fourcc和docec的其他信息。
• libvlc_media_new_location():使用一个给定的媒体资源路径来建立一个libvlc_media对象.参数psz_mrl为要读取的MRL(Media Resource Location).此函数返回新建的对象或NULL.
• libvlc_media_new_path():从本地文件系统路径新建,其他参照上一条
• libvlc_media_new_as_node():使用给定的名称创建一个libvlc_media_t并将其作为一个空的节点
• libvlc_media_add_option():添加一个选项到已有的libvlc_media_t,这个选项将被用于决定media_player如何读取媒体。这样一来就可以在每个媒体上指定各自的VLC的高级reading/streaming选项。
• libvlc_media_add_option_flag():减价一个带有可配置标记的选贤到已有的libvlc_media_t.其他同上一条.
• libvlc_media_retain():保留一个引用到一个媒体描述对象(libvlc_media_t.使用libvlc_media_release()来减少一个媒体描述对象的引用计数
• libvlc_media_release():减少一个libvlc_media_t的引用计数,如果减少到0时,此此函数将释放此对象(销毁).它将发送一个libvlc_MediaFreed事件到所有的监听者那里。如果一个libvlc_media_t被释放了，它就再也不能使用了。
• libvlc_media_get_mrl():从一个媒体描述对象处获得它的mrl
• libvlc_media_duplicate()：镜像一份媒体描述对象
• libvlc_media_get_meta():读取媒体的元数据。如果媒体还没被解析，则返回NULL，这个方法会自动调用libvlc_media_parse_async()，因此，在调用此方法以后，你可以接收到一个libvlc_MediaMetaChanged事件。如果你希望使用一个同步的版本，请确保你在调用get_meta()之前调用了libvlc_media_parse();
• libvlc_media_set_meta():设置媒体的元数据,此方法不会保存数据,还需要调用libvlc_media_save_meta()来保存.
• libvlc_media_get_state():获取当前媒体描述对象的状态.可能的状态被定义在livblc_structures.c中.
• libvlc_media_subitems():获得一个媒体描述对象的子项目.此方法将增加媒体描述对象的引用计数,使用libvlc_media_list_release()减少引用计数.
• libvlc_media_event_manager():获得一个媒体描述对象的事件管理器.
• libvlc_media_get_duration():获得一个媒体描述对象的持续时间.发生错误时返回-1.
• libvlc_media_parse():解析一个本地媒体的元数据和轨道信息,此方法是同步的.
• libvlc_media_parse_async():同上,此方法不同步,你可以监听libvlc_MediaParsedChanged事件来追踪他，如果已经被解析过了则此事件不会被触发。
• libvlc_media_is_parsed():获得一个媒体描述对象的分析状态。当分析过了返回true。
• libvlc_media_set_user_data():设置媒体描述符的用户数据,此数据仅被host程序访问,VLC.framework将它作为一个指向一个引用了一个libvlc_media_t指针的本地对象的指针来使用
• libvle_media_get_tracks_info():获得媒体描述符的基本流信息.注意你必须使用--sout="#description"播放媒体恰好一次，否则将得到一个空的数组。而多次播放则会导致多个重复数据。

VLC API集合：http://www.videolan.org/developers/vlc/doc/doxygen/html/group__libvlc.html#_details