xbmc/cdrip/CDDARipJob.h

   1 /*
   2  *  Copyright (C) 2012-2018 Team Kodi
   3  *  This file is part of Kodi - https://kodi.tv
   4  *
   5  *  SPDX-License-Identifier: GPL-2.0-or-later
   6  *  See LICENSES/README.md for more information.
   7  */
   8
   9 #pragma once
  10
  11 #include "music/tags/MusicInfoTag.h"
  12 #include "utils/Job.h"
  13
  14 namespace XFILE
  15 {
  16 class CFile;
  17 }
  18
  19 namespace KODI
  20 {
  21 namespace CDRIP
  22 {
  23
  24 class CEncoder;
  25
  26 class CCDDARipJob : public CJob
  27 {
  28 public:
  29   /*!
  30    * \brief Construct a ripper job
  31    *
  32    * \param[in] input The input file url
  33    * \param[in] output The output file url
  34    * \param[in] tag The music tag to attach to track
  35    * \param[in] encoder The encoder to use. See Encoder.h
  36    * \param[in] eject Should we eject tray on finish?
  37    * \param[in] rate The sample rate of the input
  38    * \param[in] channels Number of audio channels in input
  39    * \param[in] bps The bits per sample for input
  40    */
  41   CCDDARipJob(const std::string& input,
  42               const std::string& output,
  43               const MUSIC_INFO::CMusicInfoTag& tag,
  44               int encoder,
  45               bool eject = false,
  46               unsigned int rate = 44100,
  47               unsigned int channels = 2,
  48               unsigned int bps = 16);
  49
  50   ~CCDDARipJob() override;
  51
  52   const char* GetType() const override { return "cdrip"; }
  53   bool operator==(const CJob* job) const override;
  54   bool DoWork() override;
  55   std::string GetOutput() const { return m_output; }
  56
  57 protected:
  58   /*!
  59    * \brief Setup the audio encoder
  60    */
  61   std::unique_ptr<CEncoder> SetupEncoder(XFILE::CFile& reader);
  62
  63   /*!
  64    * \brief Helper used if output is a remote url
  65    */
  66   std::string SetupTempFile();
  67
  68   /*!
  69    * \brief Rip a chunk of audio
  70    *
  71    * \param[in] reader The input reader
  72    * \param[in] encoder The audio encoder
  73    * \param[out] percent The percentage completed on return
  74    * \return 0 (CDDARIP_OK) if everything went okay, or
  75    *         a positive error code from the reader, or
  76    *         -1 if the encoder failed
  77    * \sa CCDDARipper::GetData, CEncoder::Encode
  78    */
  79   int RipChunk(XFILE::CFile& reader, const std::unique_ptr<CEncoder>& encoder, int& percent);
  80
  81   unsigned int m_rate; //< The sample rate of the input file
  82   unsigned int m_channels; //< The number of channels in input file
  83   unsigned int m_bps; //< The bits per sample of input
  84   MUSIC_INFO::CMusicInfoTag m_tag; //< Music tag to attach to output file
  85   std::string m_input; //< The input url
  86   std::string m_output; //< The output url
  87   bool m_eject; //< Should we eject tray when we are finished?
  88   int m_encoder; //< The audio encoder
  89 };
  90
  91 } /* namespace CDRIP */
  92 } /* namespace KODI */