VSF中的流模塊

流模塊單獨分出來講是因為內容相對比較多,而且也有一定難度。流模塊可以對應數據的生產者/消費者模型,生產者可以向流里寫數據(生產數據),消費者從流里讀取數據(消費數據)。并且,通過回調接口,可以實現自動流控。VSF中的流模塊的實現,也可以用來闡述面向對象的編程思想,因為流只是一個抽象類,實際使用的是具體的fifo流、buffer流或者multibuf流等具體內存結構實現的流。所以,流只是一個標準接口,如果一個模塊支持流接口的話,就可以很方便的和其他支持流接口的模塊對接。比如,wave播放模塊的輸入流,可以接到文件流,對應播放本地的wav文件;也可以接到http流,對用播放網上的wav文件,而wave播放模塊并不需要在意流的來源。

下面介紹一下流的接口,和實現自動流控的原理:

struct vsf_stream_cb_t
{
    void *param;
    void (*on_inout)(void *param);
    void (*on_connect)(void *param);
    void (*on_disconnect)(void *param);
};

struct vsf_stream_t
{
    // user_mem points to user structure, eg queue/fifo
    struct vsf_stream_op_t const *op;

    // callback_tx is notification for tx end of the stream
    // when rx end read the data out, will notify the tx end
    struct vsf_stream_cb_t callback_tx;
    // callback_rx is notification for rx end of the stream
    // when tx end write the data in, will notify the rx end
    struct vsf_stream_cb_t callback_rx;
    bool tx_ready;
    bool rx_ready;
    bool overflow;
};

vsf_err_t stream_init(struct vsf_stream_t *stream);
vsf_err_t stream_fini(struct vsf_stream_t *stream);
uint32_t stream_write(struct vsf_stream_t *stream, struct vsf_buffer_t *buffer);
uint32_t stream_read(struct vsf_stream_t *stream, struct vsf_buffer_t *buffer);
uint32_t stream_get_data_size(struct vsf_stream_t *stream);
uint32_t stream_get_free_size(struct vsf_stream_t *stream);
uint32_t stream_get_wbuf(struct vsf_stream_t *stream, uint8_t **ptr);
uint32_t stream_get_rbuf(struct vsf_stream_t *stream, uint8_t **ptr);
void stream_connect_rx(struct vsf_stream_t *stream);
void stream_connect_tx(struct vsf_stream_t *stream);
void stream_disconnect_rx(struct vsf_stream_t *stream);
void stream_disconnect_tx(struct vsf_stream_t *stream);

上面是流的數據結構,和操作接口。初始化和讀寫函數一看就能明白,stream_get_data_size是得到流里的數據大小,stream_get_free_size是得到流里的空余空間大小。stream_get_wbuf和stream_get_rbuf用于得到當前的讀寫指針,只在非常特殊的情況下使用。stream_connect_XX和stream_disconnect_XX是流的接收或者發送端的連接或者斷開。vsf_stream_t中,callback_XX是接收或者發送端設置的回調函數,當流的一端連接/斷開/讀寫數據的時候,通過回調接口通知流的另一端。

基于callback,就可以實現流控,生產者寫入數據到流的時候,會通知消費者去消費數據;消費者消費了數據的時候,也會通知生產者。生產者可以通過stream_get_free_size來得到流里空余空間的小大,只有大于生產者一次可產生的數據的時候(比如對于全速USB,就是64字節的最大ep大小),生產者才會產生數據。如果空余空間不夠的話,生產者只需要等待消費者消費數據后,再次通知生產者,然后生產者再判斷是否有足夠的空余空間。當然,實現流控的前提是生產者可以控制數據的產生。

流的實現:

uint32_t stream_read(struct vsf_stream_t *stream, struct vsf_buffer_t *buffer)
{
    uint32_t count = stream->op->read(stream, buffer);

    if (stream->tx_ready && (stream->callback_tx.on_inout != NULL) && count)
    {
        stream->callback_tx.on_inout(stream->callback_tx.param);
    }
    return count;
}

uint32_t stream_write(struct vsf_stream_t *stream, struct vsf_buffer_t *buffer)
{
    uint32_t count = stream->op->write(stream, buffer);

    if (count < buffer->size)
    {
        stream->overflow = true;
    }
    if (stream->rx_ready && (stream->callback_rx.on_inout != NULL) && count)
    {
        stream->callback_rx.on_inout(stream->callback_rx.param);
    }
    return count;
}

這里只是簡單用讀寫接口舉例,實際的讀寫操作,有op參數里指定的讀寫接口實現。代碼里,也只是簡單調用op指定的讀寫接口,然后判斷是否溢出以及是否需要調用回調接口。

流結構中,并沒有指定緩沖的數據結構,因為應用可以根據實際應用需求,來選擇緩沖類型。這里用最常用的fifo流來舉例:

struct vsf_fifostream_t
{
    struct vsf_stream_t stream;
    struct vsf_fifo_t mem;
};

static void fifo_stream_init(struct vsf_stream_t *stream)
{
    struct vsf_fifostream_t *fifostream = (struct vsf_fifostream_t *)stream;
    vsf_fifo_init(&fifostream->mem);
}

static uint32_t fifo_stream_get_data_length(struct vsf_stream_t *stream)
{
    struct vsf_fifostream_t *fifostream = (struct vsf_fifostream_t *)stream;
    return vsf_fifo_get_data_length(&fifostream->mem);
}

static uint32_t
fifo_stream_write(struct vsf_stream_t *stream, struct vsf_buffer_t *buffer)
{
    struct vsf_fifostream_t *fifostream = (struct vsf_fifostream_t *)stream;
    return vsf_fifo_push(&fifostream->mem, buffer->size, buffer->buffer);
}

static uint32_t
fifo_stream_read(struct vsf_stream_t *stream, struct vsf_buffer_t *buffer)
{
    struct vsf_fifostream_t *fifostream = (struct vsf_fifostream_t *)stream;
    return vsf_fifo_pop(&fifostream->mem, buffer->size, buffer->buffer);
}

const struct vsf_stream_op_t fifostream_op =
{
    .init = fifo_stream_init,
    .fini = fifo_stream_init,
    .write = fifo_stream_write,
    .read = fifo_stream_read,
    .get_data_length = fifo_stream_get_data_length,
    .get_avail_length = fifo_stream_get_avail_length,
    .get_wbuf = fifo_stream_get_wbuf,
    .get_rbuf = fifo_stream_get_rbuf,
};

這里只是列舉了幾個函數。fifo流繼承自vsf_stream_t,并且指定了fifo的緩沖類型。fifostream_op里指定了fifo流的各種操作接口,實際實現只是簡單調用fifo模塊的對應接口。可以把vsf_fifostream_t強制類型轉換為vsf_stream_t,就可以使用標準的流接口了。實際可以通過宏來實現各種不同類型的流的強制轉換:

#define STREAM_INIT(s)          stream_init((struct vsf_stream_t *)(s))
#define STREAM_FINI(s)          stream_fini((struct vsf_stream_t *)(s))
#define STREAM_WRITE(s, b)      stream_write((struct vsf_stream_t *)(s), (b))
#define STREAM_READ(s, b)       stream_read((struct vsf_stream_t *)(s), (b))
#define STREAM_GET_DATA_SIZE(s) stream_get_data_size((struct vsf_stream_t *)(s))
#define STREAM_GET_FREE_SIZE(s) stream_get_free_size((struct vsf_stream_t *)(s))
#define STREAM_GET_WBUF(s, p)   stream_get_wbuf((struct vsf_stream_t *)(s), (p))
#define STREAM_GET_RBUF(s, p)   stream_get_rbuf((struct vsf_stream_t *)(s), (p))
#define STREAM_CONNECT_RX(s)    stream_connect_rx((struct vsf_stream_t *)(s))
#define STREAM_CONNECT_TX(s)    stream_connect_tx((struct vsf_stream_t *)(s))
#define STREAM_DISCONNECT_RX(s) stream_disconnect_rx((struct vsf_stream_t *)(s))
#define STREAM_DISCONNECT_TX(s) stream_disconnect_tx((struct vsf_stream_t *)(s))

和標準接口只是大小寫的區別。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,119評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,382評論 3 415
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,038評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,853評論 1 309
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,616評論 6 408
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,112評論 1 323
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,192評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,355評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,869評論 1 334
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,727評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,928評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,467評論 5 358
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,165評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,570評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,813評論 1 282
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,585評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,892評論 2 372

推薦閱讀更多精彩內容