stream/pvr.h

   1 /*
   2  *  Copyright (C) 2006 Benjamin Zores
   3  *  Copyright (C) 2007 Sven Gothel (Channel Navigation)
   4  *   Stream layer for hardware MPEG 1/2/4 encoders a.k.a PVR
   5  *    (such as WinTV PVR-150/250/350/500 (a.k.a IVTV), pvrusb2 and cx88).
   6  *   See http://ivtvdriver.org/index.php/Main_Page for more details on the
   7  *    cards supported by the ivtv driver.
   8  *
   9  *   This program is free software; you can redistribute it and/or modify
  10  *  it under the terms of the GNU General Public License as published by
  11  *  the Free Software Foundation; either version 2 of the License, or
  12  *  (at your option) any later version.
  13  *
  14  *   This program is distributed in the hope that it will be useful,
  15  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  *  GNU General Public License for more details.
  18  *
  19  *   You should have received a copy of the GNU General Public License
  20  *  along with this program; if not, write to the Free Software Foundation,
  21  *  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  22  */
  23
  24 #ifndef PVR_H
  25 #define PVR_H
  26
  27 #include "tv.h"
  28
  29 /**
  30  * @brief Get the current station name.
  31  *        The pointer is valid, till the stream is closed.
  32  * @return The stream's station name
  33  */
  34 const char *pvr_get_current_stationname (stream_t *stream);
  35
  36 /**
  37  * @brief Get the current channel name.
  38  *        The pointer is valid, till the stream is closed.
  39  * @return The stream's channel name
  40  */
  41 const char *pvr_get_current_channelname (stream_t *stream);
  42
  43 /**
  44  * @brief Get the current frequency.
  45  * @return frequency
  46  */
  47 int pvr_get_current_frequency (stream_t *stream);
  48
  49 /**
  50  * @brief Set the current station using the channel name.
  51  *        This function will fail,
  52  *        if the channel does not exist, or the station is not enabled
  53  * @return 0 if the station is available, otherwise -1
  54  */
  55 int pvr_set_channel (stream_t *stream, const char *channel);
  56
  57 /**
  58  * @brief Set the current station using to the last set channel
  59  * @return 0 if the station is available, otherwise -1
  60  */
  61 int pvr_set_lastchannel (stream_t *stream);
  62
  63 /**
  64  * @brief Set the current channel using the frequency.
  65  *        This function will fail,
  66  *        if the frequency does not exist, or the station is not enabled
  67  * @return 0 if the station is available, otherwise -1
  68  */
  69 int pvr_set_freq (stream_t *stream, int freq);
  70
  71 /**
  72  * @brief Set the current station while stepping.
  73  *        This function will fail,
  74  *        if the station does not exist, or the station is not enabled
  75  * @return 0 if the station is available, otherwise -1
  76  */
  77 int pvr_set_channel_step (stream_t *stream, int step);
  78
  79 /**
  80  * @brief Set the current frequency while stepping
  81  *        This function will fail,
  82  *        if the frequency is invalid, i.e. <0
  83  * @return 0 if success, otherwise -1
  84  */
  85 int pvr_force_freq_step (stream_t *stream, int step);
  86
  87 #endif /* PVR_H */