Bandwidth limit access filter
[vlc.git] / modules / access_filter / bandwidth.c
1 /*****************************************************************************
2  * bandwidth.c
3  *****************************************************************************
4  * Copyright © 2007 Rémi Denis-Courmont
5  * $Id: dump.c 19948 2007-04-26 19:53:53Z courmisch $
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
20  *****************************************************************************/
21
22 #include <vlc/vlc.h>
23
24 #include <stdio.h>
25 #include <stdlib.h>
26 #include <assert.h>
27 #include <errno.h>
28
29 #include <vlc_access.h>
30
31 #define BANDWIDTH_TEXT N_("Bandwidth limit (bytes/s)")
32 #define BANDWIDTH_LONGTEXT N_( \
33     "The bandwidth module will drop any data in excess of that many bytes " \
34     "per seconds." )
35
36 static int  Open (vlc_object_t *);
37 static void Close (vlc_object_t *);
38
39 /* TODO: burst support */
40
41 vlc_module_begin ();
42     set_shortname (_("Bandwidth"));
43     set_description (_("Bandwidth limiter"));
44     set_category (CAT_INPUT);
45     set_subcategory (SUBCAT_INPUT_ACCESS_FILTER);
46     set_capability ("access_filter", 0);
47     add_shortcut ("bandwidth");
48     set_callbacks (Open, Close);
49
50     add_integer ("access-bandwidth", 65536, NULL, BANDWIDTH_TEXT,
51                  BANDWIDTH_LONGTEXT, VLC_FALSE);
52 vlc_module_end();
53
54 static int Read (access_t *access, uint8_t *buffer, int len);
55 static int Seek (access_t *access, int64_t offset);
56 static int Control (access_t *access, int cmd, va_list ap);
57
58 struct access_sys_t
59 {
60     mtime_t last_time;
61     size_t  last_size;
62     size_t  bandwidth;
63 };
64
65 /**
66  * Open()
67  */
68 static int Open (vlc_object_t *obj)
69 {
70     access_t *access = (access_t*)obj;
71     access_t *src = access->p_source;
72
73     if (src->pf_read != NULL)
74         access->pf_read = Read;
75     else
76     {
77         msg_Err (obj, "block bandwidth limit not implemented");
78         return VLC_EGENERIC;
79     }
80
81     if (src->pf_seek != NULL)
82         access->pf_seek = Seek;
83
84     access->pf_control = Control;
85     access->info = src->info;
86
87     access_sys_t *p_sys = access->p_sys = malloc (sizeof (*p_sys));
88     if (p_sys == NULL)
89         return VLC_ENOMEM;
90
91     memset (p_sys, 0, sizeof (*p_sys));
92     p_sys->bandwidth = var_CreateGetInteger (access, "access-bandwidth");
93     p_sys->last_time = mdate ();
94
95     msg_Dbg (obj, "bandwidth limit: %u bytes/s", p_sys->bandwidth);
96     return VLC_SUCCESS;
97 }
98
99
100 /**
101  * Close()
102  */
103 static void Close (vlc_object_t *obj)
104 {
105     access_t *access = (access_t *)obj;
106     access_sys_t *p_sys = access->p_sys;
107     free (p_sys);
108 }
109
110
111 static int Read (access_t *access, uint8_t *buffer, int len)
112 {
113     access_t *src = access->p_source;
114     access_sys_t *p_sys = access->p_sys;
115     mtime_t now;
116
117     if (len == 0)
118         return 0;
119
120 retry:
121     now = mdate ();
122     if (now <= p_sys->last_time)
123     {
124         msg_Err (access, "*** ALERT *** System clock is going backward! ***");
125         return 0; /* Uho, your clock is broken. */
126     }
127
128     mtime_t delta = now - p_sys->last_time;
129     p_sys->last_time = now;
130
131     delta *= p_sys->bandwidth;
132     delta /= 1000000u;
133
134     if (delta == 0)
135     {
136         now += 1000000u / p_sys->bandwidth;
137         mwait (now);
138         goto retry;
139     }
140
141     if (len > delta)
142     {
143         msg_Dbg (access, "reading %u bytes instead of %u", (unsigned)delta,
144                  len);
145         len = (int)delta;
146     }
147
148
149     src->info.i_update = access->info.i_update;
150     len = src->pf_read (src, buffer, len);
151     access->info = src->info;
152
153     msg_Dbg (access, "read %u bytes", len);
154     return len;
155 }
156
157
158 static int Control (access_t *access, int cmd, va_list ap)
159 {
160     access_t *src = access->p_source;
161     return src->pf_control (src, cmd, ap);
162 }
163
164
165 static int Seek (access_t *access, int64_t offset)
166 {
167     access_t *src = access->p_source;
168
169     src->info.i_update = access->info.i_update;
170     int ret = src->pf_seek (src, offset);
171     access->info = src->info;
172     return ret;
173 }