stream/pvr.h

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