Originally written for Symbian, it is no longer needed since we figured
[speexdsp.git] / include / speex / speex_jitter.h
1 /* Copyright (C) 2002 Jean-Marc Valin */
2 /**
3    @file speex_jitter.h
4    @brief Adaptive jitter buffer for Speex
5 */
6 /*
7    Redistribution and use in source and binary forms, with or without
8    modification, are permitted provided that the following conditions
9    are met:
10    
11    - Redistributions of source code must retain the above copyright
12    notice, this list of conditions and the following disclaimer.
13    
14    - Redistributions in binary form must reproduce the above copyright
15    notice, this list of conditions and the following disclaimer in the
16    documentation and/or other materials provided with the distribution.
17    
18    - Neither the name of the Xiph.org Foundation nor the names of its
19    contributors may be used to endorse or promote products derived from
20    this software without specific prior written permission.
21    
22    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
26    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
27    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
28    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
29    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
30    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
31    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
32    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33
34 */
35
36 #ifndef SPEEX_JITTER_H
37 #define SPEEX_JITTER_H
38
39 #include "speex.h"
40 #include "speex_bits.h"
41
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45
46 struct JitterBuffer_;
47
48 typedef struct JitterBuffer_ JitterBuffer;
49
50 typedef struct _JitterBufferPacket JitterBufferPacket;
51
52 struct _JitterBufferPacket {
53    char        *data;
54    spx_uint32_t len;
55    spx_uint32_t timestamp;
56    spx_uint32_t span;
57 };
58
59
60 #define JITTER_BUFFER_OK 0
61 #define JITTER_BUFFER_MISSING 1
62 #define JITTER_BUFFER_INCOMPLETE 2
63 #define JITTER_BUFFER_INTERNAL_ERROR -1
64 #define JITTER_BUFFER_BAD_ARGUMENT -2
65
66 /** Initialise jitter buffer */
67 JitterBuffer *jitter_buffer_init(int tick);
68
69 /** Reset jitter buffer */
70 void jitter_buffer_reset(JitterBuffer *jitter);
71
72 /** Destroy jitter buffer */
73 void jitter_buffer_destroy(JitterBuffer *jitter);
74
75 /** Put one packet into the jitter buffer */
76 void jitter_buffer_put(JitterBuffer *jitter, const JitterBufferPacket *packet);
77
78 /** Get one packet from the jitter buffer */
79 int jitter_buffer_get(JitterBuffer *jitter, JitterBufferPacket *packet, spx_uint32_t *current_timestamp);
80
81 /** Get pointer timestamp of jitter buffer */
82 int jitter_buffer_get_pointer_timestamp(JitterBuffer *jitter);
83
84 /** Advance by one tick */
85 void jitter_buffer_tick(JitterBuffer *jitter);
86
87
88 /** Speex jitter-buffer state. */
89 typedef struct SpeexJitter {
90    SpeexBits current_packet;                                              /**< Current Speex packet                */
91    int valid_bits;                                                        /**< True if Speex bits are valid        */
92    JitterBuffer *packets;
93    void *dec;                                                             /**< Pointer to Speex decoder            */
94    spx_int32_t frame_size;                                                        /**< Frame size of Speex decoder         */
95 } SpeexJitter;
96
97 /** Initialise jitter buffer */
98 void speex_jitter_init(SpeexJitter *jitter, void *decoder, int sampling_rate);
99
100 /** Destroy jitter buffer */
101 void speex_jitter_destroy(SpeexJitter *jitter);
102
103 /** Put one packet into the jitter buffer */
104 void speex_jitter_put(SpeexJitter *jitter, char *packet, int len, int timestamp);
105
106 /** Get one packet from the jitter buffer */
107 void speex_jitter_get(SpeexJitter *jitter, spx_int16_t *out, int *start_offset);
108
109 /** Get pointer timestamp of jitter buffer */
110 int speex_jitter_get_pointer_timestamp(SpeexJitter *jitter);
111
112 #ifdef __cplusplus
113 }
114 #endif
115
116
117 #endif