git.sesse.net Git - vlc/blob - 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 <assert.h>
  25 #include <errno.h>
  26
  27 #include <vlc_access.h>
  28
  29 #define BANDWIDTH_TEXT N_("Bandwidth limit (bytes/s)")
  30 #define BANDWIDTH_LONGTEXT N_( \
  31     "The bandwidth module will drop any data in excess of that many bytes " \
  32     "per seconds." )
  33
  34 static int  Open (vlc_object_t *);
  35 static void Close (vlc_object_t *);
  36
  37 /* TODO: burst support */
  38
  39 vlc_module_begin ();
  40     set_shortname (_("Bandwidth"));
  41     set_description (_("Bandwidth limiter"));
  42     set_category (CAT_INPUT);
  43     set_subcategory (SUBCAT_INPUT_ACCESS_FILTER);
  44     set_capability ("access_filter", 0);
  45     add_shortcut ("bandwidth");
  46     set_callbacks (Open, Close);
  47
  48     add_integer ("access-bandwidth", 65536, NULL, BANDWIDTH_TEXT,
  49                  BANDWIDTH_LONGTEXT, VLC_FALSE);
  50 vlc_module_end();
  51
  52 static int Read (access_t *access, uint8_t *buffer, int len);
  53 static int Seek (access_t *access, int64_t offset);
  54 static int Control (access_t *access, int cmd, va_list ap);
  55
  56 struct access_sys_t
  57 {
  58     mtime_t last_time;
  59     size_t  last_size;
  60     size_t  bandwidth;
  61 };
  62
  63 /**
  64  * Open()
  65  */
  66 static int Open (vlc_object_t *obj)
  67 {
  68     access_t *access = (access_t*)obj;
  69     access_t *src = access->p_source;
  70
  71     if (src->pf_read != NULL)
  72         access->pf_read = Read;
  73     else
  74     {
  75         msg_Err (obj, "block bandwidth limit not implemented");
  76         return VLC_EGENERIC;
  77     }
  78
  79     if (src->pf_seek != NULL)
  80         access->pf_seek = Seek;
  81
  82     access->pf_control = Control;
  83     access->info = src->info;
  84
  85     access_sys_t *p_sys = access->p_sys = malloc (sizeof (*p_sys));
  86     if (p_sys == NULL)
  87         return VLC_ENOMEM;
  88
  89     memset (p_sys, 0, sizeof (*p_sys));
  90     p_sys->bandwidth = var_CreateGetInteger (access, "access-bandwidth");
  91     p_sys->last_time = mdate ();
  92
  93     msg_Dbg (obj, "bandwidth limit: %lu bytes/s",
  94              (unsigned long)p_sys->bandwidth);
  95     return VLC_SUCCESS;
  96 }
  97
  98
  99 /**
 100  * Close()
 101  */
 102 static void Close (vlc_object_t *obj)
 103 {
 104     access_t *access = (access_t *)obj;
 105     access_sys_t *p_sys = access->p_sys;
 106     free (p_sys);
 107 }
 108
 109
 110 static int Read (access_t *access, uint8_t *buffer, int len)
 111 {
 112     access_t *src = access->p_source;
 113     access_sys_t *p_sys = access->p_sys;
 114     mtime_t now;
 115
 116     if (len == 0)
 117         return 0;
 118
 119 retry:
 120     now = mdate ();
 121     if (now <= p_sys->last_time)
 122     {
 123         msg_Err (access, "*** ALERT *** System clock is going backward! ***");
 124         return 0; /* Uho, your clock is broken. */
 125     }
 126
 127     mtime_t delta = now - p_sys->last_time;
 128     p_sys->last_time = now;
 129
 130     delta *= p_sys->bandwidth;
 131     delta /= 1000000u;
 132
 133     if (delta == 0)
 134     {
 135         now += 1000000u / p_sys->bandwidth;
 136         mwait (now);
 137         goto retry;
 138     }
 139
 140     if (len > delta)
 141     {
 142         msg_Dbg (access, "reading %u bytes instead of %u", (unsigned)delta,
 143                  len);
 144         len = (int)delta;
 145     }
 146
 147
 148     src->info.i_update = access->info.i_update;
 149     len = src->pf_read (src, buffer, len);
 150     access->info = src->info;
 151
 152     msg_Dbg (access, "read %u bytes", len);
 153     return len;
 154 }
 155
 156
 157 static int Control (access_t *access, int cmd, va_list ap)
 158 {
 159     access_t *src = access->p_source;
 160     return src->pf_control (src, cmd, ap);
 161 }
 162
 163
 164 static int Seek (access_t *access, int64_t offset)
 165 {
 166     access_t *src = access->p_source;
 167
 168     src->info.i_update = access->info.i_update;
 169     int ret = src->pf_seek (src, offset);
 170     access->info = src->info;
 171     return ret;
 172 }